Skip to content

Commit

Permalink
Update rule suggestions link to new docs page (#509)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg authored Feb 3, 2024
1 parent 41ec710 commit d86b890
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/examples/eslint-plugin-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This plugin is for x purpose.
🎨 Set in the `stylistic` configuration.\
⌨️ Set in the `typescript` configuration.\
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
⚙️ Has configuration options.\
💭 Requires type information.\
🗂️ The type of rule.\
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

💼⚠️ This rule is enabled in the ✅ `recommended` config. This rule _warns_ in the 🎨 `stylistic` config.

💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

💭 This rule requires type information.

Expand Down
4 changes: 2 additions & 2 deletions lib/rule-doc-notices.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ function configsToNoticeSentence(

// A few individual notices declared here just so they can be reused in multiple notices.
const NOTICE_FIXABLE = `${EMOJI_FIXABLE} This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).`;
const NOTICE_HAS_SUGGESTIONS = `${EMOJI_HAS_SUGGESTIONS} This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`;
const NOTICE_HAS_SUGGESTIONS = `${EMOJI_HAS_SUGGESTIONS} This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).`;

/**
* An object containing the text for each notice type (as a string or function to generate the string).
Expand Down Expand Up @@ -239,7 +239,7 @@ const RULE_NOTICES: {
[NOTICE_TYPE.FIXABLE]: NOTICE_FIXABLE,
[NOTICE_TYPE.FIXABLE_AND_HAS_SUGGESTIONS]: ({ fixable, hasSuggestions }) => {
if (fixable && hasSuggestions) {
return `${EMOJI_FIXABLE}${EMOJI_HAS_SUGGESTIONS} This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`;
return `${EMOJI_FIXABLE}${EMOJI_HAS_SUGGESTIONS} This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).`;
} else if (fixable) {
return NOTICE_FIXABLE;
} else if (hasSuggestions) {
Expand Down
2 changes: 1 addition & 1 deletion lib/rule-list-legend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export const SEVERITY_TYPE_TO_WORD: {

// A few individual legends declared here just so they can be reused in multiple legends.
const LEGEND_FIXABLE = `${EMOJI_FIXABLE} Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).`;
const LEGEND_HAS_SUGGESTIONS = `${EMOJI_HAS_SUGGESTIONS} Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`;
const LEGEND_HAS_SUGGESTIONS = `${EMOJI_HAS_SUGGESTIONS} Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).`;

/**
* An object containing the legends for each column (as a string or function to generate the string).
Expand Down
4 changes: 2 additions & 2 deletions test/lib/generate/__snapshots__/general-test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Description.
✅ Set in the \`recommended\` configuration.\\
🎨 Set in the \`style\` configuration.\\
🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
| Name | Description | 💼 | 🔧 | 💡 |
| :----------------------------- | :--------------------- | :---- | :- | :- |
Expand All @@ -28,7 +28,7 @@ exports[`generate (general) basic updates the documentation 2`] = `
💼 This rule is enabled in the following configs: 🌐 \`all\`, ✅ \`recommended\`.
🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
<!-- end auto-generated rule header -->
## Rule details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ exports[`generate (--rule-doc-notices) basic shows the right rule doc notices 1`
<!-- begin auto-generated rules list -->
🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\\
❌ Deprecated.
| Name | Description | 🔧 | 💡 | ❌ |
Expand All @@ -19,7 +19,7 @@ exports[`generate (--rule-doc-notices) basic shows the right rule doc notices 1`
exports[`generate (--rule-doc-notices) basic shows the right rule doc notices 2`] = `
"# Description for no-foo (\`test/no-foo\`)
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
🔧 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ exports[`generate (--rule-list-columns) basic shows the right columns and legend
"## Rules
<!-- begin auto-generated rules list -->
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\\
🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
| 💡 | 🔧 | Name |
Expand All @@ -20,7 +20,7 @@ exports[`generate (--rule-list-columns) basic shows the right columns and legend
❌ This rule is deprecated.
🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
🔧💡 This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
<!-- end auto-generated rule header -->
"
Expand All @@ -31,7 +31,7 @@ exports[`generate (--rule-list-columns) consolidated fixableAndHasSuggestions co
<!-- begin auto-generated rules list -->
🔧 Automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
| Name | 🔧💡 |
| :----------------------------- | :--- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ exports[`generate (--rule-list-split) with boolean (camelCase) splits the list w
"## Rules
<!-- begin auto-generated rules list -->
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
| Name | 💡 |
| :----------------------------- | :- |
Expand Down

0 comments on commit d86b890

Please sign in to comment.