zds_analysis 1.0.0

Lint rules for Dart and Flutter used internally at Zebra Technologies

ZDS Analysis

This package provides lint rules for Dart and Flutter which are used at Zebra Technologies Corporation.

Note: This package was heavily inspired by both Very Good Analysis and RydMike.

Usage

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

dev_dependencies:
  zds_analysis: ^1.0.0

Then, add an include in analysis_options.yaml:

include: package:zds_analysis/analysis_options.yaml

This will ensure you always use the latest version of the lints.

Our versions follow the Dart SDK versions. If you wish to restrict the lint version, specify a version of analysis_options.yaml. For example, for projects using Dark SDK versions 2.18.x:

include: package:zds_analysis/analysis_options.2.18.yaml

For strict typed rules, use:

include: package:zds_analysis/analysis_options_strict.yaml

Or, specific version:

include: package:zds_analysis/analysis_options_strict.2.18.yaml

For library specific lints (not for use in applications):

include: package:zds_analysis/analysis_options_lib.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:zds_analysis/analysis_options.yaml
linter:
  rules:
    public_member_api_docs: false