node/test/parallel/test-eslint-prefer-primordials.js
Leko cef144421c tools: add new ESLint rule: prefer-primordials
I added a new custom ESLint rule to fix these problems.

We have a lot of replaceable codes with primordials.
Accessing built-in objects is restricted by existing rule
(no-restricted-globals), but accessing property in the built-in objects
is not restricted right now. We manually review codes that can be
replaced by primordials, but there's a lot of code that actually needs
to be fixed. We have often made pull requests to replace the primordials
with.

Restrict accessing global built-in objects such as `Promise`.
Restrict calling static methods such as `Array.from` or `Symbol.for`.
Don't restrict prototype methods to prevent false-positive.

PR-URL: https://github.com/nodejs/node/pull/35448
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
2020-11-07 18:28:14 +08:00

159 lines
4.6 KiB
JavaScript

'use strict';
const common = require('../common');
if (!common.hasCrypto)
common.skip('missing crypto');
common.skipIfEslintMissing();
const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
const rule = require('../../tools/eslint-rules/prefer-primordials');
new RuleTester({
parserOptions: { ecmaVersion: 6 },
env: { es6: true }
})
.run('prefer-primordials', rule, {
valid: [
'new Array()',
'JSON.stringify({})',
'class A { *[Symbol.iterator] () { yield "a"; } }',
'const a = { *[Symbol.iterator] () { yield "a"; } }',
'Object.defineProperty(o, Symbol.toStringTag, { value: "o" })',
'parseInt("10")',
`
const { Reflect } = primordials;
module.exports = function() {
const { ownKeys } = Reflect;
}
`,
{
code: 'const { Array } = primordials; new Array()',
options: [{ name: 'Array' }]
},
{
code: 'const { JSONStringify } = primordials; JSONStringify({})',
options: [{ name: 'JSON' }]
},
{
code: 'const { SymbolFor } = primordials; SymbolFor("xxx")',
options: [{ name: 'Symbol' }]
},
{
code: `
const { SymbolIterator } = primordials;
class A { *[SymbolIterator] () { yield "a"; } }
`,
options: [{ name: 'Symbol' }]
},
{
code: `
const { Symbol } = primordials;
const a = { *[Symbol.iterator] () { yield "a"; } }
`,
options: [{ name: 'Symbol', ignore: ['iterator'] }]
},
{
code: `
const { ObjectDefineProperty, Symbol } = primordials;
ObjectDefineProperty(o, Symbol.toStringTag, { value: "o" })
`,
options: [{ name: 'Symbol', ignore: ['toStringTag'] }]
},
{
code: 'const { Symbol } = primordials; Symbol.for("xxx")',
options: [{ name: 'Symbol', ignore: ['for'] }]
},
{
code: 'const { NumberParseInt } = primordials; NumberParseInt("xxx")',
options: [{ name: 'parseInt' }]
},
{
code: `
const { ReflectOwnKeys } = primordials;
module.exports = function() {
ReflectOwnKeys({})
}
`,
options: [{ name: 'Reflect' }],
},
],
invalid: [
{
code: 'new Array()',
options: [{ name: 'Array' }],
errors: [{ message: /const { Array } = primordials/ }]
},
{
code: 'JSON.parse("{}")',
options: [{ name: 'JSON' }],
errors: [
{ message: /const { JSONParse } = primordials/ },
]
},
{
code: 'const { JSON } = primordials; JSON.parse("{}")',
options: [{ name: 'JSON' }],
errors: [{ message: /const { JSONParse } = primordials/ }]
},
{
code: 'Symbol.for("xxx")',
options: [{ name: 'Symbol' }],
errors: [
{ message: /const { SymbolFor } = primordials/ },
]
},
{
code: 'const { Symbol } = primordials; Symbol.for("xxx")',
options: [{ name: 'Symbol' }],
errors: [{ message: /const { SymbolFor } = primordials/ }]
},
{
code: `
const { Symbol } = primordials;
class A { *[Symbol.iterator] () { yield "a"; } }
`,
options: [{ name: 'Symbol' }],
errors: [{ message: /const { SymbolIterator } = primordials/ }]
},
{
code: `
const { Symbol } = primordials;
const a = { *[Symbol.iterator] () { yield "a"; } }
`,
options: [{ name: 'Symbol' }],
errors: [{ message: /const { SymbolIterator } = primordials/ }]
},
{
code: `
const { ObjectDefineProperty, Symbol } = primordials;
ObjectDefineProperty(o, Symbol.toStringTag, { value: "o" })
`,
options: [{ name: 'Symbol' }],
errors: [{ message: /const { SymbolToStringTag } = primordials/ }]
},
{
code: `
const { Number } = primordials;
Number.parseInt('10')
`,
options: [{ name: 'Number', into: Number }],
errors: [{ message: /const { NumberParseInt } = primordials/ }]
},
{
code: 'parseInt("10")',
options: [{ name: 'parseInt', into: 'Number' }],
errors: [{ message: /const { NumberParseInt } = primordials/ }]
},
{
code: `
module.exports = function() {
const { ownKeys } = Reflect;
}
`,
options: [{ name: 'Reflect' }],
errors: [{ message: /const { ReflectOwnKeys } = primordials/ }]
},
]
});