Brian Wilkerson
bee0b56db8
The class `VerifyDiagnosticsTest` is used to verify the correctness of the values of the `documentation` keys in the `messages.yaml` files. As a part of that, it verifies that the code snippets in the documentation follow the rule that - "Example" snippets generate one instance of the documented diagnostic and no other diagnostics - "Common fixed" snippets generate no diagnostics. Snippets that fail to meet that criteria are not verified because checking for them has been disabled. A common reason for failing to meet the criteria is the production of one or more other diagnostics, typically due to overreporting. Not verifying them has some drawbacks. - It's on an all-or-nothing basis; if a diagnostic is ignored all snippets will be ignored even if only one snippet fails to follow the rule. - There's no indication if new diagnostics start being generated for the snippet. - There's no indication when the overreporting is fixed so that the snippets can now be verified. I propose we add a way to list the additional diagnostics to ignore and remove these cases from the excluded diagnostics list. Specifically, I want to add a new directive (in the test's sense, not in the language's sense of that term) containing a list of expected other diagnostics. I considered using an ignore comment, but errors can't be ignored this way and sometimes the diagnostics that need to be ignored are errors. This CL implements the proposal and removes one diagnostic from the list as a sample of how this support will be used. If this approach is adopted, other diagnostics can be removed from the list and the snippets can be updated accordingly in one or more follow-on CLs. This will _not_ remove the need for the list of ignored diagnostics because that list has other use cases. However, I do think that we should try to find solutions for those other use cases and eventually remove the list entirely if possible. Change-Id: I52b6b738e41b2163843caf915a6c0fe7f461ec44 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/494620 Reviewed-by: Paul Berry <paulberry@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@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.