Skip to content

Commit df759eb

Browse files
authored
build: update scripts to use the new package name (#6)
* build: update scripts to the new package name * fix: update rules.meta.replacedBy
1 parent ffed3ed commit df759eb

File tree

6 files changed

+20
-12
lines changed

6 files changed

+20
-12
lines changed

lib/rules/no-unsupported-features.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,8 +1047,8 @@ module.exports = {
10471047
category: "Possible Errors",
10481048
recommended: false,
10491049
replacedBy: [
1050-
"node/no-unsupported-features/es-syntax",
1051-
"node/no-unsupported-features/es-builtins",
1050+
"n/no-unsupported-features/es-syntax",
1051+
"n/no-unsupported-features/es-builtins",
10521052
],
10531053
url:
10541054
"https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/no-unsupported-features.md",

scripts/new-rule.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,20 @@ new RuleTester().run("${ruleId}", rule, {
8383
👍 Examples of **correct** code for this rule:
8484
8585
\`\`\`js
86-
/*eslint node/${ruleId}: error */
86+
/*eslint n/${ruleId}: error */
8787
\`\`\`
8888
8989
👎 Examples of **incorrect** code for this rule:
9090
9191
\`\`\`js
92-
/*eslint node/${ruleId}: error */
92+
/*eslint n/${ruleId}: error */
9393
\`\`\`
9494
9595
## ⚙ Options
9696
9797
\`\`\`json
9898
{
99-
"node/${ruleId}": ["error", ...]
99+
"n/${ruleId}": ["error", ...]
100100
}
101101
\`\`\`
102102
`

scripts/rules.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@
77
const path = require("path")
88
const glob = require("fast-glob")
99
const rootDir = path.resolve(__dirname, "../lib/rules/")
10+
const {pluginName} = require("./utils");
1011

1112
/**
1213
* @typedef {Object} RuleInfo
1314
* @property {string} filePath The path to the rule definition.
14-
* @property {string} id The rule ID. (This includes `node/` prefix.)
15-
* @property {string} name The rule name. (This doesn't include `node/` prefix.)
15+
* @property {string} id The rule ID. (This includes `n/` prefix.)
16+
* @property {string} name The rule name. (This doesn't include `n/` prefix.)
1617
* @property {string} category The category ID.
1718
* @property {string} description The description of this rule.
1819
* @property {boolean} recommended The flag to indicate a recommended rule.
@@ -38,7 +39,7 @@ const rules = glob
3839
return Object.assign(
3940
{
4041
filePath,
41-
id: `node/${name}`,
42+
id: `${pluginName}/${name}`,
4243
name,
4344
deprecated: Boolean(meta.deprecated),
4445
fixable: Boolean(meta.fixable),

scripts/update-docs-header-and-footer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ function renderHeader(rule) {
2626

2727
if (rule.recommended) {
2828
lines.push(
29-
"> - ⭐️ This rule is included in `plugin:node/recommended` preset."
29+
"> - ⭐️ This rule is included in `plugin:n/recommended` preset."
3030
)
3131
}
3232
if (rule.fixable) {
@@ -36,7 +36,7 @@ function renderHeader(rule) {
3636
}
3737
if (rule.deprecated) {
3838
const replace = rule.replacedBy.map(
39-
ruleId => `[${ruleId}](./${ruleId.replace("node/", "")}.md)`
39+
ruleId => `[${ruleId}](./${ruleId.replace(/^n\//, "")}.md)`
4040
)
4141
const replaceText =
4242
replace.length === 0

scripts/update-readme.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
const fs = require("fs")
88
const path = require("path")
99
const { categories, rules } = require("./rules")
10+
const { pluginName } = require("./utils")
1011

1112
/**
1213
* Render a given rule as a table row.
@@ -27,10 +28,11 @@ function renderRule(rule) {
2728
*/
2829
function renderDeprecatedRule(rule) {
2930
const link = `[${rule.id}](./docs/rules/${rule.name}.md)`
31+
const pluginNameReg = new RegExp(`^${pluginName}[/]`, "u")
3032
const replacedBy = rule.replacedBy
3133
.map(nameRaw => {
32-
const name = nameRaw.replace(/^node[/]/u, "")
33-
return `[node/${name}](./docs/rules/${name}.md)`
34+
const name = nameRaw.replace(pluginNameReg, "")
35+
return `[${pluginName}/${name}](./docs/rules/${name}.md)`
3436
})
3537
.join(" and ")
3638

scripts/utils.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
'use strict';
2+
3+
const pkg = require('../package.json');
4+
exports.pluginName = pkg.name.replace(/^eslint-plugin-/u, '');
5+

0 commit comments

Comments
 (0)