Added more arguments

Author: AndreasArvidsson

.prettierrc.json

@@ -2,7 +2,7 @@
     "tabWidth": 4,
     "overrides": [
         {
-            "files": "*.yaml",
+            "files": "*.{yaml,md}",
             "options": {
                 "tabWidth": 2
             }

README.md

@@ -2,16 +2,48 @@
 
 Linting and formatting tools for Talon and Cursorless.
 
-## Guidelines
+## CLI
 
-- Each pre-commit hook should have a matching npm binary with the same name.
-- Binaries ending with `-fmt` are formatters by default and turn into linters/checkers with the `--check` argument.
-- (Future) binaries ending with `-check` are linters by default and turn into fixers with the `--fix` argument.
+```sh
+talon-fmt [options] [file/dir/glob ...]
+snippet-fmt [options] [file/dir/glob ...]
+tree-sitter-fmt [options] [file/dir/glob ...]
+```
+
+### Options
+
+| Option               | Meaning                          | Default |
+| -------------------- | -------------------------------- | ------- |
+| `--help`             | Show help                        |         |
+| `--version`          | Show version                     |         |
+| `--check`            | Check formatting without writing |         |
+| `--indent-tabs`      | Use tabs for indentation         |         |
+| `--indent-width <n>` | Set indentation width            | `4`     |
+| `--line-width <n>`   | Set preferred maximum line width | `80`    |
+| `--column-width <n>` | Set aligned left-column width    |         |
 
 ## Exit codes
 
 | Code | Information                         |
 | ---- | ----------------------------------- |
 | 0    | Everything formatted properly       |
-| 1    | Something wasn’t formatted properly |
+| 1    | Something wasn't formatted properly |
 | 2    | Runtime error                       |
+
+## Pre commit
+
+```yaml
+repos:
+  - repo: https://github.com/cursorless-dev/talon-tools
+    rev: v0.1.0
+    hooks:
+      - talon-fmt
+      - snippet-fmt
+      - tree-sitter-fmt
+```
+
+## Guidelines
+
+- Each pre-commit hook should have a matching npm binary with the same name.
+- Binaries ending with `-fmt` are formatters by default and turn into linters/checkers with the `--check` argument.
+- (Future) binaries ending with `-check` are linters by default and turn into fixers with the `--fix` argument.

package.json

@@ -28,12 +28,12 @@
         "prepack": "npm run build",
         "build": "tsx ./src/build.ts",
         "clean": "rm -rf out",
-        "lint": "npm run lint:fmt && npm run lint:ts",
-        "lint:fmt": "prettier --check .",
+        "lint": "npm run lint:ts &&npm run lint:fmt",
         "lint:ts": "tsc -p . && eslint src",
-        "fix": "npm run fix:fmt && npm run fix:ts",
-        "fix:fmt": "prettier --write --list-different .",
+        "lint:fmt": "prettier --check .",
+        "fix": "npm run fix:ts && npm run fix:fmt",
         "fix:ts": "eslint src --fix",
+        "fix:fmt": "prettier --write --list-different .",
         "test": "tsx src/test/runAllTests.ts"
     },
     "dependencies": {

src/test/cli.test.ts

@@ -7,6 +7,7 @@ import { formatFile, formatFiles, mainFormatStdin } from "../cli/cli.js";
 import type { CLI, ParsedArgs } from "../types.js";
 import { EXIT_FAIL, EXIT_OK } from "../util/constants.js";
 import { parseArgs } from "../util/parseArgs.js";
+import { getDefaultArguments } from "../util/getDefaultArguments.js";
 
 suite("CLI", () => {
     test("formats a file in place", async () => {
@@ -143,35 +144,70 @@ suite("CLI", () => {
     });
 
     test("parses check mode", () => {
-        const expected: ParsedArgs = {
+        const expected = getArguments({
             filePatterns: ["a.txt", "b.txt"],
-            help: false,
-            version: false,
             check: true,
-        };
+        });
         const actual = parseArgs(["--check", "a.txt", "b.txt"]);
 
         assert.deepEqual(actual, expected);
     });
 
     test("parses check mode and end-of-options marker", () => {
-        const expected: ParsedArgs = {
+        const expected = getArguments({
             filePatterns: ["--check"],
-            help: false,
-            version: false,
             check: true,
-        };
+        });
         const actual = parseArgs(["--check", "--", "--check"]);
 
         assert.deepEqual(actual, expected);
     });
 
+    test("parses tabs and width arguments", () => {
+        const expected = getArguments({
+            filePatterns: ["a.txt"],
+            help: false,
+            version: false,
+            check: false,
+            indentTabs: true,
+            indentWidth: 2,
+            lineWidth: 80,
+            columnWidth: 24,
+        });
+        const actual = parseArgs([
+            "--indent-tabs",
+            "--indent-width",
+            "2",
+            "--line-width",
+            "80",
+            "--column-width",
+            "24",
+            "a.txt",
+        ]);
+
+        assert.deepEqual(actual, expected);
+    });
+
     test("rejects unknown arguments", () => {
         assert.throws(
             () => parseArgs(["--check", "--write"]),
             /Unknown argument: --write/,
         );
     });
+
+    test("rejects missing width values", () => {
+        assert.throws(
+            () => parseArgs(["--indent-width"]),
+            /Missing value for argument: --indent-width/,
+        );
+    });
+
+    test("rejects invalid width values", () => {
+        assert.throws(
+            () => parseArgs(["--line-width", "0"]),
+            /Invalid value for --line-width: 0/,
+        );
+    });
 });
 
 async function createTempFile(
@@ -230,3 +266,10 @@ async function captureStreamWrite<T>(
         stream.write = originalWrite;
     }
 }
+
+function getArguments(args: Partial<ParsedArgs>) {
+    return {
+        ...getDefaultArguments(),
+        ...args,
+    };
+}

src/types.ts

@@ -10,4 +10,8 @@ export interface ParsedArgs {
     help: boolean;
     version: boolean;
     check: boolean;
+    indentTabs: boolean;
+    indentWidth: number;
+    lineWidth: number;
+    columnWidth: number | undefined;
 }

src/util/getDefaultArguments.ts

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

src/util/parseArgs.ts

@@ -1,13 +1,34 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 
 import type { ParsedArgs } from "../types.js";
+import { getDefaultArguments } from "./getDefaultArguments.js";
 
-export const KNOWN_ARGUMENTS = ["--help", "--version", "--check"] as const;
+export const KNOWN_FLAG_ARGUMENTS = [
+    "--help",
+    "--version",
+    "--check",
+    "--indent-tabs",
+] as const;
 
-type KnownArgument = (typeof KNOWN_ARGUMENTS)[number];
-type ArgHandler = (parsedArgs: ParsedArgs) => void;
+export const KNOWN_VALUE_ARGUMENTS = [
+    "--indent-width",
+    "--line-width",
+    "--column-width",
+] as const;
 
-const ARG_HANDLERS: Record<KnownArgument, ArgHandler> = {
+type FlagArg = (typeof KNOWN_FLAG_ARGUMENTS)[number];
+type ValueArg = (typeof KNOWN_VALUE_ARGUMENTS)[number];
+type KnownArg = FlagArg | ValueArg;
+
+type FlagHandler = (parsedArgs: ParsedArgs) => void;
+
+type ValueHandler = (
+    parsedArgs: ParsedArgs,
+    argName: KnownArg,
+    value: string,
+) => void;
+
+const FLAG_ARG_HANDLERS: Record<FlagArg, FlagHandler> = {
     "--help": (parsedArgs) => {
         parsedArgs.help = true;
     },
@@ -17,15 +38,25 @@ const ARG_HANDLERS: Record<KnownArgument, ArgHandler> = {
     "--check": (parsedArgs) => {
         parsedArgs.check = true;
     },
+    "--indent-tabs": (parsedArgs) => {
+        parsedArgs.indentTabs = true;
+    },
+};
+
+const VALUE_ARG_HANDLERS: Record<ValueArg, ValueHandler> = {
+    "--indent-width": (parsedArgs, argName, value) => {
+        parsedArgs.indentWidth = parsePositiveInteger(argName, value);
+    },
+    "--line-width": (parsedArgs, argName, value) => {
+        parsedArgs.lineWidth = parsePositiveInteger(argName, value);
+    },
+    "--column-width": (parsedArgs, argName, value) => {
+        parsedArgs.columnWidth = parsePositiveInteger(argName, value);
+    },
 };
 
 export function parseArgs(argv: string[]): ParsedArgs {
-    const result: ParsedArgs = {
-        filePatterns: [],
-        help: false,
-        version: false,
-        check: false,
-    };
+    const result = getDefaultArguments();
 
     for (let i = 0; i < argv.length; i++) {
         const arg = argv[i];
@@ -36,10 +67,22 @@ export function parseArgs(argv: string[]): ParsedArgs {
             break;
         }
 
-        const handler = ARG_HANDLERS[arg as KnownArgument];
+        const flagHandler = FLAG_ARG_HANDLERS[arg as FlagArg];
 
-        if (handler != null) {
-            handler(result);
+        if (flagHandler != null) {
+            flagHandler(result);
+            continue;
+        }
+
+        const valueHandler = VALUE_ARG_HANDLERS[arg as ValueArg];
+
+        if (valueHandler != null) {
+            const value = argv[i + 1];
+            if (value == null) {
+                throw new Error(`Missing value for argument: ${arg}`);
+            }
+            valueHandler(result, arg as ValueArg, value);
+            i++;
             continue;
         }
 
@@ -52,3 +95,13 @@ export function parseArgs(argv: string[]): ParsedArgs {
 
     return result;
 }
+
+function parsePositiveInteger(argName: KnownArg, value: string): number {
+    const parsed = Number.parseInt(value, 10);
+
+    if (!Number.isInteger(parsed) || parsed <= 0) {
+        throw new Error(`Invalid value for ${argName}: ${value}`);
+    }
+
+    return parsed;
+}

src/util/printHelp.ts

@@ -1,7 +1,19 @@
 import type { CLI } from "../types.js";
-import { KNOWN_ARGUMENTS } from "./parseArgs.js";
+import { KNOWN_FLAG_ARGUMENTS, KNOWN_VALUE_ARGUMENTS } from "./parseArgs.js";
 
 export function printHelp(cli: CLI) {
-    const args = KNOWN_ARGUMENTS.join("|");
-    console.log(`Usage: ${cli.binName} [${args}] [file/dir/glob ...]`);
+    console.log(`Usage: ${cli.binName} [options] [file/dir/glob ...]`);
+    console.log("");
+    console.log("Flags:");
+
+    for (const option of KNOWN_FLAG_ARGUMENTS) {
+        console.log(`  ${option}`);
+    }
+
+    console.log("");
+    console.log("Options:");
+
+    for (const option of KNOWN_VALUE_ARGUMENTS) {
+        console.log(`  ${option} <n>`);
+    }
 }