[oxlint] how to read a rule's "config" when it's missing in docs?

[mesqueeb]

I was looking at consistent-indexed-object-style where there are two options we can pass, but they are undocumented.

How can I find out the exact spelling of the options I can pass to the rule?
I looked at the rule source, which led me here

• So I believe it's ["error", "record"] if you want Record but what if you want the other way?
• I think it's either "index-signature" or "index signature"

I can test both to see what works, but in general, if a rule has no documented config, how to best read the code to know?

[nrayburn-tech]

The “from_configuration” function is the right one. However it’s going to contain custom logic that you’ll have to understand to interpret the possible options.

The best thing is to just create an issue with the rule that is missing documentation for somebody to update it. If you understand rust and can contribute, then great you can do it yourself. Otherwise, it’ll wait for somebody to pick up.

[mesqueeb]

@nrayburn-tech @Sysix I've contributed better docs for this here: #12019 do I need to create a graphite account in order to be able to contribute?

[nrayburn-tech]

No. You can use Graphite, but you don’t have to ( I don’t ).

[nrayburn-tech]

I’m not super confident on my interpretation, but if you put anything other than “record” then I think you get the index signature behavior.

[Sysix]

You can look at the tests to be sure:

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

Line 266 in 94a418d

Some(serde_json::json!(["index-signature"])),

Tells that the configurations is:

"consistent-indexed-object-style": ["error", "index-signature"]

A configuration like:

Some(serde_json::json!([{"fake": "hello"}])),

Will be resolved to:

"consistent-indexed-object-style": ["error", {
  "fake": "hello"
}]