Added preserve multiline option to talonFormatter

Author: AndreasArvidsson

README.md

@@ -34,6 +34,7 @@ Supported `.editorconfig` properties:
 | `indent_size`          | Set indentation width               | `4`      |
 | `max_line_length`      | Set preferred maximum line width    | `80`     |
 | `insert_final_newline` | Ensure the file ends with a newline | `true`   |
+| `preserve_multiline`   | Keep existing multi-line formatting | `false`  |
 | `column_width`         | Set aligned left-column width       |          |
 
 Use `--` to mark the end of options. Any following arguments are treated as

src/talon/talonFormatter.ts

@@ -15,6 +15,7 @@ interface Options {
     readonly lineWidth?: number;
     readonly columnWidth?: number;
     readonly insertFinalNewline?: boolean;
+    readonly preserveMultiline?: boolean;
 }
 
 export function talonFormatter(node: Node, options: Options = {}): string {
@@ -27,6 +28,7 @@ export function talonFormatter(node: Node, options: Options = {}): string {
         options.lineWidth ?? DEFAULT_LINE_WIDTH,
         columnWidth,
         options.insertFinalNewline ?? DEFAULT_INSERT_FINAL_NEWLINE,
+        options.preserveMultiline ?? false,
     );
     return formatter.getText(node);
 }
@@ -40,6 +42,7 @@ class TalonFormatter {
         private lineWidth: number,
         private columnWidth: number | undefined,
         private insertFinalNewline: boolean,
+        private preserveMultiline: boolean,
     ) {}
 
     getText(node: Node): string {
@@ -56,20 +59,30 @@ class TalonFormatter {
         return nodeText;
     }
 
-    private getLeftRightText(node: Node): string {
+    private getLeftRightText(node: Node, forceMultiline: boolean): string {
         const [leftNode, _colonNode, ...rightNodes] = node.children;
         const left = this.getNodeText(leftNode);
 
-        if (rightNodes.length === 1) {
-            if (isLeftRightSingleLine(leftNode, rightNodes)) {
+        if (!forceMultiline && rightNodes.length === 1) {
+            if (
+                !this.preserveMultiline ||
+                isLeftRightSingleLine(leftNode, rightNodes)
+            ) {
+                const lastRow = this.lastRow;
                 const right = this.getNodeText(rightNodes[0]);
-                const leftWithPadding =
-                    this.columnWidth != null
-                        ? `${left}: `.padEnd(this.columnWidth)
-                        : `${left}: `;
-                if (leftWithPadding.length + right.length <= this.lineWidth) {
-                    return leftWithPadding + right;
+                if (!right.includes(this.eol)) {
+                    const leftWithPadding =
+                        this.columnWidth != null
+                            ? `${left}: `.padEnd(this.columnWidth)
+                            : `${left}: `;
+                    if (
+                        leftWithPadding.length + right.length <=
+                        this.lineWidth
+                    ) {
+                        return leftWithPadding + right;
+                    }
                 }
+                this.lastRow = lastRow;
             }
         }
 
@@ -135,8 +148,10 @@ class TalonFormatter {
             case "face_declaration":
             case "gamepad_declaration":
             case "deck_declaration":
+                return this.getLeftRightText(node, false);
+
             case "settings_declaration":
-                return this.getLeftRightText(node);
+                return this.getLeftRightText(node, true);
 
             case "comment": {
                 // When using crlf eol comments have a trailing `\r`

src/test/talonFormatter.test.ts

@@ -194,6 +194,7 @@ suite("Talon formatter", () => {
 
         const actual = talonFormatter(rootNode, {
             endOfLine: "crlf",
+            preserveMultiline: true,
         });
 
         assert.equal(actual, "foo:\r\n    edit.left()\r\n");
@@ -207,6 +208,7 @@ suite("Talon formatter", () => {
 
         const actual = talonFormatter(rootNode, {
             indentTabs: true,
+            preserveMultiline: true,
         });
 
         assert.equal(actual, "foo:\n\tedit.left()\n");
@@ -220,6 +222,7 @@ suite("Talon formatter", () => {
 
         const actual = talonFormatter(rootNode, {
             indentWidth: 2,
+            preserveMultiline: true,
         });
 
         assert.equal(actual, "foo:\n  edit.left()\n");
@@ -235,7 +238,7 @@ suite("Talon formatter", () => {
             insertFinalNewline: false,
         });
 
-        assert.equal(actual, "foo:\n    edit.left()");
+        assert.equal(actual, "foo: edit.left()");
     });
 
     test("lineWidth: 7", async () => {
@@ -256,6 +259,16 @@ suite("Talon formatter", () => {
 
         assert.equal(actual, `foo:\n    ${right}\n`);
     });
+
+    test("preserveMultiline: true", async () => {
+        const rootNode = await parseText("aaa:\n    bbb", "tree-sitter-talon");
+
+        const actual = talonFormatter(rootNode, {
+            preserveMultiline: true,
+        });
+
+        assert.equal(actual, "aaa:\n    bbb\n");
+    });
 });
 
 function getContentString(content: Content): string {

src/types.ts

@@ -21,6 +21,7 @@ export interface Options {
     maxLineLength?: number;
     columnWidth?: number;
     insertFinalNewline?: boolean;
+    preserveMultiline?: boolean;
 }
 
 export interface ParsedArgs {
@@ -34,4 +35,5 @@ export interface ParsedArgs {
 export interface EditorConfigOptions extends KnownProps {
     max_line_length?: number | "unset";
     column_width?: number | "unset";
+    preserve_multiline?: boolean | "unset";
 }

src/util/getOptionsFromConfig.ts

@@ -29,15 +29,16 @@ export async function getOptionsFromConfig(filePath: string): Promise<Options> {
         options.columnWidth = config.column_width;
     }
 
-    if (config.end_of_line != null && config.end_of_line !== "unset") {
-        options.endOfLine = config.end_of_line;
+    if (typeof config.insert_final_newline === "boolean") {
+        options.insertFinalNewline = config.insert_final_newline;
     }
 
-    if (
-        config.insert_final_newline != null &&
-        config.insert_final_newline !== "unset"
-    ) {
-        options.insertFinalNewline = config.insert_final_newline;
+    if (typeof config.preserve_multiline === "boolean") {
+        options.preserveMultiline = config.preserve_multiline;
+    }
+
+    if (config.end_of_line != null && config.end_of_line !== "unset") {
+        options.endOfLine = config.end_of_line;
     }
 
     return options;