feat: more flexible glob patterns

.changeset/improve-glob-patterns.md

@@ -0,0 +1,5 @@
+---
+"lingo.dev": patch
+---
+
+Add support for globstar patterns in bucket configuration and improve path matching

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

@@ -1,4 +1,4 @@
-import { describe, it, expect, vi } from "vitest";
+import { describe, it, expect, vi, beforeEach } from "vitest";
 import { getBuckets } from "./buckets";
 import { glob, Path } from "glob";
 
@@ -9,6 +9,10 @@ vi.mock("glob", () => ({
 }));
 
 describe("getBuckets", () => {
+  beforeEach(() => {
+    vi.mocked(glob.sync).mockReset();
+  });
+
   const makeI18nConfig = (include: any[]) => ({
     $schema: "https://lingo.dev/schema/i18n.json",
     version: 0,
@@ -167,6 +171,329 @@ describe("getBuckets", () => {
       },
     ]);
   });
+
+  it("restores locale placeholder when using recursive globstar patterns", () => {
+    mockGlobSync([
+      "src/modules/core/auth/en/strings/messages.json",
+      "src/modules/marketing/en/strings/dashboard.json",
+    ]);
+
+    const i18nConfig = makeI18nConfig([
+      "src/modules/**/[locale]/strings/*.json",
+    ]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/modules/core/auth/[locale]/strings/messages.json",
+            delimiter: null,
+          },
+          {
+            pathPattern:
+              "src/modules/marketing/[locale]/strings/dashboard.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("restores placeholder when extglob wraps the locale segment", () => {
+    mockGlobSync(["src/modules/core-en.json", "src/modules/marketing-en.json"]);
+
+    const i18nConfig = makeI18nConfig([
+      "src/modules/@(core|marketing)-[locale].json",
+    ]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          { pathPattern: "src/modules/core-[locale].json", delimiter: null },
+          {
+            pathPattern: "src/modules/marketing-[locale].json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("restores placeholder when brace expansion surrounds locale segment", () => {
+    mockGlobSync([
+      "src/modules/core/en/strings/messages.json",
+      "src/modules/marketing/en/strings/dashboard.json",
+    ]);
+
+    const i18nConfig = makeI18nConfig([
+      "src/modules/{core,marketing}/[locale]/strings/*.json",
+    ]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/modules/core/[locale]/strings/messages.json",
+            delimiter: null,
+          },
+          {
+            pathPattern:
+              "src/modules/marketing/[locale]/strings/dashboard.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("preserves glob character classes around locale placeholder", () => {
+    mockGlobSync(["src/files/id-en.json"]);
+
+    const i18nConfig = makeI18nConfig(["src/files/??-[locale].json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/files/id-[locale].json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("supports globstar at the beginning of the pattern", () => {
+    mockGlobSync([
+      "src/modules/core/en/messages.json",
+      "src/modules/marketing/en/dashboard.json",
+    ]);
+
+    const i18nConfig = makeI18nConfig(["**/[locale]/*.json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/modules/core/[locale]/messages.json",
+            delimiter: null,
+          },
+          {
+            pathPattern: "src/modules/marketing/[locale]/dashboard.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("supports multiple globstars surrounding the locale segment", () => {
+    mockGlobSync([
+      "src/modules/core/services/en/api/messages.json",
+      "src/modules/marketing/en/email/templates/messages.json",
+    ]);
+
+    const i18nConfig = makeI18nConfig(["src/**/[locale]/**/messages.json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/modules/core/services/[locale]/api/messages.json",
+            delimiter: null,
+          },
+          {
+            pathPattern:
+              "src/modules/marketing/[locale]/email/templates/messages.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("supports globstar segments after the locale placeholder", () => {
+    mockGlobSync(["src/i18n/en/deep/messages.json"]);
+
+    const i18nConfig = makeI18nConfig(["src/i18n/[locale]/**/messages.json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/i18n/[locale]/deep/messages.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("supports globstar leading directly into the locale file name", () => {
+    mockGlobSync(["src/en.json", "src/translations/en.json"]);
+
+    const i18nConfig = makeI18nConfig(["**/[locale].json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          { pathPattern: "src/[locale].json", delimiter: null },
+          {
+            pathPattern: "src/translations/[locale].json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("supports trailing globstar before the file extension", () => {
+    mockGlobSync(["src/files/en/report.json", "src/files/en/app.json"]);
+
+    const i18nConfig = makeI18nConfig(["src/files/[locale]/**.json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/files/[locale]/report.json",
+            delimiter: null,
+          },
+          {
+            pathPattern: "src/files/[locale]/app.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("handles consecutive globstars before the locale segment", () => {
+    mockGlobSync(["src/a/b/en/messages.json", "src/en/messages.json"]);
+
+    const i18nConfig = makeI18nConfig(["src/**/**/[locale]/messages.json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          {
+            pathPattern: "src/a/b/[locale]/messages.json",
+            delimiter: null,
+          },
+          {
+            pathPattern: "src/[locale]/messages.json",
+            delimiter: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  it("deduplicates overlapping include patterns", () => {
+    mockGlobSync(["src/i18n/en.json"]);
+    mockGlobSync(["src/i18n/en.json"]);
+
+    const i18nConfig = makeI18nConfig([
+      "src/i18n/**/[locale].json",
+      "src/i18n/[locale].json",
+    ]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [{ pathPattern: "src/i18n/[locale].json", delimiter: null }],
+      },
+    ]);
+  });
+
+  it("keeps distinct entries for matching paths with different delimiters", () => {
+    mockGlobSync(["src/i18n/en.json"]);
+    mockGlobSync(["src/i18n/en.json"]);
+
+    const i18nConfig = makeI18nConfig([
+      { path: "src/i18n/[locale].json", delimiter: "-" },
+      { path: "src/i18n/[locale].json", delimiter: "_" },
+    ]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          { pathPattern: "src/i18n/[locale].json", delimiter: "-" },
+          { pathPattern: "src/i18n/[locale].json", delimiter: "_" },
+        ],
+      },
+    ]);
+  });
+
+  it("excludes entries matching both path pattern and delimiter", () => {
+    mockGlobSync(["src/i18n/en.json"]);
+    mockGlobSync(["src/i18n/en.json"]);
+    mockGlobSync(["src/i18n/en.json"]);
+
+    const i18nConfig = makeI18nConfig([
+      { path: "src/i18n/[locale].json", delimiter: "-" },
+      { path: "src/i18n/[locale].json", delimiter: "_" },
+    ]);
+    i18nConfig.buckets.json.exclude = [
+      { path: "src/i18n/[locale].json", delimiter: "-" },
+    ];
+
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [{ pathPattern: "src/i18n/[locale].json", delimiter: "_" }],
+      },
+    ]);
+  });
+
+  it("restores placeholder when locale appears multiple times in a segment", () => {
+    mockGlobSync(["src/files/en-en.json"]);
+
+    const i18nConfig = makeI18nConfig(["src/files/[locale]-[locale].json"]);
+    const buckets = getBuckets(i18nConfig);
+
+    expect(buckets).toEqual([
+      {
+        type: "json",
+        paths: [
+          { pathPattern: "src/files/[locale]-[locale].json", delimiter: null },
+        ],
+      },
+    ]);
+  });
+
+  it("throws when pattern resolves outside of the current working directory", () => {
+    const i18nConfig = makeI18nConfig(["../outside/[locale].json"]);
+
+    expect(() => getBuckets(i18nConfig)).toThrowError(
+      /Invalid path pattern: \.{2}\//,
+    );
+  });
 });
 
 function mockGlobSync(...args: string[][]) {