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:lints or the discontinued package:pedantic for those who prefer stricter rules.
lint supports 3 different set of rules:
strict: tries to be strict but not annoying. Perfect for production app code
casual: great when prototyping, to be used in code samples, any non-production code
package: like strict but for dart packages, that have a public API
Install
Add lint as dependency to your pubspec.yaml. Version ^1.0.0 means you're automatically getting the latest version for lint when running pub upgrade
dev_dependencies:lint:^2.0.0
Create an analysis_options.yaml file in the root of your project with the following content:
# This file configures the analyzer to use the lint rule set from `package:lint`include:package:lint/strict.yaml# For production apps# include: package:lint/casual.yaml # For code samples, hackathons and other non-production code# include: package:lint/package.yaml # Use this for packages with public API# You might want to exclude auto-generated files from dart analysis.# Uncomment the section below and the files you want to exclude.# analyzer:# exclude:# - '**.freezed.dart'# - '**.g.dart'# You can customize the lint rules set to your own liking. A list of all rules# can be found at https://dart.dev/tools/linter-rules# Uncomment the section below and the rules you want to customize.# linter:# rules:# Util classes are awesome!# avoid_classes_with_only_static_members: false# Make constructors the first thing in every class# sort_constructors_first: true# Choose wisely, but you don't have to# prefer_double_quotes: true# prefer_single_quotes: true
Lint badge
You're using lint in your open-source project?
Add the badge to your README.md show that you honor strict lint rules
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.
License
Copyright 2022 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.
