@lingui/format-po 4.0.0-next.2

package/README.md

@@ -0,0 +1,77 @@
+[![License][badge-license]][license]
+[![Version][badge-version]][package]
+[![Downloads][badge-downloads]][package]
+
+# @lingui/format-po
+
+> Read and write message catalogs in Gettext PO format with ICU plurals
+
+`@lingui/format-po` is part of [LinguiJS][linguijs]. See the
+[documentation][documentation] for all information, tutorials and examples.
+
+## Catalog example
+
+```po
+#, Comment for translators
+#: src/App.js:4, src/Component.js:2
+msgid "MessageID"
+msgstr "Translated Message"
+```
+
+## Installation
+
+```sh
+npm install --save-dev @lingui/format-po
+# yarn add --dev @lingui/format-po
+```
+
+## Usage
+
+```js
+// lingui.config.{js,ts}
+import {formatter} from "@lingui/format-po"
+
+export default {
+  [...]
+  format: formatter({lineNumbers: false}),
+}
+```
+
+Possible options:
+
+```ts
+export 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
+}
+```
+
+## License
+
+This package is licensed under [MIT][license] license.
+
+[license]: https://github.com/lingui/js-lingui/blob/main/LICENSE
+[linguijs]: https://github.com/lingui/js-lingui
+[documentation]: https://lingui.dev
+[package]: https://www.npmjs.com/package/@lingui/format-po
+[badge-downloads]: https://img.shields.io/npm/dw/@lingui/format-po.svg
+[badge-version]: https://img.shields.io/npm/v/@lingui/format-po.svg
+[badge-license]: https://img.shields.io/npm/l/@lingui/format-po.svg

package/dist/po.cjs

