[patch] fix sorting with empty comment arrays in JSON

GitHub: fixes #75

Author: electrovir

cspell.config.cjs

@@ -11,5 +11,6 @@ module.exports = {
         'farmerpaul',
         'meriyah',
         'robinfr',
+        'softline',
     ],
 };

src/printer/insert-new-lines.test.ts

@@ -0,0 +1,41 @@
+import {assert} from '@augment-vir/assert';
+import {describe, it} from '@augment-vir/test';
+import {type Doc, doc} from 'prettier';
+import {insertLinesIntoArray} from './insert-new-lines.js';
+
+describe(insertLinesIntoArray.name, () => {
+    it('handles comment-only array doc emitted by Prettier GitHub Issue #75', () => {
+        const commentOnlyArrayDoc: Doc = [
+            '[',
+            [
+                doc.builders.indent([
+                    doc.builders.softline,
+                    [
+                        '// "source.fixAll.eslint",',
+                        [
+                            doc.builders.hardline,
+                            doc.builders.breakParent,
+                        ],
+                        '// "source.fixAll.prettier",',
+                    ],
+                ]),
+                [
+                    doc.builders.hardline,
+                    doc.builders.breakParent,
+                ],
+            ],
+            ']',
+        ];
+
+        assert.strictEquals(
+            insertLinesIntoArray({
+                inputDoc: commentOnlyArrayDoc,
+                manualWrap: false,
+                lineCounts: [],
+                wrapThreshold: Infinity,
+                debug: false,
+            }),
+            commentOnlyArrayDoc,
+        );
+    });
+});

src/printer/insert-new-lines.ts

@@ -17,7 +17,25 @@ const nestingSyntaxClose = ']})`';
 
 const found = 'Found "[" but:';
 
-function insertLinesIntoArray({
+function extractIndentDoc({
+    maybeIndentDoc,
+}: Readonly<{
+    maybeIndentDoc: Doc | undefined;
+}>): ReturnType<typeof doc.builders.indent> | undefined {
+    if (isDocCommand(maybeIndentDoc) && maybeIndentDoc.type === 'indent') {
+        return maybeIndentDoc;
+    } else if (Array.isArray(maybeIndentDoc)) {
+        const firstDoc = maybeIndentDoc[0];
+
+        if (isDocCommand(firstDoc) && firstDoc.type === 'indent') {
+            return firstDoc;
+        }
+    }
+
+    return undefined;
+}
+
+export function insertLinesIntoArray({
     inputDoc,
     manualWrap,
     lineCounts,
@@ -95,20 +113,25 @@ function insertLinesIntoArray({
                     parentDoc[childIndex + 2] = maybeBreak.breakContents;
                 }
                 const indentIndex = childIndex + 1;
-                const bracketSibling =
+                const maybeBracketSibling =
                     parentDoc[indentIndex] === ''
                         ? parentDoc[indentIndex + 1]
                         : parentDoc[indentIndex];
+                const bracketSibling = extractIndentDoc({
+                    maybeIndentDoc: maybeBracketSibling,
+                });
                 if (debug) {
                     console.info({
                         bracketSibling,
                     });
                 }
-                if (bracketSibling === ']') {
+                if (maybeBracketSibling === ']') {
                     return false;
-                } else if (!isDocCommand(bracketSibling) || bracketSibling.type !== 'indent') {
+                } else if (!bracketSibling) {
                     throw new Error(
-                        `${found} its sibling was not an indent Doc.: ${stringify(bracketSibling)}`,
+                        `${found} its sibling was not an indent Doc.: ${stringify(
+                            maybeBracketSibling,
+                        )}`,
                     );
                 }
                 const indentContents = bracketSibling.contents;

src/test/json.test.ts

@@ -345,6 +345,18 @@ const jsonTests: MultilineArrayTest[] = [
             */
         `,
     },
+    {
+        it: 'handles array with only comments GitHub Issue #75',
+        code: `
+            {
+                "editor.codeActionsOnSave": [
+                    // "hello",
+                    // "source.fixAll.eslint",
+                    // "source.fixAll.prettier",
+                ]
+            }
+        `,
+    },
     {
         it: 'basic JSON array',
         code: `