@lingui/cli 4.11.1 → 4.11.3

package/dist/api/catalog.js

@@ -88,7 +88,7 @@ class Catalog {
     async collect(options = {}) {
         let paths = this.sourcePaths;
         if (options.files) {
-            options.files = options.files.map((p) => (0, normalize_path_1.default)(p, false));
+            options.files = options.files.map((p) => (0, utils_1.makePathRegexSafe)((0, normalize_path_1.default)(p, false)));
             const regex = new RegExp(options.files.join("|"), "i");
             paths = paths.filter((path) => regex.test(path));
         }

package/dist/api/compile.js

@@ -57,12 +57,11 @@ function buildExportStatement(expression, namespace) {
         // import type { Messages } from "@lingui/core";
         const importMessagesTypeDeclaration = t.importDeclaration([t.importSpecifier(t.identifier("Messages"), t.identifier("Messages"))], t.stringLiteral("@lingui/core"));
         importMessagesTypeDeclaration.importKind = "type";
-        // Create the exported `messages` identifier with a `Messages` TS type annotation
-        const messagesIdentifier = t.identifier("messages");
-        messagesIdentifier.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier("Messages")));
-        // export const messages:Messages = { message: "Translation" }
+        // Cast the expression to `Messages`
+        const castExpression = t.tsAsExpression(expression, t.tsTypeReference(t.identifier("Messages")));
+        // export const messages = ({ message: "Translation" } as Messages)
         const exportDeclaration = t.exportNamedDeclaration(t.variableDeclaration("const", [
-            t.variableDeclarator(messagesIdentifier, expression),
+            t.variableDeclarator(t.identifier("messages"), castExpression),
         ]));
         return t.program([importMessagesTypeDeclaration, exportDeclaration]);
     }

package/dist/api/help.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.helpRun = void 0;
 /**
- * Detect where's is the command lingui extract or lingui compile
- * and how is being run (npm, yarn) and construct help
+ * Detect where is the command lingui extract or lingui compile
+ * and how is being run (npm, yarn, pnpm) and construct help
  * for follow-up commands based on that.
  *
  * Example:
@@ -15,6 +15,10 @@ exports.helpRun = void 0;
  * ...
  * (use "yarn lingui compile" to compile catalogs for production)
  *
+ * $ pnpm run extract
+ * ...
+ * (use "pnpm run compile" to compile catalogs for production)
+ *
  * $ npm run extract
  * ...
  * (use "npm run compile" to compile catalogs for production)
@@ -32,9 +36,20 @@ function helpRun(command) {
             command = res[0];
         }
     }
-    const isYarn = process.env.npm_config_user_agent &&
-        process.env.npm_config_user_agent.includes("yarn");
-    const runCommand = isYarn ? "yarn" : "npm run";
+    const runCommand = runCommandFrom(process.env.npm_config_user_agent);
     return `${runCommand} ${command}`;
 }
 exports.helpRun = helpRun;
+function runCommandFrom(userAgent) {
+    const defaultRunCommand = "npm run";
+    if (!userAgent) {
+        return defaultRunCommand;
+    }
+    if (userAgent.includes("yarn")) {
+        return "yarn";
+    }
+    if (userAgent.includes("pnpm")) {
+        return "pnpm run";
+    }
+    return defaultRunCommand;
+}

package/dist/api/utils.d.ts

@@ -18,3 +18,7 @@ export declare function normalizeSlashes(path: string): string;
  * Preserve absolute paths:    /absolute/path => /absolute/path
  */
 export declare function normalizeRelativePath(sourcePath: string): string;
+/**
+ * Escape special regex characters used in file-based routing systems
+ */
+export declare function makePathRegexSafe(path: string): string;

package/dist/api/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeRelativePath = exports.normalizeSlashes = exports.makeInstall = exports.hasYarn = exports.writeFileIfChanged = exports.writeFile = exports.isDirectory = exports.readFile = exports.replacePlaceholders = exports.prettyOrigin = exports.PATHSEP = void 0;
+exports.makePathRegexSafe = exports.normalizeRelativePath = exports.normalizeSlashes = exports.makeInstall = exports.hasYarn = exports.writeFileIfChanged = exports.writeFile = exports.isDirectory = exports.readFile = exports.replacePlaceholders = exports.prettyOrigin = exports.PATHSEP = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const normalize_path_1 = __importDefault(require("normalize-path"));
@@ -110,3 +110,10 @@ function normalizeRelativePath(sourcePath) {
         (isDir ? "/" : ""));
 }
 exports.normalizeRelativePath = normalizeRelativePath;
+/**
+ * Escape special regex characters used in file-based routing systems
+ */
+function makePathRegexSafe(path) {
+    return path.replace(/[(){}[\]^$+]/g, "\\$&");
+}
+exports.makePathRegexSafe = makePathRegexSafe;

package/dist/services/translationIO.js

@@ -9,6 +9,8 @@ const pofile_1 = __importDefault(require("pofile"));
 const https_1 = __importDefault(require("https"));
 const glob_1 = __importDefault(require("glob"));
 const date_fns_1 = require("date-fns");
