https://github.com/vxern/words
A curated collection of lints for use by Dart packages to ensure higher program safety and to promote best practices.
https://github.com/vxern/words
analysis collection dart flutter linter lints rules ruleset static-analysis
Last synced: 3 months ago
JSON representation
A curated collection of lints for use by Dart packages to ensure higher program safety and to promote best practices.
- Host: GitHub
- URL: https://github.com/vxern/words
- Owner: vxern
- License: mit
- Created: 2021-08-20T14:23:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T19:57:44.000Z (11 months ago)
- Last Synced: 2025-03-16T16:18:37.760Z (3 months ago)
- Topics: analysis, collection, dart, flutter, linter, lints, rules, ruleset, static-analysis
- Homepage: https://pub.dev/packages/words
- Size: 42 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
The [words](https://pub.dev/packages/words) package comprises two sets of
[lints][rules] which help in development of consistent, predictable
applications.
Two sets of linter rules are used:
- **Core lints**: Lints applicable to _all_ Dart code across every platform.
- **Flutter lints**: **Core** lints + additional lints only applicable to the
Flutter framework.
To learn more about lints, visit the official Dart
[lints](https://pub.dev/packages/lints) package repository.
## How to enable these lints
1. Add the `words` package as a developer dependency using the terminal:
```terminal
dart pub add --dev words
```
2. Create an `analysis_options.yaml` file at the root of the repository (next to
`pubspec.yaml`).
3. In a Flutter project you should add:
```yaml
include: package:words/flutter.yaml
```
Otherwise:
```yaml
include: package:words/core.yaml
```
[vxern]: https://github.com/vxern
[rules]: https://dart.dev/tools/linter-rules