feat(cli): add keyColumn option for CSV buckets with duplicate key validation (#2076)

cherkanovart · claude · web-flow · commit bb295f77c0c7 · 2026-04-24T19:36:21.000+02:00
* feat(cli): add keyColumn option for CSV loaders and update related commands

* chore: add changeset for csv keyColumn feature

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* fix(cli): handle empty CSV and sparse first-row edge cases in key column validation

- Use split(/\r?\n/) with trim check instead of non-null assertion for empty CSV safety
- Parse header row separately (to_line: 1) for column validation to avoid
  missing columns when first data row is sparse with relax_column_count_less

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* feat(cli): add keyColumn configuration to CSV i18n settings

---------

Co-authored-by: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/.changeset/csv-key-column.md b/.changeset/csv-key-column.md
@@ -0,0 +1,6 @@
+---
+"lingo.dev": patch
+"@lingo.dev/_spec": patch
+---
+
+feat(cli): add `keyColumn` option for CSV buckets to specify which column is the unique row identifier, and validate key uniqueness to prevent silent data loss from duplicate keys
diff --git a/packages/cli/demo/csv/i18n.json b/packages/cli/demo/csv/i18n.json
@@ -10,7 +10,8 @@
     "csv": {
       "include": [
         "./example.csv"
-      ]
+      ],
+      "keyColumn": "KEY"
     }
   },
   "$schema": "https://lingo.dev/schema/i18n.json"
diff --git a/packages/cli/src/cli/cmd/cleanup.ts b/packages/cli/src/cli/cmd/cleanup.ts
@@ -69,6 +69,7 @@ export default new Command()
             {
               defaultLocale: sourceLocale,
               formatter: i18nConfig!.formatter,
+              keyColumn: bucket.keyColumn,
             },
             bucket.lockedKeys,
             bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/i18n.ts b/packages/cli/src/cli/cmd/i18n.ts
@@ -222,6 +222,7 @@ export default new Command()
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
                 formatter: i18nConfig!.formatter,
+                keyColumn: bucket.keyColumn,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
@@ -263,6 +264,7 @@ export default new Command()
                 defaultLocale: sourceLocale,
                 returnUnlocalizedKeys: true,
                 injectLocale: bucket.injectLocale,
+                keyColumn: bucket.keyColumn,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
@@ -377,6 +379,7 @@ export default new Command()
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
                 formatter: i18nConfig!.formatter,
+                keyColumn: bucket.keyColumn,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/lockfile.ts b/packages/cli/src/cli/cmd/lockfile.ts
@@ -42,6 +42,7 @@ export default new Command()
             {
               defaultLocale: sourceLocale,
               formatter: i18nConfig!.formatter,
+              keyColumn: bucket.keyColumn,
             },
             bucket.lockedKeys,
             bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/purge.ts b/packages/cli/src/cli/cmd/purge.ts
@@ -102,6 +102,7 @@ export default new Command()
                   defaultLocale: sourceLocale,
                   injectLocale: bucket.injectLocale,
                   formatter: i18nConfig!.formatter,
+                  keyColumn: bucket.keyColumn,
                 },
                 bucket.lockedKeys,
                 bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/run/_types.ts b/packages/cli/src/cli/cmd/run/_types.ts
@@ -1,9 +1,4 @@
-import {
-  bucketTypeSchema,
-  I18nConfig,
-  localeCodeSchema,
-  bucketTypes,
-} from "@lingo.dev/_spec";
+import { bucketTypeSchema, I18nConfig, bucketTypes } from "@lingo.dev/_spec";
 import { z } from "zod";
 import { ILocalizer } from "../../localizer/_types";
 
@@ -36,6 +31,7 @@ export type CmdRunTask = {
   localizableKeys: string[];
   onlyKeys: string[];
   formatter?: "prettier" | "biome";
+  keyColumn?: string;
 };
 
 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
