docs(linter): document rules (#6983)

closes #6370
oxc-project · Oct 28, 2024 · 4551baa · 4551baa
1 parent 46e5360
commit 4551baa
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/crates/oxc_linter/src/config/oxlintrc.rs b/crates/oxc_linter/src/config/oxlintrc.rs
@@ -51,7 +51,23 @@ use crate::{options::LintPlugins, utils::read_to_string};
 pub struct Oxlintrc {
     pub plugins: LintPlugins,
     pub categories: OxlintCategories,
-    /// See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).
+    /// Example
+    ///
+    /// `.oxlintrc.json`
+    ///
+    /// ```json
+    /// {
+    ///   "$schema": "./node_modules/oxlint/configuration_schema.json",
+    ///   "rules": {
+    ///     "eqeqeq": "warn",
+    ///     "import/no-cycle": "error",
+    ///     "prefer-const": ["error", { "ignoreReadBeforeAssign": true }]
+    ///   }
+    ///  }
+    /// ```
+    ///
+    /// See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of
+    /// rules.
     pub rules: OxlintRules,
     pub settings: OxlintSettings,
     /// Environments enable and disable collections of global variables.

diff --git a/crates/oxc_linter/src/snapshots/schema_json.snap b/crates/oxc_linter/src/snapshots/schema_json.snap
@@ -50,7 +50,7 @@ expression: json
       ]
     },
     "rules": {
-      "description": "See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).",
+      "description": "Example\n\n`.oxlintrc.json`\n\n```json { \"$schema\": \"./node_modules/oxlint/configuration_schema.json\", \"rules\": { \"eqeqeq\": \"warn\", \"import/no-cycle\": \"error\", \"prefer-const\": [\"error\", { \"ignoreReadBeforeAssign\": true }] } } ```\n\nSee [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of rules.",
       "default": {},
       "allOf": [
         {

diff --git a/npm/oxlint/configuration_schema.json b/npm/oxlint/configuration_schema.json
@@ -46,7 +46,7 @@
       ]
     },
     "rules": {
-      "description": "See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).",
+      "description": "Example\n\n`.oxlintrc.json`\n\n```json { \"$schema\": \"./node_modules/oxlint/configuration_schema.json\", \"rules\": { \"eqeqeq\": \"warn\", \"import/no-cycle\": \"error\", \"prefer-const\": [\"error\", { \"ignoreReadBeforeAssign\": true }] } } ```\n\nSee [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html) for the list of rules.",
       "default": {},
       "allOf": [
         {