@@ -0,0 +1,111 @@
+'use strict';
+
+const dateFns = require('date-fns');
+const PO = require('pofile');
+const api = require('@lingui/cli/api');
+
+const splitOrigin = (origin) => {
+  const [file, line] = origin.split(":");
+  return [file, line ? Number(line) : null];
+};
+const joinOrigin = (origin) => origin.join(":");
+function isGeneratedId(id, message) {
+  return id === api.generateMessageId(message.message, message.context);
+}
+function getCreateHeaders(language) {
+  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 } : {}
+  };
+}
+const EXPLICIT_ID_FLAG = "explicit-id";
+const serialize = (catalog, options) => {
+  return Object.keys(catalog).map((id) => {
+    const message = catalog[id];
+    const item = new PO.Item();
+    item.extractedComments = [...message.extractedComments || []];
+    item.flags = (message.flags || []).reduce((acc, flag) => {
+      acc[flag] = true;
+      return acc;
+    }, {});
+    const _isGeneratedId = isGeneratedId(id, message);
+    if (_isGeneratedId) {
+      item.msgid = message.message;
+      if (options.printLinguiId) {
+        if (!item.extractedComments.find((c) => c.includes("js-lingui-id"))) {
+          item.extractedComments.push(`js-lingui-id: ${id}`);
+        }
+      }
+    } else {
+      item.flags[EXPLICIT_ID_FLAG] = true;
+      item.msgid = id;
+    }
+    if (message.context) {
+      item.msgctxt = message.context;
+    }
+    item.msgstr = [message.translation];
+    item.comments = message.comments || [];
+    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) {
+  return items.reduce((catalog, item) => {
+    const message = {
+      translation: item.msgstr[0],
+      extractedComments: item.extractedComments || [],
+      comments: item.comments || [],
+      context: item.msgctxt ?? null,
+      obsolete: item.flags.obsolete || item.obsolete,
+      origin: (item.references || []).map((ref) => splitOrigin(ref)),
+      flags: Object.keys(item.flags).map((flag) => flag.trim())
+    };
+    let id = item.msgid;
+    if (!item.flags[EXPLICIT_ID_FLAG]) {
+      id = api.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.parse(content);
+      return deserialize(po.items);
+    },
+    serialize(catalog, ctx) {
+      let po;
+      if (ctx.existing) {
+        po = PO.parse(ctx.existing);
+      } else {
+        po = new PO();
+        po.headers = getCreateHeaders(ctx.locale);
+        po.headerOrder = Object.keys(po.headers);
+      }
+      po.items = serialize(catalog, options);
+      return po.toString();
+    }
+  };
+}
+
+exports.formatter = formatter;

package/dist/po.d.ts

@@ -0,0 +1,33 @@
+import { CatalogType } 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;
+};
+declare function formatter(options?: PoFormatterOptions): {
+    catalogExtension: string;
+    templateExtension: string;
+    parse(content: string): CatalogType;
+    serialize(catalog: CatalogType, ctx: {
+        locale: string;
+        existing: string;
+    }): string;
+};
+
+export { PoFormatterOptions, formatter };

package/dist/po.mjs

@@ -0,0 +1,109 @@
+import { format } from 'date-fns';
+import PO from 'pofile';
+import { generateMessageId } from '@lingui/cli/api';
+
+const splitOrigin = (origin) => {
+  const [file, line] = origin.split(":");
+  return [file, line ? Number(line) : null];
+};
+const joinOrigin = (origin) => origin.join(":");
+function isGeneratedId(id, message) {
+  return id === generateMessageId(message.message, message.context);
+}
+function getCreateHeaders(language) {
+  return {
+    "POT-Creation-Date": 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 } : {}
+  };
+}
+const EXPLICIT_ID_FLAG = "explicit-id";
+const serialize = (catalog, options) => {
+  return Object.keys(catalog).map((id) => {
+    const message = catalog[id];
+    const item = new PO.Item();
+    item.extractedComments = [...message.extractedComments || []];
+    item.flags = (message.flags || []).reduce((acc, flag) => {
+      acc[flag] = true;
+      return acc;
+    }, {});
+    const _isGeneratedId = isGeneratedId(id, message);
+    if (_isGeneratedId) {
+      item.msgid = message.message;
+      if (options.printLinguiId) {
+        if (!item.extractedComments.find((c) => c.includes("js-lingui-id"))) {
+          item.extractedComments.push(`js-lingui-id: ${id}`);
+        }
+      }
+    } else {
+      item.flags[EXPLICIT_ID_FLAG] = true;
+      item.msgid = id;
+    }
+    if (message.context) {
+      item.msgctxt = message.context;
+    }
+    item.msgstr = [message.translation];
+    item.comments = message.comments || [];
+    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) {
+  return items.reduce((catalog, item) => {
+    const message = {
+      translation: item.msgstr[0],
+      extractedComments: item.extractedComments || [],
+      comments: item.comments || [],
+      context: item.msgctxt ?? null,
+      obsolete: item.flags.obsolete || item.obsolete,
+      origin: (item.references || []).map((ref) => splitOrigin(ref)),
+      flags: Object.keys(item.flags).map((flag) => flag.trim())
+    };
+    let id = item.msgid;
+    if (!item.flags[EXPLICIT_ID_FLAG]) {
+      id = 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.parse(content);
+      return deserialize(po.items);
+    },
+    serialize(catalog, ctx) {
+      let po;
+      if (ctx.existing) {
+        po = PO.parse(ctx.existing);
+      } else {
+        po = new PO();
+        po.headers = getCreateHeaders(ctx.locale);
+        po.headerOrder = Object.keys(po.headers);
+      }
+      po.items = serialize(catalog, options);
+      return po.toString();
+    }
+  };
+}
+
+export { formatter };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@lingui/format-po",
+  "version": "4.0.0-next.2",
+  "description": "Gettext PO format for Lingui Catalogs",
+  "main": "./dist/po.cjs",
+  "module": "./dist/po.mjs",
+  "types": "./dist/po.d.ts",
+  "license": "MIT",
+  "keywords": [
+    "i18n",
+    "lingui-format",
+    "lingui-formatter",
+    "gettext",
+    "po",
+    "pot",
+    "internationalization",
+    "i10n",
+    "localization",
+    "i9n",
+    "translation"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && unbuild",
+    "stub": "unbuild --stub"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lingui/js-lingui.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lingui/js-lingui/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist/"
+  ],
+  "dependencies": {
+    "@lingui/cli": "4.0.0-next.2",
+    "@lingui/conf": "4.0.0-next.2",
+    "date-fns": "^2.29.3",
+    "pofile": "^1.1.4"
+  },
+  "devDependencies": {
+    "@lingui/jest-mocks": "workspace:^",
+    "unbuild": "^1.1.2"
+  }
+}