oxlint 1.29.0 → 1.31.0

package/configuration_schema.json

@@ -21,14 +21,16 @@
         {
           "$ref": "#/definitions/OxlintEnv"
         }
-      ]
+      ],
+      "markdownDescription": "Environments enable and disable collections of global variables."
     },
     "extends": {
       "description": "Paths of configuration files that this configuration file extends (inherits from). The files\nare resolved relative to the location of the configuration file that contains the `extends`\nproperty. The configuration files are merged from the first to the last, with the last file\noverriding the previous ones.",
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "markdownDescription": "Paths of configuration files that this configuration file extends (inherits from). The files\nare resolved relative to the location of the configuration file that contains the `extends`\nproperty. The configuration files are merged from the first to the last, with the last file\noverriding the previous ones."
     },
     "globals": {
       "description": "Enabled or disabled specific global variables.",
@@ -37,7 +39,8 @@
         {
           "$ref": "#/definitions/OxlintGlobals"
         }
-      ]
+      ],
+      "markdownDescription": "Enabled or disabled specific global variables."
     },
     "ignorePatterns": {
       "description": "Globs to ignore during linting. These are resolved from the configuration file path.",
@@ -45,7 +48,8 @@
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "markdownDescription": "Globs to ignore during linting. These are resolved from the configuration file path."
     },
     "jsPlugins": {
       "description": "JS plugins.\n\nNote: JS plugins are experimental and not subject to semver.\nThey are not supported in language server at present.",
@@ -56,7 +60,8 @@
       "items": {
         "type": "string"
       },
-      "uniqueItems": true
+      "uniqueItems": true,
+      "markdownDescription": "JS plugins.\n\nNote: JS plugins are experimental and not subject to semver.\nThey are not supported in language server at present."
     },
     "overrides": {
       "description": "Add, remove, or otherwise reconfigure rules for specific files or groups of files.",
@@ -64,7 +69,8 @@
         {
           "$ref": "#/definitions/OxlintOverrides"
         }
-      ]
+      ],
+      "markdownDescription": "Add, remove, or otherwise reconfigure rules for specific files or groups of files."
     },
     "plugins": {
       "description": "Enabled built-in plugins for Oxlint.\nYou can view the list of available plugins on\n[the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).\n\nNOTE: Setting the `plugins` field will overwrite the base set of plugins.\nThe `plugins` array should reflect all of the plugins you want to use.",
@@ -76,7 +82,8 @@
         {
           "type": "null"
         }
-      ]
+      ],
+      "markdownDescription": "Enabled built-in plugins for Oxlint.\nYou can view the list of available plugins on\n[the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).\n\nNOTE: Setting the `plugins` field will overwrite the base set of plugins.\nThe `plugins` array should reflect all of the plugins you want to use."
     },
     "rules": {
       "description": "Example\n\n`.oxlintrc.json`\n\n```json\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"rules\": {\n\"eqeqeq\": \"warn\",\n\"import/no-cycle\": \"error\",\n\"prefer-const\": [\"error\", { \"ignoreReadBeforeAssign\": true }]\n}\n}\n```\n\nSee [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of\nrules.",
@@ -85,7 +92,8 @@
         {
           "$ref": "#/definitions/OxlintRules"
         }
-      ]
+      ],
+      "markdownDescription": "Example\n\n`.oxlintrc.json`\n\n```json\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"rules\": {\n\"eqeqeq\": \"warn\",\n\"import/no-cycle\": \"error\",\n\"prefer-const\": [\"error\", { \"ignoreReadBeforeAssign\": true }]\n}\n}\n```\n\nSee [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of\nrules."
     },
     "settings": {
       "default": {
@@ -136,14 +144,16 @@
             "warn",
             "error",
             "deny"
-          ]
+          ],
+          "markdownDescription": "Oxlint rule.\n- \"allow\" or \"off\": Turn off the rule.\n- \"warn\": Turn the rule on as a warning (doesn't affect exit code).\n- \"error\" or \"deny\": Turn the rule on as an error (will exit with a failure code)."
         },
         {
           "description": "Oxlint rule.\n    \n- 0: Turn off the rule.\n- 1: Turn the rule on as a warning (doesn't affect exit code).\n- 2: Turn the rule on as an error (will exit with a failure code).",
           "type": "integer",
           "format": "uint32",
           "maximum": 2.0,
-          "minimum": 0.0
+          "minimum": 0.0,
+          "markdownDescription": "Oxlint rule.\n    \n- 0: Turn off the rule.\n- 1: Turn the rule on as a warning (doesn't affect exit code).\n- 2: Turn the rule on as an error (will exit with a failure code)."
         }
       ]
     },
