Add JsonConverter(converters) option (#1135)

Co-authored-by: Kevin Moore <[email protected]>

Author: rrousselGit

checked_yaml/pubspec.yaml

@@ -22,5 +22,7 @@ dev_dependencies:
   test_process: ^2.0.0
 
 dependency_overrides:
+  json_annotation:
+    path: ../json_annotation
   json_serializable:
     path: ../json_serializable

json_annotation/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.6.0
+
+- Added `JsonSerializable(converters: <JsonConverter>[])`
+  ([#1072](https://github.com/google/json_serializable.dart/issues/1072))
+
 ## 4.5.0
 
 - Added `FieldRename.screamingSnake`.
@@ -38,7 +43,7 @@
 
 ## 4.0.1
 
-- Fix a potential error with `checked: true` when `ArgumentError.message` is 
+- Fix a potential error with `checked: true` when `ArgumentError.message` is
   `null`.
 - Updated `JsonSerializable.fromJson` to handle `null` values.
 - Deprecate `JsonSerializable` `defaults` and `withDefaults()`.

json_annotation/lib/src/json_converter.dart

@@ -8,6 +8,37 @@
 ///
 /// [S] is the type of the value stored in JSON. It must be a valid JSON type
 /// such as [String], [int], or [Map<String, dynamic>].
+///
+///
+/// [JsonConverter]s can be placed either on the class:
+///
+/// ```dart
+/// class MyConverter extends JsonConverter<Value, JSON> {
+///   // TODO
+/// }
+///
+/// @JsonSerializable()
+/// @MyJsonConverter()
+/// class Example {}
+/// ```
+///
+/// or on a property:
+///
+/// ```dart
+/// @JsonSerializable()
+/// @MyJsonConverter()
+/// class Example {
+///   @MyJsonConverter()
+///   final Value property;
+/// }
+/// ```
+///
+/// Or finally, passed to the annotation:
+///
+///```dart
+/// @JsonSerializable(converters: [MyConverter()])
+/// class Example {}
+/// ```
 abstract class JsonConverter<T, S> {
   const JsonConverter();
 

json_annotation/lib/src/json_serializable.dart

@@ -6,6 +6,7 @@ import 'package:meta/meta_meta.dart';
 
 import 'allowed_keys_helpers.dart';
 import 'checked_helpers.dart';
+import 'json_converter.dart';
 import 'json_key.dart';
 
 part 'json_serializable.g.dart';
@@ -190,6 +191,40 @@ class JsonSerializable {
   /// `includeIfNull`, that value takes precedent.
   final bool? includeIfNull;
 
+  /// A list of [JsonConverter] to apply to this class.
+  ///
+  /// Writing:
+  ///
+  /// ```dart
+  /// @JsonSerializable(converters: [MyJsonConverter()])
+  /// class Example {...}
+  /// ```
+  ///
+  /// is equivalent to writing:
+  ///
+  /// ```dart
+  /// @JsonSerializable()
+  /// @MyJsonConverter()
+  /// class Example {...}
+  /// ```
+  ///
+  /// The main difference is that this allows reusing a custom
+  /// [JsonSerializable] over multiple classes:
+  ///
+  /// ```dart
+  /// const myCustomAnnotation = JsonSerializable(
+  ///   converters: [MyJsonConverter()],
+  /// );
+  ///
+  /// @myCustomAnnotation
+  /// class Example {...}
+  ///
+  /// @myCustomAnnotation
+  /// class Another {...}
+  /// ```
+  @JsonKey(ignore: true)
+  final List<JsonConverter>? converters;
+
   /// Creates a new [JsonSerializable] instance.
   const JsonSerializable({
     @Deprecated('Has no effect') bool? nullable,
@@ -203,6 +238,7 @@ class JsonSerializable {
     this.fieldRename,
     this.ignoreUnannotated,
     this.includeIfNull,
+    this.converters,
     this.genericArgumentFactories,
   });
 

json_annotation/pubspec.yaml

@@ -1,5 +1,5 @@
 name: json_annotation
-version: 4.5.0
+version: 4.6.0
 description: >-
   Classes and helper functions that support JSON code generation via the
   `json_serializable` package.

json_serializable/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 - Added support for using a `JsonConverter<MyClass, Object>` on properties
   of type `MyClass?`. ([#822](https://github.com/google/json_serializable.dart/issues/822))
+- Added support for `JsonSerializable(converters: <JsonConverter>[])`
+  ([#1072](https://github.com/google/json_serializable.dart/issues/1072))
 
 ## 6.2.0
 

json_serializable/README.md

@@ -199,14 +199,14 @@ targets:
 [`Enum`]: https://api.dart.dev/stable/dart-core/Enum-class.html
 [`int`]: https://api.dart.dev/stable/dart-core/int-class.html
 [`Iterable`]: https://api.dart.dev/stable/dart-core/Iterable-class.html
-[`JsonConverter`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonConverter-class.html
-[`JsonEnum`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonEnum-class.html
-[`JsonKey.fromJson`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonKey/fromJson.html
-[`JsonKey.toJson`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonKey/toJson.html
-[`JsonKey`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonKey-class.html
-[`JsonLiteral`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonLiteral-class.html
-[`JsonSerializable`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonSerializable-class.html
-[`JsonValue`]: https://pub.dev/documentation/json_annotation/4.5.0/json_annotation/JsonValue-class.html
+[`JsonConverter`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonConverter-class.html
+[`JsonEnum`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonEnum-class.html
+[`JsonKey.fromJson`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonKey/fromJson.html
+[`JsonKey.toJson`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonKey/toJson.html
+[`JsonKey`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonKey-class.html
+[`JsonLiteral`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonLiteral-class.html
+[`JsonSerializable`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonSerializable-class.html
+[`JsonValue`]: https://pub.dev/documentation/json_annotation/4.6.0/json_annotation/JsonValue-class.html
 [`List`]: https://api.dart.dev/stable/dart-core/List-class.html
 [`Map`]: https://api.dart.dev/stable/dart-core/Map-class.html
 [`num`]: https://api.dart.dev/stable/dart-core/num-class.html

json_serializable/lib/src/check_dependencies.dart

@@ -10,7 +10,7 @@ import 'package:pubspec_parse/pubspec_parse.dart';
 
 const _productionDirectories = {'lib', 'bin'};
 const _annotationPkgName = 'json_annotation';
-final requiredJsonAnnotationMinVersion = Version.parse('4.5.0');
+final requiredJsonAnnotationMinVersion = Version.parse('4.6.0');
 
 Future<void> pubspecHasRightVersion(BuildStep buildStep) async {
   final segments = buildStep.inputId.pathSegments;

json_serializable/lib/src/json_serializable_generator.dart

@@ -20,7 +20,7 @@ class JsonSerializableGenerator
     extends GeneratorForAnnotation<JsonSerializable> {
   final Settings _settings;
 
-  JsonSerializable get config => _settings.config;
+  JsonSerializable get config => _settings.config.toJsonSerializable();
 
   JsonSerializableGenerator.fromSettings(this._settings);
 

json_serializable/lib/src/settings.dart

@@ -43,38 +43,19 @@ class Settings {
         GenericFactoryHelper(),
       ].followedBy(_typeHelpers).followedBy(_coreHelpers);
 
-  final JsonSerializable _config;
-
-  // #CHANGE WHEN UPDATING json_annotation
-  ClassConfig get config => ClassConfig(
-        checked: _config.checked ?? ClassConfig.defaults.checked,
-        anyMap: _config.anyMap ?? ClassConfig.defaults.anyMap,
-        constructor: _config.constructor ?? ClassConfig.defaults.constructor,
-        createFactory:
-            _config.createFactory ?? ClassConfig.defaults.createFactory,
-        createToJson: _config.createToJson ?? ClassConfig.defaults.createToJson,
-        ignoreUnannotated:
-            _config.ignoreUnannotated ?? ClassConfig.defaults.ignoreUnannotated,
-        explicitToJson:
-            _config.explicitToJson ?? ClassConfig.defaults.explicitToJson,
-        includeIfNull:
-            _config.includeIfNull ?? ClassConfig.defaults.includeIfNull,
-        genericArgumentFactories: _config.genericArgumentFactories ??
-            ClassConfig.defaults.genericArgumentFactories,
-        fieldRename: _config.fieldRename ?? ClassConfig.defaults.fieldRename,
-        disallowUnrecognizedKeys: _config.disallowUnrecognizedKeys ??
-            ClassConfig.defaults.disallowUnrecognizedKeys,
-      );
+  final ClassConfig config;
 
   /// Creates an instance of [Settings].
   ///
   /// If [typeHelpers] is not provided, the built-in helpers are used:
   /// [BigIntHelper], [DateTimeHelper], [DurationHelper], [JsonHelper], and
   /// [UriHelper].
-  const Settings({
+  Settings({
     JsonSerializable? config,
     List<TypeHelper>? typeHelpers,
-  })  : _config = config ?? ClassConfig.defaults,
+  })  : config = config != null
+            ? ClassConfig.fromJsonSerializable(config)
+            : ClassConfig.defaults,
         _typeHelpers = typeHelpers ?? defaultHelpers;
 
   /// Creates an instance of [Settings].