Introduced ignore attribute to JsonKey.

.travis.yml

@@ -1,30 +1,57 @@
 # Created with https://github.com/dart-lang/mono_repo
 language: dart
 
-dart:
-  - dev
-  - stable
+jobs:
+  include:
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartfmt
+      env: PKG="example"
+      dart: dev
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartanalyzer
+      env: PKG="example"
+      dart: dev
+    - stage: unit_test
+      script: ./tool/travis.sh test
+      env: PKG="example"
+      dart: dev
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartfmt
+      env: PKG="json_annotation"
+      dart: dev
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartfmt
+      env: PKG="json_annotation"
+      dart: stable
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartanalyzer
+      env: PKG="json_annotation"
+      dart: dev
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartanalyzer
+      env: PKG="json_annotation"
+      dart: stable
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartfmt
+      env: PKG="json_serializable"
+      dart: dev
+    - stage: analyzer_and_format
+      script: ./tool/travis.sh dartanalyzer
+      env: PKG="json_serializable"
+      dart: dev
+    - stage: unit_test
+      script: ./tool/travis.sh test
+      env: PKG="json_serializable"
+      dart: dev
 
-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
-
-matrix:
-  exclude:
-    - dart: stable
-      env: PKG=json_serializable TASK=dartanalyzer
-    - dart: stable
-      env: PKG=json_serializable TASK=dartfmt
-
-script: ./tool/travis.sh
+stages:
+  - analyzer_and_format
+  - unit_test
 
 # Only building master means that we don't run two builds for each pull request.
 branches:
   only: [master]
 
 cache:
- directories:
-   - $HOME/.pub-cache
+  directories:
+    - $HOME/.pub-cache

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.

README.md

@@ -1,19 +1,31 @@
 # [![Build Status](https://travis-ci.org/dart-lang/json_serializable.svg?branch=master)](https://travis-ci.org/dart-lang/json_serializable)
 
-Provides `source_gen` `Generator`s which generate code to
-make it simple to serialize to and from JSON.
+Provides [source_gen] `Generator`s to create code for JSON serialization and
+deserialization.
 
-## [json_serializable]
+## json_serializable
+
+* Package: https://pub.dartlang.org/packages/json_serializable
+* [Source code](json_serializable)
 
 The core package providing Generators for JSON-specific tasks.
 
 Import it into your pubspec `dev_dependencies:` section.
 
-## [json_annotation]
+## json_annotation
+
+* Package: https://pub.dartlang.org/packages/json_annotation
+* [Source code](json_annotation)
 
 The annotation package which has no dependencies.
 
 Import it into your pubspec `dependencies:` section.
 
-[json_serializable]: https://github.com/dart-lang/json_serializable/blob/master/json_serializable/README.md
-[json_annotation]: https://github.com/dart-lang/json_serializable/blob/master/json_annotation/README.md
+## example
+
+* [Source code](example)
+
+An example showing how to setup and use `json_serializable` and
+`json_annotation`.
+
+[source_gen]: https://pub.dartlang.org/packages/source_gen

analysis_options.yaml

@@ -8,33 +8,65 @@ analyzer:
     dead_code: error
 linter:
   rules:
-    # Errors
-    - avoid_empty_else
-    - comment_references
-    - control_flow_in_finally
-    - empty_statements
-    - hash_and_equals
-    - implementation_imports
-    - test_types_in_equals
-    - throw_in_finally
-    - unrelated_type_equality_checks
-    - valid_regexps
-
-    # Style
     - annotate_overrides
+    - avoid_empty_else
+    - avoid_function_literals_in_foreach_calls
     - avoid_init_to_null
+    - avoid_null_checks_in_equality_operators
     - avoid_return_types_on_setters
+    - avoid_returning_null
+    - avoid_unused_constructor_parameters
     - await_only_futures
     - camel_case_types
+    - cancel_subscriptions
+    #- cascade_invocations
+    - comment_references
+    - constant_identifier_names
+    - control_flow_in_finally
     - directives_ordering
     - empty_catches
     - empty_constructor_bodies
+    - empty_statements
+    - hash_and_equals
+    - implementation_imports
+    - invariant_booleans
+    - iterable_contains_unrelated_type
     - library_names
     - library_prefixes
+    - list_remove_unrelated_type
+    - no_adjacent_strings_in_list
+    - no_duplicate_case_values
     - non_constant_identifier_names
+    - omit_local_variable_types
     - only_throw_errors
+    - overridden_fields
+    - package_api_docs
+    - package_names
+    - package_prefixed_library_names
+    - prefer_adjacent_string_concatenation
+    - prefer_collection_literals
+    - prefer_conditional_assignment
+    - prefer_const_constructors
+    - prefer_contains
     - prefer_final_fields
