Oxlint Configuration File
This configuration is aligned with ESLint v8's configuration schema (eslintrc.json).
Usage: oxlint -c oxlintrc.json
NOTE
Only the .json format is supported.
Example
.oxlintrc.json
{
"env": {
"browser": true
},
"globals": {
"foo": "readonly"
},
"settings": {},
"rules": {
"eqeqeq": "warn"
}
}env
type: object
Predefine global variables.
globals
type: object
Add or remove global variables.
rules
See Oxlint Rules
settings
type: object
Shared settings for plugins
settings.jsdoc
type: object
settings.jsdoc.augmentsExtendsReplacesDocs
type: boolean
Only for require-(yields|returns|description|example|param|throws) rule
settings.jsdoc.exemptDestructuredRootsFromChecks
type: boolean
Only for require-param-type and require-param-description rule
settings.jsdoc.ignoreInternal
type: boolean
For all rules but NOT apply to empty-tags rule
settings.jsdoc.ignorePrivate
type: boolean
For all rules but NOT apply to check-access and empty-tags rule
settings.jsdoc.ignoreReplacesDocs
type: boolean
Only for require-(yields|returns|description|example|param|throws) rule
settings.jsdoc.implementsReplacesDocs
type: boolean
Only for require-(yields|returns|description|example|param|throws) rule
settings.jsdoc.overrideReplacesDocs
type: boolean
Only for require-(yields|returns|description|example|param|throws) rule
settings.jsdoc.tagNamePreference
type: object
settings.jsx-a11y
type: object
settings.jsx-a11y.components
type: object
settings.jsx-a11y.polymorphicPropName
type: [ string, null ]
settings.next
type: object
settings.next.rootDir
settings.react
type: object
settings.react.formComponents
type: array
settings.react.formComponents[n]
settings.react.linkComponents
type: array