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 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:

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.

Libraries

analysis_context
analysis_context_collection
analyzer
analyzer.context.declared_variables
analyzer.dart.ast.ast
Defines the AST model. The AST (Abstract Syntax Tree) model describes the syntactic (as opposed to semantic) structure of Dart code. The semantic structure of the code is modeled by the element model. [...]
analyzer.dart.ast.syntactic_entity
analyzer.dart.ast.token
Defines the tokens that are produced by the scanner, used by the parser, and referenced from the AST structure.
analyzer.dart.ast.visitor
Defines AST visitors that support useful patterns for visiting the nodes in an AST structure. [...]
analyzer.dart.constant.value
The interface used to access the result of constant evaluation. [...]
analyzer.dart.element.visitor
Defines element visitors that support useful patterns for visiting the elements in an element model. [...]
analyzer.error.listener
analyzer.exception.exception
analyzer.file_system.memory_file_system
analyzer.file_system.physical_file_system
analyzer.instrumentation.file_instrumentation
analyzer.plugin.embedded_resolver_provider
analyzer.plugin.resolver_provider
analyzer.source.custom_resolver
analyzer.source.embedder
analyzer.source.package_map_provider
analyzer.source.path_filter
analyzer.source.pub_package_map_provider
analyzer.source.sdk_ext
analyzer.src.analysis_options.analysis_options_provider
ast_factory
context.context_root
context_builder
context_locator
context_root
declared_variables
element
error
error_processor
file_system
instrumentation
line_info
overlay_file_system
resolution_map
results
session
source_range
src.source.package_map_provider
standard_ast_factory
standard_resolution_map
task.model
type
uri_converter