docs(linter): add docs for config settings (#4827)

oxc-project · Nov 21, 2024 · df143ca · df143ca
1 parent 849489e
commit df143ca
Show file tree

Hide file tree

Showing 7 changed files with 195 additions and 7 deletions.
diff --git a/crates/oxc_linter/src/config/settings/jsx_a11y.rs b/crates/oxc_linter/src/config/settings/jsx_a11y.rs
@@ -3,12 +3,46 @@ use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-// <https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations>
+/// Configure JSX A11y plugin rules.
+///
+/// See
+/// [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations)'s
+/// configuration for a full reference.
 #[derive(Debug, Clone, Deserialize, Default, Serialize, JsonSchema)]
 #[cfg_attr(test, derive(PartialEq))]
 pub struct JSXA11yPluginSettings {
+    /// An optional setting that define the prop your code uses to create polymorphic components.
+    /// This setting will be used to determine the element type in rules that
+    /// require semantic context.
+    ///
+    /// For example, if you set the `polymorphicPropName` to `as`, then this element:
+    ///
+    /// ```jsx
+    /// <Box as="h3">Hello</Box>
+    /// ```
+    ///
+    /// Will be treated as an `h3`. If not set, this component will be treated
+    /// as a `Box`.
     #[serde(rename = "polymorphicPropName")]
     pub polymorphic_prop_name: Option<CompactStr>,
+
+    /// To have your custom components be checked as DOM elements, you can
+    /// provide a mapping of your component names to the DOM element name.
+    ///
+    /// ## Example
+    ///
+    /// ```json
+    /// {
+    ///   "settings": {
+    ///     "jsx-a11y": {
+    ///       "components": {
+    ///         "Link": "a",
+    ///         "IconButton": "button"
+    ///       }
+    ///     }
+    ///   }
+    /// }
+    /// ```
     #[serde(default)]
     pub components: FxHashMap<CompactStr, CompactStr>,
 }
diff --git a/crates/oxc_linter/src/config/settings/mod.rs b/crates/oxc_linter/src/config/settings/mod.rs
@@ -11,7 +11,34 @@ use self::{
     react::ReactPluginSettings,
 };
 
-/// Shared settings for plugins
+/// # Oxlint Plugin Settings
+///
+/// Configure the behavior of linter plugins.
+///
+/// ## Example
+///
+/// Here's an example if you're using Next.js in a monorepo:
+///
+/// ```json
+/// {
+///   "settings": {
+///     "next": {
+///       "rootDir": "apps/dashboard/"
+///     },
+///     "react": {
+///       "linkComponents": [
+///         { "name": "Link", "linkAttribute": "to" }
+///       ]
+///     },
+///     "jsx-a11y": {
+///       "components": {
+///         "Link": "a",
+///         "Button": "button"
+///       }
+///     }
+///   }
+/// }
+/// ```
 #[derive(Debug, Clone, Deserialize, Serialize, Default, JsonSchema)]
 #[cfg_attr(test, derive(PartialEq))]
 pub struct OxlintSettings {

diff --git a/crates/oxc_linter/src/config/settings/next.rs b/crates/oxc_linter/src/config/settings/next.rs
@@ -3,9 +3,26 @@ use std::borrow::Cow;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize, Serializer};
 
+/// Configure Next.js plugin rules.
 #[derive(Debug, Clone, Deserialize, Default, Serialize, JsonSchema)]
 #[cfg_attr(test, derive(PartialEq))]
 pub struct NextPluginSettings {
+    /// The root directory of the Next.js project.
+    ///
+    /// This is particularly useful when you have a monorepo and your Next.js
+    /// project is in a subfolder.
+    ///
+    /// ## Example
+    ///
+    /// ```json
+    /// {
+    ///   "settings": {
+    ///     "next": {
+    ///       "rootDir": "apps/dashboard/"
+    ///     }
+    ///   }
+    /// }
+    /// ```
     #[serde(default)]
     #[serde(rename = "rootDir")]
     root_dir: OneOrMany<String>,

diff --git a/crates/oxc_linter/src/config/settings/react.rs b/crates/oxc_linter/src/config/settings/react.rs
@@ -4,14 +4,55 @@ use oxc_span::CompactStr;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-// <https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc->
+/// Configure React plugin rules.
+///
+/// Derived from [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)
 #[derive(Debug, Clone, Deserialize, Default, Serialize, JsonSchema)]
 #[cfg_attr(test, derive(PartialEq))]
 pub struct ReactPluginSettings {
+    /// Components used as alternatives to `<form>` for forms, such as `<Formik>`.
+    ///
+    /// ## Example
+    ///
+    /// ```jsonc
+    /// {
+    ///   "settings": {
+    ///     "react": {
+    ///       "formComponents": [
+    ///         "CustomForm",
+    ///         // OtherForm is considered a form component and has an endpoint attribute
+    ///         { "name": "OtherForm", "formAttribute": "endpoint" },
+    ///         // allows specifying multiple properties if necessary
+    ///         { "name": "Form", "formAttribute": ["registerEndpoint", "loginEndpoint"] }
+    ///       ]
+    ///     }
+    ///   }
+    /// }
+    /// ```
     #[serde(default)]
     #[serde(rename = "formComponents")]
     form_components: Vec<CustomComponent>,
 
+    /// Components used as alternatives to `<a>` for linking, such as `<Link>`.
+    ///
+    /// ## Example
+    ///
+    /// ```jsonc
+    /// {
+    ///   "settings": {
+    ///     "react": {
+    ///       "linkComponents": [
+    ///         "HyperLink",
+    ///         // Use `linkAttribute` for components that use a different prop name
+    ///         // than `href`.
+    ///         { "name": "MyLink", "linkAttribute": "to" },
+    ///         // allows specifying multiple properties if necessary
+    ///         { "name": "Link", "linkAttribute": ["to", "href"] }
+    ///       ]
+    ///     }
+    ///   }
+    /// }
+    /// ```
     #[serde(default)]
     #[serde(rename = "linkComponents")]
     link_components: Vec<CustomComponent>,

diff --git a/crates/oxc_linter/src/snapshots/schema_json.snap b/crates/oxc_linter/src/snapshots/schema_json.snap
@@ -241,16 +241,19 @@ snapshot_kind: text
       }
     },
     "JSXA11yPluginSettings": {
+      "description": "Configure JSX A11y plugin rules.\n\nSee [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations)'s configuration for a full reference.",
       "type": "object",
       "properties": {
         "components": {
+          "description": "To have your custom components be checked as DOM elements, you can provide a mapping of your component names to the DOM element name.\n\n## Example\n\n```json { \"settings\": { \"jsx-a11y\": { \"components\": { \"Link\": \"a\", \"IconButton\": \"button\" } } } } ```",
           "default": {},
           "type": "object",
           "additionalProperties": {
             "type": "string"
           }
         },
         "polymorphicPropName": {
+          "description": "An optional setting that define the prop your code uses to create polymorphic components. This setting will be used to determine the element type in rules that require semantic context.\n\nFor example, if you set the `polymorphicPropName` to `as`, then this element:\n\n```jsx <Box as=\"h3\">Hello</Box> ```\n\nWill be treated as an `h3`. If not set, this component will be treated as a `Box`.",
           "type": [
             "string",
             "null"
@@ -265,9 +268,11 @@ snapshot_kind: text
       }
     },
     "NextPluginSettings": {
+      "description": "Configure Next.js plugin rules.",
       "type": "object",
       "properties": {
         "rootDir": {
+          "description": "The root directory of the Next.js project.\n\nThis is particularly useful when you have a monorepo and your Next.js project is in a subfolder.\n\n## Example\n\n```json { \"settings\": { \"next\": { \"rootDir\": \"apps/dashboard/\" } } } ```",
           "default": [],
           "allOf": [
             {
@@ -383,7 +388,8 @@ snapshot_kind: text
       "$ref": "#/definitions/DummyRuleMap"
     },
     "OxlintSettings": {
-      "description": "Shared settings for plugins",
+      "title": "Oxlint Plugin Settings",
+      "description": "Configure the behavior of linter plugins.\n\n## Example\n\nHere's an example if you're using Next.js in a monorepo:\n\n```json { \"settings\": { \"next\": { \"rootDir\": \"apps/dashboard/\" }, \"react\": { \"linkComponents\": [ { \"name\": \"Link\", \"linkAttribute\": \"to\" } ] }, \"jsx-a11y\": { \"components\": { \"Link\": \"a\", \"Button\": \"button\" } } } } ```",
       "type": "object",
       "properties": {
         "jsdoc": {
@@ -438,16 +444,19 @@ snapshot_kind: text
       }
     },
     "ReactPluginSettings": {
+      "description": "Configure React plugin rules.\n\nDerived from [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)",
       "type": "object",
       "properties": {
         "formComponents": {
+          "description": "Components used as alternatives to `<form>` for forms, such as `<Formik>`.\n\n## Example\n\n```jsonc { \"settings\": { \"react\": { \"formComponents\": [ \"CustomForm\", // OtherForm is considered a form component and has an endpoint attribute { \"name\": \"OtherForm\", \"formAttribute\": \"endpoint\" }, // allows specifying multiple properties if necessary { \"name\": \"Form\", \"formAttribute\": [\"registerEndpoint\", \"loginEndpoint\"] } ] } } } ```",
           "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
           }
         },
         "linkComponents": {
+          "description": "Components used as alternatives to `<a>` for linking, such as `<Link>`.\n\n## Example\n\n```jsonc { \"settings\": { \"react\": { \"linkComponents\": [ \"HyperLink\", // Use `linkAttribute` for components that use a different prop name // than `href`. { \"name\": \"MyLink\", \"linkAttribute\": \"to\" }, // allows specifying multiple properties if necessary { \"name\": \"Link\", \"linkAttribute\": [\"to\", \"href\"] } ] } } } ```",
           "default": [],
           "type": "array",
           "items": {

diff --git a/npm/oxlint/configuration_schema.json b/npm/oxlint/configuration_schema.json
@@ -236,16 +236,19 @@
       }
     },
     "JSXA11yPluginSettings": {
+      "description": "Configure JSX A11y plugin rules.\n\nSee [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations)'s configuration for a full reference.",
       "type": "object",
       "properties": {
         "components": {
+          "description": "To have your custom components be checked as DOM elements, you can provide a mapping of your component names to the DOM element name.\n\n## Example\n\n```json { \"settings\": { \"jsx-a11y\": { \"components\": { \"Link\": \"a\", \"IconButton\": \"button\" } } } } ```",
           "default": {},
           "type": "object",
           "additionalProperties": {
             "type": "string"
           }
         },
         "polymorphicPropName": {
+          "description": "An optional setting that define the prop your code uses to create polymorphic components. This setting will be used to determine the element type in rules that require semantic context.\n\nFor example, if you set the `polymorphicPropName` to `as`, then this element:\n\n```jsx <Box as=\"h3\">Hello</Box> ```\n\nWill be treated as an `h3`. If not set, this component will be treated as a `Box`.",
           "type": [
             "string",
             "null"
@@ -260,9 +263,11 @@
       }
     },
     "NextPluginSettings": {
+      "description": "Configure Next.js plugin rules.",
       "type": "object",
       "properties": {
         "rootDir": {
+          "description": "The root directory of the Next.js project.\n\nThis is particularly useful when you have a monorepo and your Next.js project is in a subfolder.\n\n## Example\n\n```json { \"settings\": { \"next\": { \"rootDir\": \"apps/dashboard/\" } } } ```",
           "default": [],
           "allOf": [
             {
@@ -378,7 +383,8 @@
       "$ref": "#/definitions/DummyRuleMap"
     },
     "OxlintSettings": {
-      "description": "Shared settings for plugins",
+      "title": "Oxlint Plugin Settings",
+      "description": "Configure the behavior of linter plugins.\n\n## Example\n\nHere's an example if you're using Next.js in a monorepo:\n\n```json { \"settings\": { \"next\": { \"rootDir\": \"apps/dashboard/\" }, \"react\": { \"linkComponents\": [ { \"name\": \"Link\", \"linkAttribute\": \"to\" } ] }, \"jsx-a11y\": { \"components\": { \"Link\": \"a\", \"Button\": \"button\" } } } } ```",
       "type": "object",
       "properties": {
         "jsdoc": {
@@ -433,16 +439,19 @@
       }
     },
     "ReactPluginSettings": {
+      "description": "Configure React plugin rules.\n\nDerived from [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc-)",
       "type": "object",
       "properties": {
         "formComponents": {
+          "description": "Components used as alternatives to `<form>` for forms, such as `<Formik>`.\n\n## Example\n\n```jsonc { \"settings\": { \"react\": { \"formComponents\": [ \"CustomForm\", // OtherForm is considered a form component and has an endpoint attribute { \"name\": \"OtherForm\", \"formAttribute\": \"endpoint\" }, // allows specifying multiple properties if necessary { \"name\": \"Form\", \"formAttribute\": [\"registerEndpoint\", \"loginEndpoint\"] } ] } } } ```",
           "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
           }
         },
         "linkComponents": {
+          "description": "Components used as alternatives to `<a>` for linking, such as `<Link>`.\n\n## Example\n\n```jsonc { \"settings\": { \"react\": { \"linkComponents\": [ \"HyperLink\", // Use `linkAttribute` for components that use a different prop name // than `href`. { \"name\": \"MyLink\", \"linkAttribute\": \"to\" }, // allows specifying multiple properties if necessary { \"name\": \"Link\", \"linkAttribute\": [\"to\", \"href\"] } ] } } } ```",
           "default": [],
           "type": "array",
           "items": {