+    - prefer_initializing_formals
+    - prefer_interpolation_to_compose_strings
+    - prefer_is_empty
     - prefer_is_not_empty
     - prefer_single_quotes
+    - prefer_typing_uninitialized_variables
+    - recursive_getters
     - slash_for_doc_comments
+    - super_goes_last
+    - test_types_in_equals
+    - throw_in_finally
     - type_init_formals
+    - unawaited_futures
+    - unnecessary_brace_in_string_interps
+    - unnecessary_getters_setters
+    - unnecessary_lambdas
+    - unnecessary_null_aware_assignments
+    - unnecessary_statements
+    - unnecessary_this
+    - unrelated_type_equality_checks
+    - valid_regexps

example/.gitignore

@@ -0,0 +1,5 @@
+# Files and directories created by pub
+.packages
+.pub/
+build/
+pubspec.lock

example/.mono_repo.yml

@@ -0,0 +1,11 @@
+# See https://github.com/dart-lang/mono_repo for details
+dart:
+  - dev
+
+stages:
+  - analyzer_and_format:
+    - dartfmt
+    - dartanalyzer: --fatal-infos --fatal-warnings .
+  - unit_test:
+    # Run the tests -- include the default-skipped presubmit tests
+    - test: --run-skipped

example/README.md

@@ -0,0 +1,48 @@
+*This example assumes you're using a recent version of the Dart or Flutter SDK.*
+
+* Dart: you need a [v2 pre-release](https://www.dartlang.org/dart-2).
+* Flutter: at least 0.0.23 (Feb 5, 2018).
+
+To use [package:json_serializable][json_serializable] in your package, add these
+dependencies to your `pubspec.yaml`.
+
+```yaml
+dependencies:
+  json_annotation: ^0.2.2
+
+dev_dependencies:
+  build_runner: ^0.7.6
+  json_serializable: ^0.4.0
+```
+
+Annotate your code with classes defined in
+[package:json_annotation][json_annotation].
+
+* See [`lib/example.dart`][example] for an example of a file using these
+  annotations.
+
+* See [`lib/example.g.dart`][example_g] for the generated file.
+
+If you would like to use a custom header, or enable the wrapper option, add a
+[`build.yaml`][build_config] file and a default target.
+
+Run `pub run build_runner build` to generate files into your source directory.
+
+```console
+> pub run build_runner build
+[INFO] ensureBuildScript: Generating build script completed, took 368ms
+[INFO] BuildDefinition: Reading cached asset graph completed, took 54ms
+[INFO] BuildDefinition: Checking for updates since last build completed, took 663ms
+[INFO] Build: Running build completed, took 10ms
+[INFO] Build: Caching finalized dependency graph completed, took 44ms
+[INFO] Build: Succeeded after 4687ms with 1 outputs
+```
+
+*NOTE*: If you're using Flutter, running a script from a Dart package is a bit
+tricky. Replace `pub run` with `flutter packages pub run`.
+
+[example]: lib/example.dart
+[example_g]: lib/example.g.dart
+[build_config]: build.yaml
+[json_annotation]: https://pub.dartlang.org/packages/json_annotation
+[json_serializable]: https://pub.dartlang.org/packages/json_serializable

example/build.yaml

@@ -0,0 +1,13 @@
+# Read about `build.yaml` at https://pub.dartlang.org/packages/build_config
+targets:
+  $default:
+    builders:
+      json_serializable:
+        options:
+          header: |+
+           // 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.
+
+           // GENERATED CODE - DO NOT MODIFY BY HAND
+

example/dart_test.yaml

@@ -0,0 +1,3 @@
+tags:
+  presubmit-only:
+    skip: "Should only be run during presubmit"

json_serializable/example/example.dart → example/lib/example.dart

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 // ignore_for_file: annotate_overrides
-library json_serializable.example;
 
 import 'package:json_annotation/json_annotation.dart';
 part 'example.g.dart';

json_serializable/example/example.g.dart → example/lib/example.g.dart

@@ -4,7 +4,7 @@
 
 // GENERATED CODE - DO NOT MODIFY BY HAND
 
-part of json_serializable.example;
+part of 'example.dart';
 
 // **************************************************************************
 // Generator: JsonSerializableGenerator

example/pubspec.yaml

@@ -0,0 +1,16 @@
+name: example
+author: Dart Team <misc@dartlang.org>
+
+environment:
+  sdk: '>=2.0.0-dev.9 <2.0.0'
+
+dependencies:
+  json_annotation: ^0.2.2
+
+dev_dependencies:
+  build_runner: ^0.7.6
+  json_serializable: ^0.4.0
+
+  # Used by tests. Not required to use `json_serializable`.
+  path: ^1.5.1
+  test: ^0.12.29