Merge pull request #194 from Workiva/add_json_typedefs

Add typedefs for json maps

Author: rmconsole7-wk

.github/workflows/dart_ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [ 2.18.7, 2.19.6 ]
+        sdk: [ 2.19.6, stable ]
     steps:
       - uses: actions/checkout@v2
       - uses: dart-lang/setup-dart@v1

w_common/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.1.0](https://github.com/Workiva/w_common/compare/3.0.0...3.1.0)
+
+- Adds JsonMap and JsonMapObject typedefs
+- Update SDK minimum to 2.19.0 to support the non-function
+ typedef language feature.
+- Raised package versions to their first nullsafe version.
+
 ## [3.0.0](https://github.com/Workiva/w_common/compare/2.1.2...3.0.0)
 
 - Migrate to null-safety.

w_common/lib/json_serializable.dart

@@ -21,10 +21,16 @@ abstract class JsonSerializable {
   /// Returns a map representing the serialized class.
   ///
   ///   @override
-  ///   Map<String, dynamic> toJson() {
-  ///     Map<String, dynamic> fieldMap = {};
+  ///   JsonMap toJson() {
+  ///     JsonMap fieldMap = {};
   ///     fieldMap['context'] = _context;
   ///     return fieldMap;
   ///   }
-  Map<String, dynamic> toJson();
+  JsonMap toJson();
 }
+
+/// A type definition for a map that represents the default JSON object type Map<String, dynamic>.
+typedef JsonMap = Map<String, dynamic>;
+
+/// A type definition for a map that represents a JSON map of Map<String, Object?>.
+typedef JsonMapObject = Map<String, Object?>;

w_common/lib/src/common/disposable.dart

@@ -553,6 +553,7 @@ class Disposable implements _Disposable, DisposableManagerV7, LeakFlagger {
   }
 
   void manageDisposable(Disposable disposable) {
+    // ignore: unnecessary_null_comparison
     if (disposable == null) {
       return;
     }

w_common/lib/src/common/managed_stream_subscription.dart

@@ -43,6 +43,7 @@ class ManagedStreamSubscription<T> implements StreamSubscription<T> {
     // StreamSubscription.cancel() will return null if no cleanup was
     // necessary. This behavior is described in the docs as "for historical
     // reasons" so this may change in the future.
+    // ignore: unnecessary_null_comparison
     if (result == null) {
       _complete();
       return Future(() {});

w_common/pubspec.yaml

@@ -4,7 +4,7 @@ description: General utilities for Dart projects.
 homepage: https://www.github.com/Workiva/w_common
 
 environment:
-  sdk: '>=2.12.0 <3.0.0'
+  sdk: '>=2.19.0 <3.0.0'
 
 dependencies:
   intl: '>=0.17.0 <0.19.0'
@@ -17,9 +17,9 @@ dev_dependencies:
   build_test: ^2.0.0
   build_web_compilers: ^3.0.0
   dependency_validator: ^3.0.0
-  mocktail: ^1.0.3
+  mocktail: ^1.0.4
   test: ^1.21.1
-  workiva_analysis_options: ^1.0.0
+  workiva_analysis_options: ^1.4.2
 
 dependency_validator:
   ignore:

w_common_tools/lib/src/bin/compile_sass.dart

@@ -117,7 +117,7 @@ class SassCompilationOptions {
       exitCode = 1;
       return;
     }
-
+    // ignore: unnecessary_null_comparison
     if (unparsedArgs != null && unparsedArgs.isNotEmpty) {
       compileTargets = unparsedArgs.map(path.relative).toList();
       exitCode = _validateCompileTargets();