netsells_flutter_analysis 5.0.0

Static analysis rules for Dart and Flutter used at Netsells

Netsells Flutter Analysis

This package provides lint rules for Dart and Flutter which are used at Netsells.

Note: This package was heavily inspired by very_good_analysis.

Usage

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

dev_dependencies:
  netsells_flutter_analysis: ^5.0.0

copied to clipboard

Then, add an include in analysis_options.yaml:

include: package:netsells_flutter_analysis/analysis_options.yaml

copied to clipboard

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:netsells_flutter_analysis/analysis_options.4.0.0.yaml

copied to clipboard

Suppressing Lints

There may be cases where specific lint rules are undesirable. Lint rules can be surpressed 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 surpress 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 {}

copied to clipboard

File Level

To surpress 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 {}

copied to clipboard