docs: add missing backticks to sort-imports (#19282)

lumirlumir · web-flow · commit d122c8a756bb · 2024-12-30T12:48:36.000-05:00
* docs: add missing backticks to `sort-imports`

* wip
diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json
@@ -2894,7 +2894,7 @@
             }
         ],
         "docs": {
-            "description": "Enforce sorted import declarations within modules",
+            "description": "Enforce sorted `import` declarations within modules",
             "recommended": false,
             "frozen": true,
             "url": "https://eslint.org/docs/latest/rules/sort-imports"
diff --git a/docs/src/rules/sort-imports.md b/docs/src/rules/sort-imports.md
@@ -8,7 +8,7 @@ related_rules:
 
 
 
-The import statement is used to import members (functions, objects or primitives) that have been exported from an external module. Using a specific member syntax:
+The `import` statement is used to import members (functions, objects or primitives) that have been exported from an external module. Using a specific member syntax:
 
 ```js
 // single - Import single member.
@@ -22,18 +22,18 @@ import {foo, bar} from "my-module.js";
 import * as myModule from "my-module.js";
 ```
 
-The import statement can also import a module without exported bindings. Used when the module does not export anything, but runs it own code or changes the global context object.
+The `import` statement can also import a module without exported bindings. Used when the module does not export anything, but runs it own code or changes the global context object.
 
 ```js
 // none - Import module without exported bindings.
 import "my-module.js"
 ```
 
-When declaring multiple imports, a sorted list of import declarations make it easier for developers to read the code and find necessary imports later. This rule is purely a matter of style.
+When declaring multiple imports, a sorted list of `import` declarations make it easier for developers to read the code and find necessary imports later. This rule is purely a matter of style.
 
 ## Rule Details
 
-This rule checks all import declarations and verifies that all imports are first sorted by the used member syntax and then alphabetically by the first member or alias name.
+This rule checks all `import` declarations and verifies that all imports are first sorted by the used member syntax and then alphabetically by the first member or alias name.
 
 The `--fix` option on the command line automatically fixes some problems reported by this rule: multiple members on a single line are automatically sorted (e.g. `import { b, a } from 'foo.js'` is corrected to `import { a, b } from 'foo.js'`), but multiple lines are not reordered.
 
diff --git a/lib/rules/sort-imports.js b/lib/rules/sort-imports.js
@@ -1,5 +1,5 @@
 /**
- * @fileoverview Rule to require sorting of import declarations
+ * @fileoverview Rule to enforce sorted `import` declarations within modules
  * @author Christian Schuller
  */
 
@@ -23,7 +23,7 @@ module.exports = {
         }],
 
         docs: {
-            description: "Enforce sorted import declarations within modules",
+            description: "Enforce sorted `import` declarations within modules",
             recommended: false,
             frozen: true,
             url: "https://eslint.org/docs/latest/rules/sort-imports"

Original file line number	Diff line number	Diff line change
`@@ -2894,7 +2894,7 @@`
`2894`	`2894`	`}`
`2895`	`2895`	`],`
`2896`	`2896`	`"docs": {`
`2897`		`- "description": "Enforce sorted import declarations within modules",`
	`2897`	+ "description": "Enforce sorted `import` declarations within modules",
`2898`	`2898`	`"recommended": false,`
`2899`	`2899`	`"frozen": true,`
`2900`	`2900`	`"url": "https://eslint.org/docs/latest/rules/sort-imports"`