Add some breadcrumbs to make updating json_annotation easier...later

Author: kevmoo

json_serializable/lib/src/settings.dart

@@ -45,6 +45,7 @@ class Settings {
 
   final JsonSerializable _config;
 
+  // #CHANGE WHEN UPDATING json_annotation
   ClassConfig get config => ClassConfig(
         checked: _config.checked ?? ClassConfig.defaults.checked,
         anyMap: _config.anyMap ?? ClassConfig.defaults.anyMap,

json_serializable/lib/src/type_helpers/config_types.dart

@@ -111,6 +111,7 @@ const _$FieldRenameEnumMap = {
   FieldRename.pascal: 'pascal',
 };
 
+// #CHANGE WHEN UPDATING json_annotation
 Map<String, dynamic> _$JsonSerializableToJson(JsonSerializable instance) =>
     <String, dynamic>{
       'any_map': instance.anyMap,

json_serializable/lib/src/utils.dart

@@ -75,6 +75,7 @@ T enumValueForDartObject<T>(
 
 /// Return an instance of [JsonSerializable] corresponding to a the provided
 /// [reader].
+// #CHANGE WHEN UPDATING json_annotation
 JsonSerializable _valueForAnnotation(ConstantReader reader) => JsonSerializable(
       anyMap: reader.read('anyMap').literalValue as bool?,
       checked: reader.read('checked').literalValue as bool?,

json_serializable/test/config_test.dart

@@ -76,8 +76,12 @@ void main() {
 
     final configMap = Map<String, dynamic>.from(yaml);
 
-    expect(configMap.keys, unorderedEquals(generatorConfigDefaultJson.keys),
-        reason: 'All supported keys are documented.');
+    expect(
+      configMap.keys,
+      unorderedEquals(generatorConfigDefaultJson.keys),
+      reason: 'All supported keys are documented. '
+          'Did you forget to change README.md?',
+    );
 
     expect(
       JsonSerializable.fromJson(configMap).toJson(),
@@ -131,6 +135,7 @@ $lastLine''',
   });
 }
 
+// #CHANGE WHEN UPDATING json_annotation
 const _invalidConfig = {
   'any_map': 42,
   'checked': 42,

json_serializable/test/custom_configuration_test.dart

@@ -110,7 +110,11 @@ Future<void> main() async {
           expected[jsonSerialKey] = generatorConfigDefaultJson[jsonSerialKey];
         }
 
-        expect(_ConfigLogger.configurations.first.toJson(), expected);
+        expect(
+          _ConfigLogger.configurations.first.toJson(),
+          expected,
+          reason: 'Did you forget to change README.md?',
+        );
       },
     );
   });

json_serializable/test/shared_config.dart

@@ -7,9 +7,10 @@ import 'package:json_serializable/src/type_helpers/config_types.dart';
 
 final jsonSerializableFields = generatorConfigDefaultJson.keys.toList();
 
-final generatorConfigDefaultJson = Map<String, dynamic>.unmodifiable(
-    ClassConfig.defaults.withDefaults().toJson());
+final generatorConfigDefaultJson =
+    Map<String, dynamic>.unmodifiable(ClassConfig.defaults.toJson());
 
+// #CHANGE WHEN UPDATING json_annotation
 final generatorConfigNonDefaultJson =
     Map<String, dynamic>.unmodifiable(const JsonSerializable(
   anyMap: true,

json_serializable/test/test_sources/test_sources.dart

@@ -5,6 +5,7 @@ class ConfigurationImplicitDefaults {
   int? field;
 }
 
+// #CHANGE WHEN UPDATING json_annotation
 @JsonSerializable(
   anyMap: false,
   checked: false,