@lingui/format-po 5.9.1 → 6.0.0-next.0

package/dist/po.d.mts

@@ -69,4 +69,5 @@ type PoFormatterOptions = {
 };
 declare function formatter(options?: PoFormatterOptions): CatalogFormatter;
 
-export { type PoFormatterOptions, formatter };
+export { formatter };
+export type { PoFormatterOptions };

package/dist/po.mjs

@@ -1,10 +1,23 @@
-import { format } from 'date-fns';
 import PO from 'pofile';
 import { generateMessageId } from '@lingui/message-utils/generateMessageId';
 
 function normalizePlaceholderValue(text) {
   return text.replace(/\n/g, " ").replace(/\s{2,}/g, " ");
 }
+function formatPotCreationDate(date) {
+  const pad = (n) => String(n).padStart(2, "0");
+  const year = date.getFullYear();
+  const month = pad(date.getMonth() + 1);
+  const day = pad(date.getDate());
+  const hour = pad(date.getHours());
+  const minute = pad(date.getMinutes());
+  const offsetMinutes = -date.getTimezoneOffset();
+  const sign = offsetMinutes >= 0 ? "+" : "-";
+  const abs = Math.abs(offsetMinutes);
+  const offsetH = pad(Math.floor(abs / 60));
+  const offsetM = pad(abs % 60);
+  return `${year}-${month}-${day} ${hour}:${minute}${sign}${offsetH}${offsetM}`;
+}
 
 const splitOrigin = (origin) => {
   const [file, line] = origin.split(":");
@@ -21,7 +34,7 @@ function isGeneratedId(id, message) {
 }
 function getCreateHeaders(language, customHeaderAttributes) {
   return {
-    "POT-Creation-Date": format(/* @__PURE__ */ new Date(), "yyyy-MM-dd HH:mmxxxx"),
+    "POT-Creation-Date": formatPotCreationDate(/* @__PURE__ */ new Date()),
     "MIME-Version": "1.0",
     "Content-Type": "text/plain; charset=utf-8",
     "Content-Transfer-Encoding": "8bit",
@@ -84,7 +97,7 @@ const serialize = (catalog, options, ctx) => {
     if (message.context) {
       item.msgctxt = message.context;
     }
-    if (!_isGeneratedId && (ctx.locale === ctx.sourceLocale || ctx.locale === null)) {
+    if (!_isGeneratedId && (ctx.locale === ctx.sourceLocale || !ctx.locale)) {
       item.msgstr = [message.translation || message.message];
     } else {
       item.msgstr = [message.translation];
@@ -97,7 +110,7 @@ const serialize = (catalog, options, ctx) => {
         item.references = message.origin ? message.origin.map(joinOrigin) : [];
       }
     }
-    item.obsolete = message.obsolete;
+    item.obsolete = message.obsolete || false;
     return item;
   });
 };
@@ -110,7 +123,7 @@ function deserialize(items, options) {
         // drop flags from comments
         (c) => c !== GENERATED_ID_FLAG && c !== EXPLICIT_ID_FLAG
       ),
-      context: item.msgctxt ?? null,
+      context: item.msgctxt ?? void 0,
       obsolete: item.flags.obsolete || item.obsolete,
       origin: (item.references || []).map((ref) => splitOrigin(ref)),
       extra: {

package/package.json

@@ -1,10 +1,8 @@
 {
   "name": "@lingui/format-po",
-  "version": "5.9.1",
+  "version": "6.0.0-next.0",
   "description": "Gettext PO format for Lingui Catalogs",
-  "main": "./dist/po.cjs",
-  "module": "./dist/po.mjs",
-  "types": "./dist/po.d.ts",
+  "type": "module",
   "sideEffects": false,
   "license": "MIT",
   "keywords": [
@@ -21,9 +19,13 @@
     "translation",
     "multilingual"
   ],
+  "exports": {
+    ".": "./dist/po.mjs"
+  },
   "scripts": {
-    "build": "rimraf ./dist && unbuild",
-    "stub": "unbuild --stub"
+    "test": "vitest run",
+    "build": "unbuild",
+    "check-types": "tsc --noEmit"
   },
   "homepage": "https://lingui.dev",
   "repository": {
@@ -35,7 +37,7 @@
     "url": "https://github.com/lingui/js-lingui/issues"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22.19.0"
   },
   "files": [
     "LICENSE",
@@ -43,15 +45,16 @@
     "dist/"
   ],
   "dependencies": {
-    "@lingui/conf": "5.9.1",
-    "@lingui/message-utils": "5.9.1",
-    "date-fns": "^3.6.0",
+    "@lingui/conf": "6.0.0-next.0",
+    "@lingui/message-utils": "6.0.0-next.0",
     "pofile": "^1.1.4"
   },
   "devDependencies": {
-    "@lingui/jest-mocks": "^3.0.3",
-    "mockdate": "^3.0.5",
-    "unbuild": "2.0.0"
+    "unbuild": "3.6.1",
+    "vitest": "4.0.18"
+  },
+  "unbuild": {
+    "declaration": "node16"
   },
-  "gitHead": "4abb5a8fff1e1936a83a7d1ae602092607c520a1"
+  "gitHead": "a9576050487a4f7dfbc88db20814d5a1bb861c8c"
 }

package/dist/po.cjs

@@ -1,170 +0,0 @@
-'use strict';
-
-const dateFns = require('date-fns');
-const PO = require('pofile');
-const generateMessageId = require('@lingui/message-utils/generateMessageId');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
-
-const PO__default = /*#__PURE__*/_interopDefaultCompat(PO);
-
-function normalizePlaceholderValue(text) {
-  return text.replace(/\n/g, " ").replace(/\s{2,}/g, " ");
-}
-
-const splitOrigin = (origin) => {
-  const [file, line] = origin.split(":");
-  return [file, line ? Number(line) : null];
-};
-const splitMultiLineComments = (comments) => {
-  return comments.flatMap(
-    (comment) => comment.includes("\n") ? comment.split("\n").map((slice) => slice.trim()).filter(Boolean) : comment
-  );
-};
-const joinOrigin = (origin) => origin.join(":");
-function isGeneratedId(id, message) {
-  return id === generateMessageId.generateMessageId(message.message, message.context);
-}
-function getCreateHeaders(language, customHeaderAttributes) {
-  return {
-    "POT-Creation-Date": dateFns.format(/* @__PURE__ */ new Date(), "yyyy-MM-dd HH:mmxxxx"),
-    "MIME-Version": "1.0",
-    "Content-Type": "text/plain; charset=utf-8",
-    "Content-Transfer-Encoding": "8bit",
-    "X-Generator": "@lingui/cli",
-    ...language ? { Language: language } : {},
-    ...customHeaderAttributes ?? {}
-  };
-}
-const EXPLICIT_ID_FLAG = "js-lingui-explicit-id";
-const GENERATED_ID_FLAG = "js-lingui-generated-id";
-const serialize = (catalog, options, ctx) => {
-  return Object.keys(catalog).map((id) => {
-    const message = catalog[id];
-    const item = new PO__default.Item();
-    item.extractedComments = [
-      ...message.comments?.length ? splitMultiLineComments(message.comments) : []
-    ];
-    item.flags = (message.extra?.flags || []).reduce((acc, flag) => {
-      acc[flag] = true;
-      return acc;
-    }, {});
-    const _isGeneratedId = isGeneratedId(id, message);
-    if (_isGeneratedId) {
-      item.msgid = message.message;
-      if (options.explicitIdAsDefault) {
-        if (!item.extractedComments.includes(GENERATED_ID_FLAG)) {
-          item.extractedComments.push(GENERATED_ID_FLAG);
-        }
-      }
-      if (options.printLinguiId) {
-        if (!item.extractedComments.find((c) => c.includes("js-lingui-id"))) {
-          item.extractedComments.push(`js-lingui-id: ${id}`);
-        }
-      }
-    } else {
-      if (!options.explicitIdAsDefault) {
-        if (!item.extractedComments.includes(EXPLICIT_ID_FLAG)) {
-          item.extractedComments.push(EXPLICIT_ID_FLAG);
-        }
-      }
-      item.msgid = id;
-    }
-    if (options.printPlaceholdersInComments !== false) {
-      item.extractedComments = item.extractedComments.filter(
-        (comment) => !comment.startsWith("placeholder ")
-      );
-      const limit = typeof options.printPlaceholdersInComments === "object" && options.printPlaceholdersInComments.limit ? options.printPlaceholdersInComments.limit : 3;
-      if (message.placeholders) {
-        Object.entries(message.placeholders).forEach(([name, value]) => {
-          if (/^\d+$/.test(name)) {
-            value.slice(0, limit).forEach((entry) => {
-              item.extractedComments.push(
-                `placeholder {${name}}: ${normalizePlaceholderValue(entry)}`
-              );
-            });
-          }
-        });
-      }
-    }
-    if (message.context) {
-      item.msgctxt = message.context;
-    }
-    if (!_isGeneratedId && (ctx.locale === ctx.sourceLocale || ctx.locale === null)) {
-      item.msgstr = [message.translation || message.message];
-    } else {
-      item.msgstr = [message.translation];
-    }
-    item.comments = message.extra?.translatorComments || [];
-    if (options.origins !== false) {
-      if (message.origin && options.lineNumbers === false) {
-        item.references = message.origin.map(([path]) => path);
-      } else {
-        item.references = message.origin ? message.origin.map(joinOrigin) : [];
-      }
-    }
-    item.obsolete = message.obsolete;
-    return item;
-  });
-};
-function deserialize(items, options) {
-  return items.reduce((catalog, item) => {
-    const comments = item.extractedComments;
-    const message = {
-      translation: item.msgstr[0],
-      comments: comments.filter(
-        // drop flags from comments
-        (c) => c !== GENERATED_ID_FLAG && c !== EXPLICIT_ID_FLAG
-      ),
-      context: item.msgctxt ?? null,
-      obsolete: item.flags.obsolete || item.obsolete,
-      origin: (item.references || []).map((ref) => splitOrigin(ref)),
-      extra: {
-        translatorComments: item.comments || [],
-        flags: Object.keys(item.flags).map((flag) => flag.trim())
-      }
-    };
-    let id = item.msgid;
-    if (options.explicitIdAsDefault ? comments.includes(GENERATED_ID_FLAG) : !comments.includes(EXPLICIT_ID_FLAG)) {
-      id = generateMessageId.generateMessageId(item.msgid, item.msgctxt);
-      message.message = item.msgid;
-    }
-    catalog[id] = message;
-    return catalog;
-  }, {});
-}
-function formatter(options = {}) {
-  options = {
-    origins: true,
-    lineNumbers: true,
-    ...options
-  };
-  return {
-    catalogExtension: ".po",
-    templateExtension: ".pot",
-    parse(content) {
-      const po = PO__default.parse(content);
-      return deserialize(po.items, options);
-    },
-    serialize(catalog, ctx) {
-      let po;
-      if (ctx.existing) {
-        po = PO__default.parse(ctx.existing);
-      } else {
-        po = new PO__default();
-        po.headers = getCreateHeaders(
-          ctx.locale,
-          options.customHeaderAttributes
-        );
-        po.headerOrder = Object.keys(po.headers);
-      }
-      po.items = serialize(catalog, options, {
-        locale: ctx.locale,
-        sourceLocale: ctx.sourceLocale
-      });
-      return po.toString();
-    }
-  };
-}
-
-exports.formatter = formatter;

package/dist/po.d.cts

@@ -1,72 +0,0 @@
-import { CatalogFormatter } from '@lingui/conf';
-
-type PoFormatterOptions = {
-    /**
-     * Print places where message is used
-     *
-     * @default true
-     */
-    origins?: boolean;
-    /**
-     * Print line numbers in origins
-     *
-     * @default true
-     */
-    lineNumbers?: boolean;
-    /**
-     * Print `js-lingui-id: Xs4as` statement in extracted comments section
-     *
-     * @default false
-     */
-    printLinguiId?: boolean;
-    /**
-     * By default, the po-formatter treats the pair `msgid` + `msgctx` as the source
-     * for generating an ID by hashing its value.
-     *
-     * For messages with explicit IDs, the formatter adds a special comment `js-lingui-explicit-id` as a flag.
-     * When this flag is present, the formatter will use the `msgid` as-is without any additional processing.
-     *
-     * Set this option to true if you exclusively use explicit-ids in your project.
-     *
-     * https://lingui.dev/tutorials/explicit-vs-generated-ids#using-custom-id
-     *
-     * @default false
-     */
-    explicitIdAsDefault?: boolean;
-    /**
-     * Custom attributes to append to the PO file header
-     *
-     * @default {}
-     */
-    customHeaderAttributes?: {
-        [key: string]: string;
-    };
-    /**
-     * Print values for unnamed placeholders as comments for each message.
-     *
-     * This can give more context to translators for better translations.
-     *
-     * By default first 3 placeholders are shown.
-     *
-     * Example:
-     *
-     * ```js
-     * t`Hello ${user.name} ${value}`
-     * ```
-     *
-     * This will be extracted as
-     *
-     * ```po
-     * #. placeholder {0}: user.name
-     * msgid "Hello {0} {value}"
-     * ```
-     *
-     * @default true
-     */
-    printPlaceholdersInComments?: boolean | {
-        limit?: number;
-    };
-};
-declare function formatter(options?: PoFormatterOptions): CatalogFormatter;
-
-export { type PoFormatterOptions, formatter };

package/dist/po.d.ts

@@ -1,72 +0,0 @@
-import { CatalogFormatter } from '@lingui/conf';
-
-type PoFormatterOptions = {
-    /**
-     * Print places where message is used
-     *
-     * @default true
-     */
-    origins?: boolean;
-    /**
-     * Print line numbers in origins
-     *
-     * @default true
-     */
-    lineNumbers?: boolean;
-    /**
-     * Print `js-lingui-id: Xs4as` statement in extracted comments section
-     *
-     * @default false
-     */
-    printLinguiId?: boolean;
-    /**
-     * By default, the po-formatter treats the pair `msgid` + `msgctx` as the source
-     * for generating an ID by hashing its value.
-     *
-     * For messages with explicit IDs, the formatter adds a special comment `js-lingui-explicit-id` as a flag.
-     * When this flag is present, the formatter will use the `msgid` as-is without any additional processing.
-     *
-     * Set this option to true if you exclusively use explicit-ids in your project.
-     *
-     * https://lingui.dev/tutorials/explicit-vs-generated-ids#using-custom-id
-     *
-     * @default false
-     */
-    explicitIdAsDefault?: boolean;
-    /**
-     * Custom attributes to append to the PO file header
-     *
-     * @default {}
-     */
-    customHeaderAttributes?: {
-        [key: string]: string;
-    };
-    /**
-     * Print values for unnamed placeholders as comments for each message.
-     *
-     * This can give more context to translators for better translations.
-     *
-     * By default first 3 placeholders are shown.
-     *
-     * Example:
-     *
-     * ```js
-     * t`Hello ${user.name} ${value}`
-     * ```
-     *
-     * This will be extracted as
-     *
-     * ```po
-     * #. placeholder {0}: user.name
-     * msgid "Hello {0} {value}"
-     * ```
-     *
-     * @default true
-     */
-    printPlaceholdersInComments?: boolean | {
-        limit?: number;
-    };
-};
-declare function formatter(options?: PoFormatterOptions): CatalogFormatter;
-
-export { type PoFormatterOptions, formatter };