@@ -34,9 +34,7 @@ export default async function execute(input: CmdRunContext) {
       {
         title: "Initializing localization engine",
         task: async (ctx, task) => {
-          task.title = `Localization engine ${chalk.hex(colors.green)(
-            "ready",
-          )} (${ctx.localizer!.id})`;
+          task.title = `Localization engine ${chalk.hex(colors.green)("ready")} (${ctx.localizer!.id})`;
         },
       },
       {
@@ -124,9 +122,9 @@ function createWorkerStatusMessage(args: {
     "[locale]",
     args.assignedTask.targetLocale,
   );
-  return `[${chalk.hex(colors.yellow)(
-    `${args.percentage}%`,
-  )}] Processing: ${chalk.dim(displayPath)} (${chalk.hex(colors.yellow)(
+  return `[${chalk.hex(colors.yellow)(`${args.percentage}%`)}] Processing: ${chalk.dim(displayPath)} (${chalk.hex(
+    colors.yellow,
+  )(
     args.assignedTask.sourceLocale,
   )} -> ${chalk.hex(colors.yellow)(args.assignedTask.targetLocale)})`;
 }
@@ -147,9 +145,7 @@ function createExecutionProgressMessage(ctx: CmdRunContext) {
 
   return `Processed ${chalk.green(succeededTasksCount)}/${
     ctx.tasks.length
-  }, Failed ${chalk.red(failedTasksCount)}, Skipped ${chalk.dim(
-    skippedTasksCount,
-  )}`;
+  }, Failed ${chalk.red(failedTasksCount)}, Skipped ${chalk.dim(skippedTasksCount)}`;
 }
 
 function createLoaderForTask(assignedTask: CmdRunTask) {
@@ -160,6 +156,7 @@ function createLoaderForTask(assignedTask: CmdRunTask) {
       defaultLocale: assignedTask.sourceLocale,
       injectLocale: assignedTask.injectLocale,
       formatter: assignedTask.formatter,
+      keyColumn: assignedTask.keyColumn,
     },
     assignedTask.lockedKeys,
     assignedTask.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/run/frozen.ts b/packages/cli/src/cli/cmd/run/frozen.ts
@@ -60,6 +60,7 @@ export default async function frozen(input: CmdRunContext) {
                     defaultLocale: resolvedSourceLocale,
                     injectLocale: bucket.injectLocale,
                     formatter: input.config!.formatter,
+                    keyColumn: bucket.keyColumn,
                   },
                   bucket.lockedKeys,
                   bucket.lockedPatterns,
@@ -101,6 +102,7 @@ export default async function frozen(input: CmdRunContext) {
                   defaultLocale: resolvedSourceLocale,
                   returnUnlocalizedKeys: true,
                   injectLocale: bucket.injectLocale,
+                  keyColumn: bucket.keyColumn,
                 },
                 bucket.lockedKeys,
                 bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/cmd/run/plan.ts b/packages/cli/src/cli/cmd/run/plan.ts
@@ -39,23 +39,15 @@ export default async function plan(
         task: async (ctx, task) => {
           const bucketCount = buckets.length;
           const bucketFilter = input.flags.bucket
-            ? ` ${chalk.dim(
-                `(filtered by: ${chalk.hex(colors.yellow)(
-                  input.flags.bucket!.join(", "),
-                )})`,
-              )}`
+            ? ` ${chalk.dim(`(filtered by: ${chalk.hex(colors.yellow)(input.flags.bucket!.join(", "))})`)}`
             : "";
-          task.title = `Found ${chalk.hex(colors.yellow)(
-            bucketCount.toString(),
-          )} bucket(s)${bucketFilter}`;
+          task.title = `Found ${chalk.hex(colors.yellow)(bucketCount.toString())} bucket(s)${bucketFilter}`;
         },
       },
       {
         title: "Detecting locales",
         task: async (ctx, task) => {
-          task.title = `Found ${chalk.hex(colors.yellow)(
-            _targetLocales.length.toString(),
-          )} target locale(s)`;
+          task.title = `Found ${chalk.hex(colors.yellow)(_targetLocales.length.toString())} target locale(s)`;
         },
       },
       {
@@ -82,15 +74,9 @@ export default async function plan(
           }
 
           const fileFilter = input.flags.file
-            ? ` ${chalk.dim(
-                `(filtered by: ${chalk.hex(colors.yellow)(
-                  input.flags.file.join(", "),
-                )})`,
-              )}`
+            ? ` ${chalk.dim(`(filtered by: ${chalk.hex(colors.yellow)(input.flags.file.join(", "))})`)}`
             : "";
-          task.title = `Found ${chalk.hex(colors.yellow)(
-            patterns.length.toString(),
-          )} path pattern(s)${fileFilter}`;
+          task.title = `Found ${chalk.hex(colors.yellow)(patterns.length.toString())} path pattern(s)${fileFilter}`;
         },
       },
       {
@@ -137,14 +123,13 @@ export default async function plan(
                   localizableKeys: bucket.localizableKeys || [],
                   onlyKeys: input.flags.key || [],
                   formatter: input.config!.formatter,
+                  keyColumn: bucket.keyColumn,
                 });
               }
             }
           }
 
