Merge pull request #255 from microsoft/awful-ptarmigan

JSON sort: sort symbols first, then lower case, then upper case

Author: aiday-mar

src/test/sort.test.ts

@@ -1449,11 +1449,11 @@ suite('Sort JSON', () => {
 
         const expected = [
             '{',
-            '  "Test": "Test",',
-            '  "tEst": "tEst",',
-            '  "teSt": "teSt",',
+            '  "test": "test",',
             '  "tesT": "tesT",',
-            '  "test": "test"',
+            '  "teSt": "teSt",',
+            '  "tEst": "tEst",',
+            '  "Test": "Test"',
             '}'
         ].join('\n');
 
@@ -1463,21 +1463,41 @@ suite('Sort JSON', () => {
     test('sorting an already sorted JSON object with mixed case keys', () => {
         const content = [
             '{',
-            '  "Test": "Test",',
-            '  "tEst": "tEst",',
-            '  "teSt": "teSt",',
+            '  "test": "test",',
             '  "tesT": "tesT",',
-            '  "test": "test"',
+            '  "teSt": "teSt",',
+            '  "tEst": "tEst",',
+            '  "Test": "Test"',
             '}'
         ].join('\n');
 
         const expected = [
             '{',
-            '  "Test": "Test",',
-            '  "tEst": "tEst",',
-            '  "teSt": "teSt",',
+            '  "test": "test",',
             '  "tesT": "tesT",',
-            '  "test": "test"',
+            '  "teSt": "teSt",',
+            '  "tEst": "tEst",',
+            '  "Test": "Test"',
+            '}'
+        ].join('\n');
+
+        testSort(content, expected, formattingOptions);
+    });
+
+    test('sorting symbols before letters', () => {
+        const content = [
+            '{',
+            '  "Test": "Test",',
+            '  "test": "test",',
+            '  "[test]: "test',
+            '}'
+        ].join('\n');
+
+        const expected = [
+            '{',
+            '  "[test]: "test,',
+            '  "test": "test",',
+            '  "Test": "Test"',
             '}'
         ].join('\n');
 

src/utils/sort.ts

@@ -375,12 +375,8 @@ 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 sortProperties(properties: PropertyTree[]): void {
+    properties.sort((a, b) => a.propertyName.localeCompare(b.propertyName));
 }
 
 function updateSortingQueue(queue: any[], propertyTree: PropertyTree, beginningLineNumber: number) {
@@ -397,7 +393,7 @@ function updateSortingQueue(queue: any[], propertyTree: PropertyTree, beginningL
         const diff = minimumBeginningLineNumber - propertyTree.beginningLineNumber!;
         beginningLineNumber = beginningLineNumber + diff;
 
-        sortPropertiesCaseSensitive(propertyTree.childrenProperties);
+        sortProperties(propertyTree.childrenProperties);
 
         queue.push(new SortingRange(beginningLineNumber, propertyTree.childrenProperties));