Move annotations into json_annotation package

kevmoo · kevmoo · commit 14ddc18c6556 · 2017-09-27T14:45:22.000-07:00
Closes #37
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,8 @@ dart:
   - stable
 
 env:
+  - PKG=json_annotation TASK=dartanalyzer
+  - PKG=json_annotation TASK=dartfmt
   - PKG=json_serializable TASK=dartanalyzer
   - PKG=json_serializable TASK=dartfmt
   - PKG=json_serializable TASK=test
diff --git a/json_annotation/.gitignore b/json_annotation/.gitignore
@@ -0,0 +1,4 @@
+# Files and directories created by pub
+.packages
+.pub/
+pubspec.lock
diff --git a/json_annotation/.travis.yml b/json_annotation/.travis.yml
@@ -0,0 +1,16 @@
+language: dart
+dart:
+  - dev
+  - stable
+
+dart_task:
+  - dartfmt
+  - dartanalyzer
+
+# Only building master means that we don't run two builds for each pull request.
+branches:
+  only: [master]
+
+cache:
+  directories:
+    - $HOME/.pub-cache
diff --git a/json_annotation/CHANGELOG.md b/json_annotation/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.2.0
+
+- Moved annotation classes for `JsonSerializable` and `JsonLiteral`.
diff --git a/json_annotation/LICENSE b/json_annotation/LICENSE
@@ -0,0 +1,26 @@
+Copyright 2017, the Dart project authors. All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google Inc. nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/json_annotation/README.md b/json_annotation/README.md
@@ -0,0 +1,9 @@
+Annotations for [json_serializable]. Use these to eliminate a production
+dependency on `json_serializable` and the associated transitive dependencies.
+
+## Features and bugs
+
+Please file feature requests and bugs at the [issue tracker][tracker].
+
+[tracker]: https://github.com/dart-lang/json_serializable/issues
+[json_serializable]: https://pub.dartlang.org/packages/json_serializable
diff --git a/json_annotation/analysis_options.yaml b/json_annotation/analysis_options.yaml
@@ -0,0 +1,15 @@
+analyzer:
+  strong-mode: true
+#   exclude:
+#     - path/to/excluded/files/**
+
+# Lint rules and documentation, see http://dart-lang.github.io/linter/lints
+linter:
+  rules:
+    - cancel_subscriptions
+    - hash_and_equals
+    - iterable_contains_unrelated_type
+    - list_remove_unrelated_type
+    - test_types_in_equals
+    - unrelated_type_equality_checks
+    - valid_regexps
diff --git a/json_annotation/lib/json_annotation.dart b/json_annotation/lib/json_annotation.dart
@@ -0,0 +1,8 @@
+// Copyright (c) 2017, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+/// Use these annotations on members you'd like to enable source generation on.
+
+export 'src/json_literal.dart';
+export 'src/json_serializable.dart';
diff --git a/json_annotation/lib/src/json_literal.dart b/json_annotation/lib/src/json_literal.dart
diff --git a/json_annotation/lib/src/json_serializable.dart b/json_annotation/lib/src/json_serializable.dart
diff --git a/json_annotation/pubspec.yaml b/json_annotation/pubspec.yaml
@@ -0,0 +1,7 @@
+name: json_annotation
+version: 0.2.0
+description: Annotations for the json_serializable package
+homepage: https://github.com/dart-lang/json_serializable
+author: Dart Team <misc@dartlang.org>
+environment:
+  sdk: '>=1.24.0 <2.0.0'
diff --git a/json_serializable/CHANGELOG.md b/json_serializable/CHANGELOG.md
@@ -1,3 +1,12 @@
+## 0.2.4
+
+* Moved the annotations in `annotations.dart` to `package:json_annotations`.
+  * Allows package authors to release code that has the corresponding 
+    annotations without requiring package users to inherit all of the transitive
+    dependencies.
+
+* Deprecated `annotations.dart`.
+
 ## 0.2.3
 
 * Write out `toJson` methods more efficiently when the first fields written are
diff --git a/json_serializable/example/example.dart b/json_serializable/example/example.dart
@@ -5,7 +5,7 @@
 // ignore_for_file: annotate_overrides
 library json_serializable.example;
 
