feat: add biome formatter (#1192)

vrcprl · web-flow · commit bbc71b9948cc · 2025-10-01T15:51:40.000+02:00
* feat: add biome formatter

* chore: formatting

* chore: removed console.log

* chore: changeset
diff --git a/.changeset/olive-beds-wash.md b/.changeset/olive-beds-wash.md
@@ -0,0 +1,6 @@
+---
+"@lingo.dev/_spec": patch
+"lingo.dev": patch
+---
+
+Add biome support
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -130,6 +130,8 @@
     "@babel/parser": "^7.27.1",
     "@babel/traverse": "^7.27.4",
     "@babel/types": "^7.27.1",
+    "@biomejs/js-api": "^0.6.2",
+    "@biomejs/wasm-nodejs": "^1.8.3",
     "@datocms/cma-client-node": "^4.0.1",
     "@gitbeaker/rest": "^39.34.3",
     "@inkjs/ui": "^2.0.0",
diff --git a/packages/cli/src/cli/cmd/cleanup.ts b/packages/cli/src/cli/cmd/cleanup.ts
@@ -68,6 +68,7 @@ export default new Command()
             bucketConfig.pathPattern,
             {
               defaultLocale: sourceLocale,
+              formatter: i18nConfig!.formatter,
             },
           );
           bucketLoader.setDefaultLocale(sourceLocale);
diff --git a/packages/cli/src/cli/cmd/i18n.ts b/packages/cli/src/cli/cmd/i18n.ts
@@ -209,6 +209,7 @@ export default new Command()
               {
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
+                formatter: i18nConfig!.formatter,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
@@ -357,6 +358,7 @@ export default new Command()
               {
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
+                formatter: i18nConfig!.formatter,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/lockfile.ts b/packages/cli/src/cli/cmd/lockfile.ts
@@ -41,6 +41,7 @@ export default new Command()
             bucketConfig.pathPattern,
             {
               defaultLocale: sourceLocale,
+              formatter: i18nConfig!.formatter,
             },
           );
           bucketLoader.setDefaultLocale(sourceLocale);
diff --git a/packages/cli/src/cli/cmd/purge.ts b/packages/cli/src/cli/cmd/purge.ts
@@ -99,6 +99,7 @@ export default new Command()
                 {
                   defaultLocale: sourceLocale,
                   injectLocale: bucket.injectLocale,
+                  formatter: i18nConfig!.formatter,
                 },
                 bucket.lockedKeys,
                 bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/run/_types.ts b/packages/cli/src/cli/cmd/run/_types.ts
@@ -29,6 +29,7 @@ export type CmdRunTask = {
   lockedKeys: string[];
   lockedPatterns: string[];
   onlyKeys: string[];
+  formatter?: "prettier" | "biome";
 };
 
 export const flagsSchema = z.object({
diff --git a/packages/cli/src/cli/cmd/run/execute.ts b/packages/cli/src/cli/cmd/run/execute.ts
@@ -124,6 +124,7 @@ function createLoaderForTask(assignedTask: CmdRunTask) {
     {
       defaultLocale: assignedTask.sourceLocale,
       injectLocale: assignedTask.injectLocale,
+      formatter: assignedTask.formatter,
     },
     assignedTask.lockedKeys,
     assignedTask.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/run/plan.ts b/packages/cli/src/cli/cmd/run/plan.ts
@@ -133,6 +133,7 @@ export default async function plan(
                   lockedKeys: bucket.lockedKeys || [],
                   lockedPatterns: bucket.lockedPatterns || [],
                   onlyKeys: input.flags.key || [],
+                  formatter: input.config!.formatter,
                 });
               }
             }
diff --git a/packages/cli/src/cli/cmd/status.ts b/packages/cli/src/cli/cmd/status.ts
@@ -197,6 +197,7 @@ export default new Command()
               {
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
+                formatter: i18nConfig!.formatter,
               },
               bucket.lockedKeys,
             );
