Paul Berry
05ab41c99b
I will soon be adding an API for generating summaries that generates them in one phase, as opposed to the current two-phase approach of building unlinked summaries and then linking them together. This is will be needed in order to support full type inference of summaries, since full type inference requires examining the contents of block-bodied closures, and it's not worth the effort of trying serialize the contents of block-bodied closures into unlinked summaries. To prepare for this, the summary tests need to be generalized so that during the transition period they will be able to be run with either API. This CL introduces several classes in a new `test_strategies.dart` file: - Interfaces `SummaryBaseTestStrategy`, `SummaryBlackBoxTestStrategy`, and `SummaryLinkerTestStrategy`. These interfaces define the methods that can be invoked by tests of the summary mechanism. - Implementations of those interfaces: `SummaryBlackBoxTestStrategyPrelink`, `SummaryBlackBoxTestStrategyTwoPhase`, and `SummaryLinkerTestStrategyTwoPhase`. These classes provide the ability to drive the summary mechanism in various ways. When the one-phase API is added, more classes will be added to drive it. - A few private classes occupying intermediate positions in the class hierarchy, as well as auxiliary data structures needed by the above classes. The tests themselves have been moved into mixin classes so that they can be applied to any of the implementations above. Change-Id: Iac3585944297f78f184d35de544aa4c8d8abe99a Reviewed-on: https://dart-review.googlesource.com/72320 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com> Commit-Queue: Paul Berry <paulberry@google.com>
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 dartanalyzer 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
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 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
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 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.