Paul Berry
6e9ff48ca2
Previously, flow analysis's tracking of properties was done through the `VariableModel.properties` field. This field wasn't properly updated during joins, rebases, and handling of try/finally; as a result, flow analysis failed to detect some possible promotion opportunities for fields. This wasn't previously a problem, because we didn't support field promotion (the only reason flow analysis tracked fields at all was so that error messages could explain that field promotion *wasn't* supported). However, now that we are going to be adding field promotion support, it's important that it works properly with joins, rebases, and try/finally. So, instead of tracking properties through `VariableModel.properties`, we assign each property its own promotion key, and include properties in the `FlowModel.variableInfo`. This ensures that property promotion will be properly handled by the existing logic for joins, rebases, and try/finally, because that logic just treats the promotion keys as opaque keys--it doesn't even know whether a given entry in `FlowModel.variableInfo` represents a variable or a property access. Note that changes to `use_of_nullable_value_test.dart` reflect improvements to detection of when promotion via properties is being attempted. Previously, when analyzing the code in these tests, a context message was emitted explaining that promotion failed due to field promotion not being supported, even though no attempt was made to promote a field; this erroneous context message was codified into the test expectations. Now that flow analysis no longer incorrectly judges there to have been a field promotion attempt, we need to also correct the test expectations. Bug: https://github.com/dart-lang/language/issues/2020 Change-Id: I6c5cb1f6f4c98cbfa199baea24cd373408820996 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/250181 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: 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
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.