Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1105)

Unified Diff: reflectable/README.md

Issue 2002033002: Extends README.md to mention indirect use. (Closed) Base URL: https://github.com/dart-lang/reflectable.git@master
Patch Set: Created 4 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: reflectable/README.md
diff --git a/reflectable/README.md b/reflectable/README.md
index e1aa92e3d35272188c0e295a856e57706e2fbe16..5e8cc8bde5c8c873c6845d37ecaa9a69bd0cda32 100644
--- a/reflectable/README.md
+++ b/reflectable/README.md
@@ -139,10 +139,18 @@ transformers:
formatted: true # Optional.
```
-Note that it is possible to use globbing with entry points, based on the
-package [glob](https://pub.dartlang.org/packages/glob). For instance,
-`entry_points: ["test/*_test.dart"]` can be used to specify that all Dart
-source files in `test` whose name ends in `_test.dart` are entry points.
+Note that it is necessary to include the reflectable transformer in the
+`pubspec.yaml` of your package if you use reflectable directly *or indirectly*
+(by depending on a package that uses reflectable), because the transformer may
+need to generate code based on files in your package. In particular, if you
+are writing a package which uses reflectable and is expected to be used by
+clients, please make it explicit that such clients must include the reflectable
+transformer in their `pubspec.yaml`.
+
+It is possible to use globbing with entry points, based on the package
+[glob](https://pub.dartlang.org/packages/glob). For instance, `entry_points:
+["test/*_test.dart"]` can be used to specify that all Dart source files in
+`test` whose name ends in `_test.dart` are entry points.
Now run `pub build --mode=debug web` to perform the transformation. This will
rename the file `web/main.dart` and generate a new file `build/web/main.dart`.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698