@lingui/cli 5.2.0 → 5.3.0

package/dist/api/catalog.d.ts

@@ -3,7 +3,7 @@ import { FormatterWrapper } from "./formats";
 import { CliExtractOptions } from "../lingui-extract";
 import { CliExtractTemplateOptions } from "../lingui-extract-template";
 import { CompiledCatalogNamespace } from "./compile";
-import { GetTranslationsOptions } from "./catalog/getTranslationsForCatalog";
+import { GetTranslationsOptions, TranslationMissingEvent } from "./catalog/getTranslationsForCatalog";
 import { AllCatalogsType, CatalogType, ExtractedCatalogType } from "./types";
 export type MakeOptions = CliExtractOptions & {
     orderBy?: OrderBy;
@@ -44,8 +44,11 @@ export declare class Catalog {
     merge(prevCatalogs: AllCatalogsType, nextCatalog: ExtractedCatalogType, options: MergeOptions): {
         [k: string]: CatalogType;
     };
-    getTranslations(locale: string, options: GetTranslationsOptions): Promise<{
-        [id: string]: string;
+    getTranslations(locale: string, options: Omit<GetTranslationsOptions, "onMissing">): Promise<{
+        missing: TranslationMissingEvent[];
+        messages: {
+            [id: string]: string;
+        };
     }>;
     write(locale: string, messages: CatalogType): Promise<[created: boolean, filename: string]>;
     writeTemplate(messages: CatalogType): Promise<void>;

package/dist/api/catalog.js

@@ -101,7 +101,14 @@ class Catalog {
         ]));
     }
     async getTranslations(locale, options) {
-        return await (0, getTranslationsForCatalog_1.getTranslationsForCatalog)(this, locale, options);
+        const missing = [];
+        const messages = await (0, getTranslationsForCatalog_1.getTranslationsForCatalog)(this, locale, Object.assign(Object.assign({}, options), { onMissing: (event) => {
+                missing.push(event);
+            } }));
+        return {
+            missing,
+            messages,
+        };
     }
     async write(locale, messages) {
         const filename = this.getFilename(locale);

package/dist/api/compile.d.ts

@@ -10,7 +10,24 @@ export type CreateCompileCatalogOptions = {
     pseudoLocale?: string;
     compilerBabelOptions?: GeneratorOptions;
 };
-export declare function createCompiledCatalog(locale: string, messages: CompiledCatalogType, options: CreateCompileCatalogOptions): string;
+export type MessageCompilationError = {
+    /**
+     * ID of the message in the Catalog
+     */
+    id: string;
+    /**
+     * Message itself
+     */
+    source: string;
+    /**
+     * Error associated with this message
+     */
+    error: Error;
+};
+export declare function createCompiledCatalog(locale: string, messages: CompiledCatalogType, options: CreateCompileCatalogOptions): {
+    source: string;
+    errors: MessageCompilationError[];
+};
 /**
  * Compile string message into AST tree. Message format is parsed/compiled into
  * JS arrays, which are handled in client.

package/dist/api/compile.js

@@ -45,14 +45,24 @@ const pseudoLocalize_1 = __importDefault(require("./pseudoLocalize"));
 function createCompiledCatalog(locale, messages, options) {
     const { strict = false, namespace = "cjs", pseudoLocale, compilerBabelOptions = {}, } = options;
     const shouldPseudolocalize = locale === pseudoLocale;
+    const errors = [];
     const compiledMessages = Object.keys(messages).reduce((obj, key) => {
         // Don't use `key` as a fallback translation in strict mode.
         const translation = (messages[key] || (!strict ? key : ""));
-        obj[key] = compile(translation, shouldPseudolocalize);
+        try {
+            obj[key] = compile(translation, shouldPseudolocalize);
+        }
+        catch (e) {
+            errors.push({
+                id: key,
+                source: translation,
+                error: e,
+            });
+        }
         return obj;
     }, {});
     if (namespace === "json") {
-        return JSON.stringify({ messages: compiledMessages });
+        return { source: JSON.stringify({ messages: compiledMessages }), errors };
     }
     const ast = buildExportStatement(
     //build JSON.parse(<compiledMessages>) statement
@@ -60,7 +70,7 @@ function createCompiledCatalog(locale, messages, options) {
     const code = (0, generator_1.default)(ast, Object.assign({ minified: true, jsescOption: {
             minimal: true,
         } }, compilerBabelOptions)).code;
-    return "/*eslint-disable*/" + code;
+    return { source: "/*eslint-disable*/" + code, errors };
 }
 function buildExportStatement(expression, namespace) {
     if (namespace === "ts") {
@@ -105,5 +115,5 @@ function buildExportStatement(expression, namespace) {
  * JS arrays, which are handled in client.
  */
 function compile(message, shouldPseudolocalize = false) {
-    return (0, compileMessage_1.compileMessage)(message, (value) => shouldPseudolocalize ? (0, pseudoLocalize_1.default)(value) : value);
+    return (0, compileMessage_1.compileMessageOrThrow)(message, (value) => shouldPseudolocalize ? (0, pseudoLocalize_1.default)(value) : value);
 }

package/dist/api/index.d.ts

@@ -3,4 +3,5 @@ export { getCatalogForFile, getCatalogs } from "./catalog/getCatalogs";
 export { createCompiledCatalog } from "./compile";
 export { default as extractor, extractFromFileWithBabel, } from "./extractors/babel";
 export { getCatalogDependentFiles } from "./catalog/getCatalogDependentFiles";
+export { createMissingErrorMessage, createCompilationErrorMessage, } from "./messages";
 export * from "./types";

package/dist/api/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCatalogDependentFiles = exports.extractFromFileWithBabel = exports.extractor = exports.createCompiledCatalog = exports.getCatalogs = exports.getCatalogForFile = exports.getFormat = void 0;
+exports.createCompilationErrorMessage = exports.createMissingErrorMessage = exports.getCatalogDependentFiles = exports.extractFromFileWithBabel = exports.extractor = exports.createCompiledCatalog = exports.getCatalogs = exports.getCatalogForFile = exports.getFormat = void 0;
 var formats_1 = require("./formats");
 Object.defineProperty(exports, "getFormat", { enumerable: true, get: function () { return formats_1.getFormat; } });
 var getCatalogs_1 = require("./catalog/getCatalogs");
@@ -30,4 +30,7 @@ Object.defineProperty(exports, "extractor", { enumerable: true, get: function ()
 Object.defineProperty(exports, "extractFromFileWithBabel", { enumerable: true, get: function () { return babel_1.extractFromFileWithBabel; } });
 var getCatalogDependentFiles_1 = require("./catalog/getCatalogDependentFiles");
 Object.defineProperty(exports, "getCatalogDependentFiles", { enumerable: true, get: function () { return getCatalogDependentFiles_1.getCatalogDependentFiles; } });
+var messages_1 = require("./messages");
+Object.defineProperty(exports, "createMissingErrorMessage", { enumerable: true, get: function () { return messages_1.createMissingErrorMessage; } });
+Object.defineProperty(exports, "createCompilationErrorMessage", { enumerable: true, get: function () { return messages_1.createCompilationErrorMessage; } });
 __exportStar(require("./types"), exports);

package/dist/api/messages.d.ts

@@ -0,0 +1,4 @@
+import { TranslationMissingEvent } from "./catalog/getTranslationsForCatalog";
+import { MessageCompilationError } from "./compile";
+export declare function createMissingErrorMessage(locale: string, missingMessages: TranslationMissingEvent[], configurationMsg: string): string;
+export declare function createCompilationErrorMessage(locale: string, errors: MessageCompilationError[]): string;

package/dist/api/messages.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMissingErrorMessage = createMissingErrorMessage;
+exports.createCompilationErrorMessage = createCompilationErrorMessage;
+const chalk_1 = __importDefault(require("chalk"));
+function createMissingErrorMessage(locale, missingMessages, configurationMsg) {
+    let message = `Failed to compile catalog for locale ${chalk_1.default.bold(locale)}!
+
+Missing ${missingMessages.length} translation(s):
+\n`;
+    missingMessages.forEach((missing) => {
+        const source = missing.source || missing.source === missing.id
+            ? `: ${missing.source}`
+            : "";
+        message += `${missing.id}${source}\n`;
+    });
+    return message;
+}
+function createCompilationErrorMessage(locale, errors) {
+    let message = `Failed to compile catalog for locale ${chalk_1.default.bold(locale)}!
+
+Compilation error for ${errors.length} translation(s):
+\n`;
+    errors.forEach((error) => {
+        const source = error.source || error.source === error.id ? `: ${error.source}` : "";
+        message += `${error.id}${source}\nReason: ${error.error.message}\n\n`;
+    });
+    return message;
+}

package/dist/lingui-compile.d.ts

@@ -2,6 +2,7 @@ import { LinguiConfigNormalized } from "@lingui/conf";
 export type CliCompileOptions = {
     verbose?: boolean;
     allowEmpty?: boolean;
+    failOnCompileError?: boolean;
     typescript?: boolean;
     watch?: boolean;
     namespace?: string;

package/dist/lingui-compile.js

@@ -22,13 +22,9 @@ async function command(config, options) {
     console.log("Compiling message catalogs…");
     for (const locale of config.locales) {
         for (const catalog of catalogs) {
-            const missingMessages = [];
-            const messages = await catalog.getTranslations(locale, {
+            const { messages, missing: missingMessages } = await catalog.getTranslations(locale, {
                 fallbackLocales: config.fallbackLocales,
                 sourceLocale: config.sourceLocale,
-                onMissing: (missing) => {
-                    missingMessages.push(missing);
-                },
             });
             if (!options.allowEmpty &&
                 locale !== config.pseudoLocale &&
@@ -53,35 +49,42 @@ async function command(config, options) {
                 mergedCatalogs = Object.assign(Object.assign({}, mergedCatalogs), messages);
             }
             else {
-                const namespace = options.typescript
-                    ? "ts"
-                    : options.namespace || config.compileNamespace;
-                const compiledCatalog = (0, compile_1.createCompiledCatalog)(locale, messages, {
-                    strict: false,
-                    namespace,
-                    pseudoLocale: config.pseudoLocale,
-                    compilerBabelOptions: config.compilerBabelOptions,
-                });
-                let compiledPath = await catalog.writeCompiled(locale, compiledCatalog, namespace);
-                compiledPath = (0, normalize_path_1.default)(path_1.default.relative(config.rootDir, compiledPath));
-                options.verbose &&
-                    console.error(chalk_1.default.green(`${locale} ⇒ ${compiledPath}`));
+                if (!(await compileAndWrite(locale, config, options, catalog, messages))) {
+                    return false;
+                }
             }
         }
         if (doMerge) {
-            const compileCatalog = await (0, getCatalogs_1.getCatalogForMerge)(config);
-            const namespace = options.namespace || config.compileNamespace;
-            const compiledCatalog = (0, compile_1.createCompiledCatalog)(locale, mergedCatalogs, {
-                strict: false,
-                namespace: namespace,
-                pseudoLocale: config.pseudoLocale,
-                compilerBabelOptions: config.compilerBabelOptions,
-            });
-            let compiledPath = await compileCatalog.writeCompiled(locale, compiledCatalog, namespace);
-            compiledPath = (0, normalize_path_1.default)(path_1.default.relative(config.rootDir, compiledPath));
-            options.verbose && console.log(chalk_1.default.green(`${locale} ⇒ ${compiledPath}`));
+            return await compileAndWrite(locale, config, options, await (0, getCatalogs_1.getCatalogForMerge)(config), mergedCatalogs);
+        }
+    }
+    return true;
+}
+async function compileAndWrite(locale, config, options, catalogToWrite, messages) {
+    const namespace = options.typescript
+        ? "ts"
+        : options.namespace || config.compileNamespace;
+    const { source: compiledCatalog, errors } = (0, compile_1.createCompiledCatalog)(locale, messages, {
+        strict: false,
+        namespace,
+        pseudoLocale: config.pseudoLocale,
+        compilerBabelOptions: config.compilerBabelOptions,
+    });
+    if (errors.length) {
+        let message = (0, api_1.createCompilationErrorMessage)(locale, errors);
+        if (options.failOnCompileError) {
+            message += `These errors fail command execution because \`--strict\` option passed`;
+            console.error(chalk_1.default.red(message));
+            return false;
+        }
+        else {
+            message += `You can fail command execution on these errors by passing \`--strict\` option`;
+            console.error(chalk_1.default.red(message));
         }
     }
+    let compiledPath = await catalogToWrite.writeCompiled(locale, compiledCatalog, namespace);
+    compiledPath = (0, normalize_path_1.default)(path_1.default.relative(config.rootDir, compiledPath));
+    options.verbose && console.error(chalk_1.default.green(`${locale} ⇒ ${compiledPath}`));
     return true;
 }
 if (require.main === module) {
@@ -112,6 +115,7 @@ if (require.main === module) {
         previousRun = previousRun.then(() => command(config, {
             verbose: options.watch || options.verbose || false,
             allowEmpty: !options.strict,
+            failOnCompileError: !!options.strict,
             typescript: options.typescript || config.compileNamespace === "ts" || false,
             namespace: options.namespace, // we want this to be undefined if user does not specify so default can be used
         }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/cli",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "CLI for working wit message catalogs",
   "keywords": [
     "cli",
@@ -57,12 +57,12 @@
     "@babel/parser": "^7.22.0",
     "@babel/runtime": "^7.21.0",
     "@babel/types": "^7.21.2",
-    "@lingui/babel-plugin-extract-messages": "5.2.0",
-    "@lingui/babel-plugin-lingui-macro": "5.2.0",
-    "@lingui/conf": "5.2.0",
-    "@lingui/core": "5.2.0",
-    "@lingui/format-po": "5.2.0",
-    "@lingui/message-utils": "5.2.0",
+    "@lingui/babel-plugin-extract-messages": "5.3.0",
+    "@lingui/babel-plugin-lingui-macro": "5.3.0",
+    "@lingui/conf": "5.3.0",
+    "@lingui/core": "5.3.0",
+    "@lingui/format-po": "5.3.0",
+    "@lingui/message-utils": "5.3.0",
     "babel-plugin-macros": "^3.0.1",
     "chalk": "^4.1.0",
     "chokidar": "3.5.1",
@@ -90,5 +90,5 @@
     "mock-fs": "^5.2.0",
     "mockdate": "^3.0.5"
   },
-  "gitHead": "9c50b4877ca8b134d0d96c09a8055221ca70b095"
+  "gitHead": "ed491cce7e5209378922327e0e7b802fb7b5873d"
 }