docs(linter): add docs for config settings

crates/oxc_linter/src/config/settings/jsx_a11y.rs

@@ -3,11 +3,42 @@ use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
 use serde::Deserialize;
 
-// <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, Deserialize, Default, JsonSchema)]
 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>,
 }

crates/oxc_linter/src/config/settings/mod.rs

@@ -11,7 +11,31 @@ use self::{
     react::ReactPluginSettings,
 };
 
-/// Shared settings for plugins
+/// Configure the behavior of linter plugins.
+///
+/// ## Example
+/// Here's an example if you're using Next.js in a monorepo:
+/// ```jsonc
+/// {
+///   "settings": {
+///     "next": {
+///       "rootDir": "apps/dashboard/"
+///     },
+///     "react": {
+///       "linkComponents": [
+///         // support next/link
+///         { "name": "Link", "linkAttribute": "to" }
+///       ]
+///     },
+///     "jsx-a11y": {
+///       "components": {
+///         "Link": "a",
+///         "Button": "button"
+///       }
+///     }
+///   }
+/// }
+/// ```
 #[derive(Debug, Deserialize, Default, JsonSchema)]
 pub struct OxlintSettings {
     #[serde(default)]

crates/oxc_linter/src/config/settings/next.rs

@@ -3,8 +3,24 @@ use std::borrow::Cow;
 use schemars::JsonSchema;
 use serde::Deserialize;
 
+/// Configure Next.js plugin rules.
 #[derive(Debug, Deserialize, Default, JsonSchema)]
 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>,

crates/oxc_linter/src/config/settings/react.rs

@@ -4,13 +4,52 @@ use oxc_span::CompactStr;
 use schemars::JsonSchema;
 use serde::Deserialize;
 
-// <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, Deserialize, Default, JsonSchema)]
 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>,