diff --git a/packages/cli/src/cli/loaders/formatters/_base.ts b/packages/cli/src/cli/loaders/formatters/_base.ts
@@ -0,0 +1,37 @@
+import path from "path";
+import { ILoader } from "../_types";
+import { createLoader } from "../_utils";
+
+export type BaseFormatterOptions = {
+  bucketPathPattern: string;
+  stage?: "pull" | "push" | "both";
+  alwaysFormat?: boolean;
+};
+
+export function createBaseFormatterLoader(
+  options: BaseFormatterOptions,
+  formatFn: (data: string, filePath: string) => Promise<string>,
+): ILoader<string, string> {
+  const stage = options.stage || "both";
+
+  const formatData = async (locale: string, data: string) => {
+    const draftPath = options.bucketPathPattern.replaceAll("[locale]", locale);
+    const finalPath = path.resolve(draftPath);
+    return await formatFn(data, finalPath);
+  };
+
+  return createLoader({
+    async pull(locale, data) {
+      if (!["pull", "both"].includes(stage)) {
+        return data;
+      }
+      return await formatData(locale, data);
+    },
+    async push(locale, data) {
+      if (!["push", "both"].includes(stage)) {
+        return data;
+      }
+      return await formatData(locale, data);
+    },
+  });
+}
diff --git a/packages/cli/src/cli/loaders/formatters/biome.ts b/packages/cli/src/cli/loaders/formatters/biome.ts
@@ -0,0 +1,77 @@
+import path from "path";
+import fs from "fs/promises";
+import { Biome, Distribution } from "@biomejs/js-api";
+import { ILoader } from "../_types";
+import { createBaseFormatterLoader } from "./_base";
+
+export type BiomeLoaderOptions = {
+  bucketPathPattern: string;
+  stage?: "pull" | "push" | "both";
+  alwaysFormat?: boolean;
+};
+
+export default function createBiomeLoader(
+  options: BiomeLoaderOptions,
+): ILoader<string, string> {
+  return createBaseFormatterLoader(options, async (data, filePath) => {
+    return await formatDataWithBiome(data, filePath, options);
+  });
+}
+
+async function findBiomeConfig(startPath: string): Promise<string | null> {
+  let currentDir = path.dirname(startPath);
+  const root = path.parse(currentDir).root;
+
+  while (currentDir !== root) {
+    for (const configName of ["biome.json", "biome.jsonc"]) {
+      const configPath = path.join(currentDir, configName);
+      try {
+        await fs.access(configPath);
+        return configPath;
+      } catch {
+        // Config file doesn't exist, continue searching
+      }
+    }
+
+    const parentDir = path.dirname(currentDir);
+    if (parentDir === currentDir) break;
+    currentDir = parentDir;
+  }
+
+  return null;
+}
+
+async function formatDataWithBiome(
+  data: string,
+  filePath: string,
+  options: BiomeLoaderOptions,
+): Promise<string> {
+  try {
+    const biome = await Biome.create({
+      distribution: Distribution.NODE,
+    });
+
+    // Load config from biome.json/biome.jsonc if exists
+    const configPath = await findBiomeConfig(filePath);
+    if (!configPath && !options.alwaysFormat) {
+      return data; // Skip if no config and not forced
+    }
+
+    if (configPath) {
+      const configContent = await fs.readFile(configPath, "utf-8");
+      biome.applyConfiguration(JSON.parse(configContent));
+    }
+
+    const formatted = biome.formatContent(data, {
+      filePath,
+    });
+
+    return formatted.content;
+  } catch (error) {
+    if (error instanceof Error) {
+      console.log();
+      console.log("⚠️  Biome formatting failed:", error.message);
+    }
+    return data; // Fallback to unformatted
+  }
+}
diff --git a/packages/cli/src/cli/loaders/formatters/index.ts b/packages/cli/src/cli/loaders/formatters/index.ts
@@ -0,0 +1,33 @@
+import createPrettierLoader, { PrettierLoaderOptions } from "./prettier";
+import createBiomeLoader from "./biome";
+import { ILoader } from "../_types";
+import { Options } from "prettier";
+
+export type FormatterType = "prettier" | "biome" | undefined;
+export type ParserType = Options["parser"];
+
+export function createFormatterLoader(
+  formatterType: FormatterType,
+  parser: ParserType,
+  bucketPathPattern: string,
+): ILoader<string, string> {
+  // If explicitly set to undefined, auto-detect (prefer prettier for backward compatibility)
+  if (formatterType === undefined) {
+    return createPrettierLoader({ parser, bucketPathPattern });
+  }
+
+  if (formatterType === "prettier") {
+    return createPrettierLoader({ parser, bucketPathPattern });
+  }
+
+  if (formatterType === "biome") {
+    return createBiomeLoader({ bucketPathPattern });
+  }
+
+  throw new Error(`Unknown formatter: ${formatterType}`);
+}
+
+// Re-export for direct access if needed
+export { createPrettierLoader, createBiomeLoader };
+export type { PrettierLoaderOptions };
+export type { BiomeLoaderOptions } from "./biome";
diff --git a/packages/cli/src/cli/loaders/formatters/prettier.ts b/packages/cli/src/cli/loaders/formatters/prettier.ts
@@ -1,7 +1,6 @@
-import path from "path";
 import prettier, { Options } from "prettier";
