languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-07-25 04:15:45 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
dart-sdk/pkg/analyzer
History
Konstantin Shcheglov e6b02b5895 Extension type. Update nullability, remove implied interfaces. 
2edfa84697

Change-Id: I108d57aa2b601ccc3de0e7097507f6115b430d94
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/337000
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Commit-Queue: Konstantin Shcheglov <scheglov@google.com>
2023-11-17 20:59:48 +00:00
..
doc analysis_server: Enforce single quotes preference 2023-09-13 17:48:22 +00:00
example
lib Extension type. Update nullability, remove implied interfaces. 2023-11-17 20:59:48 +00:00
test Extension type. Update nullability, remove implied interfaces. 2023-11-17 20:59:48 +00:00
tool enable flutter_style_todos 2023-11-15 23:04:19 +00:00
.gitignore
analysis_options.yaml enable flutter_style_todos 2023-11-15 23:04:19 +00:00
CHANGELOG.md Prepare to publish analyzer 6.3.0 and _fe_analyzer_shared 65.0.0 2023-10-11 14:44:31 +00:00
LICENSE
messages.yaml enable flutter_style_todos 2023-11-15 23:04:19 +00:00
OWNERS
pubspec.yaml Begin developing code for "Wolf analysis". 2023-11-08 17:50:43 +00:00
README.md Link to dart.dev for linter rules 2023-06-02 18:26:13 +00:00
TRIAGE.md [analyzer] Remove many instances of the word 'hint' 2023-03-23 03:59:55 +00:00

README.md

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.