Fix some styling bugs

Author: AndreasArvidsson

out/lib.js

@@ -54,6 +54,7 @@ export interface SyntaxNode {
     type: string;
     startPosition: Point;
     endPosition: Point;
+    parent: SyntaxNode | null;
     children: SyntaxNode[];
 }
 export {};

out/snippetFormatter.js

@@ -1,6 +1,6 @@
 {
     "name": "@cursorless/talon-tools",
-    "version": "0.1.10",
+    "version": "0.2.0",
     "description": "Linting and formatting tools for Talon and Cursorless",
     "author": "Cursorless Dev",
     "license": "MIT",

out/talonFormatter.js

@@ -112,14 +112,20 @@ class TalonFormatter {
         return `${nl}${text}`;
     }
 
-    private pairWithChildren(node: SyntaxNode) {
+    private pairWithChildren(
+        node: SyntaxNode,
+        unwrap: boolean = false,
+    ): string {
         const { children } = node;
-        const pre = children[0].text;
-        const post = children[children.length - 1].text;
         const middle = children
             .slice(1, -1)
             .map((n) => this.getNodeText(n))
             .join(" ");
+        if (unwrap) {
+            return middle;
+        }
+        const pre = children[0].text;
+        const post = children[children.length - 1].text;
         return `${pre}${middle}${post}`;
     }
 
@@ -133,7 +139,7 @@ class TalonFormatter {
 
             case "matches": {
                 // There are no match nodes and there is no comment before
-                if (node.children.length < 2 && this.lastRow === 0) {
+                if (node.children.length < 2 && isFirstChild(node)) {
                     return "";
                 }
                 return node.children
@@ -205,6 +211,11 @@ class TalonFormatter {
                 return node.text.trim();
 
             case "parenthesized_rule":
+                return this.pairWithChildren(
+                    node,
+                    node.parent != null && rangeEqual(node, node.parent),
+                );
+
             case "optional":
                 return this.pairWithChildren(node);
 
@@ -254,3 +265,16 @@ function isLeftRightSingleLine(
 ): boolean {
     return left.endPosition.row === rights[rights.length - 1].startPosition.row;
 }
+
+function rangeEqual(a: SyntaxNode, b: SyntaxNode): boolean {
+    return (
+        a.startPosition.row === b.startPosition.row &&
+        a.startPosition.column === b.startPosition.column &&
+        a.endPosition.row === b.endPosition.row &&
+        a.endPosition.column === b.endPosition.column
+    );
+}
+
+function isFirstChild(node: SyntaxNode): boolean {
+    return node.parent?.children.findIndex((n) => n.id === node.id) === 0;
+}

out/treeSitterFormatter.js

@@ -1,7 +1,7 @@
 import * as assert from "node:assert";
 import { snippetFormatter } from "../snippet/snippetFormatter.js";
-
-type Content = string | string[];
+import type { Content } from "./testUtils.js";
+import { getContentString } from "./testUtils.js";
 
 const fixtures: {
     title: string;
@@ -132,7 +132,3 @@ suite("Snippet formatter", () => {
         });
     }
 });
-
-function getContentString(content: Content): string {
-    return Array.isArray(content) ? content.join("\n") : content;
-}

out/types.d.ts

@@ -1,25 +1,57 @@
 import * as assert from "node:assert";
 import { talonFormatter } from "../talon/talonFormatter.js";
-import type { SyntaxNode } from "../types.js";
 import { parseText } from "../util/parseText.js";
-
-type Content = string | string[];
-
-const fixtures: { title: string; pre: Content; post: Content }[] = [
+import type { Content } from "./testUtils.js";
+import {
+    captureStreamWrite,
+    createNode,
+    getContentString,
+} from "./testUtils.js";
+
+const fixtures: {
+    title: string;
+    columnWidth?: number;
+    pre: Content;
+    post: Content;
+}[] = [
     {
-        title: "matchers",
+        title: "Matchers",
         pre: ["app  :  vscode", "", "and  not  mode :  command", "-", ""],
         post: ["app: vscode", "", "and not mode: command", "-", ""],
     },
 
     {
-        title: "command singe line",
+        title: "Command single line",
         pre: "foo  :  edit.left(  )",
-        post: ["foo:                        edit.left()", ""],
+        post: ["foo: edit.left()", ""],
+    },
+
+    {
+        title: "Empty header",
+        pre: "\n-\na:b",
+        post: "a: b\n",
     },
 
     {
-        title: "command multi line",
+        title: "Pipe padding",
+        pre: "a|b:c",
+        post: "a | b: c\n",
+    },
+
+    {
+        title: "Unnecessary parentheses",
+        pre: "(a):b",
+        post: "a: b\n",
+    },
+
+    {
+        title: "Comment before divider",
+        pre: "# a\n-\nb: c",
+        post: "# a\n-\nb: c\n",
+    },
+
+    {
+        title: "Command multi line",
         pre: [
             "foo  : ",
             "  # actions",
@@ -40,7 +72,7 @@ const fixtures: { title: string; pre: Content; post: Content }[] = [
     },
 
     {
-        title: "settings declaration",
+        title: "Settings declaration",
         pre: [
             "settings()  :  ",
             "  speech.timeout  =  0.400",
@@ -57,7 +89,7 @@ const fixtures: { title: string; pre: Content; post: Content }[] = [
     },
 
     {
-        title: "tag/key/gamepad/parrot/face declarations",
+        title: "Tag/key/gamepad/parrot/face declarations",
         pre: [
             "tag()  :  user.some_tag",
             "key( enter )  :  'key'",
@@ -68,19 +100,19 @@ const fixtures: { title: string; pre: Content; post: Content }[] = [
         ],
         post: [
             "tag(): user.some_tag",
-            "key(enter):                 'key'",
-            "gamepad(north):             'gamepad'",
-            "parrot(pop):                'parrot'",
-            "noise(pop):                 'noise'",
-            "face(smile):                'face'",
+            "key(enter): 'key'",
+            "gamepad(north): 'gamepad'",
+            "parrot(pop): 'parrot'",
+            "noise(pop): 'noise'",
+            "face(smile): 'face'",
             "",
         ],
     },
 
     {
         title: "CRLF comment",
         pre: "# Hello\r\nfoo: 'bar'",
-        post: "# Hello\nfoo:                        'bar'\n",
+        post: "# Hello\nfoo: 'bar'\n",
     },
 
     {
@@ -97,6 +129,7 @@ const fixtures: { title: string; pre: Content; post: Content }[] = [
 
     {
         title: "Large file",
+        columnWidth: 28,
         pre: `\
 not   mode  : command
 tag :  stuff
@@ -180,19 +213,13 @@ suite("Talon formatter", () => {
             const content = getContentString(fixture.pre);
             const rootNode = await parseText(content, "tree-sitter-talon");
             const actual = talonFormatter(rootNode, {
-                columnWidth: 28,
+                columnWidth: fixture.columnWidth,
             });
             const expected = getContentString(fixture.post);
             assert.equal(actual, expected);
         });
     }
 
-    test("comment before divider", async () => {
-        const rootNode = await parseText("# a\n-\nb: c", "tree-sitter-talon");
-        const actual = talonFormatter(rootNode);
-        assert.equal(actual, "# a\n-\nb: c\n");
-    });
-
     test("endOfLine: CRLF", async () => {
         const rootNode = await parseText(
             "foo:\n  edit.left()",
@@ -276,40 +303,3 @@ suite("Talon formatter", () => {
         );
     });
 });
-
-function getContentString(content: Content): string {
-    return Array.isArray(content) ? content.join("\n") : content;
-}
-
-function createNode(type: string, text: string): SyntaxNode {
-    return {
-        id: 1,
-        type,
-        text,
-        startPosition: { row: 0, column: 0 },
-        endPosition: { row: 0, column: text.length },
-        children: [],
-    };
-}
-
-async function captureStreamWrite<T>(
-    stream: NodeJS.WriteStream,
-    callback: () => Promise<T> | T,
-): Promise<{ result: T; text: string }> {
-    let text = "";
-    const originalWrite = stream.write.bind(stream);
-
-    (stream.write as unknown as (chunk: string) => boolean) = (
-        chunk: string | Uint8Array,
-    ) => {
-        text += chunk.toString();
-        return true;
-    };
-
-    try {
-        const result = await callback();
-        return { result, text };
-    } finally {
-        stream.write = originalWrite;
-    }
-}