@@ -203,14 +213,16 @@
       "type": "object",
       "additionalProperties": {
         "$ref": "#/definitions/DummyRule"
-      }
+      },
+      "markdownDescription": "See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html)"
     },
     "GlobSet": {
       "description": "A set of glob patterns.",
       "type": "array",
       "items": {
         "type": "string"
-      }
+      },
+      "markdownDescription": "A set of glob patterns."
     },
     "GlobalValue": {
       "type": "string",
@@ -226,37 +238,44 @@
         "augmentsExtendsReplacesDocs": {
           "description": "Only for `require-(yields|returns|description|example|param|throws)` rule",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Only for `require-(yields|returns|description|example|param|throws)` rule"
         },
         "exemptDestructuredRootsFromChecks": {
           "description": "Only for `require-param-type` and `require-param-description` rule",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Only for `require-param-type` and `require-param-description` rule"
         },
         "ignoreInternal": {
           "description": "For all rules but NOT apply to `empty-tags` rule",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "For all rules but NOT apply to `empty-tags` rule"
         },
         "ignorePrivate": {
           "description": "For all rules but NOT apply to `check-access` and `empty-tags` rule",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "For all rules but NOT apply to `check-access` and `empty-tags` rule"
         },
         "ignoreReplacesDocs": {
           "description": "Only for `require-(yields|returns|description|example|param|throws)` rule",
           "default": true,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Only for `require-(yields|returns|description|example|param|throws)` rule"
         },
         "implementsReplacesDocs": {
           "description": "Only for `require-(yields|returns|description|example|param|throws)` rule",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Only for `require-(yields|returns|description|example|param|throws)` rule"
         },
         "overrideReplacesDocs": {
           "description": "Only for `require-(yields|returns|description|example|param|throws)` rule",
           "default": true,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Only for `require-(yields|returns|description|example|param|throws)` rule"
         },
         "tagNamePreference": {
           "default": {},
@@ -280,7 +299,8 @@
             "items": {
               "type": "string"
             }
-          }
+          },
+          "markdownDescription": "Map of attribute names to their DOM equivalents.\nThis is useful for non-React frameworks that use different attribute names.\n\nExample:\n\n```json\n{\n\"settings\": {\n\"jsx-a11y\": {\n\"attributes\": {\n\"for\": [\"htmlFor\", \"for\"]\n}\n}\n}\n}\n```"
         },
         "components": {
           "description": "To have your custom components be checked as DOM elements, you can\nprovide a mapping of your component names to the DOM element name.\n\nExample:\n\n```json\n{\n\"settings\": {\n\"jsx-a11y\": {\n\"components\": {\n\"Link\": \"a\",\n\"IconButton\": \"button\"\n}\n}\n}\n}\n```",
@@ -288,16 +308,19 @@
           "type": "object",
           "additionalProperties": {
             "type": "string"
-          }
+          },
+          "markdownDescription": "To have your custom components be checked as DOM elements, you can\nprovide a mapping of your component names to the DOM element name.\n\nExample:\n\n```json\n{\n\"settings\": {\n\"jsx-a11y\": {\n\"components\": {\n\"Link\": \"a\",\n\"IconButton\": \"button\"\n}\n}\n}\n}\n```"
         },
         "polymorphicPropName": {
           "description": "An optional setting that define the prop your code uses to create polymorphic components.\nThis setting will be used to determine the element type in rules that\nrequire semantic context.\n\nFor example, if you set the `polymorphicPropName` to `as`, then this element:\n\n```jsx\n<Box as=\"h3\">Hello</Box>\n```\n\nWill be treated as an `h3`. If not set, this component will be treated\nas a `Box`.",
           "type": [
             "string",
             "null"
-          ]
+          ],
+          "markdownDescription": "An optional setting that define the prop your code uses to create polymorphic components.\nThis setting will be used to determine the element type in rules that\nrequire semantic context.\n\nFor example, if you set the `polymorphicPropName` to `as`, then this element:\n\n```jsx\n<Box as=\"h3\">Hello</Box>\n```\n\nWill be treated as an `h3`. If not set, this component will be treated\nas a `Box`."
         }
-      }
+      },
+      "markdownDescription": "Configure JSX A11y plugin rules.\n\nSee\n[eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations)'s\nconfiguration for a full reference."
     },
     "LintPluginOptionsSchema": {
       "type": "string",
@@ -341,9 +364,11 @@
             {
               "$ref": "#/definitions/OneOrMany_for_String"
             }
-          ]
+          ],
+          "markdownDescription": "The root directory of the Next.js project.\n\nThis is particularly useful when you have a monorepo and your Next.js\nproject is in a subfolder.\n\nExample:\n\n```json\n{\n\"settings\": {\n\"next\": {\n\"rootDir\": \"apps/dashboard/\"\n}\n}\n}\n```"
         }