-          task.title = `Prepared ${chalk.hex(colors.green)(
-            ctx.tasks.length.toString(),
-          )} translation task(s)`;
+          task.title = `Prepared ${chalk.hex(colors.green)(ctx.tasks.length.toString())} translation task(s)`;
         },
       },
     ],
diff --git a/packages/cli/src/cli/cmd/show/_shared-key-command.ts b/packages/cli/src/cli/cmd/show/_shared-key-command.ts
@@ -61,6 +61,7 @@ export async function executeKeyCommand(
           {
             defaultLocale: sourceLocale,
             injectLocale: bucket.injectLocale,
+            keyColumn: bucket.keyColumn,
           },
           [], // Don't apply any filtering when reading
           [],
diff --git a/packages/cli/src/cli/cmd/status.ts b/packages/cli/src/cli/cmd/status.ts
@@ -199,6 +199,7 @@ export default new Command()
                 defaultLocale: sourceLocale,
                 injectLocale: bucket.injectLocale,
                 formatter: i18nConfig!.formatter,
+                keyColumn: bucket.keyColumn,
               },
               bucket.lockedKeys,
               bucket.lockedPatterns,
diff --git a/packages/cli/src/cli/loaders/csv.spec.ts b/packages/cli/src/cli/loaders/csv.spec.ts
@@ -94,4 +94,106 @@ describe("csv loader", () => {
       "The first pull must be for the default locale",
     );
   });
