mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
thosakwe 2017-09-15 15:30:44 -04:00
parent 79608562aa
commit 8e5e0f0377
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -18,8 +18,8 @@ In your `pubspec.yaml`, you need to install the following dependencies:
dependencies: dependencies:
angel_serialize: ^1.0.0-alpha angel_serialize: ^1.0.0-alpha
dev_dependencies: dev_dependencies:
angel_serialize_builder: ^1.0.0-alpha angel_serialize_generator: ^1.0.0-alpha
build_runner: ^0.3.0 build_runner: ^0.5.0
``` ```
You'll want to create a Dart script, usually named `tool/phases.dart` that invokes You'll want to create a Dart script, usually named `tool/phases.dart` that invokes
@ -28,11 +28,13 @@ the `JsonModelGenerator`.
```dart ```dart
import 'package:build_runner/build_runner.dart'; import 'package:build_runner/build_runner.dart';
import 'package:source_gen/source_gen.dart'; import 'package:source_gen/source_gen.dart';
import 'package:angel_serialize_builder/angel_serialize_builder.dart'; import 'package:angel_serialize_generator/angel_serialize_generator.dart';
final PhaseGroup PHASES = new PhaseGroup.singleAction( final List<BuildAction> actions = [
new GeneratorBuilder([const JsonModelGenerator()]), new BuildAction(new PartBuilder([const JsonModelGenerator()]),
new InputSet('[YOUR_PACKAGE_NAME_HERE]', const ['lib/src/models/*.dart'])); '<package-name>',
inputs: const ['test/models/*.dart'])
];
``` ```
And then, a `tool/build.dart` can build your serializers: And then, a `tool/build.dart` can build your serializers:
@ -40,7 +42,7 @@ And then, a `tool/build.dart` can build your serializers:
import 'package:build_runner/build_runner.dart'; import 'package:build_runner/build_runner.dart';
import 'phases.dart'; import 'phases.dart';
main() => build(PHASES, deleteFilesByDefault: true); main() => build(actions, deleteFilesByDefault: true);
``` ```
If you want to watch for file changes and re-build when necessary, replace the `build` call If you want to watch for file changes and re-build when necessary, replace the `build` call