@lingui/cli 6.5.0 → 6.7.0

package/README.md

@@ -4,22 +4,43 @@
 
 # @lingui/cli
 
-> lingui command line library for manipulating message catalogues
+> Lingui CLI: extracts i18n messages from source code into catalogs and compiles the translated catalogs for the runtime
 
-`@lingui/cli` is part of [LinguiJS][linguijs]. See the [documentation][documentation] for all information, tutorials and examples.
+`@lingui/cli` is part of [Lingui][documentation]. Lingui is a lightweight, open-source internationalization (i18n) library for JavaScript and TypeScript. It brings compile-time macros and a CLI for message extraction to React, React Native, Vue, SolidJS, Astro, Svelte, and Node.js.
 
-## Installation & Usage
+The `lingui` command reads `lingui.config.js` (or `.ts`) from the project root: the source locale, the target locales and where the catalogs live. The [installation guide][installation] shows the minimal file and the [configuration reference][conf] lists every option.
 
-See the [reference][reference] documentation.
+## Installation
+
+```sh
+npm install --save-dev @lingui/cli
+```
+
+## Usage
+
+- `lingui extract` finds the messages in the source, merges them into one catalog per locale, keeps existing translations and marks removed messages as obsolete.
+- `lingui compile` compiles the translated catalogs into JavaScript modules for the runtime and reports messages with invalid ICU syntax.
+- `lingui extract-template` writes a single `.pot` template with the source messages, for translation platforms that create the locale files themselves.
+- `lingui extract-experimental` follows the imports from each entry point instead of a glob, so a multi-page app gets one catalog per page.
+
+Extraction parses JavaScript and TypeScript out of the box; Vue single-file components need [`@lingui/extractor-vue`][extractor-vue]. Catalogs are PO files by default, with [other formats][catalog-formats] available as separate packages. To let the bundler compile catalogs instead of running `lingui compile`, use [`@lingui/vite-plugin`][vite-plugin], [`@lingui/loader`][loader] or [`@lingui/metro-transformer`][metro-transformer].
+
+See the [CLI reference][reference] for all commands and options.
 
 ## License
 
-This package is licensed under [MIT][license] license.
+This package is licensed under the [MIT][license] license.
 
 [license]: https://github.com/lingui/js-lingui/blob/main/LICENSE
-[linguijs]: https://github.com/lingui/js-lingui
 [documentation]: https://lingui.dev
+[installation]: https://lingui.dev/installation
+[conf]: https://lingui.dev/ref/conf
 [reference]: https://lingui.dev/ref/cli
+[catalog-formats]: https://lingui.dev/ref/catalog-formats
+[extractor-vue]: https://lingui.dev/ref/extractor-vue
+[vite-plugin]: https://lingui.dev/ref/vite-plugin
+[loader]: https://lingui.dev/ref/loader
+[metro-transformer]: https://lingui.dev/ref/metro-transformer
 [package]: https://www.npmjs.com/package/@lingui/cli
 [badge-downloads]: https://img.shields.io/npm/dw/@lingui/cli.svg
 [badge-version]: https://img.shields.io/npm/v/@lingui/cli.svg

package/dist/api/catalog/getCatalogs.js

@@ -43,13 +43,18 @@ export async function getCatalogs(config) {
         });
         candidates.forEach((catalogDir) => {
             const name = path.basename(catalogDir);
+            const globName = escapeCatalogNameForGlob(name);
             catalogs.push(new Catalog({
                 name,
                 path: normalizeRelativePath(replacePlaceholders(catalog.path, { name })),
                 include: include.map((path) => replacePlaceholders(path, { name })),
                 exclude: exclude.map((path) => replacePlaceholders(path, { name })),
                 format,
-            }, config));
+            }, config, {
+                path: replacePlaceholders(catalog.path, { name: globName }),
+                include: include.map((path) => replacePlaceholders(path, { name: globName })),
+                exclude: exclude.map((path) => replacePlaceholders(path, { name: globName })),
+            }));
         });
     });
     if (config.experimental?.extractor &&
@@ -58,6 +63,9 @@ export async function getCatalogs(config) {
     }
     return catalogs;
 }
