Files
sdk/pkg/linter/tool/machine/README.md
T
Parker Lougheed e2a2761cc6 [linter] Clarify status and use of rules.json and clean up generation
- Adds a doc at `pkg/linter/tool/machine/rules.json` with info about the file.
- Drops the disabled test that checked that the file is up to date.
- Drops inclusion of rule sets from the `rules.json` file.
- Consolidate the remaining logic for determining rule sets


Closes https://github.com/dart-lang/linter/issues/4756
Closes https://github.com/dart-lang/sdk/issues/55977
Contributes to https://github.com/dart-lang/sdk/issues/56835

Change-Id: Ic030640571c0f8cf553a218a2e32c5a767535564
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/388481
Auto-Submit: Parker Lougheed <parlough@gmail.com>
Reviewed-by: Devon Carew <devoncarew@google.com>
Commit-Queue: Devon Carew <devoncarew@google.com>
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
Reviewed-by: Phil Quitslund <pquitslund@google.com>
Reviewed-by: Samuel Rawlins <srawlins@google.com>
2024-10-08 18:39:29 +00:00

1.2 KiB

Generated inter rule information

Warning

The rules.json file is unsupported and deprecated, and should not be relied on.

The rules.json is generated from lint information in the rule source files as well as the pkg/linter/messages.yaml file. It is primarily used by the dart.dev website.

To update the rules.json file, run:

dart run pkg/linter/tool/machine/machine.dart -w

Deprecation and replacement

The rules.json file is unsupported and deprecated, and should not be used nor should its contents be relied on. In the future, it will stop receiving updates and will be removed without notice.

If you need a list of all available and stable lint rules, you can reference dart.dev/lints/all. dart.dev/lints has details about each lint rule, including deprecated, removed, and experimental rules.

Some of the information in the rules.json file is instead available in the pkg/linter/messages.yaml file. However, the messages.yaml file is subject to change and is not guaranteed to be stable. To follow along and provide feedback on this transition, check out SDK issue #56835.