https://github.com/netsells/flutter-analysis
This package provides lint rules for Dart and Flutter which are used at Netsells.
https://github.com/netsells/flutter-analysis
Last synced: about 1 month ago
JSON representation
This package provides lint rules for Dart and Flutter which are used at Netsells.
- Host: GitHub
- URL: https://github.com/netsells/flutter-analysis
- Owner: netsells
- License: mit
- Created: 2021-10-27T08:01:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T14:48:43.000Z (over 1 year ago)
- Last Synced: 2025-02-02T18:51:46.456Z (3 months ago)
- Language: Dart
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Netsells Flutter Analysis
This package provides lint rules for Dart and Flutter which are used at [Netsells](https://netsells.co.uk).
**Note**: This package was heavily inspired by [very_good_analysis](https://pub.dev/packages/very_good_analysis).
## Usage
To use the lints, add a dependency in your `pubspec.yaml`:
```yaml
dev_dependencies:
netsells_flutter_analysis: ^5.0.0
```
Then, add an include in `analysis_options.yaml`:
```yaml
include: package:netsells_flutter_analysis/analysis_options.yaml
```
This will ensure you always use the latest version of the lints. If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead:
```yaml
include: package:netsells_flutter_analysis/analysis_options.4.0.0.yaml
```
## Suppressing Lints
There may be cases where specific lint rules are undesirable. Lint rules can be surpressed at the line, file, or project level.
An example use case for suppressing lint rules at the file level is suppressing the `prefer_const_constructors` in order to achieve 100% code coverage. This is due to the fact that const constructors are executed before the tests are run, resulting in no coverage collection.
### Line Level
To surpress a specific lint rule for a specific line of code, use an `ignore` comment directly above the line:
```dart
// ignore: public_member_api_docs
class A {}
```
### File Level
To surpress a specific lint rule of a specific file, use an `ignore_for_file` comment at the top of the file:
```dart
// ignore_for_file: public_member_api_docs
class A {}
class B {}
```