Document machine/rules.json about sdk HOT 8 OPEN

If we intend the file to be public, I'll recommend adding a version number to the format, so that we can change the format in the future, and told depending on the file can tell that they're not compatible with the new format.

If the file is not intended to be public, consider adding a notice, maybe:

{
  "_NOTICE:_": "This file is for internal use by the SDK. Format may change without notice.",
  "lints": ... current content ...
}

(Oh why does JSON not have comments!)

from sdk.

@parlough: do we have a copy of rules.json somewhere on dart.dev or am I mis-remembering?

Not directly hosted on the site, but it's mirrored at https://github.com/dart-lang/site-www/blob/main/src/_data/linter_rules.json and used to generate the the linter rule docs that are indexed at https://dart.dev/tools/linter-rules#rules.

I don't think we intend for it to be public

Originally it was. The impetus was a tool csells built. I expect it's no longer being maintained but it's possible there are others. Parker may know more...

Currently the machine/rules.json file has no versioning strategy and its current form will likely be retired soon as we introduce new documentation for choosing lints (dart-lang/site-www#4499, dart-lang/site-www#4498). So keeping that in mind, I'd say it's best to consider the current file as not public.

The final form of its replacement hasn't been decided yet, but I'll update here when it is ready and will keep in mind the use cases outlined here as well as any potential versioning concerns.

from sdk.

@parlough: do we have a copy of rules.json somewhere on dart.dev or am I mis-remembering?

I don't think we intend for it to be public

Originally it was. The impetus was a tool @csells built. I expect it's no longer being maintained but it's possible there are others. Parker may know more...

from sdk.

Oh very cool! In that case I like the versioning suggestion.

from sdk.

I believe this rules.json file is being used by @gaetschwartz to produce the all_lint_rules_community package. Does the Dart team produce an alternative? I absolutely love having all of the lint rules turned on by default, with some that I turn off. I catch so many problems in my code doing that.

from sdk.

/fyi @parlough

from sdk.

I don't think we intend for it to be public, or to have to consider versioning or consider any change to it a "breaking" change.

from sdk.

Thanks @parlough!

from sdk.