Added logger and --quiet and --debug flags to CLI.

Author: AndreasArvidsson

.pre-commit-hooks.yaml

@@ -1,17 +1,17 @@
 - id: snippet-fmt
   name: Format snippet files
-  entry: snippet-fmt
+  entry: snippet-fmt --quiet
   language: node
   files: \.snippet$
 
 - id: talon-fmt
   name: Format Talon files
-  entry: talon-fmt
+  entry: talon-fmt --quiet
   language: node
   files: \.(talon|talon-list)$
 
 - id: tree-sitter-fmt
   name: Format Tree-sitter query files
-  entry: tree-sitter-fmt
+  entry: tree-sitter-fmt --quiet
   language: node
   files: \.scm$

README.md

@@ -18,7 +18,11 @@ All binaries support these options:
 | ----------- | -------------------------------- |
 | `--help`    | Show help                        |
 | `--version` | Show version                     |
+| `--quiet`   | Suppress non-error output        |
 | `--check`   | Check formatting without writing |
+| `--debug`   | Print debug output               |
+
+Use `--debug` when diagnosing parser or formatter support for new syntax.
 
 ## Formatting options
 

out/cli/cli.d.ts

@@ -1,6 +1,28 @@
 import type { Readable } from "node:stream";
-import type { CLI } from "../types.js";
+import type { CLI, Logger } from "../types.js";
 export declare function main(cli: CLI): Promise<void>;
-export declare function formatFiles(cli: CLI, check: boolean, filePaths: string[]): Promise<number>;
-export declare function formatFile(cli: CLI, check: boolean, filePath: string): Promise<boolean>;
-export declare function mainFormatStdin(cli: CLI, stdin: Readable, check: boolean): Promise<number>;
+interface FormatFilesArgs {
+    cli: CLI;
+    logger: Logger;
+    check: boolean;
+    debug: boolean;
+    filePaths: string[];
+}
+export declare function formatFiles({ cli, logger, check, debug, filePaths, }: FormatFilesArgs): Promise<number>;
+interface FormatFileArgs {
+    cli: CLI;
+    logger: Logger;
+    check: boolean;
+    debug: boolean;
+    filePath: string;
+}
+export declare function formatFile({ cli, logger, check, debug, filePath, }: FormatFileArgs): Promise<boolean>;
+interface MainFormatStdinArgs {
+    cli: CLI;
+    logger: Logger;
+    stdin: Readable;
+    check: boolean;
+    debug: boolean;
+}
+export declare function mainFormatStdin({ cli, logger, stdin, check, debug, }: MainFormatStdinArgs): Promise<number>;
+export {};

out/lib.js

@@ -1,4 +1,4 @@
 import type { FormatterOptions, SyntaxNode } from "../types.js";
 type Options = FormatterOptions<"endOfLine" | "indentTabs" | "indentSize" | "maxLineLength" | "columnWidth" | "insertFinalNewline" | "preserveMultiline">;
-export declare function talonFormatter(node: SyntaxNode, options?: Options): string;
+export declare function talonFormatter(node: SyntaxNode, options?: Options, debug?: boolean): string;
 export {};

out/snippetFormatter.js

@@ -1,4 +1,4 @@
 import type { FormatterOptions, SyntaxNode } from "./types.js";
 type Options = FormatterOptions<"endOfLine" | "indentTabs" | "indentSize" | "insertFinalNewline">;
-export declare function treeSitterFormatter(node: SyntaxNode, options?: Options): string;
+export declare function treeSitterFormatter(node: SyntaxNode, options?: Options, debug?: boolean): string;
 export {};

out/talon/talonFormatter.d.ts

@@ -1,11 +1,11 @@
 import type { KnownProps } from "editorconfig";
-export declare const KNOWN_ARGUMENTS: readonly ["--help", "--version", "--check"];
+export declare const KNOWN_ARGUMENTS: readonly ["--help", "--version", "--quiet", "--check", "--debug"];
 export type KnownArgument = (typeof KNOWN_ARGUMENTS)[number];
 export interface CLI {
     binName: "snippet-fmt" | "talon-fmt" | "tree-sitter-fmt";
     fileEndings: readonly string[];
     getStdinFileEnding(text: string): string;
-    format(text: string, options: Options, filePath: string): Promise<string>;
+    format(text: string, options: Options, filePath: string, debug: boolean): Promise<string>;
 }
 export type EndOfLine = "lf" | "crlf";
 export interface Options {
@@ -23,6 +23,21 @@ export interface ParsedArgs {
     help: boolean;
     version: boolean;
     check: boolean;
+    quiet: boolean;
+    debug: boolean;
+}
+export interface LoggerEntry {
+    level: "log" | "warn" | "error";
+    message: string;
+}
+export interface Logger {
+    log(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    getEntries(): readonly LoggerEntry[];
+}
+export interface DebugLogger {
+    debug(message: string): void;
 }
 export interface EditorConfigOptions extends KnownProps {
     max_line_length?: number | "unset";