mirror of https://github.com/dart-lang/sdk synced 2024-09-19 15:01:29 +00:00

History

Konstantin Shcheglov b4f4de776a Update super-bounded types for null safety. https://github.com/dart-lang/language/pull/1133/files Change-Id: I633b328bb62780e09fb58535a83f7f35af161c25 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/180020 Commit-Queue: Konstantin Shcheglov <scheglov@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>		2021-01-19 20:31:03 +00:00
..
doc	Use binary format for summaries.	2020-12-01 21:30:35 +00:00
example	[pkg:analyzer] add an example of using the analysis context collection API	2021-01-04 21:35:58 +00:00
lib	Update super-bounded types for null safety.	2021-01-19 20:31:03 +00:00
test	Update super-bounded types for null safety.	2021-01-19 20:31:03 +00:00
tool	Add documentation for more diagnostics	2021-01-19 18:15:13 +00:00
.gitignore
analysis_options.yaml	Enforce await_only_futures and fix violations.	2020-09-24 14:28:00 +00:00
CHANGELOG.md	Deprecate CompilationUnitElement.functionTypeAliases	2021-01-14 22:38:23 +00:00
LICENSE
pubspec.yaml	[pkg/analyzer] widen the dep on package:crypto	2021-01-07 01:33:41 +00:00
README.md	Fix a number of URIs referring to dartlang.org	2020-05-13 18:24:12 +00:00
TRIAGE.md	Add triage instructions to the root of pkg/analyzer.	2020-11-13 21:16:04 +00:00

README.md

Analyzer for Dart

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