Chore: refactoring

Author: mysticatea

docs/rules/no-missing-import.md

@@ -34,6 +34,7 @@ import existingModule from "existing-module";
     "rules": {
         "node/no-missing-import": ["error", {
             "allowModules": [],
+            "resolvePaths": ["/path/to/a/modules/directory"],
             "tryExtensions": [".js", ".json", ".node"]
         }]
     }
@@ -58,6 +59,13 @@ This option is an array of strings as module names.
 }
 ```
 
+### resolvePaths
+
+Adds additional paths to try for when resolving imports.
+If a path is relative, it will be resolved from CWD.
+
+Default is `[]`
+
 ### tryExtensions
 
 When an import path does not exist, this rule checks whether or not any of `path.js`, `path.json`, and `path.node` exists.
@@ -71,13 +79,16 @@ The following options can be set by [shared settings](http://eslint.org/docs/use
 Several rules have the same option, but we can set this option at once.
 
 - `allowModules`
+- `resolvePaths`
 - `tryExtensions`
 
-```json
-{
+```js
+// .eslintrc.js
+module.exports = {
     "settings": {
         "node": {
             "allowModules": ["electron"],
+            "resolvePaths": [__dirname],
             "tryExtensions": [".js", ".json", ".node"]
         }
     },

docs/rules/no-missing-require.md

@@ -39,8 +39,8 @@ var foo = require(FOO_NAME);
     "rules": {
         "node/no-missing-require": ["error", {
             "allowModules": [],
-            "tryExtensions": [".js", ".json", ".node"],
-            "resolvePaths": ["/an/absolute/path"]
+            "resolvePaths": ["/path/to/a/modules/directory"],
+            "tryExtensions": [".js", ".json", ".node"]
         }]
     }
 }
@@ -64,37 +64,37 @@ This option is an array of strings as module names.
 }
 ```
 
+### resolvePaths
+
+Adds additional paths to try for when resolving a require.
+If a path is relative, it will be resolved from CWD.
+
+Default is `[]`
+
 ### tryExtensions
 
 When an import path does not exist, this rule checks whether or not any of `path.js`, `path.json`, and `path.node` exists.
 `tryExtensions` option is the extension list this rule uses at the time.
 
 Default is `[".js", ".json", ".node"]`.
 
-### resolvePaths
-
-Adds additional paths to try for when resolving a require.
-The paths must be absolute.
-
-Default is `[]`
-
 ## Shared Settings
 
 The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
 Several rules have the same option, but we can set this option at once.
 
 - `allowModules`
-- `tryExtensions`
 - `resolvePaths`
+- `tryExtensions`
 
 ```js
 // .eslintrc.js
 module.exports = {
     "settings": {
         "node": {
             "allowModules": ["electron"],
-            "tryExtensions": [".js", ".json", ".node"],
-            "resolvePaths": [__dirname]
+            "resolvePaths": [__dirname],
+            "tryExtensions": [".js", ".json", ".node"]
         }
     },
     "rules": {

lib/rules/no-extraneous-import.js

@@ -13,6 +13,7 @@ const checkExtraneous = require("../util/check-extraneous")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getImportTargets = require("../util/get-import-export-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -60,6 +61,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     convertPath: getConvertPath.schema,
+                    resolvePaths: getResolvePaths.schema,
                 },
                 additionalProperties: false,
             },

lib/rules/no-extraneous-require.js

@@ -13,6 +13,7 @@ const checkExtraneous = require("../util/check-extraneous")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getRequireTargets = require("../util/get-require-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -60,6 +61,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     convertPath: getConvertPath.schema,
+                    resolvePaths: getResolvePaths.schema,
                 },
                 additionalProperties: false,
             },

lib/rules/no-missing-import.js

@@ -12,6 +12,7 @@
 const checkExistence = require("../util/check-existence")
 const getAllowModules = require("../util/get-allow-modules")
 const getImportExportTargets = require("../util/get-import-export-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 const getTryExtensions = require("../util/get-try-extensions")
 
 //------------------------------------------------------------------------------
@@ -34,7 +35,6 @@ function create(context) {
         "Program:exit"(node) {
             checkExistence(
                 context,
-                filePath,
                 getImportExportTargets(context, node)
             )
         },
@@ -60,6 +60,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     tryExtensions: getTryExtensions.schema,
+                    resolvePaths: getResolvePaths.schema,
                 },
                 additionalProperties: false,
             },

lib/rules/no-missing-require.js

@@ -12,6 +12,7 @@
 const checkExistence = require("../util/check-existence")
 const getAllowModules = require("../util/get-allow-modules")
 const getRequireTargets = require("../util/get-require-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 const getTryExtensions = require("../util/get-try-extensions")
 
 //------------------------------------------------------------------------------
@@ -34,7 +35,6 @@ function create(context) {
         "Program:exit"() {
             checkExistence(
                 context,
-                filePath,
                 getRequireTargets(context)
             )
         },
@@ -60,6 +60,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     tryExtensions: getTryExtensions.schema,
+                    resolvePaths: getResolvePaths.schema,
                 },
                 additionalProperties: false,
             },

lib/rules/no-unpublished-import.js

@@ -13,6 +13,7 @@ const checkPublish = require("../util/check-publish")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getImportExportTargets = require("../util/get-import-export-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 const getTryExtensions = require("../util/get-try-extensions")
 
 //------------------------------------------------------------------------------
@@ -61,6 +62,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     convertPath: getConvertPath.schema,
+                    resolvePaths: getResolvePaths.schema,
                     tryExtensions: getTryExtensions.schema,
                 },
                 additionalProperties: false,

lib/rules/no-unpublished-require.js

@@ -13,6 +13,7 @@ const checkPublish = require("../util/check-publish")
 const getAllowModules = require("../util/get-allow-modules")
 const getConvertPath = require("../util/get-convert-path")
 const getRequireTargets = require("../util/get-require-targets")
+const getResolvePaths = require("../util/get-resolve-paths")
 const getTryExtensions = require("../util/get-try-extensions")
 
 //------------------------------------------------------------------------------
@@ -61,6 +62,7 @@ module.exports = {
                 properties: {
                     allowModules: getAllowModules.schema,
                     convertPath: getConvertPath.schema,
+                    resolvePaths: getResolvePaths.schema,
                     tryExtensions: getTryExtensions.schema,
                 },
                 additionalProperties: false,

lib/util/check-existence.js

@@ -10,11 +10,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const path = require("path")
-const resolve = require("resolve")
 const exists = require("./exists")
 const getAllowModules = require("./get-allow-modules")
-const getResolvePaths = require("./get-resolve-paths")
 
 //------------------------------------------------------------------------------
 // Public Interface
@@ -27,40 +24,30 @@ const getResolvePaths = require("./get-resolve-paths")
  * See Also: https://nodejs.org/api/modules.html
  *
  * @param {RuleContext} context - A context to report.
- * @param {string} filePath - The current file path.
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkForExistence(context, filePath, targets) {
-    const allowed = getAllowModules(context)
-    const paths = getResolvePaths(context)
-    const opts = {paths, basedir: path.dirname(path.resolve(filePath))}
+module.exports = function checkForExistence(context, targets) {
+    const allowed = new Set(getAllowModules(context))
 
     for (const target of targets) {
-        // Workaround for https://github.com/substack/node-resolve/issues/78
-        if (target.filePath) {
-            if (exists(target.filePath)) {
-                continue
-            }
-        }
-        else if (allowed.indexOf(target.moduleName) !== -1) {
-            continue
-        }
-        else {
-            try {
-                resolve.sync(target.name, opts)
-                continue
-            }
-            catch (_err) {
-                // ignore.
-            }
-        }
+        const missingModule = (
+            target.moduleName != null &&
+            !allowed.has(target.moduleName) &&
+            target.filePath == null
+        )
+        const missingFile = (
+            target.moduleName == null &&
+            !exists(target.filePath)
+        )
 
-        context.report({
-            node: target.node,
-            loc: target.node.loc,
-            message: "\"{{name}}\" is not found.",
-            data: target,
-        })
+        if (missingModule || missingFile) {
+            context.report({
+                node: target.node,
+                loc: target.node.loc,
+                message: "\"{{name}}\" is not found.",
+                data: target,
+            })
+        }
     }
 }

lib/util/check-extraneous.js

@@ -9,32 +9,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const path = require("path")
-const resolve = require("resolve")
 const getAllowModules = require("./get-allow-modules")
-const getConvertPath = require("./get-convert-path")
 const getPackageJson = require("./get-package-json")
 
-//------------------------------------------------------------------------------
-// Helpers
-//------------------------------------------------------------------------------
-
-/**
- * Check whether the given package exists or not.
- * @param {string} name The package name to check.
- * @param {string} basedir The path to starting directory.
- * @returns {boolean} `true` if the package was found.
- */
-function exists(name, basedir) {
-    try {
-        resolve.sync(name, {basedir})
-        return true
-    }
-    catch (_err) {
-        return false
-    }
-}
-
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -49,24 +26,13 @@ function exists(name, basedir) {
  * @param {ImportTarget[]} targets - A list of target information to check.
  * @returns {void}
  */
-module.exports = function checkForExtraeous(context, filePath, targets) {
+module.exports = function checkForExtraneous(context, filePath, targets) {
     const packageInfo = getPackageJson(filePath)
     if (!packageInfo) {
         return
     }
 
     const allowed = new Set(getAllowModules(context))
-    const convertPath = getConvertPath(context)
-    const rootPath = path.dirname(packageInfo.filePath)
-    const toRelative = function(fullPath) { // eslint-disable-line func-style
-        const retv = path.relative(rootPath, fullPath).replace(/\\/g, "/")
-        return convertPath(retv)
-    }
-    const convertedPath = path.resolve(
-        rootPath,
-        toRelative(path.resolve(filePath))
-    )
-    const basedir = path.dirname(convertedPath)
     const dependencies = new Set(
         [].concat(
             Object.keys(packageInfo.dependencies || {}),
@@ -77,12 +43,11 @@ module.exports = function checkForExtraeous(context, filePath, targets) {
     )
 
     for (const target of targets) {
-        const name = target.moduleName
         const extraneous = (
-            name != null &&
-            !dependencies.has(name) &&
-            !allowed.has(name) &&
-            exists(name, basedir)
+            target.moduleName != null &&
+            target.filePath != null &&
+            !dependencies.has(target.moduleName) &&
+            !allowed.has(target.moduleName)
         )
 
         if (extraneous) {