Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 74 additions & 22 deletions src/rules/sort-keys.js
Original file line number Diff line number Diff line change
Expand Up @@ -215,23 +215,20 @@ const rule = {

return {
Object(node) {
if (node.members.length < minKeys) {
return;
}

/** @type {MemberNode} */
let prevMember;
/** @type {string} */
let prevName;
/** @type {string} */
let prevRawName;

if (node.members.length < minKeys) {
return;
}

for (const member of node.members) {
const thisName = getKey(member);
const thisRawName = getRawKey(member, sourceCode);
// Capture `prevMember` for this iteration so the fixer closure uses the
// intended node even though `prevMember` is reassigned in the loop.
const prevMemberNode = prevMember;

if (
prevMember &&
Expand All @@ -250,25 +247,80 @@ const rule = {
sortName,
},
fix(fixer) {
if (
hasAdjacentComment(member) ||
hasAdjacentComment(prevMemberNode)
) {
return null;
let group = node.members;

if (allowLineSeparatedGroups) {
let start = node.members.indexOf(member);
while (
start > 0 &&
!isLineSeparated(
node.members[start - 1],
node.members[start],
)
) {
start--;
}
let end = node.members.indexOf(member);
while (
end < node.members.length - 1 &&
!isLineSeparated(
node.members[end],
node.members[end + 1],
)
) {
end++;
}
group = node.members.slice(start, end + 1);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for other reviewers: This would change the current behavior of reporting every unsorted key but only fixing the first group (because of the break after the context.report). I think this behavior is okay as the other groups will be fixed in subsequent rounds. The alternative would be to group everything and do the fixes for every group.

}

return [
fixer.replaceText(
member,
sourceCode.getText(prevMemberNode),
),
fixer.replaceText(
prevMemberNode,
sourceCode.getText(member),
),
];
const sortedGroup = group.toSorted((a, b) => {
const nameA = getKey(a);
const nameB = getKey(b);

if (nameA === nameB) {
Comment thread
crimsonjay0 marked this conversation as resolved.
return 0;
}

const aFirst = isValidOrder(nameA, nameB);
const bFirst = isValidOrder(nameB, nameA);

if (aFirst && bFirst) {
return 0;
}
return aFirst ? -1 : 1;
});

const fixes = [];
for (let i = 0; i < group.length; i++) {
const origMember = group[i];
const replacementMember = sortedGroup[i];

if (origMember === replacementMember) {
continue;
}

if (
hasAdjacentComment(origMember) ||
hasAdjacentComment(replacementMember)
) {
return null;
}

fixes.push(
fixer.replaceText(
origMember,
sourceCode.getText(
replacementMember,
),
),
);
}

return fixes;
},
});

break;
}

prevMember = member;
Expand Down
Loading