feat(prefer-promises): Add support for process.getBuiltinModule()

Author: ota-meshi

lib/rules/prefer-promises/dns.js

@@ -10,6 +10,9 @@ const {
     ReferenceTracker,
 } = require("@eslint-community/eslint-utils")
 const { getScope } = require("../../util/eslint-compat")
+const {
+    iterateProcessGetBuiltinModuleReferences,
+} = require("../../util/iterate-process-get-builtin-module-references")
 
 /** @type {import('@eslint-community/eslint-utils').TraceMap<boolean>} */
 const dns = {
@@ -63,6 +66,10 @@ module.exports = {
                 const tracker = new ReferenceTracker(scope, { mode: "legacy" })
                 const references = [
                     ...tracker.iterateCjsReferences(traceMap),
+                    ...iterateProcessGetBuiltinModuleReferences(
+                        tracker,
+                        traceMap
+                    ),
                     ...tracker.iterateEsmReferences(traceMap),
                 ]
 

lib/rules/prefer-promises/fs.js

@@ -6,6 +6,9 @@
 
 const { CALL, ReferenceTracker } = require("@eslint-community/eslint-utils")
 const { getScope } = require("../../util/eslint-compat")
+const {
+    iterateProcessGetBuiltinModuleReferences,
+} = require("../../util/iterate-process-get-builtin-module-references")
 
 /** @type {import('@eslint-community/eslint-utils').TraceMap<boolean>} */
 const traceMap = {
@@ -61,6 +64,10 @@ module.exports = {
                 const tracker = new ReferenceTracker(scope, { mode: "legacy" })
                 const references = [
                     ...tracker.iterateCjsReferences(traceMap),
+                    ...iterateProcessGetBuiltinModuleReferences(
+                        tracker,
+                        traceMap
+                    ),
                     ...tracker.iterateEsmReferences(traceMap),
                 ]
 

lib/util/iterate-process-get-builtin-module-references.js

@@ -0,0 +1,56 @@
+"use strict"
+const {
+    CALL,
+    getStringIfConstant,
+    READ,
+} = require("@eslint-community/eslint-utils")
+const processGetBuiltinModuleCall = {
+    process: {
+        getBuiltinModule: {
+            [CALL]: true,
+        },
+    },
+}
+/**
+ * Iterate the references of process.getBuiltinModule() modules.
+ * @template Info
+ * @param {import("@eslint-community/eslint-utils").ReferenceTracker} tracker The reference tracker.
+ * @param {import("@eslint-community/eslint-utils").TraceMap<Info>} traceMap The trace map.
+ * @returns {IterableIterator<import("@eslint-community/eslint-utils").Reference<Info>>} The iterator.
+ */
+function* iterateProcessGetBuiltinModuleReferences(tracker, traceMap) {
+    for (const { node } of tracker.iterateGlobalReferences(
+        processGetBuiltinModuleCall
+    )) {
+        if (node.type !== "CallExpression") continue
+        const key = node.arguments[0] && getStringIfConstant(node.arguments[0])
+        if (key == null) {
+            continue
+        }
+        const nextTraceMap = Object.hasOwn(traceMap, key) && traceMap[key]
+        if (!nextTraceMap) {
+            continue
+        }
+
+        if (nextTraceMap[READ]) {
+            yield {
+                node,
+                path: [key],
+                type: READ,
+                info: nextTraceMap[READ],
+            }
+        }
+
+        for (const ref of tracker.iteratePropertyReferences(
+            node,
+            nextTraceMap
+        )) {
+            yield {
+                ...ref,
+                path: [key, ...ref.path],
+            }
+        }
+    }
+}
+
+module.exports = { iterateProcessGetBuiltinModuleReferences }

tests/lib/rules/prefer-promises/dns.js

@@ -22,6 +22,10 @@ new RuleTester({
         "import * as dns from 'dns'; dns.promises.lookup()",
         "import {promises} from 'dns'; promises.lookup()",
         "import {promises as dns} from 'dns'; dns.lookup()",
+        "const dns = process.getBuiltinModule('dns'); dns.promises.lookup()",
+        "const dns = process.getBuiltinModule('node:dns'); dns.promises.lookup()",
+        "const {promises} = process.getBuiltinModule('dns'); promises.lookup()",
+        "const {promises: dns} = process.getBuiltinModule('dns'); dns.lookup()",
     ],
     invalid: [
         {
@@ -52,6 +56,18 @@ new RuleTester({
             code: "import {lookup} from 'dns'; lookup()",
             errors: [{ messageId: "preferPromises", data: { name: "lookup" } }],
         },
+        {
+            code: "const dns = process.getBuiltinModule('dns'); dns.lookup()",
+            errors: [{ messageId: "preferPromises", data: { name: "lookup" } }],
+        },
+        {
+            code: "const dns = process.getBuiltinModule('node:dns'); dns.lookup()",
+            errors: [{ messageId: "preferPromises", data: { name: "lookup" } }],
+        },
+        {
+            code: "const {lookup} = process.getBuiltinModule('dns'); lookup()",
+            errors: [{ messageId: "preferPromises", data: { name: "lookup" } }],
+        },
 
         // Other members
         {

tests/lib/rules/prefer-promises/fs.js

@@ -23,6 +23,10 @@ new RuleTester({
         "import * as fs from 'fs'; fs.promises.access()",
         "import {promises} from 'fs'; promises.access()",
         "import {promises as fs} from 'fs'; fs.access()",
+        "const fs = process.getBuiltinModule('fs'); fs.promises.access()",
+        "const fs = process.getBuiltinModule('node:fs'); fs.promises.access()",
+        "const {promises} = process.getBuiltinModule('fs'); promises.access()",
+        "const {promises: fs} = process.getBuiltinModule('fs'); fs.access()",
     ],
     invalid: [
         {
@@ -53,6 +57,18 @@ new RuleTester({
             code: "import {access} from 'fs'; access()",
             errors: [{ messageId: "preferPromises", data: { name: "access" } }],
         },
+        {
+            code: "const fs = process.getBuiltinModule('fs'); fs.access()",
+            errors: [{ messageId: "preferPromises", data: { name: "access" } }],
+        },
+        {
+            code: "const fs = process.getBuiltinModule('node:fs'); fs.access()",
+            errors: [{ messageId: "preferPromises", data: { name: "access" } }],
+        },
+        {
+            code: "const {access} = process.getBuiltinModule('fs'); access()",
+            errors: [{ messageId: "preferPromises", data: { name: "access" } }],
+        },
 
         // Other members
         {