-import { ILoader } from "./_types";
-import { createLoader } from "./_utils";
+import { ILoader } from "../_types";
+import { createBaseFormatterLoader } from "./_base";
 
 export type PrettierLoaderOptions = {
   parser: Options["parser"];
@@ -13,34 +12,8 @@ export type PrettierLoaderOptions = {
 export default function createPrettierLoader(
   options: PrettierLoaderOptions,
 ): ILoader<string, string> {
-  const stage = options.stage || "both";
-  return createLoader({
-    async pull(locale, data) {
-      if (!["pull", "both"].includes(stage)) {
-        return data;
-      }
-
-      const draftPath = options.bucketPathPattern.replaceAll(
-        "[locale]",
-        locale,
-      );
-      const finalPath = path.resolve(draftPath);
-
-      return await formatDataWithPrettier(data, finalPath, options);
-    },
-    async push(locale, data) {
-      if (!["push", "both"].includes(stage)) {
-        return data;
-      }
-
-      const draftPath = options.bucketPathPattern.replaceAll(
-        "[locale]",
-        locale,
-      );
-      const finalPath = path.resolve(draftPath);
-
-      return await formatDataWithPrettier(data, finalPath, options);
-    },
+  return createBaseFormatterLoader(options, async (data, filePath) => {
+    return await formatDataWithPrettier(data, filePath, options);
   });
 }
 
diff --git a/packages/cli/src/cli/loaders/index.ts b/packages/cli/src/cli/loaders/index.ts
@@ -19,8 +19,8 @@ import createPropertiesLoader from "./properties";
 import createXcodeStringsLoader from "./xcode-strings";
 import createXcodeStringsdictLoader from "./xcode-stringsdict";
 import createXcodeXcstringsLoader from "./xcode-xcstrings";
-import createPrettierLoader from "./prettier";
 import createUnlocalizableLoader from "./unlocalizable";
+import { createFormatterLoader, FormatterType } from "./formatters";
 import createPoLoader from "./po";
 import createXliffLoader from "./xliff";
 import createXmlLoader from "./xml";
@@ -51,6 +51,7 @@ type BucketLoaderOptions = {
   defaultLocale: string;
   injectLocale?: string[];
   targetLocale?: string;
+  formatter?: FormatterType;
 };
 
 export default function createBucketLoader(
@@ -85,7 +86,7 @@ export default function createBucketLoader(
     case "html":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "html", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "html", bucketPathPattern),
         createHtmlLoader(),
         createSyncLoader(),
         createUnlocalizableLoader(options.returnUnlocalizedKeys),
@@ -100,7 +101,7 @@ export default function createBucketLoader(
     case "json":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "json", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "json", bucketPathPattern),
         createJsonLoader(),
         createEnsureKeyOrderLoader(),
         createFlatLoader(),
@@ -134,18 +135,15 @@ export default function createBucketLoader(
     case "markdown":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "markdown", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "markdown", bucketPathPattern),
         createMarkdownLoader(),
         createSyncLoader(),
         createUnlocalizableLoader(options.returnUnlocalizedKeys),
       );
     case "mdx":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({
-          parser: "mdx",
-          bucketPathPattern,
-        }),
+        createFormatterLoader(options.formatter, "mdx", bucketPathPattern),
         createMdxCodePlaceholderLoader(),
         createMdxLockedPatternsLoader(lockedPatterns),
         createMdxFrontmatterSplitLoader(),
@@ -206,7 +204,7 @@ export default function createBucketLoader(
     case "yaml":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "yaml", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "yaml", bucketPathPattern),
         createYamlLoader(),
         createFlatLoader(),
         createEnsureKeyOrderLoader(),
@@ -217,7 +215,7 @@ export default function createBucketLoader(
     case "yaml-root-key":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "yaml", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "yaml", bucketPathPattern),
         createYamlLoader(),
         createRootKeyLoader(true),
         createFlatLoader(),
@@ -228,7 +226,7 @@ export default function createBucketLoader(
     case "flutter":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "json", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "json", bucketPathPattern),
         createJsonLoader(),
         createEnsureKeyOrderLoader(),
         createFlutterLoader(),
@@ -297,7 +295,11 @@ export default function createBucketLoader(
     case "typescript":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "typescript", bucketPathPattern }),
+        createFormatterLoader(
+          options.formatter,
+          "typescript",
+          bucketPathPattern,
+        ),
         createTypescriptLoader(),
         createFlatLoader(),
         createEnsureKeyOrderLoader(),
@@ -316,7 +318,7 @@ export default function createBucketLoader(
     case "json-dictionary":
       return composeLoaders(
         createTextFileLoader(bucketPathPattern),
-        createPrettierLoader({ parser: "json", bucketPathPattern }),
+        createFormatterLoader(options.formatter, "json", bucketPathPattern),
         createJsonLoader(),
         createJsonKeysLoader(),
         createEnsureKeyOrderLoader(),
diff --git a/packages/spec/src/config.ts b/packages/spec/src/config.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ export default new Command()`
`68`	`68`	`bucketConfig.pathPattern,`
`69`	`69`	`{`
`70`	`70`	`defaultLocale: sourceLocale,`
	`71`	`+ formatter: i18nConfig!.formatter,`
`71`	`72`	`},`
`72`	`73`	`);`
`73`	`74`	`bucketLoader.setDefaultLocale(sourceLocale);`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ export default new Command()`
`41`	`41`	`bucketConfig.pathPattern,`
`42`	`42`	`{`
`43`	`43`	`defaultLocale: sourceLocale,`
	`44`	`+ formatter: i18nConfig!.formatter,`
`44`	`45`	`},`
`45`	`46`	`);`
`46`	`47`	`bucketLoader.setDefaultLocale(sourceLocale);`
Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ export default new Command()`
`99`	`99`	`{`
`100`	`100`	`defaultLocale: sourceLocale,`
`101`	`101`	`injectLocale: bucket.injectLocale,`
	`102`	`+ formatter: i18nConfig!.formatter,`
`102`	`103`	`},`
`103`	`104`	`bucket.lockedKeys,`
`104`	`105`	`bucket.lockedPatterns,`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,7 @@ function createLoaderForTask(assignedTask: CmdRunTask) {`
`124`	`124`	`{`
`125`	`125`	`defaultLocale: assignedTask.sourceLocale,`
`126`	`126`	`injectLocale: assignedTask.injectLocale,`
	`127`	`+ formatter: assignedTask.formatter,`
`127`	`128`	`},`
`128`	`129`	`assignedTask.lockedKeys,`
`129`	`130`	`assignedTask.lockedPatterns,`
Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,7 @@ export default async function plan(`
`133`	`133`	`lockedKeys: bucket.lockedKeys \|\| [],`
`134`	`134`	`lockedPatterns: bucket.lockedPatterns \|\| [],`
`135`	`135`	`onlyKeys: input.flags.key \|\| [],`
	`136`	`+ formatter: input.config!.formatter,`
`136`	`137`	`});`
`137`	`138`	`}`
`138`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -197,6 +197,7 @@ export default new Command()`
`197`	`197`	`{`
`198`	`198`	`defaultLocale: sourceLocale,`
`199`	`199`	`injectLocale: bucket.injectLocale,`
	`200`	`+ formatter: i18nConfig!.formatter,`
`200`	`201`	`},`
`201`	`202`	`bucket.lockedKeys,`
`202`	`203`	`);`