feat(cli): support multiple locales in path (#490)

Author: mathio

.changeset/polite-candles-brush.md

@@ -0,0 +1,5 @@
+---
+"lingo.dev": minor
+---
+
+support multiple [locale] placeholders in bucket path

packages/cli/src/cli/loaders/index.spec.ts

@@ -404,6 +404,26 @@ describe("bucket loaders", () => {
 
       expect(fs.writeFile).toHaveBeenCalledWith("i18n/es.json", expectedOutput, { encoding: "utf-8", flag: "w" });
     });
+
+    it("should load and save json data for paths with multiple locales", async () => {
+      setupFileMocks();
+
+      const input = { "button.title": "Submit" };
+      const payload = { "button.title": "Enviar" };
+      const expectedOutput = JSON.stringify(payload, null, 2);
+
+      mockFileOperations(JSON.stringify(input));
+
+      const jsonLoader = createBucketLoader("json", "i18n/[locale]/[locale].json");
+      jsonLoader.setDefaultLocale("en");
+      const data = await jsonLoader.pull("en");
+
+      await jsonLoader.push("es", payload);
+
+      expect(data).toEqual(input);
+      expect(fs.access).toHaveBeenCalledWith("i18n/en/en.json");
+      expect(fs.writeFile).toHaveBeenCalledWith("i18n/es/es.json", expectedOutput, { encoding: "utf-8", flag: "w" });
+    });
   });
 
   describe("markdown bucket loader", () => {

packages/cli/src/cli/loaders/text-file.ts

@@ -11,7 +11,7 @@ export default function createTextFileLoader(pathPattern: string): ILoader<void,
       return trimmedResult;
     },
     async push(locale, data, _, originalLocale) {
-      const draftPath = pathPattern.replace("[locale]", locale);
+      const draftPath = pathPattern.replaceAll("[locale]", locale);
       const finalPath = path.resolve(draftPath);
 
       // Create parent directories if needed
@@ -33,7 +33,7 @@ export default function createTextFileLoader(pathPattern: string): ILoader<void,
 }
 
 async function readFileForLocale(pathPattern: string, locale: string) {
-  const draftPath = pathPattern.replace("[locale]", locale);
+  const draftPath = pathPattern.replaceAll("[locale]", locale);
   const finalPath = path.resolve(draftPath);
   const exists = await fs
     .access(finalPath)

packages/cli/src/cli/utils/buckets.spec.ts

@@ -0,0 +1,58 @@
+import { describe, it, expect, vi } from "vitest";
+import { getBuckets } from "./buckets";
+
+vi.mock("glob", () => ({
+  sync: vi.fn().mockImplementation((path) => [{ isFile: () => true, fullpath: () => path }]),
+}));
+
+describe("getBuckets", () => {
+  const makeI18nConfig = (include: any[]) => ({
+    version: 0,
+    locale: {
+      source: "en",
+      targets: ["fr", "es"],
+    },
+    buckets: {
+      json: {
+        include,
+      },
+    },
+  });
+
+  it("should return correct buckets", () => {
+    const i18nConfig = makeI18nConfig(["src/i18n/[locale].json", "src/translations/[locale]/messages.json"]);
+    const buckets = getBuckets(i18nConfig);
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        config: [
+          { pathPattern: "src/i18n/[locale].json", delimiter: null },
+          { pathPattern: "src/translations/[locale]/messages.json", delimiter: null },
+        ],
+      },
+    ]);
+  });
+
+  it("should return correct bucket with delimiter", () => {
+    const i18nConfig = makeI18nConfig([{ path: "src/i18n/[locale].json", delimiter: "-" }]);
+    const buckets = getBuckets(i18nConfig);
+    expect(buckets).toEqual([{ type: "json", config: [{ pathPattern: "src/i18n/[locale].json", delimiter: "-" }] }]);
+  });
+
+  it("should return bucket with multiple locale placeholders", () => {
+    const i18nConfig = makeI18nConfig([
+      "src/i18n/[locale]/[locale].json",
+      "src/[locale]/translations/[locale]/messages.json",
+    ]);
+    const buckets = getBuckets(i18nConfig);
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        config: [
+          { pathPattern: "src/i18n/[locale]/[locale].json", delimiter: null },
+          { pathPattern: "src/[locale]/translations/[locale]/messages.json", delimiter: null },
+        ],
+      },
+    ]);
+  });
+});

packages/cli/src/cli/utils/buckets.ts

@@ -59,21 +59,18 @@ function expandPlaceholderedGlob(_pathPattern: string, sourceLocale: string): st
       docUrl: "invalidPathPattern",
     });
   }
