-
-
Notifications
You must be signed in to change notification settings - Fork 729
Open
Labels
A-linterArea - LinterArea - LinterC-docsCategory - Documentation. Related to user-facing or internal documentationCategory - Documentation. Related to user-facing or internal documentation
Description
What version of Oxlint are you using?
1.29.0
What command did you run?
N/A
What does your .oxlintrc.json config file look like?
N/A
What happened?
We were previously unable to accurately represent the options available for rules that took tuple values, and so our docs are wrong for a few rules. Currently, the docs treat options which need to be passed as ["error", "asc", { "allowLineSeparatedGroups": true }] such that they render in the docs as just a property of the object you pass, rather than an ordered parameter.
Thanks to #15904, we can now fix this problem for the following rules by either fixing their config docs, or adding them:
-
import/consistent-type-specifier-style -
func-names -
yoda -
arrow-body-style -
max-dependenciesI'm not sure if this one is possible yet without further tweaks to the docs generation -
func-style, this needs to be fixed to show that it accepts a tuple. -
init-declarations, accepts a string argument and then an options object -
curly -
grouped-accessor-pairs -
no-inner-declarations -
eqeqeq -
jsx-boolean-value
Metadata
Metadata
Assignees
Labels
A-linterArea - LinterArea - LinterC-docsCategory - Documentation. Related to user-facing or internal documentationCategory - Documentation. Related to user-facing or internal documentation