Update: fix no-deprecated-api about modules which are hiding core modules (fixes #65)

Author: mysticatea

docs/rules/no-deprecated-api.md

@@ -93,7 +93,8 @@ This rule has 2 options.
     "rules": {
         "node/no-deprecated-api": ["error", {
             "ignoreModuleItems": [],
-            "ignoreGlobalItems": []
+            "ignoreGlobalItems": [],
+            "ignoreIndirectDependencies": false
         }]
     }
 }
@@ -184,6 +185,12 @@ Examples of :+1: **correct** code for the `{"ignoreGlobalItems": ["new Buffer()"
 const data = new Buffer(10) // OK since it's in ignoreGlobalItems.
 ```
 
+### ignoreIndirectDependencies
+
+If `ignoreIndirectDependencies: true`, this rule ignores deprecated APIs if your module depends on third-party modules which have the same name as core modules indirectly. Default is `false`.
+
+If your module depends on such third-party modules directly (explicitly), this rule always ignores deprecated APIs of those.
+
 ## Known Limitations
 
 This rule cannot report the following cases:

lib/rules/no-deprecated-api.js

@@ -14,6 +14,7 @@ const dirname = require("path").dirname
 const assign = require("object-assign")
 const resolve = require("resolve").sync
 const deprecatedApis = require("../util/deprecated-apis")
+const getPackageJson = require("../util/get-package-json")
 const getValueIfString = require("../util/get-value-if-string")
 
 //------------------------------------------------------------------------------
@@ -194,6 +195,7 @@ function create(context) {
     const options = context.options[0] || {}
     const ignoredModuleItems = options.ignoreModuleItems || []
     const ignoredGlobalItems = options.ignoreGlobalItems || []
+    const ignoreIndirectDependencies = Boolean(options.ignoreIndirectDependencies)
     let globalScope = null
 
     /**
@@ -204,15 +206,29 @@ function create(context) {
      * @returns {boolean} `true` if the third party module existed.
      */
     function isThirdPartyInstalled(moduleId) {
-        try {
-            const fileName = context.getFilename()
-            if (fileName !== "<input>") {
+        const fileName = context.getFilename()
+        if (fileName !== "<input>") {
+            if (ignoreIndirectDependencies) {
                 const basedir = dirname(fileName)
-                return resolve(moduleId, {basedir}) !== moduleId
+                try {
+                    return resolve(moduleId, {basedir}) !== moduleId
+                }
+                catch (_err) {
+                    // ignore
+                }
+            }
+            else {
+                const packageInfo = getPackageJson(fileName)
+                const deps = packageInfo && packageInfo.dependencies
+                const devDeps = packageInfo && packageInfo.devDependencies
+
+                /*eslint-disable no-prototype-builtins */
+                return Boolean(
+                    (deps && deps.hasOwnProperty(moduleId)) ||
+                    (devDeps && devDeps.hasOwnProperty(moduleId))
+                )
+                /*eslint-enable */
             }
-        }
-        catch (_err) {
-            // ignore
         }
 
         return false
@@ -595,6 +611,9 @@ module.exports = {
                         additionalItems: false,
                         uniqueItems: true,
                     },
+                    ignoreIndirectDependencies: { //
+                        type: "boolean",
+                    },
                 },
                 additionalProperties: false,
             },

tests/fixtures/no-deprecated-api/indirect-thirdparty/node_modules/domain.js

@@ -0,0 +1,4 @@
+{
+    "dependencies": {
+    }
+}

tests/fixtures/no-deprecated-api/indirect-thirdparty/package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "domain": "0.0.0"
+    }
+}

tests/fixtures/no-deprecated-api/indirect-thirdparty/test.js

@@ -26,6 +26,10 @@ const NO_THIRD_PERTY = path.resolve(
     __dirname,
     "../../fixtures/no-deprecated-api/no-thirdparty/test.js"
 )
+const INDIRECT_THIRD_PERTY = path.resolve(
+    __dirname,
+    "../../fixtures/no-deprecated-api/indirect-thirdparty/test.js"
+)
 
 //------------------------------------------------------------------------------
 // Tests
@@ -161,6 +165,14 @@ ruleTester.run("no-deprecated-api", rule, {
                 ignoreGlobalItems: ["process.env.NODE_REPL_HISTORY_FILE"],
             }],
         },
+
+        // https://github.com/mysticatea/eslint-plugin-node/issues/65
+        {
+            filename: INDIRECT_THIRD_PERTY,
+            code: "require(\"domain\")",
+            env: {node: true},
+            options: [{ignoreIndirectDependencies: true}],
+        },
     ],
     invalid: [
         //----------------------------------------------------------------------
@@ -446,6 +458,21 @@ ruleTester.run("no-deprecated-api", rule, {
             errors: ["'util._extend' was deprecated since v6. Use 'Object.assign()' instead."],
         },
 
+        // https://github.com/mysticatea/eslint-plugin-node/issues/65
+        {
+            filename: INDIRECT_THIRD_PERTY,
+            code: "require(\"domain\")",
+            env: {node: true},
+            errors: ["'domain' module was deprecated since v4."],
+        },
+        {
+            filename: INDIRECT_THIRD_PERTY,
+            code: "require(\"domain\")",
+            env: {node: true},
+            options: [{ignoreIndirectDependencies: false}],
+            errors: ["'domain' module was deprecated since v4."],
+        },
+
         // ES2015 Modules
         {
             code: "import b from 'buffer'; new b.Buffer()",