@lingui/format-po-gettext 5.6.1 → 5.8.0

package/dist/po-gettext.cjs

@@ -92,7 +92,7 @@ const ICU_PLURAL_REGEX = /^{.*, plural, .*}$/;
 const ICU_SELECT_REGEX = /^{.*, select(Ordinal)?, .*}$/;
 const LINE_ENDINGS = /\r?\n/g;
 const DEFAULT_CTX_PREFIX = "js-lingui:";
-function serializePlurals(item, message, id, isGeneratedId, options) {
+function serializePlurals(item, message, id, isGeneratedId, options, formatterCtx) {
   const icuMessage = message.message;
   const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
   if (!icuMessage) {
@@ -110,20 +110,19 @@ function serializePlurals(item, message, id, isGeneratedId, options) {
           id
         );
       }
-      const ctx = new URLSearchParams({
-        pluralize_on: messageAst.arg
-      });
+      const ctx = {
+        pluralizeOn: [messageAst.arg]
+      };
       if (isGeneratedId) {
         item.msgid = stringifyICUCase(messageAst.cases[0]);
         item.msgid_plural = stringifyICUCase(
           messageAst.cases[messageAst.cases.length - 1]
         );
-        ctx.set("icu", icuMessage);
+        ctx.icu = icuMessage;
       } else {
         item.msgid_plural = id + "_plural";
       }
-      ctx.sort();
-      item.extractedComments.push(ctxPrefix + ctx.toString());
+      item.extractedComments.push(ctxPrefix + serializeContextToComment(ctx));
       if (message.translation?.length > 0) {
         const ast = parser.parse(message.translation)[0];
         if (ast.cases == null) {
@@ -134,6 +133,8 @@ function serializePlurals(item, message, id, isGeneratedId, options) {
         } else {
           item.msgstr = ast.cases.map(stringifyICUCase);
         }
+      } else if (!isGeneratedId && (formatterCtx.locale === formatterCtx.sourceLocale || formatterCtx.locale === null)) {
+        item.msgstr = messageAst.cases.map(stringifyICUCase);
       }
     } catch (e) {
       console.error(`Error parsing message ICU for key "${id}":`, e);
@@ -208,14 +209,13 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
     );
     return;
   }
-  const contextComment = item.extractedComments.find((comment) => comment.startsWith(ctxPrefix))?.substring(ctxPrefix.length);
-  const ctx = new URLSearchParams(contextComment);
-  if (contextComment != null) {
+  const ctx = getContextFromComments(item.extractedComments, ctxPrefix);
+  if (ctx) {
     item.extractedComments = item.extractedComments.filter(
       (comment) => !comment.startsWith(ctxPrefix)
     );
   }
-  const storedICU = ctx.get("icu");
+  const storedICU = ctx?.icu;
   if (storedICU != null) {
     item.msgid = storedICU;
   }
@@ -239,7 +239,7 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
   const pluralClauses = item.msgstr.map(
     (str, index) => pluralForms[index] ? pluralForms[index] + " {" + str + "}" : ""
   ).join(" ");
-  let pluralizeOn = ctx.get("pluralize_on");
+  let pluralizeOn = ctx?.pluralizeOn?.[0];
   if (!pluralizeOn) {
     console.warn(
       `Unable to determine plural placeholder name for item with key "%s" in language "${lang}" (should be stored in a comment starting with "#. ${ctxPrefix}"), assuming "count".`,
@@ -249,6 +249,128 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
   }
   item.msgstr = ["{" + pluralizeOn + ", plural, " + pluralClauses + "}"];
 };
+const updateContextComment = (item, contextComment, ctxPrefix) => {
+  item.extractedComments = [
+    ...item.extractedComments.filter((c) => !c.startsWith(ctxPrefix)),
+    ctxPrefix + contextComment
+  ];
+};
+function serializeContextToComment(ctx) {
+  const urlParams = new URLSearchParams();
+  if (ctx.icu) {
+    urlParams.set("icu", ctx.icu);
+  }
+  if (ctx.pluralizeOn) {
+    urlParams.set("pluralize_on", ctx.pluralizeOn.join(","));
+  }
+  urlParams.sort();
+  return urlParams.toString();
+}
+function getContextFromComments(extractedComments, ctxPrefix) {
+  const contextComment = extractedComments.find(
+    (comment) => comment.startsWith(ctxPrefix)
+  );
+  if (!contextComment) {
+    return void 0;
+  }
+  const urlParams = new URLSearchParams(
+    contextComment?.substring(ctxPrefix.length)
+  );
+  return {
+    icu: urlParams.get("icu"),
+    pluralizeOn: urlParams.get("pluralize_on") ? urlParams.get("pluralize_on").split(",") : []
+  };
+}
+function mergeDuplicatePluralEntries(items, options) {
+  const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
+  const itemMap = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    if (item.msgid_plural) {
+      const key = `${item.msgid}|||${item.msgid_plural}`;
+      if (!itemMap.has(key)) {
+        itemMap.set(key, []);
+      }
+      itemMap.get(key).push(item);
+    }
+  }
+  const mergedItems = [];
+  for (const duplicateItems of itemMap.values()) {
+    if (duplicateItems.length === 1) {
+      mergedItems.push(duplicateItems[0]);
+    } else {
+      const mergedItem = duplicateItems[0];
+      const allVariables = duplicateItems.map((item) => {
+        const ctx2 = getContextFromComments(item.extractedComments, ctxPrefix);
+        return ctx2?.pluralizeOn[0] || "count";
+      });
+      const ctx = getContextFromComments(
+        mergedItem.extractedComments,
+        ctxPrefix
+      );
+      if (!ctx) {
+        continue;
+      }
+      updateContextComment(
+        mergedItem,
+        serializeContextToComment({
+          icu: replaceArgInIcu(ctx.icu, allVariables[0], "$var"),
+          pluralizeOn: allVariables
+        }),
+        ctxPrefix
+      );
+      mergedItem.references = duplicateItems.flatMap((item) => item.references);
+      mergedItems.push(mergedItem);
+    }
+  }
+  return mergedItems;
+}
+function replaceArgInIcu(icu, oldVar, newVar) {
+  return icu.replace(new RegExp(`{${oldVar}, plural,`), `{${newVar}, plural,`);
+}
+function expandMergedPluralEntries(items, options) {
+  const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
+  const expandedItems = [];
+  for (const item of items) {
+    if (!item.msgid_plural) {
+      expandedItems.push(item);
+      continue;
+    }
+    const ctx = getContextFromComments(item.extractedComments, ctxPrefix);
+    if (!ctx) {
+      console.warn(
+        `Plural entry with msgid "${item.msgid}" is missing context information for expansion.`
+      );
+      expandedItems.push(item);
+      continue;
+    }
+    const variableList = ctx.pluralizeOn;
+    if (variableList.length === 1) {
+      expandedItems.push(item);
+      continue;
+    }
+    for (const variable of variableList) {
+      const newItem = new PO__default.Item();
+      newItem.msgid = item.msgid;
+      newItem.msgid_plural = item.msgid_plural;
+      newItem.msgstr = [...item.msgstr];
+      newItem.msgctxt = item.msgctxt;
+      newItem.comments = [...item.comments];
+      updateContextComment(
+        item,
+        serializeContextToComment({
+          pluralizeOn: [variable],
+          // get icu comment, replace variable placeholder with current variable
+          icu: replaceArgInIcu(ctx.icu, "\\$var", variable)
+        }),
+        ctxPrefix
+      );
+      newItem.extractedComments = item.extractedComments;
+      newItem.flags = { ...item.flags };
+      expandedItems.push(newItem);
+    }
+  }
+  return expandedItems;
+}
 function formatter(options = {}) {
   options = {
     origins: true,
@@ -261,6 +383,9 @@ function formatter(options = {}) {
     templateExtension: ".pot",
     parse(content, ctx) {
       const po = PO__default.parse(content);
+      if (options.mergePlurals) {
+        po.items = expandMergedPluralEntries(po.items, options);
+      }
       const pluralForms = getPluralCases(
         po.headers.Language,
         po.headers["Plural-Forms"]
@@ -283,8 +408,27 @@ function formatter(options = {}) {
         );
         const id = isGeneratedId ? generateMessageId.generateMessageId(item.msgid, item.msgctxt) : item.msgid;
         const message = catalog[id];
-        return serializePlurals(item, message, id, isGeneratedId, options);
+        return serializePlurals(item, message, id, isGeneratedId, options, ctx);
       });
+      if (options.mergePlurals) {
+        const mergedPlurals = mergeDuplicatePluralEntries(po.items, options);
+        const newItems = [];
+        const processed = /* @__PURE__ */ new Set();
+        po.items.forEach((item) => {
+          if (!item.msgid_plural) {
+            newItems.push(item);
+          } else {
+            const mergedItem = mergedPlurals.find(
+              (merged) => merged.msgid === item.msgid && merged.msgid_plural === item.msgid_plural
+            );
+            if (mergedItem && !processed.has(mergedItem)) {
+              processed.add(mergedItem);
+              newItems.push(mergedItem);
+            }
+          }
+        });
+        po.items = newItems;
+      }
       return po.toString();
     }
   };

package/dist/po-gettext.d.cts

@@ -2,8 +2,22 @@ import { CatalogFormatter } from '@lingui/conf';
 import { PoFormatterOptions } from '@lingui/format-po';
 
 type PoGettextFormatterOptions = PoFormatterOptions & {
+    /**
+     * Disable warning about unsupported `Select` feature encountered in catalogs
+     *
+     * @default false
+     */
     disableSelectWarning?: boolean;
+    /**
+     * Overrides the default prefix for icu and plural comments in the final PO catalog.
+     *
+     * @default "js-lingui:"
+     */
     customICUPrefix?: string;
+    /**
+     * Combine plural entries that have the same content but different variables into a single PO entry
+     */
+    mergePlurals?: boolean;
 };
 declare function formatter(options?: PoGettextFormatterOptions): CatalogFormatter;
 

package/dist/po-gettext.d.mts

@@ -2,8 +2,22 @@ import { CatalogFormatter } from '@lingui/conf';
 import { PoFormatterOptions } from '@lingui/format-po';
 
 type PoGettextFormatterOptions = PoFormatterOptions & {
+    /**
+     * Disable warning about unsupported `Select` feature encountered in catalogs
+     *
+     * @default false
+     */
     disableSelectWarning?: boolean;
+    /**
+     * Overrides the default prefix for icu and plural comments in the final PO catalog.
+     *
+     * @default "js-lingui:"
+     */
     customICUPrefix?: string;
+    /**
+     * Combine plural entries that have the same content but different variables into a single PO entry
+     */
+    mergePlurals?: boolean;
 };
 declare function formatter(options?: PoGettextFormatterOptions): CatalogFormatter;
 

package/dist/po-gettext.d.ts

@@ -2,8 +2,22 @@ import { CatalogFormatter } from '@lingui/conf';
 import { PoFormatterOptions } from '@lingui/format-po';
 
 type PoGettextFormatterOptions = PoFormatterOptions & {
+    /**
+     * Disable warning about unsupported `Select` feature encountered in catalogs
+     *
+     * @default false
+     */
     disableSelectWarning?: boolean;
+    /**
+     * Overrides the default prefix for icu and plural comments in the final PO catalog.
+     *
+     * @default "js-lingui:"
+     */
     customICUPrefix?: string;
+    /**
+     * Combine plural entries that have the same content but different variables into a single PO entry
+     */
+    mergePlurals?: boolean;
 };
 declare function formatter(options?: PoGettextFormatterOptions): CatalogFormatter;
 

package/dist/po-gettext.mjs

@@ -83,7 +83,7 @@ const ICU_PLURAL_REGEX = /^{.*, plural, .*}$/;
 const ICU_SELECT_REGEX = /^{.*, select(Ordinal)?, .*}$/;
 const LINE_ENDINGS = /\r?\n/g;
 const DEFAULT_CTX_PREFIX = "js-lingui:";
-function serializePlurals(item, message, id, isGeneratedId, options) {
+function serializePlurals(item, message, id, isGeneratedId, options, formatterCtx) {
   const icuMessage = message.message;
   const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
   if (!icuMessage) {
@@ -101,20 +101,19 @@ function serializePlurals(item, message, id, isGeneratedId, options) {
           id
         );
       }
-      const ctx = new URLSearchParams({
-        pluralize_on: messageAst.arg
-      });
+      const ctx = {
+        pluralizeOn: [messageAst.arg]
+      };
       if (isGeneratedId) {
         item.msgid = stringifyICUCase(messageAst.cases[0]);
         item.msgid_plural = stringifyICUCase(
           messageAst.cases[messageAst.cases.length - 1]
         );
-        ctx.set("icu", icuMessage);
+        ctx.icu = icuMessage;
       } else {
         item.msgid_plural = id + "_plural";
       }
-      ctx.sort();
-      item.extractedComments.push(ctxPrefix + ctx.toString());
+      item.extractedComments.push(ctxPrefix + serializeContextToComment(ctx));
       if (message.translation?.length > 0) {
         const ast = parse(message.translation)[0];
         if (ast.cases == null) {
@@ -125,6 +124,8 @@ function serializePlurals(item, message, id, isGeneratedId, options) {
         } else {
           item.msgstr = ast.cases.map(stringifyICUCase);
         }
+      } else if (!isGeneratedId && (formatterCtx.locale === formatterCtx.sourceLocale || formatterCtx.locale === null)) {
+        item.msgstr = messageAst.cases.map(stringifyICUCase);
       }
     } catch (e) {
       console.error(`Error parsing message ICU for key "${id}":`, e);
@@ -199,14 +200,13 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
     );
     return;
   }
-  const contextComment = item.extractedComments.find((comment) => comment.startsWith(ctxPrefix))?.substring(ctxPrefix.length);
-  const ctx = new URLSearchParams(contextComment);
-  if (contextComment != null) {
+  const ctx = getContextFromComments(item.extractedComments, ctxPrefix);
+  if (ctx) {
     item.extractedComments = item.extractedComments.filter(
       (comment) => !comment.startsWith(ctxPrefix)
     );
   }
-  const storedICU = ctx.get("icu");
+  const storedICU = ctx?.icu;
   if (storedICU != null) {
     item.msgid = storedICU;
   }
@@ -230,7 +230,7 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
   const pluralClauses = item.msgstr.map(
     (str, index) => pluralForms[index] ? pluralForms[index] + " {" + str + "}" : ""
   ).join(" ");
-  let pluralizeOn = ctx.get("pluralize_on");
+  let pluralizeOn = ctx?.pluralizeOn?.[0];
   if (!pluralizeOn) {
     console.warn(
       `Unable to determine plural placeholder name for item with key "%s" in language "${lang}" (should be stored in a comment starting with "#. ${ctxPrefix}"), assuming "count".`,
@@ -240,6 +240,128 @@ const convertPluralsToICU = (item, pluralForms, lang, ctxPrefix = DEFAULT_CTX_PR
   }
   item.msgstr = ["{" + pluralizeOn + ", plural, " + pluralClauses + "}"];
 };
+const updateContextComment = (item, contextComment, ctxPrefix) => {
+  item.extractedComments = [
+    ...item.extractedComments.filter((c) => !c.startsWith(ctxPrefix)),
+    ctxPrefix + contextComment
+  ];
+};
+function serializeContextToComment(ctx) {
+  const urlParams = new URLSearchParams();
+  if (ctx.icu) {
+    urlParams.set("icu", ctx.icu);
+  }
+  if (ctx.pluralizeOn) {
+    urlParams.set("pluralize_on", ctx.pluralizeOn.join(","));
+  }
+  urlParams.sort();
+  return urlParams.toString();
+}
+function getContextFromComments(extractedComments, ctxPrefix) {
+  const contextComment = extractedComments.find(
+    (comment) => comment.startsWith(ctxPrefix)
+  );
+  if (!contextComment) {
+    return void 0;
+  }
+  const urlParams = new URLSearchParams(
+    contextComment?.substring(ctxPrefix.length)
+  );
+  return {
+    icu: urlParams.get("icu"),
+    pluralizeOn: urlParams.get("pluralize_on") ? urlParams.get("pluralize_on").split(",") : []
+  };
+}
+function mergeDuplicatePluralEntries(items, options) {
+  const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
+  const itemMap = /* @__PURE__ */ new Map();
+  for (const item of items) {
+    if (item.msgid_plural) {
+      const key = `${item.msgid}|||${item.msgid_plural}`;
+      if (!itemMap.has(key)) {
+        itemMap.set(key, []);
+      }
+      itemMap.get(key).push(item);
+    }
+  }
+  const mergedItems = [];
+  for (const duplicateItems of itemMap.values()) {
+    if (duplicateItems.length === 1) {
+      mergedItems.push(duplicateItems[0]);
+    } else {
+      const mergedItem = duplicateItems[0];
+      const allVariables = duplicateItems.map((item) => {
+        const ctx2 = getContextFromComments(item.extractedComments, ctxPrefix);
+        return ctx2?.pluralizeOn[0] || "count";
+      });
+      const ctx = getContextFromComments(
+        mergedItem.extractedComments,
+        ctxPrefix
+      );
+      if (!ctx) {
+        continue;
+      }
+      updateContextComment(
+        mergedItem,
+        serializeContextToComment({
+          icu: replaceArgInIcu(ctx.icu, allVariables[0], "$var"),
+          pluralizeOn: allVariables
+        }),
+        ctxPrefix
+      );
+      mergedItem.references = duplicateItems.flatMap((item) => item.references);
+      mergedItems.push(mergedItem);
+    }
+  }
+  return mergedItems;
+}
+function replaceArgInIcu(icu, oldVar, newVar) {
+  return icu.replace(new RegExp(`{${oldVar}, plural,`), `{${newVar}, plural,`);
+}
+function expandMergedPluralEntries(items, options) {
+  const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX;
+  const expandedItems = [];
+  for (const item of items) {
+    if (!item.msgid_plural) {
+      expandedItems.push(item);
+      continue;
+    }
+    const ctx = getContextFromComments(item.extractedComments, ctxPrefix);
+    if (!ctx) {
+      console.warn(
+        `Plural entry with msgid "${item.msgid}" is missing context information for expansion.`
+      );
+      expandedItems.push(item);
+      continue;
+    }
+    const variableList = ctx.pluralizeOn;
+    if (variableList.length === 1) {
+      expandedItems.push(item);
+      continue;
+    }
+    for (const variable of variableList) {
+      const newItem = new PO.Item();
+      newItem.msgid = item.msgid;
+      newItem.msgid_plural = item.msgid_plural;
+      newItem.msgstr = [...item.msgstr];
+      newItem.msgctxt = item.msgctxt;
+      newItem.comments = [...item.comments];
+      updateContextComment(
+        item,
+        serializeContextToComment({
+          pluralizeOn: [variable],
+          // get icu comment, replace variable placeholder with current variable
+          icu: replaceArgInIcu(ctx.icu, "\\$var", variable)
+        }),
+        ctxPrefix
+      );
+      newItem.extractedComments = item.extractedComments;
+      newItem.flags = { ...item.flags };
+      expandedItems.push(newItem);
+    }
+  }
+  return expandedItems;
+}
 function formatter(options = {}) {
   options = {
     origins: true,
@@ -252,6 +374,9 @@ function formatter(options = {}) {
     templateExtension: ".pot",
     parse(content, ctx) {
       const po = PO.parse(content);
+      if (options.mergePlurals) {
+        po.items = expandMergedPluralEntries(po.items, options);
+      }
       const pluralForms = getPluralCases(
         po.headers.Language,
         po.headers["Plural-Forms"]
@@ -274,8 +399,27 @@ function formatter(options = {}) {
         );
         const id = isGeneratedId ? generateMessageId(item.msgid, item.msgctxt) : item.msgid;
         const message = catalog[id];
-        return serializePlurals(item, message, id, isGeneratedId, options);
+        return serializePlurals(item, message, id, isGeneratedId, options, ctx);
       });
+      if (options.mergePlurals) {
+        const mergedPlurals = mergeDuplicatePluralEntries(po.items, options);
+        const newItems = [];
+        const processed = /* @__PURE__ */ new Set();
+        po.items.forEach((item) => {
+          if (!item.msgid_plural) {
+            newItems.push(item);
+          } else {
+            const mergedItem = mergedPlurals.find(
+              (merged) => merged.msgid === item.msgid && merged.msgid_plural === item.msgid_plural
+            );
+            if (mergedItem && !processed.has(mergedItem)) {
+              processed.add(mergedItem);
+              newItems.push(mergedItem);
+            }
+          }
+        });
+        po.items = newItems;
+      }
       return po.toString();
     }
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/format-po-gettext",
-  "version": "5.6.1",
+  "version": "5.8.0",
   "description": "Gettext PO format with gettext-style plurals for Lingui Catalogs",
   "main": "./dist/po-gettext.cjs",
   "module": "./dist/po-gettext.mjs",
@@ -43,9 +43,9 @@
     "dist/"
   ],
   "dependencies": {
-    "@lingui/conf": "5.6.1",
-    "@lingui/format-po": "5.6.1",
-    "@lingui/message-utils": "5.6.1",
+    "@lingui/conf": "5.8.0",
+    "@lingui/format-po": "5.8.0",
+    "@lingui/message-utils": "5.8.0",
     "@messageformat/parser": "^5.0.0",
     "cldr-core": "^45.0.0",
     "node-gettext": "^3.0.0",
@@ -57,5 +57,5 @@
     "mockdate": "^3.0.5",
     "unbuild": "2.0.0"
   },
-  "gitHead": "eeab3720888fac544c3410f0148c5b13a0f0acff"
+  "gitHead": "83d0513bdda9ff14003a05d376c7fedf860dd7ee"
 }