linteo

Description:

linteo

linteo #





Provides set of Flutter and Dart linter rules used at iteo. By default, package enables all available lint rules (all_lint_rules.yaml) and disables some of them upon team agreement.
Install #

Depend on this package as a dev_dependency by running flutter pub add --dev linteo
Create analysis_options.yaml file at the root of the package (alongside the pubspec.yaml file) and include: package:linteo/analysis_options.yaml from it.

Which version to use? #



Dart Version
Linteo Version




3.1
1.3.0


2.17
1.2.0


2.17
1.1.0


2.17
1.0.1


2.18
1.0.0



Example analysis_options.yaml file #
include: package:linteo/analysis_options.yaml

linter:
rules:
# Adjust package to specific project needs
# package_api_docs: true # Uncomment to enable rule
copied to clipboard
Suppress lint #
Your project may require special case. Lint rules can be suppressed at the line, file, or project level.
Line Level #
Use an ignore: comment directly above the line
// ignore: public_member_api_docs
class A {}
copied to clipboard
File level #
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
Project Level #
Update root analysis_options.yaml according to your needs:
include: package:linteo/analysis_options.yaml
linter:
rules:
public_member_api_docs: true
copied to clipboard
Badge #
Support the project using a badge in your repository