+const EXPLICIT_ID_FLAG = "js-lingui-explicit-id";
+const EXPLICIT_ID_AND_CONTEXT_FLAG = "js-lingui-explicit-id-and-context";
 const getCreateHeaders = (language) => ({
     "POT-Creation-Date": (0, date_fns_1.format)(new Date(), "yyyy-MM-dd HH:mmxxxx"),
     "MIME-Version": "1.0",
@@ -141,32 +143,64 @@ function sync(config, options, successCallback, failCallback) {
     });
 }
 function createSegmentFromPoItem(item) {
-    const itemHasId = item.msgid != item.msgstr[0] && item.msgstr[0].length;
+    const itemHasExplicitId = item.extractedComments.includes(EXPLICIT_ID_FLAG);
+    const itemHasContext = item.msgctxt != null;
     const segment = {
         type: "source",
-        source: itemHasId ? item.msgstr[0] : item.msgid,
+        source: "",
         context: "",
         references: [],
         comment: "",
     };
-    if (itemHasId) {
+    // For segment.source & segment.context, we must remain compatible with projects created/synced before Lingui V4
+    if (itemHasExplicitId) {
+        segment.source = item.msgstr[0];
         segment.context = item.msgid;
     }
+    else {
+        segment.source = item.msgid;
+        if (itemHasContext) {
+            segment.context = item.msgctxt;
+        }
+    }
     if (item.references.length) {
         segment.references = item.references;
     }
+    // Since Lingui v4, when using explicit IDs, Lingui automatically adds 'js-lingui-explicit-id' to the extractedComments array
     if (item.extractedComments.length) {
         segment.comment = item.extractedComments.join(" | ");
+        if (itemHasExplicitId && itemHasContext) {
+            // segment.context is already used for the explicit ID, so we need to pass the context (for translators) in segment.comment
+            segment.comment = `${item.msgctxt} | ${segment.comment}`;
+            // Replace the flag to let us know how to recompose a target PO Item that is consistent with the source PO Item
+            segment.comment = segment.comment.replace(EXPLICIT_ID_FLAG, EXPLICIT_ID_AND_CONTEXT_FLAG);
+        }
     }
     return segment;
 }
 function createPoItemFromSegment(segment) {
+    var _a, _b;
+    const segmentHasExplicitId = (_a = segment.comment) === null || _a === void 0 ? void 0 : _a.includes(EXPLICIT_ID_FLAG);
+    const segmentHasExplicitIdAndContext = (_b = segment.comment) === null || _b === void 0 ? void 0 : _b.includes(EXPLICIT_ID_AND_CONTEXT_FLAG);
     const item = new pofile_1.default.Item();
-    item.msgid = segment.context ? segment.context : segment.source;
+    if (segmentHasExplicitId || segmentHasExplicitIdAndContext) {
+        item.msgid = segment.context;
+    }
+    else {
+        item.msgid = segment.source;
+        item.msgctxt = segment.context;
+    }
     item.msgstr = [segment.target];
     item.references =
         segment.references && segment.references.length ? segment.references : [];
-    item.extractedComments = segment.comment ? segment.comment.split(" | ") : [];
+    if (segment.comment) {
+        segment.comment = segment.comment.replace(EXPLICIT_ID_AND_CONTEXT_FLAG, EXPLICIT_ID_FLAG);
+        item.extractedComments = segment.comment ? segment.comment.split(" | ") : [];
+        // We recompose a target PO Item that is consistent with the source PO Item
+        if (segmentHasExplicitIdAndContext) {
+            item.msgctxt = item.extractedComments.shift();
+        }
+    }
     return item;
 }
 function saveSegmentsToTargetPos(config, paths, segmentsPerLocale) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/cli",
-  "version": "4.11.1",
+  "version": "4.11.3",
   "description": "CLI for working wit message catalogs",
   "keywords": [
     "cli",
@@ -53,15 +53,15 @@
     "@babel/parser": "^7.21.2",
     "@babel/runtime": "^7.21.0",
     "@babel/types": "^7.21.2",
-    "@lingui/babel-plugin-extract-messages": "4.11.1",
-    "@lingui/conf": "4.11.1",
-    "@lingui/core": "4.11.1",
-    "@lingui/format-po": "4.11.1",
-    "@lingui/message-utils": "4.11.1",
+    "@lingui/babel-plugin-extract-messages": "4.11.3",
+    "@lingui/conf": "4.11.3",
+    "@lingui/core": "4.11.3",
+    "@lingui/format-po": "4.11.3",
+    "@lingui/message-utils": "4.11.3",
     "babel-plugin-macros": "^3.0.1",
     "chalk": "^4.1.0",
     "chokidar": "3.5.1",
-    "cli-table": "0.3.6",
+    "cli-table": "^0.3.11",
     "commander": "^10.0.0",
     "convert-source-map": "^2.0.0",
     "date-fns": "^3.6.0",
@@ -80,7 +80,7 @@
   },
   "devDependencies": {
     "@lingui/jest-mocks": "*",
-    "@lingui/macro": "4.11.1",
+    "@lingui/macro": "4.11.3",
     "@types/convert-source-map": "^2.0.0",
     "@types/glob": "^8.1.0",
     "@types/micromatch": "^4.0.1",
@@ -88,5 +88,5 @@
     "mock-fs": "^5.2.0",
     "mockdate": "^3.0.5"
   },
-  "gitHead": "ec49d0cc53dbc4f9e0f92f0edcdf59f3e5c1de1f"
+  "gitHead": "088efe57f23e88aee7ef72c58a45db427ecd78c9"
 }