https://github.com/zebradevs/zds_analysis
https://github.com/zebradevs/zds_analysis
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zebradevs/zds_analysis
- Owner: ZebraDevs
- License: mit
- Created: 2023-10-11T16:29:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-07T14:20:17.000Z (over 1 year ago)
- Last Synced: 2025-04-01T05:11:07.190Z (about 1 year ago)
- Language: Dart
- Size: 27.3 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ZDS Analysis
This package provides lint rules for Dart and Flutter which are used at Zebra Technologies Corporation.
**Note**: This package was heavily inspired by both [Very Good Analysis](https://pub.dev/packages/very_good_analysis) and [RydMike](https://rydmike.com/blog_flutter_linting.html).
## Usage
To use the lints, add as a dev dependency in your `pubspec.yaml`:
```yaml
dev_dependencies:
zds_analysis: ^1.0.0
```
Then, add an include in `analysis_options.yaml`:
```yaml
include: package:zds_analysis/analysis_options.yaml
```
This will ensure you always use the latest version of the lints.
Our versions follow the Dart SDK versions. If you wish to restrict the lint version, specify a version of `analysis_options.yaml`.
For example, for projects using Dark SDK versions 2.18.x:
```yaml
include: package:zds_analysis/analysis_options.2.18.yaml
```
For strict typed rules, use:
```yaml
include: package:zds_analysis/analysis_options_strict.yaml
```
Or, specific version:
```yaml
include: package:zds_analysis/analysis_options_strict.2.18.yaml
```
For library specific lints (not for use in applications):
```yaml
include: package:zds_analysis/analysis_options_lib.yaml
```
## Suppressing Lints
There may be cases where specific lint rules are undesirable. Lint rules can be suppressed 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 suppress 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 suppress 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 {}
```
### Project Level
To suppress a specific lint rule for an entire project, modify `analysis_options.yaml`:
```yaml
include: package:zds_analysis/analysis_options.yaml
linter:
rules:
public_member_api_docs: false
```