Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/passsy/dart-lint

An opinionated, community-driven set of lint rules for Dart and Flutter projects. Like pedantic but stricter
https://github.com/passsy/dart-lint

dart flutter hacktoberfest lint lint-rule

Last synced: 11 days ago
JSON representation

An opinionated, community-driven set of lint rules for Dart and Flutter projects. Like pedantic but stricter

Host: GitHub
URL: https://github.com/passsy/dart-lint
Owner: passsy
License: apache-2.0
Created: 2019-09-16T11:50:30.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-11-10T05:00:53.000Z (about 1 year ago)
Last Synced: 2024-08-22T23:34:54.650Z (3 months ago)
Topics: dart, flutter, hacktoberfest, lint, lint-rule
Homepage:
Size: 323 KB
Stars: 277
Watchers: 6
Forks: 81
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

[![Pub](https://img.shields.io/pub/v/lint.svg)](https://pub.dartlang.org/packages/lint)
[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)

# 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](https://dart.dev/guides/language/effective-dart/style).

This package can be used as a replacement for [`package:lints`](https://pub.dev/packages/lints) or the discontinued [`package:pedantic`](https://github.com/dart-lang/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`
```yaml
dev_dependencies:
lint: ^2.0.0
```

Create an `analysis_options.yaml` file in the root of your project with the following content:

```yaml
# 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
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-lang.github.io/linter/lints/options/options.html
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

[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
```md
[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
```

## Comparison with other lint packages

A detailed comparison of all linting packages for dart can be found at https://rydmike.com/blog_flutter_linting.html

`lint` is among the strictest but not the strictest. It tires to find the right balance between useful and annoying.

## Which version to use?

Generally, you can just put `lint: ^2.0.0` in your `pubspec.yaml` and pub get the latest version compatible with your Dart version.

| Dart Version | Lint Version |
|--------------|---------------------------------------------------------------------|
| `3.1` | [`2.2.0`](https://pub.dev/packages/lint/versions/2.2.0/changelog) |
| `3.0` | [`2.1.0`](https://pub.dev/packages/lint/versions/2.1.0/changelog) |
| `2.18` | [`2.0.0`](https://pub.dev/packages/lint/versions/2.0.0/changelog) |
| `2.17` | [`1.10.0`](https://pub.dev/packages/lint/versions/1.10.0/changelog) |
| `2.16` | [`1.9.0`](https://pub.dev/packages/lint/versions/1.9.0/changelog) |
| `2.15` | [`1.8.0`](https://pub.dev/packages/lint/versions/1.8.0/changelog) |
| `2.14` | [`1.7.0`](https://pub.dev/packages/lint/versions/1.7.0/changelog) |
| `2.13` | [`1.6.0`](https://pub.dev/packages/lint/versions/1.6.0/changelog) |
| `2.12` | [`1.5.0`](https://pub.dev/packages/lint/versions/1.5.0/changelog) |

## Comparison to discontinued 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.

## License

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.
```