Very Good Analysis #

Developed with 💙 by Very Good Ventures 🦄

This package provides lint rules for Dart and Flutter which are used at Very Good Ventures. For more information, see the complete list of options.

Note: This package was heavily inspired by pedantic.

Usage #

To use the lints, add as a dev dependency in your pubspec.yaml:

dart pub add dev:very_good_analysis
# or
flutter pub add dev:very_good_analysis

Then, add an include in analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml

This will ensure you always use the latest version of the lints. If you wish to restrict the lint version, specify a version of analysis_options.yaml instead:

include: package:very_good_analysis/analysis_options.10.0.0.yaml

Formatter #

In addition to lint rules, this package configures the Dart formatter. Trailing commas are set to automate, which lets the formatter decide when to add or remove trailing commas to keep code readable:

formatter:
  trailing_commas: automate

If you prefer to manage trailing commas yourself, override this setting in your analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml
formatter:
  trailing_commas: preserve

Suppressing Lints #

There may be cases where specific lint rules are undesirable. Lint rules can be suppressed at the line, file, or project level.

An example use case for suppressing lint rules at the file level is suppressing the prefer_const_constructors in order to achieve 100% code coverage. This is due to the fact that const constructors are executed before the tests are run, resulting in no coverage collection.

Line Level #

To suppress a specific lint rule for a specific line of code, use an ignore comment directly above the line:

// ignore: public_member_api_docs
class A {}

File Level #

To suppress a specific lint rule of a specific file, use an ignore_for_file comment at the top of the file:

// ignore_for_file: public_member_api_docs

class A {}

class B {}

Project Level #

To suppress a specific lint rule for an entire project, modify analysis_options.yaml:

include: package:very_good_analysis/analysis_options.yaml
linter:
  rules:
    public_member_api_docs: false

Badge #

To indicate your project is using very_good_analysis →

[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)

Excluded rules #

Below is a list of rules that are not enabled by default together with the reason on why they have been excluded: