pub package package publisher

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:

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.

Libraries

dart/analysis/analysis_context
dart/analysis/analysis_context_collection
dart/analysis/analysis_options
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.
dart/sdk/build_sdk_summary
dart/analysis/code_style_options
dart/analysis/context_builder
dart/analysis/context_locator
dart/analysis/context_root
dart/analysis/declared_variables
diagnostic/diagnostic
dart/ast/doc_comment
Various classes for data computed for doc comments.
dart/element/element
Defines the element model. The element model describes the semantic (as opposed to syntactic) structure of Dart code. The syntactic structure of the code is modeled by the AST structure.
error/error
source/error_processor
exception/exception
dart/analysis/features
instrumentation/file_instrumentation
file_system/file_system
instrumentation/instrumentation
source/line_info
error/listener
instrumentation/log_adapter
instrumentation/logger
file_system/memory_file_system
instrumentation/multicast_service
instrumentation/noop_service
dart/element/nullability_suffix
file_system/overlay_file_system
file_system/physical_file_system
instrumentation/plugin_data
dart/ast/precedence
dart/analysis/results
dart/element/scope
instrumentation/service
dart/analysis/session
source/source
source/source_range
dart/ast/syntactic_entity
dart/ast/token
Defines the tokens that are produced by the scanner, used by the parser, and referenced from the AST structure.
dart/element/type
Defines the type model. The type model is part of the element model in that most types are defined by Dart code (the types dynamic and void being the notable exceptions). All types are represented by an instance of a subclass of DartType.
dart/element/type_provider
dart/element/type_system
dart/element/type_visitor
dart/analysis/uri_converter
dart/analysis/utilities
dart/constant/value
The interface used to access the result of constant evaluation.
dart/ast/visitor
Defines AST visitors that support useful patterns for visiting the nodes in an AST structure.
dart/element/visitor
Defines element visitors that support useful patterns for visiting the elements in an element model.