@lingui/format-po 6.6.0 → 6.8.0

package/README.md

@@ -4,20 +4,21 @@
 
 # @lingui/format-po
 
-> Read and write message catalogs in Gettext PO format with ICU plurals
+> Reads and writes Lingui message catalogs as gettext PO files with ICU plurals, the default catalog format
 
-`@lingui/format-po` is part of [LinguiJS][linguijs]. See the [documentation][documentation] for all information, tutorials and examples.
+`@lingui/format-po` 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
+PO is the default and recommended catalog format: it is readable, almost every translation tool supports it, and it carries comments, source locations and context for translators. The formatter ships with `@lingui/cli`, so install this package only to pass options.
 
-See the [reference][reference] documentation.
+## Usage
+
+See the [catalog formats reference][reference].
 
 ## 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
 [reference]: https://lingui.dev/ref/catalog-formats#po
 [package]: https://www.npmjs.com/package/@lingui/format-po

package/dist/po.d.mts

@@ -1,3 +1,4 @@
+import { PoFile } from 'pofile-ts';
 import { CatalogFormatter } from '@lingui/conf';
 
 type PoFormatterOptions = {
@@ -98,7 +99,9 @@ type PoFormatterOptions = {
      */
     compactMultiline?: boolean;
 };
+/** Parse a PO file while preserving obsolete markers that pofile-ts can lose. */
+declare function parsePoFile(content: string): PoFile;
 declare function formatter(options?: PoFormatterOptions): CatalogFormatter;
 
-export { formatter };
+export { formatter, parsePoFile };
 export type { PoFormatterOptions };

package/dist/po.mjs

@@ -32,16 +32,98 @@ const joinOrigin = (origin) => origin.join(":");
 function isGeneratedId(id, message) {
   return id === generateMessageId(message.message, message.context);
 }
-function getCreateHeaders(language, customHeaderAttributes) {
-  return {
-    "POT-Creation-Date": formatPotCreationDate(/* @__PURE__ */ new Date()),
-    "MIME-Version": "1.0",
-    "Content-Type": "text/plain; charset=utf-8",
-    "Content-Transfer-Encoding": "8bit",
-    "X-Generator": "@lingui/cli",
-    ...language ? { Language: language } : {},
-    ...customHeaderAttributes ?? {}
-  };
+const MANAGED_HEADERS = [
+  "POT-Creation-Date",
+  "MIME-Version",
+  "Content-Type",
+  "Content-Transfer-Encoding",
+  "X-Generator",
+  "Language"
+];
+function getNewHeaders(language, customHeaderAttributes) {
+  const nextHeaders = {};
+  nextHeaders["POT-Creation-Date"] = customHeaderAttributes?.["POT-Creation-Date"] ?? formatPotCreationDate(/* @__PURE__ */ new Date());
+  nextHeaders["MIME-Version"] = "1.0";
+  nextHeaders["Content-Type"] = "text/plain; charset=utf-8";
+  nextHeaders["Content-Transfer-Encoding"] = "8bit";
+  nextHeaders["X-Generator"] = "@lingui/cli";
+  if (language) {
+    nextHeaders.Language = language;
+  }
+  Object.entries(customHeaderAttributes ?? {}).forEach(([key, value]) => {
+    nextHeaders[key] = value;
+  });
+  return nextHeaders;
+}
+function getExistingHeaders(existingHeaders, existingHeaderOrder, customHeaderAttributes) {
+  const nextHeaders = {};
+  existingHeaderOrder.forEach((key) => {
+    if (key in existingHeaders) {
+      nextHeaders[key] = existingHeaders[key];
+    }
+  });
+  Object.entries(customHeaderAttributes ?? {}).forEach(([key, value]) => {
+    nextHeaders[key] = value;
+  });
+  return nextHeaders;
+}
+function getHeaderOrder(headers, language, customHeaderAttributes) {
+  const managedOrder = [
+    "POT-Creation-Date",
+    "MIME-Version",
+    "Content-Type",
+    "Content-Transfer-Encoding",
+    "X-Generator",
+    ...language ? ["Language"] : [],
+    ...Object.keys(customHeaderAttributes ?? {}).filter(
+      (key) => !MANAGED_HEADERS.includes(key)
+    )
+  ];
+  const order = new Set(managedOrder);
+  Object.keys(headers).forEach((key) => {
+    order.add(key);
+  });
+  return [...order];
+}
+function getExistingHeaderOrder(headers, existingHeaderOrder) {
+  const order = new Set(existingHeaderOrder.filter((key) => key in headers));
+  Object.keys(headers).forEach((key) => {
+    order.add(key);
+  });
+  return [...order];
+}
+function parsePoItemsInSourceOrder(content) {
+  const lines = content.split(/\r?\n/);
+  const messageStart = /^(?:#~\s*)?msgid(?:\s|$)/;
+  const contextStart = /^(?:#~\s*)?msgctxt(?:\s|$)/;
+  const itemStarts = [];
+  let pendingContextStart;
+  lines.forEach((rawLine, index) => {
+    const line = rawLine.trim();
+    if (contextStart.test(line)) {
+      pendingContextStart = index;
+      return;
+    }
+    if (messageStart.test(line)) {
+      itemStarts.push(pendingContextStart ?? index);
+      pendingContextStart = void 0;
+    }
+  });
+  return itemStarts.flatMap((start, index) => {
+    const end = itemStarts[index + 1] ?? lines.length;
+    return parsePo(lines.slice(start, end).join("\n")).items;
+  });
+}
+function parsePoFile(content) {
+  const po = parsePo(content);
+  const sourceItems = parsePoItemsInSourceOrder(content);
+  po.items.forEach((item, index) => {
+    const sourceItem = sourceItems[index];
+    if (sourceItem) {
+      item.obsolete = sourceItem.obsolete;
+    }
+  });
+  return po;
 }
 const EXPLICIT_ID_FLAG = "js-lingui-explicit-id";
 const GENERATED_ID_FLAG = "js-lingui-generated-id";
@@ -136,7 +218,10 @@ function deserialize(items, options) {
       id = generateMessageId(item.msgid, item.msgctxt);
       message.message = item.msgid;
     }
-    catalog[id] = message;
+    const existingMessage = catalog[id];
+    if (existingMessage === void 0 || !message.obsolete || existingMessage.obsolete) {
+      catalog[id] = message;
+    }
     return catalog;
   }, {});
 }
@@ -151,21 +236,20 @@ function formatter(options = {}) {
     catalogExtension: ".po",
     templateExtension: ".pot",
     parse(content) {
-      const po = parsePo(content);
+      const po = parsePoFile(content);
       return deserialize(po.items, options);
     },
     serialize(catalog, ctx) {
-      let po;
-      if (ctx.existing) {
-        po = parsePo(ctx.existing);
-      } else {
-        po = createPoFile();
-        po.headers = getCreateHeaders(
-          ctx.locale,
-          options.customHeaderAttributes
-        );
-        po.headerOrder = Object.keys(po.headers);
-      }
+      const existingPo = ctx.existing !== void 0 && ctx.existing !== "" ? parsePoFile(ctx.existing) : void 0;
+      const po = createPoFile();
+      po.comments = [...existingPo?.comments ?? []];
+      po.extractedComments = [...existingPo?.extractedComments ?? []];
+      po.headers = existingPo ? getExistingHeaders(
+        existingPo.headers,
+        existingPo.headerOrder,
+        options.customHeaderAttributes
+      ) : getNewHeaders(ctx.locale, options.customHeaderAttributes);
+      po.headerOrder = existingPo ? getExistingHeaderOrder(po.headers, existingPo.headerOrder) : getHeaderOrder(po.headers, ctx.locale, options.customHeaderAttributes);
       po.items = serialize(catalog, options, {
         locale: ctx.locale,
         sourceLocale: ctx.sourceLocale
@@ -182,4 +266,4 @@ function formatter(options = {}) {
   };
 }
 
-export { formatter };
+export { formatter, parsePoFile };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lingui/format-po",
-  "version": "6.6.0",
-  "description": "Gettext PO formatter for Lingui message catalogs",
+  "version": "6.8.0",
+  "description": "Reads and writes Lingui message catalogs as gettext PO files with ICU plurals, the default catalog format",
   "type": "module",
   "sideEffects": false,
   "license": "MIT",
@@ -42,8 +42,8 @@
     "dist/"
   ],
   "dependencies": {
-    "@lingui/conf": "6.6.0",
-    "@lingui/message-utils": "6.6.0",
+    "@lingui/conf": "6.8.0",
+    "@lingui/message-utils": "6.8.0",
     "pofile-ts": "^4.0.3"
   },
   "devDependencies": {
@@ -54,5 +54,5 @@
   "unbuild": {
     "declaration": "node16"
   },
-  "gitHead": "665a19815378dedd89346bb7707bdb0e28df79e7"
+  "gitHead": "8c0f1ba378076cc49b320cccd2e06c60afe94963"
 }