feat(tool): include tooling to track excluded lint rules and their reasons

[alestiago]

Status

READY

Description

Related to #99.

Creates a script that creates a table with those lint rules that are not enabled by default by Very Good Analysis, together with their reasons, if any.

Adds exclusion reasons for:

• always_put_control_body_on_new_line
• always_specify_types
• discarded_futures ([Feature Request] Add discarded_futures #74)
• prefer_double_quotes
• prefer_relative_imports
• use_decorated_box
• annotate_redeclares

Type of Change

• ✨ New feature (non-breaking change which adds functionality)
• 🛠️ Bug fix (non-breaking change which fixes an issue)
• ❌ Breaking change (fix or feature that would cause existing functionality to change)
• 🧹 Code refactor
• ✅ Build configuration change
• 📝 Documentation
• 🗑️ Chore

[oaahmad]

Hi. I noticed you are parsing the HTML page to get all lints. Then I found this: https://github.com/dart-lang/linter/blob/main/tool/machine/rules.json

It's all the rules stored as a JSON file (so it's machine-readable). You can find more information about that file by searching for "machine" in the "linter" repository ( https://github.com/dart-lang/linter ).

Just wanted to share that find to be helpful. It doesn't seem to be documented, but seems to be actively maintained by the Dart team (based on the issues in the repo). It seems less janky than trying to parse the HTML page. But do what you will with that information.

[oaahmad]

I guess this is the new link: https://github.com/dart-lang/sdk/blob/main/pkg/linter/tool/machine/rules.json

[alestiago]

Thanks @oaahmad that's precisely what I didn't like about it. Thanks for providing the old and new link!

dart-lang/sdk#55977 sounds great! The current documented link was the one I was relying on (and scraping it was far from ideal). This said, I hope the Dart team is aware that people might be consuming such internal JSON file so they are conscious on the impact their changes can have (I think Irnh is already on the right track dart-lang/sdk#55977 (comment)).