chore: refactor a few rules

eslint-community · Aug 9, 2022 · d879ccb · d879ccb
1 parent c9138e5
commit d879ccb
Show file tree

Hide file tree

Showing 17 changed files with 67 additions and 40 deletions.
diff --git a/lib/rules/no-extraneous-import.js b/lib/rules/no-extraneous-import.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkExtraneous = require("../util/check-extraneous")
+const { checkExtraneous, messages } = require("../util/check-extraneous")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getResolvePaths = require("../util/get-resolve-paths")
@@ -32,9 +32,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
-        messages: {
-            extraneous: '"{{moduleName}}" is extraneous.',
-        }
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-extraneous-require.js b/lib/rules/no-extraneous-require.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkExtraneous = require("../util/check-extraneous")
+const { checkExtraneous, messages } = require("../util/check-extraneous")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getResolvePaths = require("../util/get-resolve-paths")
@@ -34,9 +34,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
-        messages: {
-            "extraneous": '"{{moduleName}}" is extraneous.'
-        }
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-missing-import.js b/lib/rules/no-missing-import.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkExistence = require("../util/check-existence")
+const { checkExistence, messages } = require("../util/check-existence")
 const getAllowModules = require("../util/get-allow-modules")
 const getResolvePaths = require("../util/get-resolve-paths")
 const visitImport = require("../util/visit-import")
@@ -30,6 +30,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-missing-require.js b/lib/rules/no-missing-require.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkExistence = require("../util/check-existence")
+const { checkExistence, messages } = require("../util/check-existence")
 const getAllowModules = require("../util/get-allow-modules")
 const getResolvePaths = require("../util/get-resolve-paths")
 const getTryExtensions = require("../util/get-try-extensions")
@@ -32,6 +32,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-restricted-import.js b/lib/rules/no-restricted-import.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const check = require("../util/check-restricted")
+const { checkForRestriction, messages } = require("../util/check-restricted")
 const visit = require("../util/visit-import")
 
 module.exports = {
@@ -47,14 +47,13 @@ module.exports = {
                 additionalItems: false,
             },
         ],
-        messages: {
-            restricted:
-                "'{{name}}' module is restricted from being used.{{customMessage}}",
-        },
+        messages,
     },
 
     create(context) {
         const opts = { includeCore: true }
-        return visit(context, opts, targets => check(context, targets))
+        return visit(context, opts, targets =>
+            checkForRestriction(context, targets)
+        )
     },
 }
diff --git a/lib/rules/no-restricted-require.js b/lib/rules/no-restricted-require.js
@@ -5,7 +5,7 @@
  */
 "use strict"
 
-const check = require("../util/check-restricted")
+const { checkForRestriction, messages } = require("../util/check-restricted")
 const visit = require("../util/visit-require")
 
 module.exports = {
@@ -47,14 +47,13 @@ module.exports = {
                 additionalItems: false,
             },
         ],
-        messages: {
-            restricted:
-                "'{{name}}' module is restricted from being used.{{customMessage}}",
-        },
+        messages,
     },
 
     create(context) {
         const opts = { includeCore: true }
-        return visit(context, opts, targets => check(context, targets))
+        return visit(context, opts, targets =>
+            checkForRestriction(context, targets)
+        )
     },
 }
diff --git a/lib/rules/no-unpublished-import.js b/lib/rules/no-unpublished-import.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkPublish = require("../util/check-publish")
+const { checkPublish, messages } = require("../util/check-publish")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getResolvePaths = require("../util/get-resolve-paths")
@@ -32,6 +32,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-unpublished-require.js b/lib/rules/no-unpublished-require.js
@@ -4,7 +4,7 @@
  */
 "use strict"
 
