Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ workspaces, SDK requirements, overrides, and CI, follow the
with its recommended rules.
- `plugin_all.yaml`: the same plugin with every rule, including the ordering
and formatting conventions.
- `mix.yaml`: adds Mix's own `mix_lint` plugin, for projects that use Mix.
Include it next to `plugin.yaml` or `plugin_all.yaml`.

## Rules

Expand Down
3 changes: 3 additions & 0 deletions doc/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ yet they report hundreds to thousands of issues, so start with `plugin.yaml`
and switch once the code is ready (see step 6). Include one or the other, not
both.

Projects that use Mix can add `package:bitwild_analysis/mix.yaml` to the list
to enable Mix's `mix_lint` plugin as well. Both plugins run together.

On Dart 3.11 or 3.12, drop the `plugin.yaml` line and, if you want the plugin
locally, add it by path to a checkout of this repository:

Expand Down
4 changes: 4 additions & 0 deletions packages/bitwild_analysis/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## Unreleased

- Add `mix.yaml`, which enables the `mix_lint` plugin from the Mix repository.

## 0.3.0

- Rename the package from `btwld_lints` to `bitwild_analysis`. Update the
Expand Down
1 change: 1 addition & 0 deletions packages/bitwild_analysis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ include:
| `dart.yaml` | `package:lints/recommended.yaml`, strict analyzer modes, and Bitwild's shared rules. |
| `flutter.yaml` | `dart.yaml` plus `package:flutter_lints/flutter.yaml` and `prefer_const_constructors`. |
| `plugin.yaml` | The [`bitwild_lints`](../bitwild_lints) analyzer plugin at the matching release, with its recommended rules. |
| `mix.yaml` | The `mix_lint` plugin, for projects that use [Mix](https://github.com/btwld/mix). Include it next to `plugin.yaml` or `plugin_all.yaml`. |
| `plugin_all.yaml` | The same plugin with every rule, including the ordering and formatting conventions. Use instead of `plugin.yaml`. |

The rule selection comes from the rules most active Bitwild repositories already
Expand Down
22 changes: 22 additions & 0 deletions packages/bitwild_analysis/lib/mix.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Enables the mix_lint analyzer plugin for projects that use Mix.
#
# Include it next to a preset and plugin.yaml:
#
# include:
# - package:bitwild_analysis/flutter.yaml
# - package:bitwild_analysis/plugin.yaml
# - package:bitwild_analysis/mix.yaml
#
# mix_lint's bug checks are warnings, so they are on by default. Its style
# rules are lints: turn them on under the plugin's `diagnostics` in your own
# analysis_options.yaml, as described in mix_lint's README.
#
# mix_lint comes from the Mix repository's main branch until a release that
# loads alongside bitwild_lints is on pub.dev. Git plugin sources need Dart
# 3.13 or later (Flutter 3.47 or later).
plugins:
mix_lint:
git:
url: https://github.com/btwld/mix.git
path: packages/mix_lint
ref: main
Loading