-      }
+      },
+      "markdownDescription": "Configure Next.js plugin rules."
     },
     "OneOrMany_for_String": {
       "anyOf": [
@@ -390,21 +415,24 @@
           "$ref": "#/definitions/AllowWarnDeny"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "markdownDescription": "Configure an entire category of rules all at once.\n\nRules enabled or disabled this way will be overwritten by individual rules in the `rules` field.\n\nExample\n```json\n{\n    \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n    \"categories\": {\n        \"correctness\": \"warn\"\n    },\n    \"rules\": {\n        \"eslint/no-unused-vars\": \"error\"\n    }\n}\n```"
     },
     "OxlintEnv": {
       "description": "Predefine global variables.\n\nEnvironments specify what global variables are predefined.\nSee [ESLint's list of environments](https://eslint.org/docs/v8.x/use/configure/language-options#specifying-environments)\nfor what environments are available and what each one provides.",
       "type": "object",
       "additionalProperties": {
         "type": "boolean"
-      }
+      },
+      "markdownDescription": "Predefine global variables.\n\nEnvironments specify what global variables are predefined.\nSee [ESLint's list of environments](https://eslint.org/docs/v8.x/use/configure/language-options#specifying-environments)\nfor what environments are available and what each one provides."
     },
     "OxlintGlobals": {
       "description": "Add or remove global variables.\n\nFor each global variable, set the corresponding value equal to `\"writable\"`\nto allow the variable to be overwritten or `\"readonly\"` to disallow overwriting.\n\nGlobals can be disabled by setting their value to `\"off\"`. For example, in\nan environment where most Es2015 globals are available but `Promise` is unavailable,\nyou might use this config:\n\n```json\n\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"env\": {\n\"es6\": true\n},\n\"globals\": {\n\"Promise\": \"off\"\n}\n}\n\n```\n\nYou may also use `\"readable\"` or `false` to represent `\"readonly\"`, and\n`\"writeable\"` or `true` to represent `\"writable\"`.",
       "type": "object",
       "additionalProperties": {
         "$ref": "#/definitions/GlobalValue"
-      }
+      },
+      "markdownDescription": "Add or remove global variables.\n\nFor each global variable, set the corresponding value equal to `\"writable\"`\nto allow the variable to be overwritten or `\"readonly\"` to disallow overwriting.\n\nGlobals can be disabled by setting their value to `\"off\"`. For example, in\nan environment where most Es2015 globals are available but `Promise` is unavailable,\nyou might use this config:\n\n```json\n\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"env\": {\n\"es6\": true\n},\n\"globals\": {\n\"Promise\": \"off\"\n}\n}\n\n```\n\nYou may also use `\"readable\"` or `false` to represent `\"readonly\"`, and\n`\"writeable\"` or `true` to represent `\"writable\"`."
     },
     "OxlintOverride": {
       "type": "object",
@@ -421,7 +449,8 @@
             {
               "type": "null"
             }
-          ]
+          ],
+          "markdownDescription": "Environments enable and disable collections of global variables."
         },
         "files": {
           "description": "A list of glob patterns to override.\n\n## Example\n`[ \"*.test.ts\", \"*.spec.ts\" ]`",
@@ -429,7 +458,8 @@
             {
               "$ref": "#/definitions/GlobSet"
             }
-          ]
+          ],
+          "markdownDescription": "A list of glob patterns to override.\n\n## Example\n`[ \"*.test.ts\", \"*.spec.ts\" ]`"
         },
         "globals": {
           "description": "Enabled or disabled specific global variables.",
@@ -440,7 +470,8 @@
             {
               "type": "null"
             }
-          ]
+          ],
+          "markdownDescription": "Enabled or disabled specific global variables."
         },
         "jsPlugins": {
           "description": "JS plugins for this override.\n\nNote: JS plugins are experimental and not subject to semver.\nThey are not supported in language server at present.",
@@ -451,7 +482,8 @@
           "items": {
             "type": "string"
           },
-          "uniqueItems": true
+          "uniqueItems": true,
+          "markdownDescription": "JS plugins for this override.\n\nNote: JS plugins are experimental and not subject to semver.\nThey are not supported in language server at present."
         },
         "plugins": {
           "description": "Optionally change what plugins are enabled for this override. When\nomitted, the base config's plugins are used.",
@@ -463,7 +495,8 @@
             {
               "type": "null"
             }
-          ]
+          ],
+          "markdownDescription": "Optionally change what plugins are enabled for this override. When\nomitted, the base config's plugins are used."
         },
         "rules": {
           "default": {},
@@ -549,7 +582,8 @@
             }
           ]
         }