+function escapeCatalogNameForGlob(value) {
+    return value.replace(/[[\]()]/g, "[$&]");
+}
 /**
  * Ensure that value is always array. If not, turn it into an array of one element.
  */

package/dist/api/catalog.d.ts

@@ -29,7 +29,13 @@ export type CatalogProps = {
     templatePath?: string;
     format: FormatterWrapper;
 };
+type CatalogGlobPatterns = {
+    path: string;
+    include: Array<string>;
+    exclude: Array<string>;
+};
 export declare class Catalog {
+    #private;
     config: LinguiConfigNormalized;
     name?: string;
     path: string;
@@ -37,7 +43,7 @@ export declare class Catalog {
     exclude: Array<string>;
     format: FormatterWrapper;
     templateFile: string;
-    constructor({ name, path, include, templatePath, format, exclude }: CatalogProps, config: LinguiConfigNormalized);
+    constructor({ name, path, include, templatePath, format, exclude }: CatalogProps, config: LinguiConfigNormalized, globPatterns?: CatalogGlobPatterns);
     getFilename(locale: string): string;
     make(options: MakeOptions): Promise<AllCatalogsType | false>;
     makeTemplate(options: MakeTemplateOptions): Promise<CatalogType | false>;
@@ -71,3 +77,4 @@ export declare function cleanObsolete<T extends CatalogType>(messages: T): T;
 export declare function order<T extends CatalogType>(by: OrderBy, catalog: T): T;
 export declare function writeCompiled(path: string, locale: string, compiledCatalog: string, namespace?: CompiledCatalogNamespace): Promise<string>;
 export declare const orderByMessage: OrderByFn;
+export {};

package/dist/api/catalog.js

@@ -17,12 +17,19 @@ export class Catalog {
     exclude;
     format;
     templateFile;
-    constructor({ name, path, include, templatePath, format, exclude = [] }, config) {
+    #includePatterns;
+    #excludePatterns;
+    constructor({ name, path, include, templatePath, format, exclude = [] }, config, globPatterns = { path, include, exclude }) {
         this.config = config;
         this.name = name;
         this.path = normalizeRelativePath(path);
         this.include = include.map(normalizeRelativePath);
         this.exclude = [this.localeDir, ...exclude.map(normalizeRelativePath)];
+        this.#includePatterns = createCatalogPatterns(this.include, globPatterns.include.map(normalizeRelativePath));
+        this.#excludePatterns = createCatalogPatterns(this.exclude, [
+            getLocaleDir(normalizeRelativePath(globPatterns.path)),
+            ...globPatterns.exclude.map(normalizeRelativePath),
+        ]);
         this.format = format;
         this.templateFile =
             templatePath ||
@@ -194,30 +201,54 @@ export class Catalog {
     async readTemplate() {
         return await this.format.read(this.templateFile, undefined);
     }
+    /** @internal */
+    get sourcePatterns() {
+        return {
+            include: resolveCatalogPatterns(this.include, this.#includePatterns),
+            exclude: resolveCatalogPatterns(this.exclude, this.#excludePatterns),
+        };
+    }
     get sourcePaths() {
-        const includeGlobs = this.include.map((includePath) => {
+        const sourcePatterns = this.sourcePatterns;
+        const includeGlobs = this.include.map((includePath, index) => {
+            const includeGlob = sourcePatterns.include[index];
             const isDir = isDirectory(includePath);
             /**
              * glob library results from absolute patterns such as /foo/* are mounted onto the root setting using path.join.
              * On windows, this will by default result in /foo/* matching C:\foo\bar.txt.
              */
             return isDir
-                ? normalize(path.resolve(process.cwd(), includePath === "/" ? "" : includePath, "**/*.*"))
-                : includePath;
+                ? normalize(path.resolve(process.cwd(), includePath === "/" ? "" : includeGlob, "**/*.*"))
+                : includeGlob;
         });
-        return globSync(includeGlobs, { exclude: this.exclude });
+        return globSync(includeGlobs, { exclude: sourcePatterns.exclude });
     }
     get localeDir() {
-        const localePatternIndex = this.path.indexOf(LOCALE);
-        if (localePatternIndex === -1) {
-            throw Error(`Invalid catalog path: ${LOCALE} variable is missing`);
-        }
-        return this.path.substring(0, localePatternIndex);
+        return getLocaleDir(this.path);
     }
     get locales() {
         return this.config.locales;
     }
 }
+function createCatalogPatterns(values, globs) {
+    return values.map((value, index) => ({
+        value,
+        glob: globs[index] ?? value,
+    }));
+}
+function resolveCatalogPatterns(values, patterns) {
+    return values.map((value, index) => {
+        const pattern = patterns[index];
+        return pattern?.value === value ? pattern.glob : value;
+    });
+}
+function getLocaleDir(catalogPath) {
+    const localePatternIndex = catalogPath.indexOf(LOCALE);
+    if (localePatternIndex === -1) {
+        throw Error(`Invalid catalog path: ${LOCALE} variable is missing`);
+    }
+    return catalogPath.substring(0, localePatternIndex);
+}
 function getTemplatePath(ext, path) {
     return path.replace(LOCALE_SUFFIX_RE, "messages" + ext);
 }
@@ -242,12 +273,15 @@ export function order(by, catalog) {
         return acc;
     }, {});
 }
+// hardcoded en-US locale to have consistent sorting
+// @see https://github.com/lingui/js-lingui/pull/1808
+const collator = new Intl.Collator("en-US");
 /**
  * Object keys are in the same order as they were created
  * https://stackoverflow.com/a/31102605/1535540
  */
 const orderByMessageId = (a, b) => {
-    return a.messageId.localeCompare(b.messageId);
+    return collator.compare(a.messageId, b.messageId);
 };
 const orderByOrigin = (a, b) => {
     if (!a.entry.origin || !b.entry.origin) {
@@ -292,9 +326,6 @@ export async function writeCompiled(path, locale, compiledCatalog, namespace) {
     await writeFile(filename, compiledCatalog);
     return filename;
 }
-// hardcoded en-US locale to have consistent sorting
-// @see https://github.com/lingui/js-lingui/pull/1808
-const collator = new Intl.Collator("en-US");
 export const orderByMessage = (a, b) => {
     const aMsg = a.entry.message || "";
     const bMsg = b.entry.message || "";

package/dist/api/compile/compileLocale.js

@@ -14,8 +14,9 @@ export async function compileLocale(catalogs, locale, options, config, doMerge,
             fallbackLocales: config.fallbackLocales,
             sourceLocale: config.sourceLocale,
         });
+        const pseudoLocaleConfig = config.pseudoLocale.find((item) => item.locale === locale);
         if (!options.allowEmpty &&
-            locale !== config.pseudoLocale.locale &&
+            !pseudoLocaleConfig &&
             missingMessages.length > 0) {
             logger.error(styleText("red", `Error: Failed to compile catalog for locale ${styleText("bold", locale)}!`));
             if (options.verbose) {
@@ -53,12 +54,13 @@ async function compileAndWrite(locale, config, options, writePath, messages, log
     const namespace = options.typescript
         ? "ts"
         : options.namespace || config.compileNamespace;
+    const pseudoLocaleConfig = config.pseudoLocale.find((item) => item.locale === locale);
     const { source: compiledCatalog, errors } = createCompiledCatalog(locale, messages, {
         strict: false,
         namespace,
         outputPrefix: options.outputPrefix,
-        pseudoLocale: config.pseudoLocale.locale,
-        pseudoLocaleOptions: config.pseudoLocale.options,
+        pseudoLocale: pseudoLocaleConfig?.locale,
+        pseudoLocaleOptions: pseudoLocaleConfig?.options,
         compilerBabelOptions: config.compilerBabelOptions,
     });
     if (errors.length) {

package/dist/api/getPathsForExtractWatcher.js

@@ -7,8 +7,9 @@ export async function getPathsForExtractWatcher(config) {
     const paths = [];
     const ignored = [];
     catalogs.forEach((catalog) => {
-        paths.push(...catalog.include);
-        ignored.push(...catalog.exclude);
+        const sourcePatterns = catalog.sourcePatterns;
+        paths.push(...sourcePatterns.include);
+        ignored.push(...sourcePatterns.exclude);
     });
     return { paths, ignored };
 }

package/dist/api/stats.js

@@ -25,8 +25,9 @@ export function printStats(config, catalogs) {
         return a.localeCompare(b);
     })
         .forEach((locale) => {
-        if (locale === config.pseudoLocale.locale)
-            return; // skip pseudo locale
+        // skip pseudo locale
+        if (config.pseudoLocale.some((item) => item.locale === locale))
+            return;
         const catalog = catalogs[locale];
         // catalog is null if no catalog exists on disk and the locale
         // was not extracted due to a `--locale` filter

package/dist/services/translationIO.js

@@ -7,8 +7,8 @@ import { readFileSync } from "node:fs";
 import path from "node:path";
 const getTargetLocales = (config) => {
     const sourceLocale = config.sourceLocale || "en";
-    const pseudoLocale = config.pseudoLocale.locale || "pseudo";
-    return config.locales.filter((value) => value != sourceLocale && value != pseudoLocale);
+    const pseudoLocales = new Set(config.pseudoLocale.map((item) => item.locale));
+    return config.locales.filter((value) => value != sourceLocale && !pseudoLocales.has(value));
 };
 // Main sync method, call "Init" or "Sync" depending on the project context
 export default async function syncProcess(config, options, extractionResult) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lingui/cli",
-  "version": "6.5.0",
-  "description": "Lingui CLI to extract messages, compile catalogs, and manage translation workflows",
+  "version": "6.7.0",
+  "description": "Lingui CLI: extracts i18n messages from source code into catalogs and compiles the translated catalogs for the runtime",
   "type": "module",
   "keywords": [
     "lingui",
@@ -54,12 +54,12 @@
     "@babel/generator": "^7.28.5",
     "@babel/parser": "^7.22.0",
     "@babel/types": "^7.21.2",
-    "@lingui/babel-plugin-extract-messages": "6.5.0",
-    "@lingui/babel-plugin-lingui-macro": "6.5.0",
-    "@lingui/conf": "6.5.0",
-    "@lingui/core": "6.5.0",
-    "@lingui/format-po": "6.5.0",
-    "@lingui/message-utils": "6.5.0",
+    "@lingui/babel-plugin-extract-messages": "6.7.0",
+    "@lingui/babel-plugin-lingui-macro": "6.7.0",
+    "@lingui/conf": "6.7.0",
+    "@lingui/core": "6.7.0",
+    "@lingui/format-po": "6.7.0",
+    "@lingui/message-utils": "6.7.0",
     "chokidar": "5.0.0",
     "cli-table3": "^0.6.5",
     "commander": "^14.0.2",
@@ -68,7 +68,7 @@
     "ms": "^2.1.3",
     "normalize-path": "^3.0.0",
     "ora": "^9.1.0",
-    "pseudolocale": "^2.2.0",
+    "pseudolocale": "^3.1.0",
     "source-map": "^0.7.6",
     "tinypool": "^2.1.0"
   },
@@ -97,5 +97,5 @@
     "rolldown": "^1.1.1",
     "vitest": "catalog:"
   },
-  "gitHead": "9687149054666bbaf89196573ba597d0d6fd09e4"
+  "gitHead": "a2d4b6d42e052fed1d432050b20cc56cfdacfe98"
 }