https://github.com/mockturtl/tidy

Dart lint rules for analysis_options.yaml
https://github.com/mockturtl/tidy

analysis-options dart-lints

Last synced: about 1 month ago
JSON representation

Dart lint rules for analysis_options.yaml

• Host: GitHub
• URL: https://github.com/mockturtl/tidy
• Owner: mockturtl
• License: mit
• Created: 2021-01-17T02:34:06.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-20T18:11:38.000Z (3 months ago)
• Last Synced: 2024-08-20T20:24:21.469Z (3 months ago)
• Topics: analysis-options, dart-lints
• Language: Shell
• Homepage: https://pub.dev/packages/tidy
• Size: 95.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Pub](https://img.shields.io/pub/v/tidy.svg)](https://pub.dev/packages/tidy)

tidy

====

The complete annotated set of Dart analysis options, mostly enabled.

See [`tool/compare.sh`](tool/compare.sh) for a diff with [all rules](https://github.com/dart-lang/sdk/blob/main/pkg/linter/example/all.yaml).

Opinionated bits are commented.

Note a rule's existence upstream does not imply stability, or publication to [dart.dev/tools/linter-rules][].

[dart.dev/tools/linter-rules]: https://dart.dev/tools/linter-rules

Usage

-----

- Add `tidy` to your `dev_dependencies`, per .

```sh

$ dart pub add -d tidy

# or flutter pub add -d tidy

```

- Include the rules in `analysis_options.yaml` at the root of your project:

```yaml

include: package:tidy/analysis_options.yaml  # or specify a version: analysis_options.1.0.0.yaml

# You probably do want some customization.

analyzer:

  exclude:

    - lib/src/**/*.g.dart

# Override to taste as your project evolves.

# https://dart.dev/guides/language/analysis-options#disabling-individual-rules

linter:

  rules:

    public_member_api_docs: true

    prefer_final_locals: true

    require_trailing_commas: true

    unnecessary_final: false

    use_key_in_widget_constructors: true

```

### Versioning

This package follows Dart SDK versions, and aims to maintain [parity][] with rules available in the stable channel.

Its minimum SDK constraint will bump accordingly.  (Your project's Dart version must have `package:linter` with the rules you want to enable.)

In particular, your Flutter version may not ship the latest stable Dart.

[parity]: https://github.com/dart-lang/sdk/blob/master/CHANGELOG.md#linter

### Contributing

Please open a PR if upstream lands a rule not included here.

Steal this badge!

-----------------

[![style: tidy](https://img.shields.io/badge/style-tidy-43caf5.svg)](https://pub.dev/packages/tidy)

```md

[![style: tidy](https://img.shields.io/badge/style-tidy-43caf5.svg)](https://pub.dev/packages/tidy)

```