Skip to content
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

Jump to bottom

Fix: support boundary spread elements in sort-keys #11158

Merged
merged 2 commits into from Feb 15, 2019
Merged

Fix: support boundary spread elements in sort-keys #11158

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f695d2
Fix: support boundary spread elements in sort-keys
P0lip Dec 4, 2018
79484c1
Docs: rename "boundary spread operator" term
P0lip Dec 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/sort-keys.md
View file
Open in desktop
Expand Up @@ -53,7 +53,7 @@ let obj = {a: 1, ["c" + "d"]: 3, b: 2};
let obj = {a: 1, [`${c}`]: 3, b: 2};
let obj = {a: 1, [tag`c`]: 3, b: 2};

// This rule ignores objects that have a spread operator in them.
// This rule ignores objects that have a non-boundary spread operator in them.
P0lip marked this conversation as resolved.
Show resolved Hide resolved
let obj = {b: 1, ...c, a: 2};
```

Expand Down
6 changes: 5 additions & 1 deletion lib/rules/sort-keys.js
View file
Open in desktop
Expand Up @@ -127,8 +127,12 @@ module.exports = {
stack = stack.upper;
},

SpreadElement() {
stack.prevName = null;
},

Property(node) {
if (node.parent.type === "ObjectPattern" || node.parent.properties.some(n => n.type === "SpreadElement")) {
if (node.parent.type === "ObjectPattern") {
return;
}

Expand Down
58 changes: 57 additions & 1 deletion tests/lib/rules/sort-keys.js
View file
Open in desktop
Expand Up @@ -33,9 +33,18 @@ ruleTester.run("sort-keys", rule, {
// ignore non-simple computed properties.
{ code: "var obj = {a:1, b:3, [a + b]: -1, c:2}", options: [], parserOptions: { ecmaVersion: 6 } },

// ignore spread properties.
// ignore non-boundary spread properties.
P0lip marked this conversation as resolved.
Show resolved Hide resolved
{ code: "var obj = {a:1, ...z, b:1}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {b:1, ...z, a:1}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {...a, b:1, ...c, d:1}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {...a, b:1, ...d, ...c, e:2, z:5}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {b:1, ...c, ...d, e:2}", options: [], parserOptions: { ecmaVersion: 2018 } },

// boundary spread properties
{ code: "var obj = {...z, a:1, b:1}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {...z, ...c, a:1, b:1}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {a:1, b:1, ...z}", options: [], parserOptions: { ecmaVersion: 2018 } },
{ code: "var obj = {...z, ...x, a:1, ...c, ...d, f:5, e:4}", options: ["desc"], parserOptions: { ecmaVersion: 2018 } },

// ignore destructuring patterns.
{ code: "let {a, b} = {}", options: [], parserOptions: { ecmaVersion: 6 } },
Expand Down Expand Up @@ -151,6 +160,53 @@ ruleTester.run("sort-keys", rule, {
errors: ["Expected object keys to be in ascending order. 'Z' should be before 'À'."]
},

// not ignore boundary spread properties
P0lip marked this conversation as resolved.
Show resolved Hide resolved
{
code: "var obj = {...z, c:1, b:1}",
options: [],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in ascending order. 'b' should be before 'c'."]
},
{
code: "var obj = {...z, ...c, d:4, b:1, ...y, ...f, e:2, a:1}",
options: [],
parserOptions: { ecmaVersion: 2018 },
errors: [
"Expected object keys to be in ascending order. 'b' should be before 'd'.",
"Expected object keys to be in ascending order. 'a' should be before 'e'."
]
},
{
code: "var obj = {c:1, b:1, ...a}",
options: [],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in ascending order. 'b' should be before 'c'."]
},
{
code: "var obj = {...z, ...a, c:1, b:1}",
options: [],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in ascending order. 'b' should be before 'c'."]
},
{
code: "var obj = {...z, b:1, a:1, ...d, ...c}",
options: [],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in ascending order. 'a' should be before 'b'."]
},
{
code: "var obj = {...z, a:2, b:0, ...x, ...c}",
options: ["desc"],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in descending order. 'b' should be before 'a'."]
},
{
code: "var obj = {...z, a:2, b:0, ...x}",
options: ["desc"],
parserOptions: { ecmaVersion: 2018 },
errors: ["Expected object keys to be in descending order. 'b' should be before 'a'."]
},

// not ignore simple computed properties.
{
code: "var obj = {a:1, b:3, [a]: -1, c:2}",
Expand Down