analyzer 0.27.3 (latest: 0.27.3 / 0.27.4-alpha.19 )

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

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.

0.27.1

  • Moved the public and private API's for the element model into their proper places.
  • Added back support for auto-processing of plugins.

0.27.0

  • Support for DEP 37 (Assert with optional message).
  • Lexical support for DEP 40 (Interface libraries). This does not include any semantic checking to ensure that the implementation libraries are compatible with the interface library.

  • Cleaned up the initialization of plugins. Clients are now required to initialize plugins, possibly using the utility method AnalysisEngine.processRequiredPlugins().

  • Removed the old task model and code that supported it. None of the removed code was intended to be public API, but might be in use anyway.

  • Removed previously deprecated API's (marked with the @deprecated annotation).

0.26.4

  • Options processing API updated to accept untyped options maps (#25126).

0.26.3

  • (Internal) Support for _embedder.yaml discovery and processing.

0.26.2

  • Add code generation utilities for use in both analyzer and analysis server.

0.26.1+17

  • (Internal) Introduced context configuration logic (configureContext() extracted from server).

0.26.1+16

  • (Internal) Options validation plugin API update.

0.26.1+15

  • (Internal) Provisional options validation plugin API.

0.26.1+13

  • (Internal) Plugin processing fixes.

0.26.1+11

  • Fixes to address lint registry memory leaking.

0.26.1+10

  • New AnalysisContext API for associating configuration data with contexts (setConfigurationData() and getConfigurationData()).

0.26.1+9

  • OptionsProcessor extension point API changed to pass associated AnalysisContext instance into the optionsProcessed call-back.

0.26.1+6

  • Provisional (internal) plugin manifest parsing.

0.26.1+5

  • Plugin configuration ErrorHandler typedef API fix.

0.26.1+4

  • Provisional (internal) support for plugin configuration via .analysis_options.

0.26.1+2

  • Extension point for WorkManagerFactory(s).
  • Resolve enum documentation comments.
  • Fix display of parameter lists in servers Element structure (issue 24194)
  • Band-aid fix for issue #24191.

0.26.1+1

  • Removed a warning about importing unnamed libraries
  • Fix handling of empty URIs in .packages files (issue 24126)

0.26.1

  • Fix line starts in multiline comments (issue 23919).
  • Various small fixes to Windows path handling.
  • Update LineInfo computation during incremental resolution.
  • Make exclude list apply to contexts (issue 23941).
  • Fix type propagation for asynchronous for-in statements.
  • Fix ToStringVisitor for external functions (issue 23968).
  • Fix sorting of compilation unit members.
  • Add forwarding for DefaultFormalParameter metadata.
  • Fix most implementations of UriResolver.restoreAbsolute.
  • Disable dart2js hints by default.
  • Support older SDKs (Dart 1.11).

0.26.0

  • Add hook for listening to implicitly analyzed files
  • Add a PathFilter and AnalysisOptionsProvider utility classes to aid clients in excluding files from analysis when directed to do so by an options file.

  • API change: UriResolver.resolveUri(..) now takes an optional actualUri.
  • Change ResolutionCopier.visitAwaitExpression to copy *Type fields.
  • Fix highlight range for missing enum constant in switch (issue 23904).
  • Fix analyzer's treatment of ClassName?.staticMember to match spec.
  • Implement DEP 34 (less restricted mixins).
  • Fix some implementations of UriResolver.resolveUri(..) that did not properly handle the new actualUri argument.

0.25.2

  • Requires Dart SDK 1.12-dev or greater
  • Enable null-aware operators (DEP 9) by default.
  • Generic method support in the element model.

0.25.2-alpha.1

  • dart:sdk extension .sdkext changed to _sdkext (to play nicer with pub).

0.25.2-alpha.0

  • Initial support for analyzing dart:sdk extensions from .sdkext.

0.25.1

  • (Internal) code reorganization to address analysis warnings due to SDK reorg.
  • First steps towards .packages support.

0.25.0

  • Commandline interface moved to dedicated analyzer_cli package. Files moved:
  • bin/analyzer.dart
  • lib/options.dart
  • lib/src/analyzer_impl.dart
  • lib/src/error_formatter.dart
  • Removed dependency on the args package.

0.22.1

  • Changes in the async/await support.

0.22.0

New API:

  • Source.uri added.

Breaking changes:

  • DartSdk.fromEncoding replaced with fromFileUri.
  • Source.resolveRelative replaced with resolveRelativeUri.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  analyzer: 

2. Install it

You can install packages from the command line:

$ pub get

Alternatively, your editor might support pub. Check the docs for your editor to learn more.

About

Static analyzer for Dart.

Author

Email misc@dartlang.org Dart Team

Homepage

github.com/dart-lang/sdk/tree/master/pkg/analyzer

Documentation

www.dartdocs.org/documentation/analyzer/0.27.3/

Source code (hyperlinked)

www.crossdart.info/p/analyzer/0.27.3/

Uploader

scheglov@google.com
dgrove@google.com
nweiz@google.com
paulberry@google.com
sigmund@google.com
jwren@google.com
pquitslund@google.com
brianwilkerson@google.com
danrubel@google.com

Share