Chromium Code Reviews Chromium Code Reviews
Issue 1504033006:
README update to redirect to the SDK (sdk#24731). (Closed)
Base URL: https://github.com/dart-lang/analyzer_cli.git@master| Index: README.md |
| diff --git a/README.md b/README.md |
| index 1652184ec3a6fd354551e315cc0290596d089319..01ffcc9bd6d8939a0d6580779831c0e9bbe331d5 100644 |
| --- a/README.md |
| +++ b/README.md |
| @@ -1,87 +1,7 @@ |
| -# dartanalyzer |
| +**We've moved!** |
| -Use _dartanalyzer_ to statically analyze your code at the command line, |
| -checking for errors and warnings that are specified in the |
| -[Dart Language Specification](https://www.dartlang.org/docs/spec/). |
| -DartPad, code editors, and IDEs such as WebStorm use the same |
| -analysis engine that dartanalyzer uses. |
| +The `analyzer_cli` package has moved into the dart SDK [repo](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli). |
|
Kathy Walrath
2015/12/08 18:25:30
The link sounds like it goes to the top of the rep
pquitslund
2015/12/08 19:37:27
Done.
|
| -If you want to _contribute_ to the dartanalyzer project, see the |
| -[contributor docs](https://github.com/dart-lang/analyzer_cli/blob/master/CONTRIBUTOR.md). |
| -This page contains information about _using_ the dartanalyzer command-line tool. |
| +For background on this move, see this [issue](https://github.com/dart-lang/sdk/issues/24731). Going forward, please file bugs and enhancement requests against the SDK [here](https://github.com/dart-lang/sdk/issues/new). |
|
Kathy Walrath
2015/12/08 18:25:30
Let's try to make the text of these links clearer,
pquitslund
2015/12/08 19:37:27
Done.
|
| -## Basic usage |
| - |
| -Run the analyzer from the top directory of the package. |
| -Here's an example of testing a Dart file. |
| - |
| -``` |
| -dartanalyzer bin/test.dart |
| -``` |
| - |
| -## Options |
| - |
| -The following are the most commonly used options for dartanalyzer: |
| - |
| -* `--packages=`<br> |
| - Specify the path to the package resolution configuration file. |
| - For more information see |
| - [Package Resolution Configuration File](https://github.com/lrhn/dep-pkgspec/blob/master/DEP-pkgspec.md). |
| -This option cannot be used with `--package-root`. |
| - |
| -* `--package-warnings`<br> |
| - Show warnings not only for code in the specified .dart file and |
| - others in its library, but also for libraries imported with `package:`. |
| - |
| -* `--options=`<br> |
| - Specify the path to an analysis options file. |
| - |
| -* `--lints`<br> |
| - Show the results from the linter. |
| - |
| -* `--no-hints`<br> |
| - Don't show hints for improving the code. |
| - |
| -* `--ignore-unrecognized-flags`<br> |
| - Rather than printing the help message, |
| - ignore any unrecognized command-line flags. |
| - |
| -* `--version`<br> |
| - Show the analyzer version. |
| - |
| -* `-h` _or_ `--help`<br> |
| - Show all the command-line options. |
| - |
| -The following are advanced options to use with dartanalyzer: |
| - |
| -* `-b` _or_ `--batch`<br> |
| - Run in batch mode. |
| - |
| -* `--dart-sdk=`<br> |
| - Specify the directory that contains the Dart SDK. |
| - |
| -* `--fatal-warnings`<br> |
| - Except for type warnings, treat warnings as fatal. |
| - |
| -* `--format=machine`<br> |
| - Produce output in a format suitable for parsing. |
| - |
| -* `--url-mapping=libraryUri,/path/to/library.dart`<br> |
| - Tells the analyzer to use the specified library as the source |
| - for that particular import. |
| - |
| -The following options are deprecated: |
| - |
| -* `-p` _or_ `--package-root=`<br> |
| - **Deprecated.** Specify the directory to search for any libraries that are |
| - imported using `package:`. _This option is replaced as of Dart 1.12 with |
| - `--packages`._ |
| - |
| -* `--machine`<br> |
| - **Deprecated.** Replaced by `--format`. |
| - |
| -* `--show-package-warnings`<br> |
| - **Deprecated.** Replaced by `--package-warnings`. |
| - |
| -* `--show-sdk-warnings`<br> |
| - **Deprecated.** Replaced by `--warnings`. |
| +Thanks! |
