Merge pull request #238 from ttlopes/fix-json-sort

Fix microsoft/vscode#209655: fix case-sensitive JSON sorting error
microsoft · Aug 26, 2024 · bf616c2 · bf616c2
2 parents 24678bd + 6075dba
commit bf616c2
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 0 deletions.
diff --git a/src/test/sort.test.ts b/src/test/sort.test.ts
@@ -1435,4 +1435,52 @@ suite('Sort JSON', () => {
 
         testSort(content, expected, formattingOptions);
     });
+
+    test('sorting a JSON object with mixed case keys', () => {
+        const content = [
+            '{',
+            '  "tEst": "tEst",',
+            '  "tesT": "tesT",',
+            '  "teSt": "teSt",',
+            '  "Test": "Test",',
+            '  "test": "test"',
+            '}'
+        ].join('\n');
+
+        const expected = [
+            '{',
+            '  "Test": "Test",',
+            '  "tEst": "tEst",',
+            '  "teSt": "teSt",',
+            '  "tesT": "tesT",',
+            '  "test": "test"',
+            '}'
+        ].join('\n');
+
+        testSort(content, expected, formattingOptions);
+    });
+
+    test('sorting an already sorted JSON object with mixed case keys', () => {
+        const content = [
+            '{',
+            '  "Test": "Test",',
+            '  "tEst": "tEst",',
+            '  "teSt": "teSt",',
+            '  "tesT": "tesT",',
+            '  "test": "test"',
+            '}'
+        ].join('\n');
+
+        const expected = [
+            '{',
+            '  "Test": "Test",',
+            '  "tEst": "tEst",',
+            '  "teSt": "teSt",',
+            '  "tesT": "tesT",',
+            '  "test": "test"',
+            '}'
+        ].join('\n');
+
+        testSort(content, expected, formattingOptions);
+    });
 });
diff --git a/src/utils/sort.ts b/src/utils/sort.ts
@@ -375,6 +375,14 @@ function sortJsoncDocument(jsonDocument: TextDocument, propertyTree: PropertyTre
     return sortedJsonDocument;
 }
 
+function sortPropertiesCaseSensitive(properties: PropertyTree[]): void {
+    properties.sort((a, b) => {
+        const aName = a.propertyName ?? '';
+        const bName = b.propertyName ?? '';
+        return aName < bName ? -1 : aName > bName ? 1 : 0;
+    });
+}
+
 function updateSortingQueue(queue: any[], propertyTree: PropertyTree, beginningLineNumber: number) {
     if (propertyTree.childrenProperties.length === 0) {
         return;
@@ -389,6 +397,8 @@ function updateSortingQueue(queue: any[], propertyTree: PropertyTree, beginningL
         const diff = minimumBeginningLineNumber - propertyTree.beginningLineNumber!;
         beginningLineNumber = beginningLineNumber + diff;
 
+        sortPropertiesCaseSensitive(propertyTree.childrenProperties);
+
         queue.push(new SortingRange(beginningLineNumber, propertyTree.childrenProperties));
 
     } else if (propertyTree.type === Container.Array) {