Sam Rawlins
39c1850b44
Work towards https://github.com/dart-lang/sdk/issues/61481 Change-Id: I16d5333de6b5b195f629ec51ee582d793431f139 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/450220 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
2.8 KiB
Using plugins
This document describes how to enable analyzer plugins. Analyzer plugins can
report diagnostics (lints and warnings) in an IDE and also at the command line
(with dart analyze or flutter analyze). Analyzer plugins can also offer
quick fixes and assists in an IDE. A set of analyzer plugins can be enabled for
a given package or workspace via the analysis_options.yaml file, at the
root of the package or workspace source tree. Analyzer plugins cannot be
enabled, disabled, or otherwise specified or configured in a nested analysis
options file
Analyzer plugins are specified in the top-level plugins section:
plugins:
my_plugin: ^1.0.0
Note: This is similar to how analyzer plugins are enabled in the legacy
analyzer plugin system. However, in the legacy system, this plugins section
is listed under the top-level analyzer section. In the new analyzer plugin
system, plugins is a top-level section.
Individual plugins are listed similar to how dependencies are listed in a
pubspec.yaml file; they are listed as a key-value pair, with the package name
as the key. The value can either be
- a package version constraint, in which case the package is downloaded from https://pub.dev,
- a git dependency,
- an absolute path.
For example, while developing a plugin locally, it can be enabled as:
plugins:
my_plugin:
path: /path/to/my_plugin
Note: after any change is made to the plugins section of an
analysis_options.yaml file, the Dart Analysis Server must be restarted to see
the effects.
Enabling a lint rule
A plugin can report two kinds of diagnostics: warnings and lints. Any warnings
that a plugin defines are enabled by default (like analyzer warnings). Any lint
rules that a plugin defines are disabled by default (like analyzer lint rules),
and must be explicitly enabled in analysis options. Lint rules are enabled
under the diagnostics section for a plugin:
plugins:
my_plugin:
path: /path/to/my_plugin
diagnostics:
rule_1: true
rule_2: true
rule_3: false
In the configuration above, rule_1 and rule_2 are enabled. Additionally,
rule_3 is disabled, which can be useful if an included analysis options file
explicitly enables the rule.
Suppressing diagnostics
A diagnostic which is reported by a plugin can be suppressed with a comment. The syntax is similar to suppressing an out-of-the-box warning or lint diagnostic (see the docs). To suppress a warning or lint named "some_code" in a plugin named "some_plugin," use a comment like the following:
// ignore: some_plugin/some_code
// ignore_for_file: some_plugin/some_code