-import 'package:json_serializable/annotations.dart';
+import 'package:json_annotation/json_annotation.dart';
 part 'example.g.dart';
 
 @JsonSerializable()
diff --git a/json_serializable/lib/annotations.dart b/json_serializable/lib/annotations.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-/// Use these annotations on members you'd like to enable source generation on.
+@Deprecated('Use `package:json_annotation` instead.')
+library json_serializable.annotations;
 
-export 'src/json_literal.dart';
-export 'src/json_serializable.dart';
+export 'package:json_annotation/json_annotation.dart';
diff --git a/json_serializable/lib/src/json_literal_generator.dart b/json_serializable/lib/src/json_literal_generator.dart
@@ -10,7 +10,7 @@ import 'package:build/build.dart';
 import 'package:path/path.dart' as p;
 import 'package:source_gen/source_gen.dart';
 
-import 'json_literal.dart';
+import 'package:json_annotation/json_annotation.dart';
 
 class JsonLiteralGenerator extends GeneratorForAnnotation<JsonLiteral> {
   const JsonLiteralGenerator();
diff --git a/json_serializable/lib/src/json_serializable_generator.dart b/json_serializable/lib/src/json_serializable_generator.dart
@@ -8,9 +8,9 @@ import 'dart:collection';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/analyzer.dart';
+import 'package:json_annotation/json_annotation.dart';
 import 'package:source_gen/source_gen.dart';
 
-import 'json_serializable.dart';
 import 'type_helper.dart';
 import 'type_helpers/date_time_helper.dart';
 import 'type_helpers/enum_helper.dart';
diff --git a/json_serializable/pubspec.yaml b/json_serializable/pubspec.yaml
@@ -9,6 +9,7 @@ dependencies:
   analyzer: '>=0.29.10 <0.31.0'
   build: '>=0.9.0 <0.11.0'
   cli_util: ^0.1.0
+  json_annotation: any
   path: ^1.3.2
   source_gen: ^0.7.0
 dev_dependencies:
@@ -17,3 +18,7 @@ dev_dependencies:
   collection: ^1.14.0
   dart_style: ^1.0.0
   test: ^0.12.3
+
+dependency_overrides:
+  json_annotation:
+    path: ../json_annotation
diff --git a/json_serializable/test/test_files/bathtub.dart b/json_serializable/test/test_files/bathtub.dart
@@ -5,7 +5,7 @@
 // ignore_for_file: annotate_overrides, hash_and_equals
 library json_serializable.test.bathtub;
 
-import 'package:json_serializable/annotations.dart';
+import 'package:json_annotation/json_annotation.dart';
 
 import 'kitchen_sink.dart';
 
diff --git a/json_serializable/test/test_files/json_literal.dart b/json_serializable/test/test_files/json_literal.dart
@@ -4,7 +4,7 @@
 
 library json_serializable.example;
 
-import 'package:json_serializable/annotations.dart';
+import 'package:json_annotation/json_annotation.dart';
 part 'json_literal.g.dart';
 
 @JsonLiteral('data.json')
diff --git a/json_serializable/test/test_files/json_test_example.dart b/json_serializable/test/test_files/json_test_example.dart
@@ -8,7 +8,7 @@ library json_serializable.test.example;
 import 'dart:collection';
 
 import 'package:collection/collection.dart';
-import 'package:json_serializable/annotations.dart';
+import 'package:json_annotation/json_annotation.dart';
 
 part 'json_test_example.g.dart';
 
diff --git a/json_serializable/test/test_files/kitchen_sink.dart b/json_serializable/test/test_files/kitchen_sink.dart
@@ -6,7 +6,7 @@
 library json_serializable.test.kitche_sink;
 
 import 'package:collection/collection.dart';
-import 'package:json_serializable/annotations.dart';
+import 'package:json_annotation/json_annotation.dart';
 
 part 'kitchen_sink.g.dart';
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.2.0`
	`2`	`+`
	`3`	+- Moved annotation classes for `JsonSerializable` and `JsonLiteral`.