mirror of https://github.com/dart-lang/sdk synced 2024-09-20 11:41:17 +00:00

History

Brian Wilkerson 00ee3159e5 Convert interfaces to use implements not extends Change-Id: Ia49fb8aefe7eb096ab8c8365a77337155c3c473a Reviewed-on: https://dart-review.googlesource.com/c/92535 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>		2019-02-10 19:31:27 +00:00
..
doc	Update analyzer docs based on previous feedback	2018-10-19 21:09:33 +00:00
lib	Convert interfaces to use implements not extends	2019-02-10 19:31:27 +00:00
test	Split out several more hint tests	2019-02-10 18:51:22 +00:00
tool	Add pkg:analysis_tool as an SDK-only set of utils	2019-01-31 16:52:05 +00:00
.gitignore	Update .gitignore to new `dart_tool` pub cache	2018-03-12 22:44:51 +00:00
analysis_options.yaml	Update analysis options files.	2018-07-03 00:20:06 +00:00
CHANGELOG.md	Prepare to publish analyzer version 0.35.0.	2019-01-29 20:27:37 +00:00
LICENSE
pubspec.yaml	Add pkg:analysis_tool as an SDK-only set of utils	2019-01-31 16:52:05 +00:00
README.md	backlink to language docs for customized analysis	2019-01-30 18:01:04 +00:00

README.md

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

For more information, see the docs for customizing static analysis.

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.