very_good_analysis 3.1.0 icon indicating copy to clipboard operation
very_good_analysis: ^3.1.0 copied to clipboard

Lint rules for Dart and Flutter used internally at Very Good Ventures.

Very Good Analysis #

Very Good Ventures

Developed with πŸ’™ by Very Good Ventures πŸ¦„

ci pub package License: MIT style: very good analysis


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:

dev_dependencies:
  very_good_analysis: ^3.1.0

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.3.1.0.yaml

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

[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.flutter-io.cn/packages/very_good_analysis)
282
likes
140
pub points
97%
popularity

Publisher

verified publisher iconverygood.ventures

Lint rules for Dart and Flutter used internally at Very Good Ventures.

Repository (GitHub)
View/report issues

Documentation

Documentation
API reference

License

Icon for licenses.MIT (LICENSE)

More

Packages that depend on very_good_analysis