Add support for .editorconfig files

Author: AndreasArvidsson

README.md

@@ -12,31 +12,27 @@ tree-sitter-fmt [options] [file/dir/glob ...]
 
 ### Options
 
-All binaries support these global options:
+All binaries support these options:
 
 | Option      | Meaning                          |
 | ----------- | -------------------------------- |
 | `--help`    | Show help                        |
 | `--version` | Show version                     |
 | `--check`   | Check formatting without writing |
 
-`talon-fmt` also supports:
+Formatting options are read from [.editorconfig](https://editorconfig.org) based on the file path being
+formatted. For stdin, the formatter resolves a synthetic file such as
+`stdin.talon`, `stdin.talon-list`, `stdin.scm`, or `stdin.snippet` from the
+current working directory and loads `.editorconfig` relative to that path.
 
-| Option               | Meaning                          | Default |
-| -------------------- | -------------------------------- | ------- |
-| `--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    |         |
+Supported `.editorconfig` properties:
 
-`tree-sitter-fmt` also supports:
-
-| Option               | Meaning                  | Default |
-| -------------------- | ------------------------ | ------- |
-| `--indent-tabs`      | Use tabs for indentation |         |
-| `--indent-width <n>` | Set indentation width    | `4`     |
-
-`snippet-fmt` does not support any additional formatter-specific options.
+| Property          | Meaning                            |
+| ----------------- | ---------------------------------- |
+| `indent_style`    | Use tabs or spaces for indentation |
+| `indent_size`     | Set indentation width              |
+| `max_line_length` | Set preferred maximum line width   |
+| `column_width`    | Set aligned left-column width      |
 
 Use `--` to mark the end of options. Any following arguments are treated as
 file, directory, or glob patterns even if they start with `--`.

package-lock.json

@@ -44,6 +44,7 @@
     },
     "dependencies": {
         "@cursorless/tree-sitter-wasms": "^0.7.0",
+        "editorconfig": "^3.0.2",
         "fast-glob": "^3.3.3",
         "get-stdin": "^10.0.0",
         "talon-snippets": "^1.3.0",

package.json

@@ -1,10 +1,12 @@
 import getStdin from "get-stdin";
 import * as fs from "node:fs/promises";
+import * as path from "node:path";
 import * as process from "node:process";
 import type { Readable } from "node:stream";
-import type { CLI, Options } from "../types.js";
+import type { CLI } from "../types.js";
 import { EXIT_ERROR, EXIT_FAIL, EXIT_OK } from "../util/constants.js";
 import { getErrorMessage } from "../util/getErrorMessage.js";
+import { getOptionsFromConfig } from "../util/getOptionsFromConfig.js";
 import { isMissingFileError } from "../util/isMissingFileError.js";
 import { parseArgs } from "../util/parseArgs.js";
 import { parseFilePatterns } from "../util/parseFilePatterns.js";
@@ -22,7 +24,7 @@ export async function main(cli: CLI): Promise<void> {
 }
 
 async function mainUnsafe(cli: CLI): Promise<number> {
-    const args = parseArgs(cli, process.argv.slice(2));
+    const args = parseArgs(process.argv.slice(2));
 
     if (args.help) {
         printHelp(cli);
@@ -37,13 +39,13 @@ async function mainUnsafe(cli: CLI): Promise<number> {
     const hasFilePatterns = args.filePatterns.length > 0;
 
     if (hasFilePatterns) {
-        return mainFormatFiles(cli, args.check, args, args.filePatterns);
+        return mainFormatFiles(cli, args.check, args.filePatterns);
     }
 
     // If no file patterns are provided, check if there's input from stdin.
     // If stdin TTY it's an interactive terminal, so we shouldn't read from it.
     if (!process.stdin.isTTY) {
-        return mainFormatStdin(cli, process.stdin, args.check, args);
+        return mainFormatStdin(cli, process.stdin, args.check);
     }
 
     throw new Error(
@@ -54,15 +56,14 @@ async function mainUnsafe(cli: CLI): Promise<number> {
 async function mainFormatFiles(
     cli: CLI,
     check: boolean,
-    options: Options,
     filePatterns: string[],
 ): Promise<number> {
     if (check) {
         console.log("Checking formatting...");
     }
 
     const filePaths = await parseFilePatterns(cli, filePatterns);
-    const changedFileCount = await formatFiles(cli, check, options, filePaths);
+    const changedFileCount = await formatFiles(cli, check, filePaths);
 
     if (check) {
         if (changedFileCount > 0) {
@@ -88,13 +89,12 @@ async function mainFormatFiles(
 export async function formatFiles(
     cli: CLI,
     check: boolean,
-    options: Options,
     filePaths: string[],
 ): Promise<number> {
     let changedFileCount = 0;
 
     for (const fileName of filePaths) {
-        if (await formatFile(cli, check, options, fileName)) {
+        if (await formatFile(cli, check, fileName)) {
             changedFileCount++;
         }
     }
@@ -105,10 +105,10 @@ export async function formatFiles(
 export async function formatFile(
     cli: CLI,
     check: boolean,
-    options: Options,
     filePath: string,
 ): Promise<boolean> {
     try {
+        const options = await getOptionsFromConfig(filePath);
         const content = await fs.readFile(filePath, "utf8");
         const formatted = await cli.format(content, options, filePath);
 
@@ -142,10 +142,13 @@ export async function mainFormatStdin(
     cli: CLI,
     stdin: Readable,
     check: boolean,
-    options: Options,
 ): Promise<number> {
     const input = await getStdin({ stdin });
-    const formatted = await cli.format(input, options, "stdin");
+    const fileEnding = cli.getStdinFileEnding(input);
+    const fileName = `stdin.${fileEnding}`;
+    const filePath = path.resolve(fileName);
+    const options = await getOptionsFromConfig(filePath);
+    const formatted = await cli.format(input, options, filePath);
 
     if (check) {
         if (input !== formatted) {

src/cli/cli.ts

@@ -3,11 +3,15 @@
 import { snippetFormatter } from "../lib/snippetFormatter.js";
 import { main } from "./cli.js";
 
+const fileEnding = "snippet";
+
 void main({
     binName: "snippet-fmt",
-    fileEndings: ["snippet"],
-    supportedFlagArgs: [],
-    supportedValueArgs: [],
+    fileEndings: [fileEnding],
+
+    getStdinFileEnding() {
+        return fileEnding;
+    },
 
     format: async (text) => {
         const updated = snippetFormatter(text);

src/cli/snippetFormatter.ts

@@ -5,14 +5,19 @@ import { talonFormatter } from "../lib/talonFormatter.js";
 import { parseText } from "../util/parseText.js";
 import { main } from "./cli.js";
 
+const fileEndingTalon = "talon";
+const fileEndingTalonList = "talon-list";
+
 void main({
     binName: "talon-fmt",
-    fileEndings: ["talon", "talon-list"],
-    supportedFlagArgs: ["--indent-tabs"],
-    supportedValueArgs: ["--indent-width", "--line-width", "--column-width"],
+    fileEndings: [fileEndingTalon, fileEndingTalonList],
+
+    getStdinFileEnding(text) {
+        return textIsList(text) ? fileEndingTalonList : fileEndingTalon;
+    },
 
-    format: async (text, options, fileName) => {
-        if (isListFile(text, fileName)) {
+    format: async (text, options, filePath) => {
+        if (isListFile(text, filePath)) {
             const updated = talonListFormatter(text, options);
             return Promise.resolve(updated);
         }
@@ -22,12 +27,16 @@ void main({
     },
 });
 
-function isListFile(text: string, fileName: string): boolean {
-    if (fileName.endsWith(".talon-list")) {
-        return true;
-    }
-    if (fileName.endsWith(".talon")) {
+function isListFile(text: string, filePath: string): boolean {
+    if (filePath.endsWith(".talon")) {
         return false;
     }
+    if (filePath.endsWith(".talon-list")) {
+        return true;
+    }
+    return textIsList(text);
+}
+
+function textIsList(text: string): boolean {
     return text.startsWith("list:");
 }

src/cli/talonFormatter.ts

@@ -4,11 +4,15 @@ import { treeSitterFormatter } from "../lib/treeSitterFormatter.js";
 import { parseText } from "../util/parseText.js";
 import { main } from "./cli.js";
 
+const fileEnding = "scm";
+
 void main({
     binName: "tree-sitter-fmt",
-    fileEndings: ["scm"],
-    supportedFlagArgs: ["--indent-tabs"],
-    supportedValueArgs: ["--indent-width"],
+    fileEndings: [fileEnding],
+
+    getStdinFileEnding() {
+        return fileEnding;
+    },
 
     format: async (text, options) => {
         const node = await parseText(text, "tree-sitter-query");