feat(prefer-global): Add support for process.getBuiltinModule() (#436)

ota-meshi · aladdin-add · web-flow · commit 83aa3a7dc4ef · 2025-05-09T13:03:41.000+08:00
Co-authored-by: 唯然 &lt;weiran.zsd@outlook.com&gt;
diff --git a/lib/util/check-prefer-global.js b/lib/util/check-prefer-global.js
@@ -6,6 +6,9 @@
 
 const { ReferenceTracker } = require("@eslint-community/eslint-utils")
 const { getScope } = require("../util/eslint-compat")
+const {
+    iterateProcessGetBuiltinModuleReferences,
+} = require("../util/iterate-process-get-builtin-module-references")
 /**
  * @typedef TraceMap
  * @property {import('@eslint-community/eslint-utils').TraceMap<boolean>} globals
@@ -43,6 +46,10 @@ class Verifier {
 
         for (const { node } of [
             ...tracker.iterateCjsReferences(traceMap.modules),
+            ...iterateProcessGetBuiltinModuleReferences(
+                tracker,
+                traceMap.modules
+            ),
             ...tracker.iterateEsmReferences(traceMap.modules),
         ]) {
             context.report({ node, messageId: "preferGlobal" })
diff --git a/tests/lib/rules/prefer-global/buffer.js b/tests/lib/rules/prefer-global/buffer.js
@@ -7,41 +7,47 @@
 const RuleTester = require("#test-helpers").RuleTester
 const rule = require("../../../../lib/rules/prefer-global/buffer")
 
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
 new RuleTester().run("prefer-global/buffer", rule, {
     valid: [
         "var b = Buffer.alloc(10)",
         {
             code: "var b = Buffer.alloc(10)",
             options: ["always"],
         },
-        {
-            code: "var { Buffer } = require('buffer'); var b = Buffer.alloc(10)",
-            options: ["never"],
-        },
-        {
-            code: "var { Buffer } = require('node:buffer'); var b = Buffer.alloc(10)",
-            options: ["never"],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { Buffer } = ${method}('buffer'); var b = Buffer.alloc(10)`,
+                options: ["never"],
+            },
+            {
+                code: `var { Buffer } = ${method}('node:buffer'); var b = Buffer.alloc(10)`,
+                options: ["never"],
+            },
+        ]),
     ],
     invalid: [
-        {
-            code: "var { Buffer } = require('buffer'); var b = Buffer.alloc(10)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { Buffer } = require('node:buffer'); var b = Buffer.alloc(10)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { Buffer } = require('buffer'); var b = Buffer.alloc(10)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { Buffer } = require('node:buffer'); var b = Buffer.alloc(10)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { Buffer } = ${method}('buffer'); var b = Buffer.alloc(10)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { Buffer } = ${method}('node:buffer'); var b = Buffer.alloc(10)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { Buffer } = ${method}('buffer'); var b = Buffer.alloc(10)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { Buffer } = ${method}('node:buffer'); var b = Buffer.alloc(10)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
         {
             code: "var b = Buffer.alloc(10)",
             options: ["never"],
diff --git a/tests/lib/rules/prefer-global/console.js b/tests/lib/rules/prefer-global/console.js
@@ -7,41 +7,47 @@
 const RuleTester = require("#test-helpers").RuleTester
 const rule = require("../../../../lib/rules/prefer-global/console")
 
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
 new RuleTester().run("prefer-global/console", rule, {
     valid: [
         "console.log(10)",
         {
             code: "console.log(10)",
             options: ["always"],
         },
-        {
-            code: "var console = require('console'); console.log(10)",
-            options: ["never"],
-        },
-        {
-            code: "var console = require('node:console'); console.log(10)",
-            options: ["never"],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var console = ${method}('console'); console.log(10)`,
+                options: ["never"],
+            },
+            {
+                code: `var console = ${method}('node:console'); console.log(10)`,
+                options: ["never"],
+            },
+        ]),
     ],
     invalid: [
-        {
-            code: "var console = require('console'); console.log(10)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var console = require('node:console'); console.log(10)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var console = require('console'); console.log(10)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var console = require('node:console'); console.log(10)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var console = ${method}('console'); console.log(10)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var console = ${method}('node:console'); console.log(10)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var console = ${method}('console'); console.log(10)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var console = ${method}('node:console'); console.log(10)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
         {
             code: "console.log(10)",
             options: ["never"],
diff --git a/tests/lib/rules/prefer-global/process.js b/tests/lib/rules/prefer-global/process.js
@@ -7,6 +7,8 @@
 const RuleTester = require("#test-helpers").RuleTester
 const rule = require("../../../../lib/rules/prefer-global/process")
 
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
 new RuleTester().run("prefer-global/process", rule, {
     valid: [
         "process.exit(0)",
@@ -22,26 +24,32 @@ new RuleTester().run("prefer-global/process", rule, {
             code: "var process = require('node:process'); process.exit(0)",
             options: ["never"],
         },
-    ],
-    invalid: [
-        {
-            code: "var process = require('process'); process.exit(0)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var process = require('node:process'); process.exit(0)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var process = require('process'); process.exit(0)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
         {
-            code: "var process = require('node:process'); process.exit(0)",
+            code: "process.getBuiltinModule('buffer')",
             options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
         },
+    ],
+    invalid: [
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var process_ = ${method}('process'); process_.exit(0)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var process_ = ${method}('node:process'); process_.exit(0)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var process_ = ${method}('process'); process_.exit(0)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var process_ = ${method}('node:process'); process_.exit(0)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
         {
             code: "process.exit(0)",
             options: ["never"],
diff --git a/tests/lib/rules/prefer-global/text-decoder.js b/tests/lib/rules/prefer-global/text-decoder.js
@@ -7,41 +7,47 @@
 const RuleTester = require("#test-helpers").RuleTester
 const rule = require("../../../../lib/rules/prefer-global/text-decoder")
 
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
 new RuleTester().run("prefer-global/text-decoder", rule, {
     valid: [
         "var b = new TextDecoder(s)",
         {
             code: "var b = new TextDecoder(s)",
             options: ["always"],
         },
-        {
-            code: "var { TextDecoder } = require('util'); var b = new TextDecoder(s)",
-            options: ["never"],
-        },
-        {
-            code: "var { TextDecoder } = require('node:util'); var b = new TextDecoder(s)",
-            options: ["never"],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { TextDecoder } = ${method}('util'); var b = new TextDecoder(s)`,
+                options: ["never"],
+            },
+            {
+                code: `var { TextDecoder } = ${method}('node:util'); var b = new TextDecoder(s)`,
+                options: ["never"],
+            },
+        ]),
     ],
     invalid: [
-        {
-            code: "var { TextDecoder } = require('util'); var b = new TextDecoder(s)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextDecoder } = require('node:util'); var b = new TextDecoder(s)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextDecoder } = require('util'); var b = new TextDecoder(s)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextDecoder } = require('node:util'); var b = new TextDecoder(s)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { TextDecoder } = ${method}('util'); var b = new TextDecoder(s)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextDecoder } = ${method}('node:util'); var b = new TextDecoder(s)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextDecoder } = ${method}('util'); var b = new TextDecoder(s)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextDecoder } = ${method}('node:util'); var b = new TextDecoder(s)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
         {
             code: "var b = new TextDecoder(s)",
             options: ["never"],
diff --git a/tests/lib/rules/prefer-global/text-encoder.js b/tests/lib/rules/prefer-global/text-encoder.js
@@ -7,41 +7,47 @@
 const RuleTester = require("#test-helpers").RuleTester
 const rule = require("../../../../lib/rules/prefer-global/text-encoder")
 
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
 new RuleTester().run("prefer-global/text-encoder", rule, {
     valid: [
         "var b = new TextEncoder(s)",
         {
             code: "var b = new TextEncoder(s)",
             options: ["always"],
         },
-        {
-            code: "var { TextEncoder } = require('util'); var b = new TextEncoder(s)",
-            options: ["never"],
-        },
-        {
-            code: "var { TextEncoder } = require('node:util'); var b = new TextEncoder(s)",
-            options: ["never"],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { TextEncoder } = ${method}('util'); var b = new TextEncoder(s)`,
+                options: ["never"],
+            },
+            {
+                code: `var { TextEncoder } = ${method}('node:util'); var b = new TextEncoder(s)`,
+                options: ["never"],
+            },
+        ]),
     ],
     invalid: [
-        {
-            code: "var { TextEncoder } = require('util'); var b = new TextEncoder(s)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextEncoder } = require('node:util'); var b = new TextEncoder(s)",
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextEncoder } = require('util'); var b = new TextEncoder(s)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
-        {
-            code: "var { TextEncoder } = require('node:util'); var b = new TextEncoder(s)",
-            options: ["always"],
-            errors: [{ messageId: "preferGlobal" }],
-        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `var { TextEncoder } = ${method}('util'); var b = new TextEncoder(s)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextEncoder } = ${method}('node:util'); var b = new TextEncoder(s)`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextEncoder } = ${method}('util'); var b = new TextEncoder(s)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `var { TextEncoder } = ${method}('node:util'); var b = new TextEncoder(s)`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
         {
             code: "var b = new TextEncoder(s)",
             options: ["never"],
diff --git a/tests/lib/rules/prefer-global/url-search-params.js b/tests/lib/rules/prefer-global/url-search-params.js
diff --git a/tests/lib/rules/prefer-global/url.js b/tests/lib/rules/prefer-global/url.js
