Skip to content

Commit

Permalink
chore: update a few rules to use messageId
Browse files Browse the repository at this point in the history
  • Loading branch information
aladdin-add committed Aug 9, 2022
1 parent b4ec37b commit c9138e5
Show file tree
Hide file tree
Showing 11 changed files with 51 additions and 26 deletions.
17 changes: 11 additions & 6 deletions lib/rules/exports-style.js
Expand Up @@ -244,6 +244,14 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
unexpectedExports:
"Unexpected access to 'exports'. Use 'module.exports' instead.",
unexpectedModuleExports:
"Unexpected access to 'module.exports'. Use 'exports' instead.",
unexpectedAssignment:
"Unexpected assignment to 'exports'. Don't modify 'exports' itself.",
},
},

create(context) {
Expand Down Expand Up @@ -299,8 +307,7 @@ module.exports = {
context.report({
node,
loc: getLocation(node),
message:
"Unexpected access to 'exports'. Use 'module.exports' instead.",
messageId: "unexpectedExports",
})
}
}
Expand Down Expand Up @@ -335,8 +342,7 @@ module.exports = {
context.report({
node,
loc: getLocation(node),
message:
"Unexpected access to 'module.exports'. Use 'exports' instead.",
messageId: "unexpectedModuleExports",
fix(fixer) {
return fixModuleExports(node, sourceCode, fixer)
},
Expand All @@ -359,8 +365,7 @@ module.exports = {
context.report({
node,
loc: getLocation(node),
message:
"Unexpected assignment to 'exports'. Don't modify 'exports' itself.",
messageId: "unexpectedAssignment",
})
}
}
Expand Down
6 changes: 4 additions & 2 deletions lib/rules/no-callback-literal.js
Expand Up @@ -16,6 +16,9 @@ module.exports = {
type: "problem",
fixable: null,
schema: [],
messages: {
unexpectedLiteral: "Unexpected literal in error position of callback."
}
},

create(context) {
Expand All @@ -37,8 +40,7 @@ module.exports = {
) {
context.report({
node,
message:
"Unexpected literal in error position of callback.",
messageId: "unexpectedLiteral",
})
}
},
Expand Down
6 changes: 4 additions & 2 deletions lib/rules/no-deprecated-api.js
Expand Up @@ -719,6 +719,9 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
"deprecated": "{{name}} was deprecated since v{{version}}{{replace}}."
}
},
create(context) {
const { ignoredModuleItems, ignoredGlobalItems, version } =
Expand All @@ -736,8 +739,7 @@ module.exports = {
context.report({
node,
loc: node.loc,
message:
"{{name}} was deprecated since v{{version}}{{replace}}.",
messageId: "deprecated",
data: {
name,
version: info.since,
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-extraneous-import.js
Expand Up @@ -32,6 +32,9 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
extraneous: '"{{moduleName}}" is extraneous.',
}
},
create(context) {
const filePath = context.getFilename()
Expand Down
3 changes: 3 additions & 0 deletions lib/rules/no-extraneous-require.js
Expand Up @@ -34,6 +34,9 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
"extraneous": '"{{moduleName}}" is extraneous.'
}
},
create(context) {
const filePath = context.getFilename()
Expand Down
6 changes: 4 additions & 2 deletions lib/rules/no-hide-core-modules.js
Expand Up @@ -80,6 +80,9 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
"unexpectedImport": "Unexpected import of third-party module '{{name}}'.",
}
},
create(context) {
if (context.getFilename() === "<input>") {
Expand Down Expand Up @@ -149,8 +152,7 @@ module.exports = {
context.report({
node: target.node,
loc: target.node.loc,
message:
"Unexpected import of third-party module '{{name}}'.",
messageId: "unexpectedImport",
data: {
name: path
.relative(dirPath, resolved)
Expand Down
6 changes: 4 additions & 2 deletions lib/rules/no-unpublished-bin.js
Expand Up @@ -48,6 +48,9 @@ module.exports = {
},
},
],
messages: {
invalidIgnored: "npm ignores '{{name}}'. Check 'files' field of 'package.json' or '.npmignore'."
}
},
create(context) {
return {
Expand Down Expand Up @@ -86,8 +89,7 @@ module.exports = {
// Report.
context.report({
node,
message:
"npm ignores '{{name}}'. Check 'files' field of 'package.json' or '.npmignore'.",
messageId: "invalidIgnored",
data: { name: relativePath },
})
},
Expand Down
10 changes: 6 additions & 4 deletions lib/rules/no-unsupported-features.js
Expand Up @@ -1076,6 +1076,10 @@ module.exports = {
],
},
],
messages: {
unsupported:
"{{feature}} {{be}} not supported yet on Node {{version}}.",
},
},
create(context) {
const sourceCode = context.getSourceCode()
Expand Down Expand Up @@ -1161,8 +1165,7 @@ module.exports = {
if (!feature.supportedInStrict) {
context.report({
node,
message:
"{{feature}} {{be}} not supported yet on Node {{version}}.",
messageId: "unsupported",
data: {
feature: feature.name,
be: feature.singular ? "is" : "are",
Expand All @@ -1172,8 +1175,7 @@ module.exports = {
} else if (!normalizeScope(context.getScope(), node).isStrict) {
context.report({
node,
message:
"{{feature}} {{be}} not supported yet on Node {{version}}.",
messageId: "unsupported",
data: {
feature: `${feature.name} in non-strict mode`,
be: feature.singular ? "is" : "are",
Expand Down
16 changes: 10 additions & 6 deletions lib/rules/shebang.js
Expand Up @@ -86,6 +86,12 @@ module.exports = {
additionalProperties: false,
},
],
messages: {
unexpectedBOM: "This file must not have Unicode BOM.",
expectedLF: "This file must have Unix linebreaks (LF).",
expectedHashbangNode: 'This file needs shebang "#!/usr/bin/env node".',
expectedHashbang: "This file needs no shebang."
}
},
create(context) {
const sourceCode = context.getSourceCode()
Expand Down Expand Up @@ -123,7 +129,7 @@ module.exports = {
if (needsShebang && info.bom) {
context.report({
node,
message: "This file must not have Unicode BOM.",
messageId: "unexpectedBOM",
fix(fixer) {
return fixer.removeRange([-1, 0])
},
Expand All @@ -132,8 +138,7 @@ module.exports = {
if (needsShebang && info.cr) {
context.report({
node,
message:
"This file must have Unix linebreaks (LF).",
messageId: "expectedLF",
fix(fixer) {
const index = sourceCode.text.indexOf("\r")
return fixer.removeRange([index, index + 1])
Expand All @@ -144,8 +149,7 @@ module.exports = {
// Shebang is lacking.
context.report({
node,
message:
'This file needs shebang "#!/usr/bin/env node".',
messageId: "expectedHashbangNode",
fix(fixer) {
return fixer.replaceTextRange(
[-1, info.length],
Expand All @@ -157,7 +161,7 @@ module.exports = {
// Shebang is extra.
context.report({
node,
message: "This file needs no shebang.",
messageId: "expectedHashbang",
fix(fixer) {
return fixer.removeRange([0, info.length])
},
Expand Down
2 changes: 1 addition & 1 deletion lib/util/check-extraneous.js
Expand Up @@ -44,7 +44,7 @@ module.exports = function checkForExtraneous(context, filePath, targets) {
context.report({
node: target.node,
loc: target.node.loc,
message: '"{{moduleName}}" is extraneous.',
messageId: "extraneous",
data: target,
})
}
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -27,7 +27,7 @@
"esbuild": "^0.14.39",
"eslint": "^8.21.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-eslint-plugin": "^4.4.1",
"eslint-plugin-eslint-plugin": "^5.0.2",
"eslint-plugin-n": "file:.",
"fast-glob": "^3.2.11",
"globals": "^13.17.0",
Expand Down

0 comments on commit c9138e5

Please sign in to comment.