Stokkur Dart Analyzer

Stokkur Dart Analyzer

pub package License: MIT style: stokkur dart analyzer


This package provides lint rules for Flutter which are used at Stokkur Software.

Note: This package was inspired by Very Good Analysis and the Flutter recommended rules.

Usage

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

dev_dependencies:
  stokkur_dart_analyzer: ^1.0.0

Then, add an include in analysis_options.yaml:

include: package:stokkur_dart_analyzer/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:stokkur_dart_analyzer/analysis_options.1.0.0.yaml

Suppressing Lints

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

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

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

Project Level

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

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

Badge

You're using stokkur_dart_analyzer in your project? Add the badge to your README.md

style: stokkur dart analyzer

[![style: stokkur dart analyzer](https://img.shields.io/badge/style-stokkur_dart_analyzer-green?logo=Flutter&logoColor=blue)](https://bitbucket.org/stokkur/stokkur_dart_analyzer/src/master/)

Libraries

stokkur_dart_analyzer