Customizing static analysis

Static analysis allows you to find problems before executing a single line of code. It’s a powerful tool used to prevent bugs and ensure that code conforms to style guidelines.

With the help of the analyzer, you can find simple typos. For example, perhaps an accidental semicolon made its way into an if statement:

  1. void increment() {
  2.   if (count < 10) ;
  3.   count++;
  4. }
  1. lint • Avoid empty statements • example.dart:11 • empty_statements

The analyzer can also help you find more subtle problems. For example, perhaps you’ve forgotten to close a sink method:

  1. var _controller = StreamController<String>();
  1. lint • Close instances of `dart.core.Sink` • example.dart:11 • close_sinks

In the Dart ecosystem, the Dart Analysis Server and other tools use the analyzer package to perform static analysis.

You can customize static analysis to look for a variety of potential problems, including errors and warnings specified in the Dart language spec. You can also configure the linter, one of the analyzer’s plugins, to ensure that your code complies with the Dart Style Guide and other suggested guidelines in Effective Dart. Dart tools such as the Dart dev compiler (dartdevc), dartanalyzer, flutter analyze, and JetBrains IDEs use the analyzer package to evaluate your code.

This document explains how to customize the behavior of the analyzer using either an analysis options file or comments in Dart source code. If you want to add static analysis to your tool, see the analyzer package docs and the Analysis Server API Specification.

Note: The analyzer error codes are listed in the Dart SDK repo.

The analysis options file

Place the analysis options file, analysis_options.yaml, at the root of the package, in the same directory as the pubspec file.

Breaking change: The conventional name for the analysis options file used to be .analysis_options (note the leading dot and missing .yaml suffix). We expect support for the .analysis_options name to go away in a future release, so we recommend that you rename your .analysis_options files to analysis_options.yaml.