-const checkPublish = require("../util/check-publish")
+const { checkPublish, messages } = require("../util/check-publish")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getResolvePaths = require("../util/get-resolve-paths")
@@ -34,6 +34,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
+        messages,
     },
     create(context) {
         const filePath = context.getFilename()

diff --git a/lib/rules/no-unsupported-features/es-builtins.js b/lib/rules/no-unsupported-features/es-builtins.js
@@ -5,7 +5,10 @@
 "use strict"
 
 const { READ } = require("eslint-utils")
-const checkUnsupportedBuiltins = require("../../util/check-unsupported-builtins")
+const {
+    checkUnsupportedBuiltins,
+    messages,
+} = require("../../util/check-unsupported-builtins")
 const enumeratePropertyNames = require("../../util/enumerate-property-names")
 
 const trackMap = {
@@ -165,10 +168,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
-        messages: {
-            unsupported:
-                "The '{{name}}' is not supported until Node.js {{supported}}. The configured version range is '{{version}}'.",
-        },
+        messages,
     },
     create(context) {
         return {

diff --git a/lib/rules/no-unsupported-features/node-builtins.js b/lib/rules/no-unsupported-features/node-builtins.js
@@ -5,7 +5,10 @@
 "use strict"
 
 const { READ } = require("eslint-utils")
-const checkUnsupportedBuiltins = require("../../util/check-unsupported-builtins")
+const {
+    checkUnsupportedBuiltins,
+    messages,
+} = require("../../util/check-unsupported-builtins")
 const enumeratePropertyNames = require("../../util/enumerate-property-names")
 
 const trackMap = {
@@ -400,10 +403,7 @@ module.exports = {
                 additionalProperties: false,
             },
         ],
-        messages: {
-            unsupported:
-                "The '{{name}}' is not supported until Node.js {{supported}}. The configured version range is '{{version}}'.",
-        },
+        messages,
     },
     create(context) {
         return {

diff --git a/lib/rules/process-exit-as-throw.js b/lib/rules/process-exit-as-throw.js
@@ -1,3 +1,4 @@
+/* eslint-disable eslint-plugin/prefer-message-ids */
 /**
  * @author Toru Nagashima
  * See LICENSE file in root directory for full license.

diff --git a/lib/util/check-existence.js b/lib/util/check-existence.js
@@ -20,7 +20,7 @@ const mapTypescriptExtension = require("../util/map-typescript-extension")
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkExistence(context, targets) {
+exports.checkExistence = function checkExistence(context, targets) {
     const allowed = new Set(getAllowModules(context))
 
     for (const target of targets) {
@@ -47,9 +47,13 @@ module.exports = function checkExistence(context, targets) {
             context.report({
                 node: target.node,
                 loc: target.node.loc,
-                message: '"{{name}}" is not found.',
+                messageId: "notFound",
                 data: target,
             })
         }
     }
 }
+
+exports.messages = {
+    notFound: '"{{name}}" is not found.',
+}
diff --git a/lib/util/check-extraneous.js b/lib/util/check-extraneous.js
@@ -17,7 +17,7 @@ const getPackageJson = require("./get-package-json")
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkForExtraneous(context, filePath, targets) {
+exports.checkExtraneous = function checkExtraneous(context, filePath, targets) {
     const packageInfo = getPackageJson(filePath)
     if (!packageInfo) {
         return
@@ -50,3 +50,7 @@ module.exports = function checkForExtraneous(context, filePath, targets) {
         }
     }
 }
+
+exports.messages = {
+    extraneous: '"{{moduleName}}" is extraneous.',
+}
diff --git a/lib/util/check-publish.js b/lib/util/check-publish.js
@@ -20,7 +20,7 @@ const getPackageJson = require("./get-package-json")
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkForPublish(context, filePath, targets) {
+exports.checkPublish = function checkPublish(context, filePath, targets) {
     const packageInfo = getPackageJson(filePath)
     if (!packageInfo) {
         return
@@ -69,3 +69,7 @@ module.exports = function checkForPublish(context, filePath, targets) {
         }
     }
 }
+
+exports.messages = {
+    notPublished: '"{{name}}" is not published.',
+}
diff --git a/lib/util/check-restricted.js b/lib/util/check-restricted.js
@@ -90,7 +90,7 @@ function createRestrictions(defs) {
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkForRestriction(context, targets) {
+exports.checkForRestriction = function checkForRestriction(context, targets) {
     const restrictions = createRestrictions(context.options[0])
 
     for (const target of targets) {
@@ -107,3 +107,8 @@ module.exports = function checkForRestriction(context, targets) {
         }
     }
 }
+
+exports.messages = {
+    restricted:
+        "'{{name}}' module is restricted from being used.{{customMessage}}",
+}
diff --git a/lib/util/check-unsupported-builtins.js b/lib/util/check-unsupported-builtins.js
@@ -80,7 +80,10 @@ function supportedVersionToString({ backported, supported }) {
  * @param {{modules:object,globals:object}} trackMap The map for APIs to report.
  * @returns {void}
  */
-module.exports = function checkUnsupportedBuiltins(context, trackMap) {
+module.exports.checkUnsupportedBuiltins = function checkUnsupportedBuiltins(
+    context,
+    trackMap
+) {
     const options = parseOptions(context)
     const tracker = new ReferenceTracker(context.getScope(), { mode: "legacy" })
     const references = [
@@ -106,3 +109,8 @@ module.exports = function checkUnsupportedBuiltins(context, trackMap) {
         }
     }
 }
+
+exports.messages = {
+    unsupported:
+        "The '{{name}}' is not supported until Node.js {{supported}}. The configured version range is '{{version}}'.",
+}
diff --git a/tests/lib/configs/recommended.js b/tests/lib/configs/recommended.js
@@ -71,6 +71,7 @@ describe("node/recommended config", () => {
                     endColumn: 13,
                     endLine: 1,
                     line: 1,
+                    messageId: "notFound",
                     message: '"foo" is not found.',
                     nodeType: "Literal",
                     ruleId: "n/no-missing-import",
@@ -109,6 +110,7 @@ describe("node/recommended config", () => {
                     endColumn: 13,
                     endLine: 1,
                     line: 1,
+                    messageId: "notFound",
                     message: '"foo" is not found.',
                     nodeType: "Literal",
                     ruleId: "n/no-missing-import",
@@ -146,6 +148,7 @@ describe("node/recommended config", () => {
                     endColumn: 13,
                     endLine: 1,
                     line: 1,
+                    messageId: "notFound",
                     message: '"foo" is not found.',
                     nodeType: "Literal",
                     ruleId: "n/no-missing-import",