-  // Throw error if pathPattern contains "[locale]" several times
-  if (pathPattern.split("[locale]").length > 2) {
-    throw new CLIError({
-      message: `Invalid path pattern: ${pathPattern}. Path pattern must contain at most one "[locale]" placeholder.`,
-      docUrl: "invalidPathPattern",
-    });
-  }
+
   // Break down path pattern into parts
   const pathPatternChunks = pathPattern.split(path.sep);
   // Find the index of the segment containing "[locale]"
-  const localeSegmentIndex = pathPatternChunks.findIndex((segment) => segment.includes("[locale]"));
-  // Find the position of the "[locale]" placeholder within the segment
-  const localePlaceholderIndex = pathPatternChunks[localeSegmentIndex]?.indexOf("[locale]") ?? -1;
+  const localeSegmentIndexes = pathPatternChunks.reduce((indexes, segment, index) => {
+    if (segment.includes("[locale]")) {
+      indexes.push(index);
+    }
+    return indexes;
+  }, [] as number[]);
   // substitute [locale] in pathPattern with sourceLocale
-  const sourcePathPattern = pathPattern.replace(/\[locale\]/g, sourceLocale);
+  const sourcePathPattern = pathPattern.replaceAll(/\[locale\]/g, sourceLocale);
   // get all files that match the sourcePathPattern
   const sourcePaths = glob
     .sync(sourcePathPattern, { follow: true, withFileTypes: true })
@@ -83,14 +80,18 @@ function expandPlaceholderedGlob(_pathPattern: string, sourceLocale: string): st
   // transform each source file path back to [locale] placeholder paths
   const placeholderedPaths = sourcePaths.map((sourcePath) => {
     const sourcePathChunks = sourcePath.split(path.sep);
-    if (localeSegmentIndex >= 0 && localePlaceholderIndex >= 0) {
-      const placeholderedPathChunk = sourcePathChunks[localeSegmentIndex];
-      const placeholderedSegment =
-        placeholderedPathChunk.substring(0, localePlaceholderIndex) +
-        "[locale]" +
-        placeholderedPathChunk.substring(localePlaceholderIndex + sourceLocale.length);
-      sourcePathChunks[localeSegmentIndex] = placeholderedSegment;
-    }
+    localeSegmentIndexes.forEach((localeSegmentIndex) => {
+      // Find the position of the "[locale]" placeholder within the segment
+      const localePlaceholderIndex = pathPatternChunks[localeSegmentIndex]?.indexOf("[locale]") ?? -1;
+      if (localeSegmentIndex >= 0 && localePlaceholderIndex >= 0) {
+        const placeholderedPathChunk = sourcePathChunks[localeSegmentIndex];
+        const placeholderedSegment =
+          placeholderedPathChunk.substring(0, localePlaceholderIndex) +
+          "[locale]" +
+          placeholderedPathChunk.substring(localePlaceholderIndex + sourceLocale.length);
+        sourcePathChunks[localeSegmentIndex] = placeholderedSegment;
+      }
+    });
     const placeholderedPath = sourcePathChunks.join(path.sep);
     return placeholderedPath;
   });

packages/cli/src/cli/utils/find-locale-paths.spec.ts

@@ -67,6 +67,10 @@ describe("findLocaleFiles", () => {
       "src/aa/bb/foobar/cc/translations/es/values.json",
       "src/aa/en.json",
       "src/aa/translations/bb/en.json",
+      "foo/en-US/en-US.json",
+      "foo/en-US/en-US/messages.json",
+      "bar/es/baz/es.json",
+      "bar/es/es.json",
 
       // not a valid locale
       "src/xx/settings.json",
@@ -85,6 +89,10 @@ describe("findLocaleFiles", () => {
         "src/aa/bb/foobar/cc/translations/[locale]/values.json",
         "src/aa/[locale].json",
         "src/aa/translations/bb/[locale].json",
+        "foo/[locale]/[locale].json",
+        "foo/[locale]/[locale]/messages.json",
+        "bar/[locale]/baz/[locale].json",
+        "bar/[locale]/[locale].json",
       ],
     });
   });

packages/cli/src/cli/utils/find-locale-paths.ts

@@ -60,10 +60,10 @@ function findLocaleFilesWithExtension(ext: string) {
     .filter(({ locale }) => locale !== null);
 
   const localeFilesAndPatterns = potantialLocaleFilesAndPatterns.map(({ file, locale }) => {
-    const localeInDir = file.match(`/${locale}/`);
-    const pattern = localeInDir
-      ? file.replace(`/${locale}/`, `/[locale]/`)
-      : path.join(path.dirname(file), `[locale]${ext}`);
+    const pattern = file
+      .replaceAll(new RegExp(`/${locale}${ext}`, "g"), `/[locale]${ext}`)
+      .replaceAll(new RegExp(`/${locale}/`, "g"), `/[locale]/`)
+      .replaceAll(new RegExp(`/${locale}/`, "g"), `/[locale]/`); // for when there are 2 locales one after another
     return { pattern, file };
   });