diff --git a/lib/rules/no-unsupported-features.js b/lib/rules/no-unsupported-features.js index 78ac3996..104af319 100644 --- a/lib/rules/no-unsupported-features.js +++ b/lib/rules/no-unsupported-features.js @@ -1047,8 +1047,8 @@ module.exports = { category: "Possible Errors", recommended: false, replacedBy: [ - "node/no-unsupported-features/es-syntax", - "node/no-unsupported-features/es-builtins", + "n/no-unsupported-features/es-syntax", + "n/no-unsupported-features/es-builtins", ], url: "https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/no-unsupported-features.md", diff --git a/scripts/new-rule.js b/scripts/new-rule.js index 0ca6b4d5..9c48431d 100644 --- a/scripts/new-rule.js +++ b/scripts/new-rule.js @@ -83,20 +83,20 @@ new RuleTester().run("${ruleId}", rule, { 👍 Examples of **correct** code for this rule: \`\`\`js -/*eslint node/${ruleId}: error */ +/*eslint n/${ruleId}: error */ \`\`\` 👎 Examples of **incorrect** code for this rule: \`\`\`js -/*eslint node/${ruleId}: error */ +/*eslint n/${ruleId}: error */ \`\`\` ## ⚙ Options \`\`\`json { - "node/${ruleId}": ["error", ...] + "n/${ruleId}": ["error", ...] } \`\`\` ` diff --git a/scripts/rules.js b/scripts/rules.js index b56718b8..98f307a7 100644 --- a/scripts/rules.js +++ b/scripts/rules.js @@ -7,12 +7,13 @@ const path = require("path") const glob = require("fast-glob") const rootDir = path.resolve(__dirname, "../lib/rules/") +const {pluginName} = require("./utils"); /** * @typedef {Object} RuleInfo * @property {string} filePath The path to the rule definition. - * @property {string} id The rule ID. (This includes `node/` prefix.) - * @property {string} name The rule name. (This doesn't include `node/` prefix.) + * @property {string} id The rule ID. (This includes `n/` prefix.) + * @property {string} name The rule name. (This doesn't include `n/` prefix.) * @property {string} category The category ID. * @property {string} description The description of this rule. * @property {boolean} recommended The flag to indicate a recommended rule. @@ -38,7 +39,7 @@ const rules = glob return Object.assign( { filePath, - id: `node/${name}`, + id: `${pluginName}/${name}`, name, deprecated: Boolean(meta.deprecated), fixable: Boolean(meta.fixable), diff --git a/scripts/update-docs-header-and-footer.js b/scripts/update-docs-header-and-footer.js index b4daea63..698ecf98 100644 --- a/scripts/update-docs-header-and-footer.js +++ b/scripts/update-docs-header-and-footer.js @@ -26,7 +26,7 @@ function renderHeader(rule) { if (rule.recommended) { lines.push( - "> - ⭐️ This rule is included in `plugin:node/recommended` preset." + "> - ⭐️ This rule is included in `plugin:n/recommended` preset." ) } if (rule.fixable) { @@ -36,7 +36,7 @@ function renderHeader(rule) { } if (rule.deprecated) { const replace = rule.replacedBy.map( - ruleId => `[${ruleId}](./${ruleId.replace("node/", "")}.md)` + ruleId => `[${ruleId}](./${ruleId.replace(/^n\//, "")}.md)` ) const replaceText = replace.length === 0 diff --git a/scripts/update-readme.js b/scripts/update-readme.js index 86adf5ca..7eddad04 100644 --- a/scripts/update-readme.js +++ b/scripts/update-readme.js @@ -7,6 +7,7 @@ const fs = require("fs") const path = require("path") const { categories, rules } = require("./rules") +const { pluginName } = require("./utils") /** * Render a given rule as a table row. @@ -27,10 +28,11 @@ function renderRule(rule) { */ function renderDeprecatedRule(rule) { const link = `[${rule.id}](./docs/rules/${rule.name}.md)` + const pluginNameReg = new RegExp(`^${pluginName}[/]`, "u") const replacedBy = rule.replacedBy .map(nameRaw => { - const name = nameRaw.replace(/^node[/]/u, "") - return `[node/${name}](./docs/rules/${name}.md)` + const name = nameRaw.replace(pluginNameReg, "") + return `[${pluginName}/${name}](./docs/rules/${name}.md)` }) .join(" and ") diff --git a/scripts/utils.js b/scripts/utils.js new file mode 100644 index 00000000..45c525ce --- /dev/null +++ b/scripts/utils.js @@ -0,0 +1,5 @@ +'use strict'; + +const pkg = require('../package.json'); +exports.pluginName = pkg.name.replace(/^eslint-plugin-/u, ''); +