Provide a better experience for `.oxlintrc.json` configuration files

oxc-project / oxc

⚓ A collection of JavaScript tools written in Rust.

https://oxc.rs

MIT License

12.53k stars 459 forks source link

Provide a better experience for `.oxlintrc.json` configuration files #4146

Open DonIsaac opened 4 months ago

DonIsaac commented 4 months ago

We should improve the DX of using .oxlintrc.json files to configure oxlint. Below is a (possibly incomplete) list of things I think we could improve:

[ ] Add rules and their configurations to the config's JSON schema
[ ] Warn users when they attempt to use a rule hidden behind a plugin flag without enabling the plugin
[ ] Provide more documentation for settings
[ ] Add the config's JSON schema to schemastore
[ ] #7032
[ ] #7096
[x] #7101
[x] https://github.com/oxc-project/oxc/issues/6896

Boshen commented 4 months ago

cc @mysteryven who may want to participate as well.

tylerlaprade commented 4 months ago

Also the documentation does not explain much about what various things do. I don't know what env and global are used for. I don't know the correct format of settings. I don't know the allowable values for a rule - is it just "error" and "warn"?