Sam Rawlins
7cad5f5e52
We don't have a strict rule set for naming test methods, but the general idea of grouping terms with underscores (and breaking an otherwise rather universal rule of using camelCase) is to help to group like test cases (aided by our alphabetical sorting enforcement). There were examples in this file that really broke the grouping mechanism by not using consistent grouping. Here are the broad strokes of what I changed; no test bodies were changed, _only names_, but the CL is hard to review because of sorting. * `test_classGetterSetter_...` and `test_classSetter_...` were renamed to use `class` as a group (`test_class_getterSetter_...` and `test_setter_...`) consistently. * `test_factoryConstructor_...` were renamed to use `constructor` as the group base (`test_constructorFactory...`). * `test_optionalParameter_...` were renamed to use `parameter` as the group base (`test_paramter_...`). This is the bulk of the change. There were previously dozens of tests starting with `test_optionalParameter_` _and_ dozens of tests starting with `test_parameter_`. However, `unused_element` only concerns itself with optional parameters, so that can be the default meaning of `test_parameter_`. (Similar to classes; we don't report any public classes as unused, but we don't need to write `private` in every test case.) * In the parameter tests, there was an inconsistent placement of the group `isUsed` or `notUsed`. It seems like the bulk of tests place the `isUsed` or `notUsed` grouping earlier rather than at the end of the test name, so I went with that for this consistency CL. Change-Id: I54be6591615d015ae9cf87ee4c9726ed7cfee209 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/468180 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Paul Berry <paulberry@google.com>
This package provides a library that performs static analysis of Dart code. It is useful for tool integration and embedding.
End-users should use the dart analyze command-line tool to analyze their Dart code.
Integrators that want to add Dart support to their editor should use the Dart Analysis Server. The Analysis Server API Specification is available. If you are adding Dart support to an editor or IDE, please let us know by emailing our list.
Configuring the analyzer
Both dart analyze and Dart Analysis Server can be configured with an
analysis_options.yaml file (using an .analysis_options file is deprecated).
This YAML file can control which files and paths are analyzed,
which lints are applied, and more.
If you are embedding the analyzer library in your project, you are responsible for finding the analysis options file, parsing it, and configuring the analyzer.
The analysis options file should live at the root of your project (for example,
next to your pubspec.yaml). Different embedders of analyzer, such as
dart analyze or Dart Analysis Server, may choose to find the file in various
different ways. Consult their documentation to learn more.
Here is an example file that instructs the analyzer to ignore two files:
analyzer:
exclude:
- test/_data/p4/lib/lib1.dart
- test/_data/p5/p5.dart
- test/_data/bad*.dart
- test/_brokendata/**
Note that you can use globs, as defined by the glob package.
Here is an example file that enables two lint rules:
linter:
rules:
- camel_case_types
- empty_constructor_bodies
Check out all the available Dart lint rules.
You can combine the analyzer section and the linter section into a single
configuration. Here is an example:
analyzer:
exclude:
- test/_data/p4/lib/lib1.dart
linter:
rules:
- camel_case_types
For more information, see the docs for customizing static analysis.
Who uses this library?
Many tools embed this library, such as:
- dart format - a formatter for Dart code
- dart doc - a documentation generator for Dart code
- Dart Analysis Server - a stateful server that supports IDEs and editors
Support
Post issues and feature requests at https://github.com/dart-lang/sdk/issues. These will be triaged according to the analyzer triage priorities.
Questions and discussions are welcome at the Dart Analyzer Discussion Group.
Background
The APIs in this package were originally machine generated by a translator and were based on an earlier Java implementation. Several of the API's still look like their Java predecessors rather than clean Dart APIs.
In addition, there is currently no clean distinction between public and internal APIs. We plan to address this issue but doing so will, unfortunately, require a large number of breaking changes. We will try to minimize the pain this causes for our clients, but some pain is inevitable.
License
See the LICENSE file.