+
+  describe("key column validation", () => {
+    it("should throw a descriptive error when the key column has duplicate values", async () => {
+      // Mirrors the Salesfloor bug: first column is categorical, not unique,
+      // which previously caused silent row collapse.
+      const dupeCsv = buildCsv([
+        ["type", "en", "es"],
+        ["code", "Hello", ""],
+        ["code", "Bye", ""],
+        ["menu", "Home", ""],
+        ["menu", "Profile", ""],
+      ]);
+
+      const loader = createCsvLoader();
+      loader.setDefaultLocale("en");
+
+      await expect(loader.pull("en", dupeCsv)).rejects.toThrow(
+        /CSV column "type" has duplicate values/,
+      );
+    });
+
+    it("should not throw when the detected key column is unique", async () => {
+      const loader = createCsvLoader();
+      loader.setDefaultLocale("en");
+
+      // sampleCsv has unique `id` values — this should just work.
+      await expect(loader.pull("en", sampleCsv)).resolves.toBeDefined();
+    });
+
+    it("should use the `keyColumn` option instead of the first column", async () => {
+      // First column `type` is repeated; `id` is unique.
+      // With keyColumn: "id", the loader must use `id` and not fail on `type` dupes.
+      const csv = buildCsv([
+        ["type", "id", "en", "es"],
+        ["code", "hello", "Hello", ""],
+        ["code", "bye", "Bye", ""],
+        ["menu", "home", "Home", ""],
+      ]);
+
+      const loader = createCsvLoader({ keyColumn: "id" });
+      loader.setDefaultLocale("en");
+
+      const result = await loader.pull("en", csv);
+      expect(result).toEqual({ hello: "Hello", bye: "Bye", home: "Home" });
+    });
+
+    it("should throw when `keyColumn` points to a column not in the CSV", async () => {
+      const loader = createCsvLoader({ keyColumn: "nonexistent" });
+      loader.setDefaultLocale("en");
+
+      await expect(loader.pull("en", sampleCsv)).rejects.toThrow(
+        /CSV key column "nonexistent" is not present/,
+      );
+    });
+
+    it("should still throw on duplicates when `keyColumn` points at a non-unique column", async () => {
+      const csv = buildCsv([
+        ["id", "group", "en"],
+        ["1", "menu", "Hello"],
+        ["2", "menu", "Bye"],
+      ]);
+
+      const loader = createCsvLoader({ keyColumn: "group" });
+      loader.setDefaultLocale("en");
+
+      await expect(loader.pull("en", csv)).rejects.toThrow(
+        /CSV column "group" has duplicate values/,
+      );
+    });
+
+    it("should correctly push translations when `keyColumn` is not the first column", async () => {
+      // Metadata columns (`type`, `group`) come first; `id` is the key in the middle.
+      // Verifies that push matches translations by id (not row index) and preserves
+      // non-key columns through the round-trip.
+      const csv = buildCsv([
+        ["type", "group", "id", "en"],
+        ["code", "ui", "hello", "Hello"],
+        ["code", "ui", "bye", "Bye"],
+        ["menu", "nav", "home", "Home"],
+      ]);
+
+      const loader = createCsvLoader({ keyColumn: "id" });
+      loader.setDefaultLocale("en");
+      await loader.pull("en", csv);
+
+      const esCsv = await loader.push("es", {
+        hello: "Hola",
+        bye: "Adiós",
+        home: "Inicio",
+      });
+
+      const parsed = parse(esCsv, {
+        columns: true,
+        skip_empty_lines: true,
+      });
+      expect(parsed).toEqual([
+        { type: "code", group: "ui", id: "hello", en: "Hello", es: "Hola" },
+        { type: "code", group: "ui", id: "bye", en: "Bye", es: "Adiós" },
+        { type: "menu", group: "nav", id: "home", en: "Home", es: "Inicio" },
+      ]);
+    });
+  });
 });
diff --git a/packages/cli/src/cli/loaders/csv.ts b/packages/cli/src/cli/loaders/csv.ts
diff --git a/packages/cli/src/cli/loaders/index.ts b/packages/cli/src/cli/loaders/index.ts
diff --git a/packages/cli/src/cli/utils/buckets.spec.ts b/packages/cli/src/cli/utils/buckets.spec.ts
diff --git a/packages/cli/src/cli/utils/buckets.ts b/packages/cli/src/cli/utils/buckets.ts
diff --git a/packages/spec/src/config.ts b/packages/spec/src/config.ts

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ export default new Command()`
`69`	`69`	`{`
`70`	`70`	`defaultLocale: sourceLocale,`
`71`	`71`	`formatter: i18nConfig!.formatter,`
	`72`	`+ keyColumn: bucket.keyColumn,`
`72`	`73`	`},`
`73`	`74`	`bucket.lockedKeys,`
`74`	`75`	`bucket.lockedPatterns,`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ export default new Command()`
`42`	`42`	`{`
`43`	`43`	`defaultLocale: sourceLocale,`
`44`	`44`	`formatter: i18nConfig!.formatter,`
	`45`	`+ keyColumn: bucket.keyColumn,`
`45`	`46`	`},`
`46`	`47`	`bucket.lockedKeys,`
`47`	`48`	`bucket.lockedPatterns,`