[oxlint] automated docs for rule configurations

[mesqueeb]

There's many rules that miss documentation on each of the possible configurations.
I made a manual fix for one here:
https://github.com/oxc-project/oxc/pull/12019/files

But I'm struggling understanding all the configurations possible for eg. this one:

oxc/crates/oxc_linter/src/rules/typescript/explicit_function_return_type.rs

Line 113 in a257d97

fn explicit_function_return_type_diagnostic(span: Span) -> OxcDiagnostic {

never having learned rust : P

Isn't there an automated way that we can show all the possible configurations per rule based on the automated tests for each rule configuration?

[nrayburn-tech]

To have the configuration added to the docs like this https://oxc.rs/docs/guide/usage/linter/rules/eslint/func-style.html#configuration, the config needs to be supplied to the declare_oxc_lint! macro. This is probably the best approach to improve the configuration.

I know of at least 2 problems with this approach right now.

1. Using a regex in the config can't be added due to it not supporting the JsonSchema that is required. Can probably be worked around by adding a custom impl.
2. Rules that have a config that doesn't exactly match the structure of what users should be supplying. Meaning, users supply a JSON of ["record"] but it gets stored in the config struct as {is_record: boolean}.

In any case, I'll look into what I can add here. I expect most of them should be able to use this approach or easily modified to use it.

[connorshea]

I would also really like to see this, if it's possible! I've found that quite a few rules lack options documentation at all, despite implementation the options: #14743

[connorshea]

I've been working on this in that issue (turns out there is already support for autogenerated docs) and also provided a script to find all the rules with this problem, it's pretty simple work so I'd appreciate any help!