Add new ESLint rule: prefer-primordials

[Leko]

Fixed #35449

• Added a new rule for checking access built-in objects
• Fixed lint errors of the rule

Rule option

A rule option has a required key and optional keys

key name	type	required	description	example values
name	string	✔︎	Name of object	Number, Symbol, Array
ignore	string[]	-	List of properties to exclude from the lint targets	stackTraceLimit
into	string	-	Wrapping up in the specified namespace when reporting errors	Number (ex. If this rule find code that is using parseInt globally, it will report const { NumberParseInt } = primordials; ...)

Ignored properties of Error

I marked some of properties of Error as ignored.

Error.stackTraceLimit, Error.captureStackTrace

A lot of tests are failed when I replace these props with primordials.

Error.prepareStackTrace

View failed tests output

=== release test-repl-pretty-custom-stack ===                                 
Path: parallel/test-repl-pretty-custom-stack
/Users/leko/ghq/github.com/Leko/node/test/parallel/test-repl-pretty-custom-stack.js:44
  throw e;
  ^
[AssertionError [ERR_ASSERTION] [ERR_ASSERTION]: Expected values to be strictly equal:


actual - expected


'Uncaught Error: Whoops!\n' +


' at REPL1::\n' +


' at d (REPL1::)\n' +


' at c (REPL1::)\n' +


' at b (REPL1::)\n' +


' at a (REPL1::)\n'



'Uncaught Error: Whoops!--->\n' +
'REPL1::--->\n' +
'd (REPL1::)--->\n' +
'c (REPL1::)--->\n' +
'b (REPL1::)--->\n' +
'a (REPL1::)\n'--->

node:internal/main/runmain_module:17:47--->

Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:72:12)--->

Function.Module._load (node:internal/modules/cjs/loader:778:14)--->

Module.load (node:internal/modules/cjs/loader:937:32)--->

Object.Module._extensions..js (node:internal/modules/cjs/loader:1101:10)--->

Module._compile (node:internal/modules/cjs/loader:1072:30)--->

Object. (/Users/leko/ghq/github.com/Leko/node/test/parallel/test-repl-pretty-custom-stack.js:74:7)--->

Array.forEach ()--->

run (/Users/leko/ghq/github.com/Leko/node/test/parallel/test-repl-pretty-custom-stack.js:27:10)] {

generatedMessage: true,

code: 'ERR_ASSERTION',

actual: 'Uncaught Error: Whoops!\n' +

' at REPL1::\n' +

' at d (REPL1::)\n' +

' at c (REPL1::)\n' +

' at b (REPL1::)\n' +

' at a (REPL1::)\n',

expected: 'Uncaught Error: Whoops!--->\n' +

'REPL1::--->\n' +

'd (REPL1::)--->\n' +

'c (REPL1::)--->\n' +

'b (REPL1::)--->\n' +

'a (REPL1::_)\n',

operator: 'strictEqual'

}

Error.isPrototypeOf

View failed tests output

=== release test-assert-async ===                                             
Path: parallel/test-assert-async
node:internal/process/promises:218
          triggerUncaughtException(err, true /* fromPromise */);
          ^
AssertionError [ERR_ASSERTION]: TypeError is not instance of AssertionError

at Object.handler2 (/Users/leko/ghq/github.com/Leko/node/test/parallel/test-assert-async.js:202:5)

at Object. (/Users/leko/ghq/github.com/Leko/node/test/common/index.js:361:15)

at expectedException (node:assert:656:26)

at expectsError (node:assert:781:3)

at Function.rejects (node:assert:834:3)

at async Promise.all (index 20) {

generatedMessage: false,

code: 'ERR_ASSERTION',

actual: false,

expected: true,

operator: '=='

}

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• tests and/or benchmarks are included
• commit message follows commit guidelines

[targos]

I'm +1 on this. It should be doable after #35499

[Leko]

@targos Thank you for the information! I'll check your PR and mark this PR as ready for review when #35499 is merged.

[codecov-io]

Codecov Report

Merging #35448 into master will decrease coverage by 0.47%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #35448      +/-   ##
==========================================
- Coverage   96.87%   96.40%   -0.48%     
==========================================
  Files         212      220       +8     
  Lines       69641    73735    +4094     
==========================================
+ Hits        67466    71085    +3619     
- Misses       2175     2650     +475     

Impacted Files	Coverage Δ
lib/internal/crypto/scrypt.js	28.33% <0.00%> (-71.67%)	⬇️
lib/internal/crypto/diffiehellman.js	92.47% <0.00%> (-6.50%)	⬇️
lib/internal/crypto/keys.js	94.99% <0.00%> (-4.22%)	⬇️
lib/internal/crypto/util.js	96.79% <0.00%> (-3.21%)	⬇️
lib/internal/crypto/sig.js	97.54% <0.00%> (-2.46%)	⬇️
lib/internal/source_map/prepare_stack_trace.js	94.95% <0.00%> (-1.69%)	⬇️
lib/internal/crypto/keygen.js	99.20% <0.00%> (-0.49%)	⬇️
lib/internal/modules/cjs/loader.js	94.39% <0.00%> (-0.28%)	⬇️
lib/_http_server.js	98.34% <0.00%> (-0.19%)	⬇️
lib/fs.js	94.13% <0.00%> (-0.13%)	⬇️
... and 57 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c8b950a...a2f6630. Read the comment docs.

[DerekNonGeneric]

Just wanted to say thanks for doing this. Definitely +1, but don't have time for a proper review at the moment. Very happy to see this!

[targos]

LGTM based on the added unit tests and changes in lib. I am not familiar with writing ESLint rules.

[Leko]

@nodejs/collaborators Could you help me with reviewing this PR?

[aduh95]

LGTM, let's land this! 🎉

[Leko]

I found a new lint error while landing. I fixed the error.
Object.freeze in the #35915

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/34153/

[Leko]

Landed in cef1444

[ExE-Boss]

JSON, Math and Reflect don’t actually exist on primordials, only their methods.

---

I’m fixing that in #36016.