Paul Berry
1a75281742
Previously, we had a mixin class PotentiallyConstVariableElement to represent variables which might be constant. This left some holes in the type hierarchy which didn't implement PotentiallyConstVariableElement but nonetheless could be reached by constant evaluation code in the event of errors in the code being analyzed, resulting in an invalid cast exception. This CL drops PotentiallyConstVariableElement and moves its one getter to VariableElementImpl so that it will be available to all variable elements. This allows us to avoid a lot of casts, including the one that previously caused the exception. Fixes #24645. R=scheglov@google.com Review URL: https://codereview.chromium.org/1416873003 .
Analyzer for Dart
This package provides a low-level library that performs static analysis of Dart code. It is useful for tool integration and embedding.
End-users should use the dartanalyzer 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 the dartanalyzer and Dart Analysis Server can be configured
with a .analysis_options file. 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 dartanalyzer 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 the analyzer's strong mode:
analyzer:
strong-mode: true
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
Who uses this library?
Many tools embed this library, such as:
- dartfmt - a formatter for Dart code
- dartdoc - a documentation generator for Dart code
- Dart Analysis Server - a stateful server that supports IDEs and editors
Support
Questions and requests for additional functionality are welcome. Please open an issue at http://dartbug.com or by email analyzer-discuss@dartlang.org.
Background
The APIs in this package are, quite frankly, a mess at the moment. They 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 (or worse) rather than clean Dart API's.
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.