Merge branch 'main' of https://github.com/SXsid/lingo.dev

SXsid · SXsid · commit 71471a799556 · 2025-03-27T22:36:36.000+05:30
diff --git a/.changeset/funny-shoes-scream.md b/.changeset/funny-shoes-scream.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.changeset/new-buses-carry.md b/.changeset/new-buses-carry.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.changeset/polite-trees-compete.md b/.changeset/polite-trees-compete.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.changeset/serious-wasps-unite.md b/.changeset/serious-wasps-unite.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,7 @@ node_modules
 
 # Testing
 coverage
+.idea
 
 # Turbo
 .turbo
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ cd packages/cli
 pnpm run dev
 
 # in terminal window 2 - test the CLI
-cd package
+cd packages/cli
 pnpm lingo.dev --help # this command will use the current cli code + demo config from ./package/i18n.json
 ```
 
diff --git a/packages/cli/src/cli/cmd/cleanup.ts b/packages/cli/src/cli/cmd/cleanup.ts
@@ -1,4 +1,4 @@
-import { I18nConfig, resolveOverridenLocale } from "@lingo.dev/_spec";
+import { I18nConfig, resolveOverriddenLocale } from "@lingo.dev/_spec";
 import { Command } from "interactive-commander";
 import _ from "lodash";
 import { getConfig } from "../utils/config";
@@ -38,17 +38,20 @@ export default new Command()
         ora.info(`Processing bucket: ${bucket.type}`);
 
         for (const bucketConfig of bucket.config) {
-          const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+          const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
           const bucketOra = Ora({ indent: 2 }).info(`Processing path: ${bucketConfig.pathPattern}`);
-          const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, { isCacheRestore: false, defaultLocale: sourceLocale });
+          const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
+            isCacheRestore: false,
+            defaultLocale: sourceLocale,
+          });
           bucketLoader.setDefaultLocale(sourceLocale);
 
           // Load source data
           const sourceData = await bucketLoader.pull(sourceLocale);
           const sourceKeys = Object.keys(sourceData);
 
           for (const _targetLocale of targetLocales) {
-            const targetLocale = resolveOverridenLocale(_targetLocale, bucketConfig.delimiter);
+            const targetLocale = resolveOverriddenLocale(_targetLocale, bucketConfig.delimiter);
             try {
               const targetData = await bucketLoader.pull(targetLocale);
               const targetKeys = Object.keys(targetData);
diff --git a/packages/cli/src/cli/cmd/i18n.ts b/packages/cli/src/cli/cmd/i18n.ts
@@ -1,4 +1,4 @@
-import { bucketTypeSchema, I18nConfig, localeCodeSchema, resolveOverridenLocale } from "@lingo.dev/_spec";
+import { bucketTypeSchema, I18nConfig, localeCodeSchema, resolveOverriddenLocale } from "@lingo.dev/_spec";
 import { LingoDotDevEngine } from "@lingo.dev/_sdk";
 import { Command } from "interactive-commander";
 import Z from "zod";
@@ -79,7 +79,7 @@ export default new Command()
         ora.start("Creating i18n.lock...");
         for (const bucket of buckets) {
           for (const bucketConfig of bucket.config) {
-            const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+            const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
 
             const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
               isCacheRestore: false,
@@ -110,7 +110,7 @@ export default new Command()
             const bucketOra = Ora({ indent: 4 });
             bucketOra.info(`Processing path: ${bucketConfig.pathPattern}`);
 
-            const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+            const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
             const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
               isCacheRestore: true,
               defaultLocale: sourceLocale,
@@ -154,7 +154,7 @@ export default new Command()
         let requiresUpdate: string | null = null;
         bucketLoop: for (const bucket of buckets) {
           for (const bucketConfig of bucket.config) {
-            const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+            const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
 
             const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
               isCacheRestore: false,
@@ -176,7 +176,7 @@ export default new Command()
             }
 
             for (const _targetLocale of targetLocales) {
-              const targetLocale = resolveOverridenLocale(_targetLocale, bucketConfig.delimiter);
+              const targetLocale = resolveOverriddenLocale(_targetLocale, bucketConfig.delimiter);
               const { unlocalizable: targetUnlocalizable, ...targetData } = await bucketLoader.pull(targetLocale);
 
               const missingKeys = _.difference(Object.keys(sourceData), Object.keys(targetData));
@@ -227,7 +227,7 @@ export default new Command()
           for (const bucketConfig of bucket.config) {
             const bucketOra = Ora({ indent: 2 }).info(`Processing path: ${bucketConfig.pathPattern}`);
 
-            const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+            const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
 
             const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
               isCacheRestore: false,
@@ -238,7 +238,7 @@ export default new Command()
             let sourceData = await bucketLoader.pull(sourceLocale);
 
             for (const _targetLocale of targetLocales) {
-              const targetLocale = resolveOverridenLocale(_targetLocale, bucketConfig.delimiter);
+              const targetLocale = resolveOverriddenLocale(_targetLocale, bucketConfig.delimiter);
               try {
                 bucketOra.start(`[${sourceLocale} -> ${targetLocale}] (0%) Localization in progress...`);
 
diff --git a/packages/cli/src/cli/cmd/lockfile.ts b/packages/cli/src/cli/cmd/lockfile.ts
@@ -2,7 +2,7 @@ import { Command } from "interactive-commander";
 import Z from "zod";
 import Ora from "ora";
 import { createLockfileHelper } from "../utils/lockfile";
-import { bucketTypeSchema, resolveOverridenLocale } from "@lingo.dev/_spec";
+import { bucketTypeSchema, resolveOverriddenLocale } from "@lingo.dev/_spec";
 import { getConfig } from "../utils/config";
 import createBucketLoader from "../loaders";
 import { getBuckets } from "../utils/buckets";
@@ -25,8 +25,11 @@ export default new Command()
 
       for (const bucket of buckets) {
         for (const bucketConfig of bucket.config) {
-          const sourceLocale = resolveOverridenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
-          const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, { isCacheRestore: false, defaultLocale: sourceLocale });
+          const sourceLocale = resolveOverriddenLocale(i18nConfig!.locale.source, bucketConfig.delimiter);
+          const bucketLoader = createBucketLoader(bucket.type, bucketConfig.pathPattern, {
+            isCacheRestore: false,
+            defaultLocale: sourceLocale,
+          });
           bucketLoader.setDefaultLocale(sourceLocale);
 
           const sourceData = await bucketLoader.pull(sourceLocale);
diff --git a/packages/cli/src/cli/cmd/show/files.ts b/packages/cli/src/cli/cmd/show/files.ts
@@ -4,7 +4,7 @@ import Ora from "ora";
 import { getConfig } from "../../utils/config";
 import { CLIError } from "../../utils/errors";
 import { getBuckets } from "../../utils/buckets";
-import { resolveOverridenLocale } from "@lingo.dev/_spec";
+import { resolveOverriddenLocale } from "@lingo.dev/_spec";
 
 export default new Command()
   .command("files")
@@ -28,10 +28,10 @@ export default new Command()
         const buckets = getBuckets(i18nConfig);
         for (const bucket of buckets) {
           for (const bucketConfig of bucket.config) {
-            const sourceLocale = resolveOverridenLocale(i18nConfig.locale.source, bucketConfig.delimiter);
+            const sourceLocale = resolveOverriddenLocale(i18nConfig.locale.source, bucketConfig.delimiter);
             const sourcePath = bucketConfig.pathPattern.replace(/\[locale\]/g, sourceLocale);
             const targetPaths = i18nConfig.locale.targets.map((_targetLocale) => {
-              const targetLocale = resolveOverridenLocale(_targetLocale, bucketConfig.delimiter);
+              const targetLocale = resolveOverriddenLocale(_targetLocale, bucketConfig.delimiter);
               return bucketConfig.pathPattern.replace(/\[locale\]/g, targetLocale);
             });
 
diff --git a/packages/cli/src/cli/utils/buckets.ts b/packages/cli/src/cli/utils/buckets.ts
@@ -2,7 +2,7 @@ import _ from "lodash";
 import path from "path";
 import { glob } from "glob";
 import { CLIError } from "./errors";
-import { I18nConfig, resolveOverridenLocale, BucketItem } from "@lingo.dev/_spec";
+import { I18nConfig, resolveOverriddenLocale, BucketItem } from "@lingo.dev/_spec";
 import { bucketTypeSchema } from "@lingo.dev/_spec";
 import Z from "zod";
 
@@ -21,15 +21,15 @@ export function getBuckets(i18nConfig: I18nConfig) {
 
 function extractPathPatterns(sourceLocale: string, include: BucketItem[], exclude?: BucketItem[]) {
   const includedPatterns = include.flatMap((pattern) =>
-    expandPlaceholderedGlob(pattern.path, resolveOverridenLocale(sourceLocale, pattern.delimiter)).map(
+    expandPlaceholderedGlob(pattern.path, resolveOverriddenLocale(sourceLocale, pattern.delimiter)).map(
       (pathPattern) => ({
         pathPattern,
         delimiter: pattern.delimiter,
       }),
     ),
   );
   const excludedPatterns = exclude?.flatMap((pattern) =>
-    expandPlaceholderedGlob(pattern.path, resolveOverridenLocale(sourceLocale, pattern.delimiter)).map(
+    expandPlaceholderedGlob(pattern.path, resolveOverriddenLocale(sourceLocale, pattern.delimiter)).map(
       (pathPattern) => ({
         pathPattern,
         delimiter: pattern.delimiter,
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -49,8 +49,8 @@ export class LingoDotDevEngine {
     progressCallback?: (
       progress: number,
       sourceChunk: Record<string, string>,
-      processedChunk: Record<string, string>
-    ) => void
+      processedChunk: Record<string, string>,
+    ) => void,
   ): Promise<Record<string, string>> {
     const finalPayload = payloadSchema.parse(payload);
     const finalParams = localizationParamsSchema.parse(params);
@@ -68,7 +68,7 @@ export class LingoDotDevEngine {
         finalParams.targetLocale,
         { data: chunk, reference: params.reference },
         workflowId,
-        params.fast || false
+        params.fast || false,
       );
 
       if (progressCallback) {
@@ -96,7 +96,7 @@ export class LingoDotDevEngine {
       reference?: Z.infer<typeof referenceSchema>;
     },
     workflowId: string,
-    fast: boolean
+    fast: boolean,
   ): Promise<Record<string, string>> {
     const res = await fetch(`${this.config.apiUrl}/i18n`, {
       method: "POST",
@@ -115,7 +115,7 @@ export class LingoDotDevEngine {
           reference: payload.reference,
         },
         null,
-        2
+        2,
       ),
     });
 
@@ -202,8 +202,8 @@ export class LingoDotDevEngine {
     progressCallback?: (
       progress: number,
       sourceChunk: Record<string, string>,
-      processedChunk: Record<string, string>
-    ) => void
+      processedChunk: Record<string, string>,
+    ) => void,
   ): Promise<Record<string, any>> {
     return this._localizeRaw(obj, params, progressCallback);
   }
@@ -221,7 +221,7 @@ export class LingoDotDevEngine {
   async localizeText(
     text: string,
     params: Z.infer<typeof localizationParamsSchema>,
-    progressCallback?: (progress: number) => void
+    progressCallback?: (progress: number) => void,
   ): Promise<string> {
     const response = await this._localizeRaw({ text }, params, progressCallback);
     return response.text || "";
@@ -242,16 +242,16 @@ export class LingoDotDevEngine {
       sourceLocale: LocaleCode;
       targetLocales: LocaleCode[];
       fast?: boolean;
-    }
+    },
   ) {
     const responses = await Promise.all(
       params.targetLocales.map((targetLocale) =>
         this.localizeText(text, {
           sourceLocale: params.sourceLocale,
           targetLocale,
           fast: params.fast,
-        })
-      )
+        }),
+      ),
     );
 
     return responses;
@@ -270,7 +270,7 @@ export class LingoDotDevEngine {
   async localizeChat(
     chat: Array<{ name: string; text: string }>,
     params: Z.infer<typeof localizationParamsSchema>,
-    progressCallback?: (progress: number) => void
+    progressCallback?: (progress: number) => void,
   ): Promise<Array<{ name: string; text: string }>> {
     const localized = await this._localizeRaw({ chat }, params, progressCallback);
 
@@ -294,7 +294,7 @@ export class LingoDotDevEngine {
   async localizeHtml(
     html: string,
     params: Z.infer<typeof localizationParamsSchema>,
-    progressCallback?: (progress: number) => void
+    progressCallback?: (progress: number) => void,
   ): Promise<string> {
     const jsdomPackage = await import("jsdom");
     const { JSDOM } = jsdomPackage;
@@ -326,7 +326,7 @@ export class LingoDotDevEngine {
         }
 
         const siblings = Array.from(parent.childNodes).filter(
-          (n) => n.nodeType === 1 || (n.nodeType === 3 && n.textContent?.trim())
+          (n) => n.nodeType === 1 || (n.nodeType === 3 && n.textContent?.trim()),
         );
         const index = siblings.indexOf(current);
         if (index !== -1) {
@@ -392,7 +392,7 @@ export class LingoDotDevEngine {
 
       for (const index of indices) {
         const siblings = Array.from(parent.childNodes).filter(
-          (n) => n.nodeType === 1 || (n.nodeType === 3 && n.textContent?.trim())
+          (n) => n.nodeType === 1 || (n.nodeType === 3 && n.textContent?.trim()),
         );
         current = siblings[parseInt(index)] || null;
         if (current?.nodeType === 1) {
@@ -440,18 +440,36 @@ export class LingoDotDevEngine {
  * @deprecated Use LingoDotDevEngine instead. This class is maintained for backwards compatibility.
  */
 export class ReplexicaEngine extends LingoDotDevEngine {
+  private static hasWarnedDeprecation = false;
+
   constructor(config: Partial<Z.infer<typeof engineParamsSchema>>) {
     super(config);
-    console.warn("ReplexicaEngine is deprecated. Please use LingoDotDevEngine instead.");
+    if (!ReplexicaEngine.hasWarnedDeprecation) {
+      console.warn(
+        "ReplexicaEngine is deprecated and will be removed in a future release. " +
+          "Please use LingoDotDevEngine instead. " +
+          "See https://docs.lingo.dev/migration for more information.",
+      );
+      ReplexicaEngine.hasWarnedDeprecation = true;
+    }
   }
 }
 
 /**
  * @deprecated Use LingoDotDevEngine instead. This class is maintained for backwards compatibility.
  */
 export class LingoEngine extends LingoDotDevEngine {
+  private static hasWarnedDeprecation = false;
+
   constructor(config: Partial<Z.infer<typeof engineParamsSchema>>) {
     super(config);
-    console.warn("LingoEngine is deprecated. Please use LingoDotDevEngine instead.");
+    if (!LingoEngine.hasWarnedDeprecation) {
+      console.warn(
+        "LingoEngine is deprecated and will be removed in a future release. " +
+          "Please use LingoDotDevEngine instead. " +
+          "See https://docs.lingo.dev/migration for more information.",
+      );
+      LingoEngine.hasWarnedDeprecation = true;
+    }
   }
 }
diff --git a/packages/spec/src/locales.ts b/packages/spec/src/locales.ts
