Make formatter options optional

Author: AndreasArvidsson

src/lib/talonFormatter.ts

@@ -1,11 +1,16 @@
 import type { Node } from "web-tree-sitter";
-import type { Options } from "../types.js";
 import { getColumnWidth } from "../util/getColumnWidth.js";
 import { getIndentation } from "../util/getIndentation.js";
 
+interface Options {
+    readonly indentTabs?: boolean;
+    readonly indentWidth?: number;
+    readonly columnWidth?: number;
+}
+
 export function talonFormatter(node: Node, options: Options): string {
     const columnWidth = getColumnWidth(node.text) ?? options.columnWidth;
-    const indentation = getIndentation(options);
+    const indentation = getIndentation(options.indentTabs, options.indentWidth);
     const formatter = new TalonFormatter(indentation, columnWidth);
     return formatter.getText(node);
 }

src/lib/talonListFormatter.ts

@@ -1,7 +1,10 @@
-import type { Options } from "../types.js";
 import { getColumnWidth } from "../util/getColumnWidth.js";
 import { parseTalonList } from "./parseTalonList.js";
 
+interface Options {
+    readonly columnWidth?: number;
+}
+
 export function talonListFormatter(text: string, options: Options): string {
     const columnWidth = getColumnWidth(text) ?? options.columnWidth;
     const talonList = parseTalonList(text);

src/lib/treeSitterFormatter.ts

@@ -1,9 +1,13 @@
 import type { Node } from "web-tree-sitter";
-import type { Options } from "../types.js";
 import { getIndentation } from "../util/getIndentation.js";
 
+interface Options {
+    readonly indentTabs?: boolean;
+    readonly indentWidth?: number;
+}
+
 export function treeSitterFormatter(node: Node, options: Options): string {
-    const indentation = getIndentation(options);
+    const indentation = getIndentation(options.indentTabs, options.indentWidth);
     const formatter = new TreeSitterFormatter(indentation);
     return formatter.getText(node);
 }

src/test/cli.test.ts

@@ -6,10 +6,7 @@ import { PassThrough } from "node:stream";
 import { formatFile, formatFiles, mainFormatStdin } from "../cli/cli.js";
 import type { CLI, Options, ParsedArgs } from "../types.js";
 import { EXIT_FAIL, EXIT_OK } from "../util/constants.js";
-import {
-    getDefaultArguments,
-    getDefaultOptions,
-} from "../util/getDefaultArguments.js";
+import { getDefaultArguments } from "../util/getDefaultArguments.js";
 import { parseArgs } from "../util/parseArgs.js";
 import { printHelp } from "../util/printHelp.js";
 
@@ -23,12 +20,7 @@ suite("CLI", () => {
         const cli = createCLI((text) => `${text} updated`);
 
         try {
-            const didChange = await formatFile(
-                cli,
-                false,
-                getDefaultOptions(),
-                fileName,
-            );
+            const didChange = await formatFile(cli, false, {}, fileName);
             const actual = await fs.readFile(fileName, "utf8");
 
             assert.equal(didChange, true);
@@ -47,12 +39,7 @@ suite("CLI", () => {
         const cli = createCLI((text) => `${text} updated`);
 
         try {
-            const didChange = await formatFile(
-                cli,
-                true,
-                getDefaultOptions(),
-                fileName,
-            );
+            const didChange = await formatFile(cli, true, {}, fileName);
             const actual = await fs.readFile(fileName, "utf8");
 
             assert.equal(didChange, true);
@@ -78,7 +65,7 @@ suite("CLI", () => {
                 cli,
                 [unchangedFileName, changedFileName],
                 false,
-                getDefaultOptions(),
+                {},
             );
             const unchangedContent = await fs.readFile(
                 unchangedFileName,
@@ -98,12 +85,7 @@ suite("CLI", () => {
         const fileName = path.join(os.tmpdir(), "talonfmt-missing.txt");
         const cli = createCLI((text) => `${text} updated`);
 
-        const didChange = await formatFile(
-            cli,
-            false,
-            getDefaultOptions(),
-            fileName,
-        );
+        const didChange = await formatFile(cli, false, {}, fileName);
 
         assert.equal(didChange, false);
     });
@@ -120,7 +102,7 @@ suite("CLI", () => {
 
         try {
             await assert.rejects(
-                formatFile(cli, false, getDefaultOptions(), fileName),
+                formatFile(cli, false, {}, fileName),
                 /Failed to format '.*example\.txt': boom/,
             );
         } finally {
@@ -170,7 +152,6 @@ suite("CLI", () => {
             "content",
         );
         const options = {
-            ...getDefaultOptions(),
             indentTabs: true,
             indentWidth: 2,
             columnWidth: 24,
@@ -204,7 +185,6 @@ suite("CLI", () => {
 
     test("passes options and stdin file name to stdin formatter", async () => {
         const options = {
-            ...getDefaultOptions(),
             indentTabs: true,
             indentWidth: 2,
         };
@@ -266,7 +246,7 @@ suite("CLI", () => {
             check: false,
             indentTabs: true,
             indentWidth: 2,
-            lineWidth: 80,
+            lineWidth: undefined,
             columnWidth: 24,
         });
         const actual = parseArgs(
@@ -428,7 +408,7 @@ async function readAndFormatStdin(
     cli: CLI,
     input: string,
     check: boolean = false,
-    options: Options = getDefaultOptions(),
+    options: Options = {},
 ): Promise<number> {
     const stdin = new PassThrough();
     Object.defineProperty(stdin, "isTTY", { value: false });

src/test/talonFormatter.test.ts

@@ -1,7 +1,6 @@
 import * as assert from "node:assert";
 import { talonFormatter } from "../lib/talonFormatter.js";
 import { parseText } from "../util/parseText.js";
-import { getDefaultOptions } from "../util/getDefaultArguments.js";
 
 type Content = string | string[];
 
@@ -180,7 +179,6 @@ suite("Talon formatter", () => {
             const content = getContentString(fixture.pre);
             const rootNode = await parseText(content, "tree-sitter-talon");
             const actual = talonFormatter(rootNode, {
-                ...getDefaultOptions(),
                 columnWidth: 28,
             });
             const expected = getContentString(fixture.post);
@@ -195,7 +193,6 @@ suite("Talon formatter", () => {
         );
 
         const actual = talonFormatter(rootNode, {
-            ...getDefaultOptions(),
             indentTabs: true,
         });
 

src/test/talonListFormatter.test.ts

@@ -1,6 +1,5 @@
 import * as assert from "node:assert";
 import { talonListFormatter } from "../lib/talonListFormatter.js";
-import { getDefaultOptions } from "../util/getDefaultArguments.js";
 
 const fixtures: {
     title: string;
@@ -60,7 +59,6 @@ suite("Talon list formatter", () => {
     for (const fixture of fixtures) {
         test(fixture.title, () => {
             const actual = talonListFormatter(fixture.pre, {
-                ...getDefaultOptions(),
                 columnWidth: 10,
             });
             assert.equal(actual, fixture.post);

src/test/treeSitterFormatter.test.ts

@@ -1,7 +1,6 @@
 import * as assert from "node:assert";
 import { treeSitterFormatter } from "../lib/treeSitterFormatter.js";
 import { parseText } from "../util/parseText.js";
-import { getDefaultOptions } from "../util/getDefaultArguments.js";
 
 type Content = string | string[];
 
@@ -103,7 +102,7 @@ suite("Tree-sitter formatter", () => {
         test(fixture.title, async () => {
             const content = getContentString(fixture.pre);
             const rootNode = await parseText(content, "tree-sitter-query");
-            const actual = treeSitterFormatter(rootNode, getDefaultOptions());
+            const actual = treeSitterFormatter(rootNode, {});
             const expected = getContentString(fixture.post);
             assert.equal(actual, expected);
         });
@@ -113,7 +112,6 @@ suite("Tree-sitter formatter", () => {
         const rootNode = await parseText("(aaa (bbb))", "tree-sitter-query");
 
         const actual = treeSitterFormatter(rootNode, {
-            ...getDefaultOptions(),
             indentTabs: true,
         });
 

src/types.ts

@@ -26,10 +26,10 @@ export interface CLI {
 }
 
 export interface Options {
-    indentTabs: boolean;
-    indentWidth: number;
-    lineWidth: number;
-    columnWidth: number | undefined;
+    indentTabs?: boolean;
+    indentWidth?: number;
+    lineWidth?: number;
+    columnWidth?: number;
 }
 
 export interface ParsedArgs extends Options {

src/util/getDefaultArguments.ts

@@ -1,20 +1,14 @@
-import type { Options, ParsedArgs } from "../types.js";
+import type { ParsedArgs } from "../types.js";
 
 export function getDefaultArguments(): ParsedArgs {
     return {
         filePatterns: [],
         help: false,
         version: false,
         check: false,
-        ...getDefaultOptions(),
-    };
-}
-
-export function getDefaultOptions(): Options {
-    return {
-        indentTabs: false,
-        indentWidth: 4,
-        lineWidth: 80,
+        indentTabs: undefined,
+        indentWidth: undefined,
+        lineWidth: undefined,
         columnWidth: undefined,
     };
 }

src/util/getIndentation.ts

@@ -1,5 +1,6 @@
-import type { Options } from "../types.js";
-
-export function getIndentation(options: Options): string {
-    return options.indentTabs ? "\t" : " ".repeat(options.indentWidth);
+export function getIndentation(
+    indentTabs: boolean | undefined,
+    indentWidth: number | undefined,
+): string {
+    return indentTabs ? "\t" : " ".repeat(indentWidth ?? 4);
 }