Paul Berry
f1843b0abe
This logic allows us to migrate code like this:
int firstEven(Iterable<int> values)
=> values.firstWhere((i) => i.isEven, orElse: () => null);
Into:
import 'package:collection/collection.dart' show IterableExtension;
int? firstEven(Iterable<int> values)
=> values.firstWhereOrNull((i) => i.isEven);
Rather than the default behavior, which would migrate it to:
int? firsteven(Iterable<int?> values)
=> values.firstWhere((i) => i!.isEven, orElse: () => null);
(The new migration is far superior because it doesn't require the
input iterable to accept null).
This functionality is disabled at the moment, because:
- The changes it makes don't show up properly in the web preview.
- The pubspec is not yet properly updated.
I will address these issues in follow-up CLs and then enable the
feature.
Change-Id: I96f3b12d682c586631920b38406bad6aa3f4789e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/168500
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Commit-Queue: Paul Berry <paulberry@google.com>
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.