Files
eslint/tests/lib/rules/prefer-destructuring.js

815 lines
16 KiB
JavaScript

/**
* @fileoverview Prefer destructuring from arrays and objects
* @author Alex LaFroscia
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/prefer-destructuring"),
RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({ languageOptions: { ecmaVersion: 2022 } });
ruleTester.run("prefer-destructuring", rule, {
valid: [
"var [foo] = array;",
"var { foo } = object;",
"var foo;",
{
// Ensure that the default behavior does not require destructuring when renaming
code: "var foo = object.bar;",
options: [{ VariableDeclarator: { object: true } }],
},
{
// Ensure that the default behavior does not require destructuring when renaming
code: "var foo = object.bar;",
options: [{ object: true }],
},
{
code: "var foo = object.bar;",
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: false },
],
},
{
code: "var foo = object.bar;",
options: [{ object: true }, { enforceForRenamedProperties: false }],
},
{
code: "var foo = object['bar'];",
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: false },
],
},
{
code: "var foo = object[bar];",
options: [{ object: true }, { enforceForRenamedProperties: false }],
},
{
code: "var { bar: foo } = object;",
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: true },
],
},
{
code: "var { bar: foo } = object;",
options: [{ object: true }, { enforceForRenamedProperties: true }],
},
{
code: "var { [bar]: foo } = object;",
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: true },
],
},
{
code: "var { [bar]: foo } = object;",
options: [{ object: true }, { enforceForRenamedProperties: true }],
},
{
code: "var foo = array[0];",
options: [{ VariableDeclarator: { array: false } }],
},
{
code: "var foo = array[0];",
options: [{ array: false }],
},
{
code: "var foo = object.foo;",
options: [{ VariableDeclarator: { object: false } }],
},
{
code: "var foo = object['foo'];",
options: [{ VariableDeclarator: { object: false } }],
},
"({ foo } = object);",
{
// Fix #8654
code: "var foo = array[0];",
options: [
{ VariableDeclarator: { array: false } },
{ enforceForRenamedProperties: true },
],
},
{
// Fix #8654
code: "var foo = array[0];",
options: [{ array: false }, { enforceForRenamedProperties: true }],
},
"[foo] = array;",
"foo += array[0]",
{
code: "foo &&= array[0]",
languageOptions: { ecmaVersion: 2021 },
},
"foo += bar.foo",
{
code: "foo ||= bar.foo",
languageOptions: { ecmaVersion: 2021 },
},
{
code: "foo ??= bar['foo']",
languageOptions: { ecmaVersion: 2021 },
},
{
code: "foo = object.foo;",
options: [
{ AssignmentExpression: { object: false } },
{ enforceForRenamedProperties: true },
],
},
{
code: "foo = object.foo;",
options: [
{ AssignmentExpression: { object: false } },
{ enforceForRenamedProperties: false },
],
},
{
code: "foo = array[0];",
options: [
{ AssignmentExpression: { array: false } },
{ enforceForRenamedProperties: true },
],
},
{
code: "foo = array[0];",
options: [
{ AssignmentExpression: { array: false } },
{ enforceForRenamedProperties: false },
],
},
{
code: "foo = array[0];",
options: [
{
VariableDeclarator: { array: true },
AssignmentExpression: { array: false },
},
{ enforceForRenamedProperties: false },
],
},
{
code: "var foo = array[0];",
options: [
{
VariableDeclarator: { array: false },
AssignmentExpression: { array: true },
},
{ enforceForRenamedProperties: false },
],
},
{
code: "foo = object.foo;",
options: [
{
VariableDeclarator: { object: true },
AssignmentExpression: { object: false },
},
],
},
{
code: "var foo = object.foo;",
options: [
{
VariableDeclarator: { object: false },
AssignmentExpression: { object: true },
},
],
},
"class Foo extends Bar { static foo() {var foo = super.foo} }",
"foo = bar[foo];",
"var foo = bar[foo];",
{
code: "var {foo: {bar}} = object;",
options: [{ object: true }],
},
{
code: "var {bar} = object.foo;",
options: [{ object: true }],
},
// Optional chaining
"var foo = array?.[0];", // because the fixed code can throw TypeError.
"var foo = object?.foo;",
// Private identifiers
"class C { #x; foo() { const x = this.#x; } }",
"class C { #x; foo() { x = this.#x; } }",
"class C { #x; foo(a) { x = a.#x; } }",
{
code: "class C { #x; foo() { const x = this.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo() { const y = this.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo() { x = this.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo() { y = this.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo(a) { x = a.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo(a) { y = a.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "class C { #x; foo() { x = this.a.#x; } }",
options: [
{ array: true, object: true },
{ enforceForRenamedProperties: true },
],
},
{
code: "using foo = array[0];",
languageOptions: {
sourceType: "module",
ecmaVersion: 2026,
},
},
{
code: "using foo = object.foo;",
languageOptions: {
sourceType: "module",
ecmaVersion: 2026,
},
},
{
code: "await using foo = array[0];",
languageOptions: {
sourceType: "module",
ecmaVersion: 2026,
},
},
{
code: "await using foo = object.foo;",
languageOptions: {
sourceType: "module",
ecmaVersion: 2026,
},
},
],
invalid: [
{
code: "var foo = array[0];",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "foo = array[0];",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "var foo = object.foo;",
output: "var {foo} = object;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (a, b).foo;",
output: "var {foo} = (a, b);",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var length = (() => {}).length;",
output: "var {length} = () => {};",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (a = b).foo;",
output: "var {foo} = a = b;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (a || b).foo;",
output: "var {foo} = a || b;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (f()).foo;",
output: "var {foo} = f();",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.bar.foo;",
output: "var {foo} = object.bar;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foobar = object.bar;",
output: null,
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: true },
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foobar = object.bar;",
output: null,
options: [{ object: true }, { enforceForRenamedProperties: true }],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object[bar];",
output: null,
options: [
{ VariableDeclarator: { object: true } },
{ enforceForRenamedProperties: true },
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object[bar];",
output: null,
options: [{ object: true }, { enforceForRenamedProperties: true }],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object[foo];",
output: null,
options: [{ object: true }, { enforceForRenamedProperties: true }],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object['foo'];",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "foo = object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "foo = object['foo'];",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = array[0];",
output: null,
options: [
{ VariableDeclarator: { array: true } },
{ enforceForRenamedProperties: true },
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "foo = array[0];",
output: null,
options: [{ AssignmentExpression: { array: true } }],
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "var foo = array[0];",
output: null,
options: [
{
VariableDeclarator: { array: true },
AssignmentExpression: { array: false },
},
{ enforceForRenamedProperties: true },
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "var foo = array[0];",
output: null,
options: [
{
VariableDeclarator: { array: true },
AssignmentExpression: { array: false },
},
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "foo = array[0];",
output: null,
options: [
{
VariableDeclarator: { array: false },
AssignmentExpression: { array: true },
},
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "array" },
},
],
},
{
code: "foo = object.foo;",
output: null,
options: [
{
VariableDeclarator: { array: true, object: false },
AssignmentExpression: { object: true },
},
],
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "class Foo extends Bar { static foo() {var bar = super.foo.bar} }",
output: "class Foo extends Bar { static foo() {var {bar} = super.foo} }",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
// comments
{
code: "var /* comment */ foo = object.foo;",
output: "var /* comment */ {foo} = object;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var a, /* comment */foo = object.foo;",
output: "var a, /* comment */{foo} = object;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo /* comment */ = object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var a, foo /* comment */ = object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo /* comment */ = object.foo, a;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo // comment\n = object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = /* comment */ object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = // comment\n object.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (/* comment */ object).foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (object /* comment */).foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = bar(/* comment */).foo;",
output: "var {foo} = bar(/* comment */);",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = bar/* comment */.baz.foo;",
output: "var {foo} = bar/* comment */.baz;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = bar[// comment\nbaz].foo;",
output: "var {foo} = bar[// comment\nbaz];",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo // comment\n = bar(/* comment */).foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = bar/* comment */.baz/* comment */.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object// comment\n.foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object./* comment */foo;",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (/* comment */ object.foo);",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = (object.foo /* comment */);",
output: null,
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.foo/* comment */;",
output: "var {foo} = object/* comment */;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.foo// comment",
output: "var {foo} = object// comment",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.foo/* comment */, a;",
output: "var {foo} = object/* comment */, a;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.foo// comment\n, a;",
output: "var {foo} = object// comment\n, a;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
{
code: "var foo = object.foo, /* comment */ a;",
output: "var {foo} = object, /* comment */ a;",
errors: [
{
messageId: "preferDestructuring",
data: { type: "object" },
},
],
},
],
});