https://github.com/ronjb/flutter_lints_plus
Recommended lints for Flutter apps, packages, and plugins to encourage good coding practices.
https://github.com/ronjb/flutter_lints_plus
flutter lints
Last synced: 28 days ago
JSON representation
Recommended lints for Flutter apps, packages, and plugins to encourage good coding practices.
- Host: GitHub
- URL: https://github.com/ronjb/flutter_lints_plus
- Owner: ronjb
- License: mit
- Created: 2021-09-09T16:36:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T14:14:19.000Z (10 months ago)
- Last Synced: 2025-04-23T19:19:48.470Z (28 days ago)
- Topics: flutter, lints
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/flutter_lints_plus)
This package contains a recommended set of lints for [Flutter] apps, packages,
and plugins to encourage good coding practices.
This package is built on top of Flutter's `flutter_lints` set of lints from
[package:flutter_lints].
Lints are surfaced by the [dart analyzer], which statically checks dart code.
[Dart-enabled IDEs] typically present the issues identified by the analyzer in
their UI. Alternatively, the analyzer can be invoked manually by running
`flutter analyze`.
## Usage
These lints by following these instructions:
1. Depend on this package as a **dev_dependency** by running
`flutter pub add --dev flutter_lints_plus`.
2. Create an `analysis_options.yaml` file at the root of the package (alongside
the `pubspec.yaml` file) and `include: package:flutter_lints_plus/flutter.yaml`
from it.
Example `analysis_options.yaml` file:
```yaml
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.
# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints_plus/flutter.yaml
linter:
# The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints_plus/flutter.yaml`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at
# https://dart-lang.github.io/linter/lints/index.html.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
```
[Flutter]: https://flutter.dev
[dart analyzer]: https://dart.dev/guides/language/analysis-options
[Dart-enabled IDEs]: https://dart.dev/tools#ides-and-editors
[package:lints]: https://pub.dev/packages/flutter_lints
[package:lints]: https://pub.dev/packages/lints