@lingui/cli 5.6.1 → 5.8.0

package/dist/api/catalog.d.ts

@@ -1,4 +1,4 @@
-import { LinguiConfigNormalized, OrderBy } from "@lingui/conf";
+import { LinguiConfigNormalized, OrderBy, OrderByFn } from "@lingui/conf";
 import { FormatterWrapper } from "./formats";
 import { CompiledCatalogNamespace } from "./compile";
 import { GetTranslationsOptions } from "./catalog/getTranslationsForCatalog";
@@ -69,4 +69,4 @@ export declare class Catalog {
 export declare function cleanObsolete<T extends ExtractedCatalogType>(messages: T): T;
 export declare function order<T extends ExtractedCatalogType>(by: OrderBy, catalog: T): T;
 export declare function writeCompiled(path: string, locale: string, compiledCatalog: string, namespace?: CompiledCatalogNamespace): Promise<string>;
-export declare function orderByMessage<T extends ExtractedCatalogType>(messages: T): T;
+export declare const orderByMessage: OrderByFn;

package/dist/api/catalog.js

@@ -3,11 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Catalog = void 0;
+exports.orderByMessage = exports.Catalog = void 0;
 exports.cleanObsolete = cleanObsolete;
 exports.order = order;
 exports.writeCompiled = writeCompiled;
-exports.orderByMessage = orderByMessage;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const glob_1 = require("glob");
@@ -140,8 +139,7 @@ class Catalog {
         return await this.format.read(filename, undefined);
     }
     get sourcePaths() {
-        const includeGlobs = this.include
-            .map((includePath) => {
+        const includeGlobs = this.include.map((includePath) => {
             const isDir = (0, utils_1.isDirectory)(includePath);
             /**
              * glob library results from absolute patterns such as /foo/* are mounted onto the root setting using path.join.
@@ -150,8 +148,7 @@ class Catalog {
             return isDir
                 ? (0, normalize_path_1.default)(path_1.default.resolve(process.cwd(), includePath === "/" ? "" : includePath, "**/*.*"))
                 : includePath;
-        })
-            .map(utils_1.makePathRegexSafe);
+        });
         return (0, glob_1.globSync)(includeGlobs, { ignore: this.exclude, mark: true });
     }
     get localeDir() {
@@ -173,28 +170,33 @@ function cleanObsolete(messages) {
     return Object.fromEntries(Object.entries(messages).filter(([, message]) => !message.obsolete));
 }
 function order(by, catalog) {
-    return {
-        messageId: orderByMessageId,
-        message: orderByMessage,
-        origin: orderByOrigin,
-    }[by](catalog);
-}
-/**
- * Object keys are in the same order as they were created
- * https://stackoverflow.com/a/31102605/1535540
- */
-function orderByMessageId(messages) {
-    return Object.keys(messages)
-        .sort()
+    const orderByFn = typeof by === "function"
+        ? by
+        : {
+            messageId: orderByMessageId,
+            message: exports.orderByMessage,
+            origin: orderByOrigin,
+        }[by];
+    return Object.keys(catalog)
+        .sort((a, b) => {
+        return orderByFn({ messageId: a, entry: catalog[a] }, { messageId: b, entry: catalog[b] });
+    })
         .reduce((acc, key) => {
         ;
-        acc[key] = messages[key];
+        acc[key] = catalog[key];
         return acc;
     }, {});
 }
-function orderByOrigin(messages) {
-    function getFirstOrigin(messageKey) {
-        const sortedOrigins = messages[messageKey].origin.sort((a, b) => {
+/**
+ * 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);
+};
+const orderByOrigin = (a, b) => {
+    function getFirstOrigin(entry) {
+        const sortedOrigins = entry.origin.sort((a, b) => {
             if (a[0] < b[0])
                 return -1;
             if (a[0] > b[0])
@@ -203,26 +205,18 @@ function orderByOrigin(messages) {
         });
         return sortedOrigins[0];
     }
-    return Object.keys(messages)
-        .sort((a, b) => {
-        const [aFile, aLineNumber] = getFirstOrigin(a);
-        const [bFile, bLineNumber] = getFirstOrigin(b);
-        if (aFile < bFile)
-            return -1;
-        if (aFile > bFile)
-            return 1;
-        if (aLineNumber < bLineNumber)
-            return -1;
-        if (aLineNumber > bLineNumber)
-            return 1;
-        return 0;
-    })
-        .reduce((acc, key) => {
-        ;
-        acc[key] = messages[key];
-        return acc;
-    }, {});
-}
+    const [aFile, aLineNumber] = getFirstOrigin(a.entry);
+    const [bFile, bLineNumber] = getFirstOrigin(b.entry);
+    if (aFile < bFile)
+        return -1;
+    if (aFile > bFile)
+        return 1;
+    if (aLineNumber < bLineNumber)
+        return -1;
+    if (aLineNumber > bLineNumber)
+        return 1;
+    return 0;
+};
 async function writeCompiled(path, locale, compiledCatalog, namespace) {
     let ext;
     switch (namespace) {
@@ -240,21 +234,14 @@ async function writeCompiled(path, locale, compiledCatalog, namespace) {
     await (0, utils_1.writeFile)(filename, compiledCatalog);
     return filename;
 }
-function orderByMessage(messages) {
+const orderByMessage = (a, b) => {
     // hardcoded en-US locale to have consistent sorting
     // @see https://github.com/lingui/js-lingui/pull/1808
     const collator = new Intl.Collator("en-US");
-    return Object.keys(messages)
-        .sort((a, b) => {
-        const aMsg = messages[a].message || "";
-        const bMsg = messages[b].message || "";
-        const aCtxt = messages[a].context || "";
-        const bCtxt = messages[b].context || "";
-        return collator.compare(aMsg, bMsg) || collator.compare(aCtxt, bCtxt);
-    })
-        .reduce((acc, key) => {
-        ;
-        acc[key] = messages[key];
-        return acc;
-    }, {});
-}
+    const aMsg = a.entry.message || "";
+    const bMsg = b.entry.message || "";
+    const aCtxt = a.entry.context || "";
+    const bCtxt = b.entry.context || "";
+    return collator.compare(aMsg, bMsg) || collator.compare(aCtxt, bCtxt);
+};
+exports.orderByMessage = orderByMessage;

package/dist/api/compile/compileLocale.js

@@ -62,6 +62,7 @@ async function compileAndWrite(locale, config, options, writePath, messages, log
     const { source: compiledCatalog, errors } = (0, compile_1.createCompiledCatalog)(locale, messages, {
         strict: false,
         namespace,
+        outputPrefix: options.outputPrefix,
         pseudoLocale: config.pseudoLocale,
         compilerBabelOptions: config.compilerBabelOptions,
     });

package/dist/api/compile.d.ts

@@ -9,6 +9,7 @@ export type CreateCompileCatalogOptions = {
     namespace?: CompiledCatalogNamespace;
     pseudoLocale?: string;
     compilerBabelOptions?: GeneratorOptions;
+    outputPrefix?: string;
 };
 export type MessageCompilationError = {
     /**

package/dist/api/compile.js

@@ -43,7 +43,7 @@ const generator_1 = __importDefault(require("@babel/generator"));
 const compileMessage_1 = require("@lingui/message-utils/compileMessage");
 const pseudoLocalize_1 = __importDefault(require("./pseudoLocalize"));
 function createCompiledCatalog(locale, messages, options) {
-    const { strict = false, namespace = "cjs", pseudoLocale, compilerBabelOptions = {}, } = options;
+    const { strict = false, namespace = "cjs", pseudoLocale, compilerBabelOptions = {}, outputPrefix = "/*eslint-disable*/", } = options;
     const shouldPseudolocalize = locale === pseudoLocale;
     const errors = [];
     const compiledMessages = Object.keys(messages)
@@ -72,7 +72,7 @@ function createCompiledCatalog(locale, messages, options) {
     const code = (0, generator_1.default)(ast, Object.assign({ minified: true, jsescOption: {
             minimal: true,
         } }, compilerBabelOptions)).code;
-    return { source: "/*eslint-disable*/" + code, errors };
+    return { source: `${outputPrefix}` + code, errors };
 }
 function buildExportStatement(expression, namespace) {
     if (namespace === "ts") {

package/dist/lingui-compile.d.ts

@@ -8,5 +8,6 @@ export type CliCompileOptions = {
     watch?: boolean;
     namespace?: string;
     workersOptions: WorkersOptions;
+    outputPrefix?: string;
 };
 export declare function command(config: LinguiConfigNormalized, options: CliCompileOptions): Promise<boolean>;

package/dist/lingui-compile.js

@@ -80,6 +80,7 @@ if (require.main === module) {
         .option("--namespace <namespace>", "Specify namespace for compiled bundle. Ex: cjs(default) -> module.exports, es -> export, window.test -> window.test")
         .option("--watch", "Enables Watch Mode")
         .option("--debounce <delay>", "Debounces compilation for given amount of milliseconds")
+        .option("--output-prefix <prefix>", "Add a custom string to the beginning of compiled files (header/prefix). Useful for tools like linters or coverage directives. Defaults to '/*eslint-disable*/'")
         .on("--help", function () {
         console.log("\n  Examples:\n");
         console.log("    # Compile translations and use defaults or message IDs for missing translations");
@@ -102,6 +103,7 @@ if (require.main === module) {
             workersOptions: (0, resolveWorkersOptions_1.resolveWorkersOptions)(options),
             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
+            outputPrefix: options.outputPrefix,
         }));
         return previousRun;
     };

package/dist/services/translationIO.js

@@ -25,9 +25,15 @@ const getTargetLocales = (config) => {
     const pseudoLocale = config.pseudoLocale || "pseudo";
     return config.locales.filter((value) => value != sourceLocale && value != pseudoLocale);
 };
+const validCatalogFormat = (config) => {
+    if (typeof config.format === "string") {
+        return config.format === "po";
+    }
+    return config.format.catalogExtension === ".po";
+};
 // Main sync method, call "Init" or "Sync" depending on the project context
 async function syncProcess(config, options) {
-    if (config.format != "po") {
+    if (!validCatalogFormat(config)) {
         console.error(`\n----------\nTranslation.io service is only compatible with the "po" format. Please update your Lingui configuration accordingly.\n----------`);
         process.exit(1);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/cli",
-  "version": "5.6.1",
+  "version": "5.8.0",
   "description": "CLI for working wit message catalogs",
   "keywords": [
     "cli",
@@ -62,12 +62,12 @@
     "@babel/parser": "^7.22.0",
     "@babel/runtime": "^7.21.0",
     "@babel/types": "^7.21.2",
-    "@lingui/babel-plugin-extract-messages": "5.6.1",
-    "@lingui/babel-plugin-lingui-macro": "5.6.1",
-    "@lingui/conf": "5.6.1",
-    "@lingui/core": "5.6.1",
-    "@lingui/format-po": "5.6.1",
-    "@lingui/message-utils": "5.6.1",
+    "@lingui/babel-plugin-extract-messages": "5.8.0",
+    "@lingui/babel-plugin-lingui-macro": "5.8.0",
+    "@lingui/conf": "5.8.0",
+    "@lingui/core": "5.8.0",
+    "@lingui/format-po": "5.8.0",
+    "@lingui/message-utils": "5.8.0",
     "chokidar": "3.5.1",
     "cli-table": "^0.3.11",
     "commander": "^10.0.0",
@@ -82,7 +82,7 @@
     "picocolors": "^1.1.1",
     "pofile": "^1.1.4",
     "pseudolocale": "^2.0.0",
-    "source-map": "^0.8.0-beta.0",
+    "source-map": "^0.7.6",
     "threads": "^1.7.0"
   },
   "devDependencies": {
@@ -95,5 +95,5 @@
     "mockdate": "^3.0.5",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "eeab3720888fac544c3410f0148c5b13a0f0acff"
+  "gitHead": "83d0513bdda9ff14003a05d376c7fedf860dd7ee"
 }