Lint for Dart/Flutter #
lint is a hand-picked, open-source, community-driven collection of lint rules for Dart and Flutter projects.
The set of rules follows the Effective Dart: Style Guide.
This package can be used as a replacement for
package:pedantic for those who prefer stricter rules.
lint as dependency to your
dev_dependencies: lint: ^1.0.0
analysis_options.yaml file in the root of your project and import the
If you're writing a package with a public API you should use the
package version instead
Enable/Disable rules #
lint is customizable, you can add or remove rules, depending on your needs.
To do so adjust your
include: package:lint/analysis_options.yaml linter: rules: # ------ Disable individual rules ----- # # --- # # Turn off what you don't like. # # ------------------------------------- # # Use parameter order as in json response always_put_required_named_parameters_first: false # Util classes are awesome! avoid_classes_with_only_static_members: false # ------ Enable individual rules ------ # # --- # # These rules here are good but too # # opinionated to enable them by default # # ------------------------------------- # # Make constructors the first thing in every class sort_constructors_first: true # The new tabs vs. spaces. Choose wisely prefer_single_quotes: true prefer_double_quotes: true # Good packages document everything public_member_api_docs: true # Blindly follow the Flutter code style, which prefers types everywhere always_specify_types: true # Back to the 80s lines_longer_than_80_chars: true
Comparison to package:pedantic #
Google publicly shares their internal rules as
package:pedantic in open-source.
It represents what Google is enforcing internally throughout all Dart code.
For a lint rule to be added to pedantic, Google has to change all code which doesn't follow the style.
This strict practice results in only 27/150+ rules to be enabled. While some are contradictory to each other and can not enabled together, a big chunk of rules isn't enabled because it requires too much work to update all of Googles existing code.
For developers outside Google, it is the norm to have separate lint rules per project. One project might enable more rules then others.
lint enables a majority of lint rules, leaving out contradictory and very opinionated rules.
Copyright 2019 Pascal Welsch Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Release for Dart 2.8.1 with Linter v0.1.114
Min SDK is
Raise min sdk to
- Dart 2.8 pre-release
- Fix syntactical error which breaks custom rules #5
Release for Dart 2.7
Release for Dart 2.6
Exampletab to https://pub.dev/packages/lint
New version schema:
0.3.0+dart202: Dart 2.2 Release
sdk: '>=2.2.0 <2.3.0'
0.3.0+dart203: Dart 2.3 Release
sdk: '>=2.3.0 <2.4.0'
0.3.0+dart204: Dart 2.4 Release
sdk: '>=2.4.0 <2.5.0'
0.3.0+dart205: Dart 2.5 Release
sdk: '>=2.5.0 <3.0.0'
- Release for Dart 2.5 enables
- Release for Dart 2.4 enables
- Release for Dart 2.3 enables
- Release for Dart 2.2. All incompatible rules are removed
- app rule set
- package rule set
lint as dependency to your pubspec.yaml
dev_dependencies: lint: ^0.3.0
analysis_options.yaml to the root of you project.
include: package:lint/analysis_options.yaml # Not happy with the default? Customize the rules depending on your needs. # Here are some examples: linter: rules: # Make constructors the first thing in every class sort_constructors_first: true # The new tabs vs. spaces. Choose wisely prefer_single_quotes: true prefer_double_quotes: true # Good packages document everything public_member_api_docs: true # Blindly follow the Flutter code style, which prefers types everywhere always_specify_types: true # Back to the 80s lines_longer_than_80_chars: true # Use parameter order as in json response always_put_required_named_parameters_first: false # Util classes are awesome! avoid_classes_with_only_static_members: false
Hit save and see the
dartanalyzer executing the lint checks in you favorite editor.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: lint: ^1.2.0
2. Install it
You can install packages from the command line:
$ pub get
$ flutter pub get
Alternatively, your editor might support
pub get or
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on May 28, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.8.2
- pana: 0.13.8-dev
Health issues and suggestions
Document public APIs. (-1 points)
1 out of 1 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.
|Dart SDK||>=2.8.0-dev.16.0 <3.0.0|