A package for owl-shed analysis related things.

This package is a set of lints and analyzer options, currently it only enables the existing lints (it doesn't add any custom ones yet), but that may change.

During the time that I've spent looking through every dart lint, I've realised that they are very bad at naming them, and in some cases also documenting them, and so I would actually encourage you to have a read through them.

I'd also like to encourage you to look at the source for this package, at the very least the general.yaml file, as I've mostly included (informal) comments regarding each one of my choices as to why an option was enabled or disabled. As well as showing which lints are enabled by the core, recommended and flutter lint packages.

Usage

In order to use this package, install it as a dev_dependency, and then use the include syntax to choose from one of the following:

• general.yaml - Use for general applications.
• web.yaml - Use for web applications.
• package.yaml - Use when you're making a custom package.

Then additionally, you can do an extra include to specify experimental, which will also enable some of the dart lints that are still marked as experimental.

Example

# In analysis_options.yaml
include: package:owl_analysis/general.yaml

# Or
include:
  - package:owl_analysis/package.yaml
  - package:owl_analysis/experimental.yaml

Usual lints

The package also automatically includes:

include:
  - package:lints/recommended.yaml # Implicitly includes the core.yaml lints too.
  - package:flutter_lints/flutter.yaml

This means that you shouldn't need to bother with changing them or having complicated lint lists, you just add this package, choose one of the options and you're good to go.

Overrides

The core.yaml options are never overwritten to make sure that pub.dev doesn't ruin the package ratings (I also didn't see any reason to change them).

The prefer_adjacent_string_concatenation lint (from lints/recommended.yaml) however has been changed because honestly who the heck thought this was even a good idea. I certainly don't, and never will.

Development

This package is maintained over at github.com/owl-shed/dart-analysis, I probably won't accept code PRs but who knows, if you find an issue then let me know.