Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 9, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a1f386
feat(prefer-global): Add support for `process.getBuiltinModule()`
ota-meshi Mar 31, 2025
37ea00d
refactor tests
ota-meshi Apr 14, 2025
32762b5
Merge branch 'master' into prefer-global-get-builtin-module
aladdin-add May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/util/check-prefer-global.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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" })
Expand Down
58 changes: 32 additions & 26 deletions tests/lib/rules/prefer-global/buffer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
58 changes: 32 additions & 26 deletions tests/lib/rules/prefer-global/console.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
42 changes: 25 additions & 17 deletions tests/lib/rules/prefer-global/process.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)",
Expand All @@ -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"],
Expand Down
58 changes: 32 additions & 26 deletions tests/lib/rules/prefer-global/text-decoder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
58 changes: 32 additions & 26 deletions tests/lib/rules/prefer-global/text-encoder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
Loading