Skip to content

Commit c9138e5

Browse files
committed
chore: update a few rules to use messageId
1 parent b4ec37b commit c9138e5

11 files changed

+51
-26
lines changed

lib/rules/exports-style.js

+11-6
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,14 @@ module.exports = {
244244
additionalProperties: false,
245245
},
246246
],
247+
messages: {
248+
unexpectedExports:
249+
"Unexpected access to 'exports'. Use 'module.exports' instead.",
250+
unexpectedModuleExports:
251+
"Unexpected access to 'module.exports'. Use 'exports' instead.",
252+
unexpectedAssignment:
253+
"Unexpected assignment to 'exports'. Don't modify 'exports' itself.",
254+
},
247255
},
248256

249257
create(context) {
@@ -299,8 +307,7 @@ module.exports = {
299307
context.report({
300308
node,
301309
loc: getLocation(node),
302-
message:
303-
"Unexpected access to 'exports'. Use 'module.exports' instead.",
310+
messageId: "unexpectedExports",
304311
})
305312
}
306313
}
@@ -335,8 +342,7 @@ module.exports = {
335342
context.report({
336343
node,
337344
loc: getLocation(node),
338-
message:
339-
"Unexpected access to 'module.exports'. Use 'exports' instead.",
345+
messageId: "unexpectedModuleExports",
340346
fix(fixer) {
341347
return fixModuleExports(node, sourceCode, fixer)
342348
},
@@ -359,8 +365,7 @@ module.exports = {
359365
context.report({
360366
node,
361367
loc: getLocation(node),
362-
message:
363-
"Unexpected assignment to 'exports'. Don't modify 'exports' itself.",
368+
messageId: "unexpectedAssignment",
364369
})
365370
}
366371
}

lib/rules/no-callback-literal.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ module.exports = {
1616
type: "problem",
1717
fixable: null,
1818
schema: [],
19+
messages: {
20+
unexpectedLiteral: "Unexpected literal in error position of callback."
21+
}
1922
},
2023

2124
create(context) {
@@ -37,8 +40,7 @@ module.exports = {
3740
) {
3841
context.report({
3942
node,
40-
message:
41-
"Unexpected literal in error position of callback.",
43+
messageId: "unexpectedLiteral",
4244
})
4345
}
4446
},

lib/rules/no-deprecated-api.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -719,6 +719,9 @@ module.exports = {
719719
additionalProperties: false,
720720
},
721721
],
722+
messages: {
723+
"deprecated": "{{name}} was deprecated since v{{version}}{{replace}}."
724+
}
722725
},
723726
create(context) {
724727
const { ignoredModuleItems, ignoredGlobalItems, version } =
@@ -736,8 +739,7 @@ module.exports = {
736739
context.report({
737740
node,
738741
loc: node.loc,
739-
message:
740-
"{{name}} was deprecated since v{{version}}{{replace}}.",
742+
messageId: "deprecated",
741743
data: {
742744
name,
743745
version: info.since,

lib/rules/no-extraneous-import.js

+3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ module.exports = {
3232
additionalProperties: false,
3333
},
3434
],
35+
messages: {
36+
extraneous: '"{{moduleName}}" is extraneous.',
37+
}
3538
},
3639
create(context) {
3740
const filePath = context.getFilename()

lib/rules/no-extraneous-require.js

+3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ module.exports = {
3434
additionalProperties: false,
3535
},
3636
],
37+
messages: {
38+
"extraneous": '"{{moduleName}}" is extraneous.'
39+
}
3740
},
3841
create(context) {
3942
const filePath = context.getFilename()

lib/rules/no-hide-core-modules.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,9 @@ module.exports = {
8080
additionalProperties: false,
8181
},
8282
],
83+
messages: {
84+
"unexpectedImport": "Unexpected import of third-party module '{{name}}'.",
85+
}
8386
},
8487
create(context) {
8588
if (context.getFilename() === "<input>") {
@@ -149,8 +152,7 @@ module.exports = {
149152
context.report({
150153
node: target.node,
151154
loc: target.node.loc,
152-
message:
153-
"Unexpected import of third-party module '{{name}}'.",
155+
messageId: "unexpectedImport",
154156
data: {
155157
name: path
156158
.relative(dirPath, resolved)

lib/rules/no-unpublished-bin.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ module.exports = {
4848
},
4949
},
5050
],
51+
messages: {
52+
invalidIgnored: "npm ignores '{{name}}'. Check 'files' field of 'package.json' or '.npmignore'."
53+
}
5154
},
5255
create(context) {
5356
return {
@@ -86,8 +89,7 @@ module.exports = {
8689
// Report.
8790
context.report({
8891
node,
89-
message:
90-
"npm ignores '{{name}}'. Check 'files' field of 'package.json' or '.npmignore'.",
92+
messageId: "invalidIgnored",
9193
data: { name: relativePath },
9294
})
9395
},

lib/rules/no-unsupported-features.js

+6-4
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,10 @@ module.exports = {
10761076
],
10771077
},
10781078
],
1079+
messages: {
1080+
unsupported:
1081+
"{{feature}} {{be}} not supported yet on Node {{version}}.",
1082+
},
10791083
},
10801084
create(context) {
10811085
const sourceCode = context.getSourceCode()
@@ -1161,8 +1165,7 @@ module.exports = {
11611165
if (!feature.supportedInStrict) {
11621166
context.report({
11631167
node,
1164-
message:
1165-
"{{feature}} {{be}} not supported yet on Node {{version}}.",
1168+
messageId: "unsupported",
11661169
data: {
11671170
feature: feature.name,
11681171
be: feature.singular ? "is" : "are",
@@ -1172,8 +1175,7 @@ module.exports = {
11721175
} else if (!normalizeScope(context.getScope(), node).isStrict) {
11731176
context.report({
11741177
node,
1175-
message:
1176-
"{{feature}} {{be}} not supported yet on Node {{version}}.",
1178+
messageId: "unsupported",
11771179
data: {
11781180
feature: `${feature.name} in non-strict mode`,
11791181
be: feature.singular ? "is" : "are",

lib/rules/shebang.js

+10-6
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,12 @@ module.exports = {
8686
additionalProperties: false,
8787
},
8888
],
89+
messages: {
90+
unexpectedBOM: "This file must not have Unicode BOM.",
91+
expectedLF: "This file must have Unix linebreaks (LF).",
92+
expectedHashbangNode: 'This file needs shebang "#!/usr/bin/env node".',
93+
expectedHashbang: "This file needs no shebang."
94+
}
8995
},
9096
create(context) {
9197
const sourceCode = context.getSourceCode()
@@ -123,7 +129,7 @@ module.exports = {
123129
if (needsShebang && info.bom) {
124130
context.report({
125131
node,
126-
message: "This file must not have Unicode BOM.",
132+
messageId: "unexpectedBOM",
127133
fix(fixer) {
128134
return fixer.removeRange([-1, 0])
129135
},
@@ -132,8 +138,7 @@ module.exports = {
132138
if (needsShebang && info.cr) {
133139
context.report({
134140
node,
135-
message:
136-
"This file must have Unix linebreaks (LF).",
141+
messageId: "expectedLF",
137142
fix(fixer) {
138143
const index = sourceCode.text.indexOf("\r")
139144
return fixer.removeRange([index, index + 1])
@@ -144,8 +149,7 @@ module.exports = {
144149
// Shebang is lacking.
145150
context.report({
146151
node,
147-
message:
148-
'This file needs shebang "#!/usr/bin/env node".',
152+
messageId: "expectedHashbangNode",
149153
fix(fixer) {
150154
return fixer.replaceTextRange(
151155
[-1, info.length],
@@ -157,7 +161,7 @@ module.exports = {
157161
// Shebang is extra.
158162
context.report({
159163
node,
160-
message: "This file needs no shebang.",
164+
messageId: "expectedHashbang",
161165
fix(fixer) {
162166
return fixer.removeRange([0, info.length])
163167
},

lib/util/check-extraneous.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ module.exports = function checkForExtraneous(context, filePath, targets) {
4444
context.report({
4545
node: target.node,
4646
loc: target.node.loc,
47-
message: '"{{moduleName}}" is extraneous.',
47+
messageId: "extraneous",
4848
data: target,
4949
})
5050
}

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"esbuild": "^0.14.39",
2828
"eslint": "^8.21.0",
2929
"eslint-config-prettier": "^8.5.0",
30-
"eslint-plugin-eslint-plugin": "^4.4.1",
30+
"eslint-plugin-eslint-plugin": "^5.0.2",
3131
"eslint-plugin-n": "file:.",
3232
"fast-glob": "^3.2.11",
3333
"globals": "^13.17.0",

0 commit comments

Comments
 (0)