mirror of
https://github.com/nodejs/node.git
synced 2025-08-15 13:48:44 +02:00
tools: add ESLint rule no-array-destructuring
Iterating over arrays should be avoided because it relies on user-mutable global methods (`Array.prototype[Symbol.iterator]` and `%ArrayIteratorPrototype%.next`), we should instead use other alternatives. This commit adds a rule that disallow array destructuring syntax in favor of object destructuring syntax. Note that you can ignore this rule if you are using the array destructuring syntax over a safe iterable, or actually want to iterate over a user-provided object. PR-URL: https://github.com/nodejs/node/pull/36818 Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
parent
f34d8de65a
commit
26288ff25e
3 changed files with 225 additions and 0 deletions
141
test/parallel/test-eslint-no-array-destructuring.js
Normal file
141
test/parallel/test-eslint-no-array-destructuring.js
Normal file
|
@ -0,0 +1,141 @@
|
|||
'use strict';
|
||||
|
||||
const common = require('../common');
|
||||
if (!common.hasCrypto)
|
||||
common.skip('missing crypto');
|
||||
|
||||
common.skipIfEslintMissing();
|
||||
|
||||
const { RuleTester } = require('../../tools/node_modules/eslint');
|
||||
const rule = require('../../tools/eslint-rules/no-array-destructuring');
|
||||
|
||||
const USE_OBJ_DESTRUCTURING =
|
||||
'Use object destructuring instead of array destructuring.';
|
||||
const USE_ARRAY_METHODS =
|
||||
'Use primordials.ArrayPrototypeSlice to avoid unsafe array iteration.';
|
||||
|
||||
new RuleTester({
|
||||
parserOptions: { ecmaVersion: 2021 },
|
||||
env: { es6: true }
|
||||
})
|
||||
.run('no-array-destructuring', rule, {
|
||||
valid: [
|
||||
'const first = [1, 2, 3][0];',
|
||||
'const {0:first} = [1, 2, 3];',
|
||||
'({1:elem} = array);',
|
||||
'function name(param, { 0: key, 1: value },) {}',
|
||||
],
|
||||
invalid: [
|
||||
{
|
||||
code: 'const [Array] = args;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'const {0:Array} = args;'
|
||||
},
|
||||
{
|
||||
code: 'const [ , res] = args;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'const { 1:res} = args;',
|
||||
},
|
||||
{
|
||||
code: '[, elem] = options;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: '({ 1:elem} = options);',
|
||||
},
|
||||
{
|
||||
code: 'const {values:[elem]} = options;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'const {values:{0:elem}} = options;',
|
||||
},
|
||||
{
|
||||
code: '[[[elem]]] = options;',
|
||||
errors: [
|
||||
{ message: USE_OBJ_DESTRUCTURING },
|
||||
{ message: USE_OBJ_DESTRUCTURING },
|
||||
{ message: USE_OBJ_DESTRUCTURING },
|
||||
],
|
||||
output: '({0:[[elem]]} = options);',
|
||||
},
|
||||
{
|
||||
code: '[, ...rest] = options;',
|
||||
errors: [{ message: USE_ARRAY_METHODS }],
|
||||
},
|
||||
{
|
||||
code: 'for(const [key, value] of new Map);',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'for(const {0:key, 1:value} of new Map);',
|
||||
},
|
||||
{
|
||||
code: 'let [first,,,fourth] = array;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'let {0:first,3:fourth} = array;',
|
||||
},
|
||||
{
|
||||
code: 'let [,second,,fourth] = array;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'let {1:second,3:fourth} = array;',
|
||||
},
|
||||
{
|
||||
code: 'let [ ,,,fourth ] = array;',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'let { 3:fourth } = array;',
|
||||
},
|
||||
{
|
||||
code: 'let [,,,fourth, fifth,, minorFall, majorLift,...music] = arr;',
|
||||
errors: [{ message: USE_ARRAY_METHODS }],
|
||||
},
|
||||
{
|
||||
code: 'function map([key, value]) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'function map({0:key, 1:value}) {}',
|
||||
},
|
||||
{
|
||||
code: 'function map([key, value],) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'function map({0:key, 1:value},) {}',
|
||||
},
|
||||
{
|
||||
code: '(function([key, value]) {})',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: '(function({0:key, 1:value}) {})',
|
||||
},
|
||||
{
|
||||
code: '(function([key, value] = [null, 0]) {})',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: '(function({0:key, 1:value} = [null, 0]) {})',
|
||||
},
|
||||
{
|
||||
code: 'function map([key, ...values]) {}',
|
||||
errors: [{ message: USE_ARRAY_METHODS }],
|
||||
},
|
||||
{
|
||||
code: 'function map([key, value], ...args) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'function map({0:key, 1:value}, ...args) {}',
|
||||
},
|
||||
{
|
||||
code: 'async function map([key, value], ...args) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'async function map({0:key, 1:value}, ...args) {}',
|
||||
},
|
||||
{
|
||||
code: 'async function* generator([key, value], ...args) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'async function* generator({0:key, 1:value}, ...args) {}',
|
||||
},
|
||||
{
|
||||
code: 'function* generator([key, value], ...args) {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'function* generator({0:key, 1:value}, ...args) {}',
|
||||
},
|
||||
{
|
||||
code: 'const cb = ([key, value], ...args) => {}',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'const cb = ({0:key, 1:value}, ...args) => {}',
|
||||
},
|
||||
{
|
||||
code: 'class name{ method([key], ...args){} }',
|
||||
errors: [{ message: USE_OBJ_DESTRUCTURING }],
|
||||
output: 'class name{ method({0:key}, ...args){} }',
|
||||
},
|
||||
]
|
||||
});
|
Loading…
Add table
Add a link
Reference in a new issue