-      }
+      },
+      "markdownDescription": "Configure the behavior of linter plugins.\n\nHere's an example if you're using Next.js in a monorepo:\n\n```json\n{\n\"settings\": {\n\"next\": {\n\"rootDir\": \"apps/dashboard/\"\n},\n\"react\": {\n\"linkComponents\": [\n{ \"name\": \"Link\", \"linkAttribute\": \"to\" }\n]\n},\n\"jsx-a11y\": {\n\"components\": {\n\"Link\": \"a\",\n\"Button\": \"button\"\n}\n}\n}\n}\n```"
     },
     "ReactPluginSettings": {
       "description": "Configure React plugin rules.\n\nDerived from [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)",
@@ -561,7 +595,8 @@
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
-          }
+          },
+          "markdownDescription": "Components used as alternatives to `<form>` for forms, such as `<Formik>`.\n\nExample:\n\n```jsonc\n{\n\"settings\": {\n\"react\": {\n\"formComponents\": [\n\"CustomForm\",\n// OtherForm is considered a form component and has an endpoint attribute\n{ \"name\": \"OtherForm\", \"formAttribute\": \"endpoint\" },\n// allows specifying multiple properties if necessary\n{ \"name\": \"Form\", \"formAttribute\": [\"registerEndpoint\", \"loginEndpoint\"] }\n]\n}\n}\n}\n```"
         },
         "linkComponents": {
           "description": "Components used as alternatives to `<a>` for linking, such as `<Link>`.\n\nExample:\n\n```jsonc\n{\n\"settings\": {\n\"react\": {\n\"linkComponents\": [\n\"HyperLink\",\n// Use `linkAttribute` for components that use a different prop name\n// than `href`.\n{ \"name\": \"MyLink\", \"linkAttribute\": \"to\" },\n// allows specifying multiple properties if necessary\n{ \"name\": \"Link\", \"linkAttribute\": [\"to\", \"href\"] }\n]\n}\n}\n}\n```",
@@ -569,9 +604,11 @@
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
-          }
+          },
+          "markdownDescription": "Components used as alternatives to `<a>` for linking, such as `<Link>`.\n\nExample:\n\n```jsonc\n{\n\"settings\": {\n\"react\": {\n\"linkComponents\": [\n\"HyperLink\",\n// Use `linkAttribute` for components that use a different prop name\n// than `href`.\n{ \"name\": \"MyLink\", \"linkAttribute\": \"to\" },\n// allows specifying multiple properties if necessary\n{ \"name\": \"Link\", \"linkAttribute\": [\"to\", \"href\"] }\n]\n}\n}\n}\n```"
         }
-      }
+      },
+      "markdownDescription": "Configure React plugin rules.\n\nDerived from [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)"
     },
     "TagNamePreference": {
       "anyOf": [
@@ -616,9 +653,12 @@
         "typecheck": {
           "description": "Whether to enable typecheck mode for Vitest rules.\nWhen enabled, some rules will skip certain checks for describe blocks\nto accommodate TypeScript type checking scenarios.",
           "default": false,
-          "type": "boolean"
+          "type": "boolean",
+          "markdownDescription": "Whether to enable typecheck mode for Vitest rules.\nWhen enabled, some rules will skip certain checks for describe blocks\nto accommodate TypeScript type checking scenarios."
         }
-      }
+      },
+      "markdownDescription": "Configure Vitest plugin rules.\n\nSee [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)'s\nconfiguration for a full reference."
     }
-  }
-}
+  },
+  "markdownDescription": "Oxlint Configuration File\n\nThis configuration is aligned with ESLint v8's configuration schema (`eslintrc.json`).\n\nUsage: `oxlint -c oxlintrc.json --import-plugin`\n\n::: danger NOTE\n\nOnly the `.json` format is supported. You can use comments in configuration files.\n\n:::\n\nExample\n\n`.oxlintrc.json`\n\n```json\n{\n\"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n\"plugins\": [\"import\", \"typescript\", \"unicorn\"],\n\"env\": {\n\"browser\": true\n},\n\"globals\": {\n\"foo\": \"readonly\"\n},\n\"settings\": {\n},\n\"rules\": {\n\"eqeqeq\": \"warn\",\n\"import/no-cycle\": \"error\",\n\"react/self-closing-comp\": [\"error\", { \"html\": false }]\n},\n\"overrides\": [\n{\n\"files\": [\"*.test.ts\", \"*.spec.ts\"],\n\"rules\": {\n\"@typescript-eslint/no-explicit-any\": \"off\"\n}\n}\n]\n}\n```"
+}