Here’s a sample analysis options file:

  1. include: package:pedantic/analysis_options.1.8.0.yaml
  3. analyzer:
  4.   exclude: [build/**]
  5.   strong-mode:
  6.     implicit-casts: false
  8. linter:
  9.   rules:
  10.     - camel_case_types

The sample illustrates the most common top-level entries:

Another tag you might see is language:, which is used for experimental language features.

YAML is sensitive to whitespace. Don’t use tabs in a YAML file, and use 2 spaces to denote each level of indentation.

If the analyzer can’t find an analysis options file at the package root, it walks up the directory tree, looking for one. If no file is available, the analyzer defaults to standard checks.

Consider the following directory structure for a large project:

project root contains analysis_options.yaml (#1) and 3 packages, one of which (my_package) contains an analysis_options.yaml file (#2).

The analyzer uses file #1 to analyze the code in my_other_package and my_other_other_package, and file #2 to analyze the code in my_package.

Enabling stricter type checks

If you want stricter static checks than the Dart type system requires, consider using the implicit-casts and implicit-dynamic flags:

  1. analyzer:
  2.   strong-mode:
  3.     implicit-casts: false
  4.     implicit-dynamic: false

You can use the flags together or separately; both default to true.

implicit-casts: <bool>

A value of false ensures that the type inference engine never implicitly casts to a more specific type. The following valid Dart code includes an implicit downcast that would be caught by this flag:

  1. Object o = ...
  2. String s = o; // Implicit downcast
  3. String s2 = s.substring(1);
  1. error • A value of type 'Object' can't be assigned to a variable of type 'String' • invalid_assignment

implicit-dynamic: <bool>

A value of false ensures that the type inference engine never chooses the dynamic type when it can’t determine a static type.

Enabling and disabling linter rules

The analyzer package also provides a code linter. A wide variety of linter rules are available. Linters tend to be nondenominational—rules don’t have to agree with each other. For example, some rules are more appropriate for library packages and others are designed for Flutter apps. Note that linter rules can have false positives, unlike static analysis.

Enabling default Google rules: pedantic

To enable the list of linter rules that Google uses in its own Dart code, depend on the pedantic package and include its analysis_options.yaml file. Unless you need to use the pedantic API, declare a dev dependency on pedantic in your pubspec.yaml file:

  1. dev_dependencies:
  2.   pedantic: ^1.0.0

Run pub get, and then add the following line to your analysis_options.yaml file:

  1. include: package:pedantic/analysis_options.yaml

Important: When a new version of pedantic is published, code that previously passed analysis might start failing analysis. We recommend updating your code to work with the new rules. Other options are to include a specific version of the pedantic analysis options file (as described in the pedantic package page), explicitly enable individual linter rules, or disable individual rules.

Enabling Effective Dart rules: effective_dart

To enable linter rules corresponding to the guidelines in Effective Dart, add a dev dependency on the effective_dart package:

  1. dev_dependencies:
  2.   effective_dart: ^1.0.0

Run pub get, and then add the following line to your analysis_options.yaml file:

  1. include: package:effective_dart/analysis_options.yaml

Important: When a new version of effective_dart is published, code that previously passed analysis might start failing analysis. We recommend updating your code to work with the new rules. Other options are to include a specific version of the effective_dart analysis options file (as described in the effective_dart package page), explicitly enable individual linter rules, or disable individual rules.

Enabling individual rules

To enable a single linter rule, add linter: to the analysis options file, followed by rules:. On subsequent lines, specify the rules that you want to apply, prefixed with dashes. For example:

  1. linter:
  2.   rules:
  3.     - annotate_overrides
  4.     - await_only_futures
  5.     - camel_case_types
  6.     - cancel_subscriptions
  7.     - close_sinks
  8.     - comment_references
  9.     - constant_identifier_names
  10.     - control_flow_in_finally
  11.     - empty_statements

Disabling individual rules

If you include an analysis options file such as the one in pedantic, you might want to disable some of the included rules. Disabling individual rules is similar to enabling them, but with two differences:

  • Omit the dash (-) before the rule name.
  • Add : false after the rule name.

Here’s an example of an analysis options file that uses all pedantic rules except avoid_shadowing_type_parameters. It also enables the lint await_only_futures:

  1. include: package:pedantic/analysis_options.yaml
  3. linter:
  4.   rules:
  5.     avoid_shadowing_type_parameters: false
  6.     await_only_futures: true

Note: Due to YAML restrictions, you can’t mix list and key-value syntax in the same rules entry. You can, however, use the other syntax for rules in an included file.

Excluding code from analysis

Sometimes it’s OK for some code to fail analysis. For example, you might rely on code generated by a package that you don’t own—the generated code works, but produces warnings during static analysis. Or a linter rule might cause a false positive that you want to suppress.

You have a few ways to exclude code from analysis:

  • Exclude entire files from analysis.
  • Stop specific non-error rules from being applied to individual files.
  • Stop specific non-error rules from being applied to individual lines of code.

You can also disable specific rules for all files or change the severity of rules.

Version note: As of Dart 2.8, you can’t stop error rules from being applied to individual files or lines of code.

Excluding files

To exclude files from static analysis, use the exclude: analyzer option. You can list individual files, or use glob syntax:

  1. analyzer:
  2.   exclude:
  3.     - lib/client.dart
  4.     - lib/server/*.g.dart
  5.     - test/_data/**

Suppressing rules for a file

To ignore a specific non-error rule for a specific file, add an ignore_for_file comment to the file:

  1. // ignore_for_file: unused_import

This acts for the whole file, before or after the comment, and is particularly useful for generated code.

To suppress more than one rule, use a comma-separated list:

  1. // ignore_for_file: unused_import, unused_local_variable

Suppressing rules for a line of code

To suppress a specific non-error rule on a specific line of code, put an ignore comment above the line of code. Here’s an example of ignoring code that causes a runtime error, as you might do in a language test:

  1. // ignore: invalid_assignment
  2. int x = '';

To suppress more than one rule, supply a comma-separated list:

  1. // ignore: invalid_assignment, const_initialized_with_non_constant_value
  2. const x = y;

Alternatively, append the ignore rule to the line that it applies to:

  1. int x = ''; // ignore: invalid_assignment

Customizing analysis rules

Each analyzer error code and linter rule has a default severity. You can use the analysis options file to change the severity of individual rules, or to always ignore some rules.

The analyzer supports three severity levels:

info

An informational message that doesn’t cause analysis to fail. Example: todo

warning

A warning that doesn’t cause analysis to fail unless the analyzer is configured to treat warnings as errors. Example: analysis_option_deprecated

error

An error that causes analysis to fail. Example: invalid_assignment

Ignoring rules

You can ignore specific analyzer error codes and linter rules by using the errors: field. List the rule, followed by : ignore. For example, the following analysis options file instructs the analysis tools to ignore the TODO rule:

  1. analyzer:
  2.   errors:
  3.     todo: ignore

Changing the severity of rules

You can globally change the severity of a particular rule. This technique works for regular analysis issues as well as for lints. For example, the following analysis options file instructs the analysis tools to treat invalid assignments as warnings and missing returns as errors, and to provide information (but not a warning or error) about dead code:

  1. analyzer:
  2.   errors:
  3.     invalid_assignment: warning
  4.     missing_return: error
  5.     dead_code: info

Resources

Use the following resources to learn more about static analysis in Dart: