@lingui/format-json 4.0.0-next.2

package/README.md

@@ -0,0 +1,95 @@
+[![License][badge-license]][license]
+[![Version][badge-version]][package]
+[![Downloads][badge-downloads]][package]
+
+# @lingui/format-json
+
+> Read and write message catalogs in JSON 
+
+`@lingui/format-json` is part of [LinguiJS][linguijs]. See the
+[documentation][documentation] for all information, tutorials and examples.
+
+## Installation
+
+```sh
+npm install --save-dev @lingui/format-json
+# yarn add --dev @lingui/format-json
+```
+
+## Usage
+
+```js
+// lingui.config.{js,ts}
+import {formatter} from "@lingui/format-json"
+
+export default {
+  [...]
+  format: formatter({style: "lingui"}),
+}
+```
+
+Possible options: 
+
+```ts
+export type JsonFormatterOptions = {
+  /**
+   * Print places where message is used
+   *
+   * @default true
+   */
+  origins?: boolean
+
+  /**
+   * Print line numbers in origins
+   *
+   * @default true
+   */
+  lineNumbers?: boolean
+
+  /**
+   * Different styles of how information could be printed
+   *
+   * @default "lingui"
+   */
+  style?: "lingui" | "minimal"
+}
+```
+
+
+### Style: minimal
+
+Simple JSON with message ID -> translation mapping. All metadata (default message, comments for translators, message origin, etc) are stripped:
+
+```json
+{
+"MessageID": "Translated Message"
+}
+```
+
+### Style: lingui
+
+Raw catalog data serialized to JSON:
+
+```json
+{
+"MessageID": {
+  "translation": "Translated Message",
+  "message": "Default string (from source code)",
+  "origin": [
+    ["path/to/src.js", 42]
+  ]
+}
+}
+```
+
+## 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-json
+[badge-downloads]: https://img.shields.io/npm/dw/@lingui/format-json.svg
+[badge-version]: https://img.shields.io/npm/v/@lingui/format-json.svg
+[badge-license]: https://img.shields.io/npm/l/@lingui/format-json.svg

package/dist/json.cjs

@@ -0,0 +1,67 @@
+'use strict';
+
+const R = require('ramda');
+
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n.default = e;
+  return n;
+}
+
+const R__namespace = /*#__PURE__*/_interopNamespaceDefault(R);
+
+const serializeMinimal = R__namespace.map(
+  (message) => message.translation || ""
+);
+const deserializeMinimal = R__namespace.map((translation) => ({
+  translation,
+  obsolete: false,
+  message: null,
+  origin: []
+}));
+const removeOrigins = R__namespace.map(({ origin, ...message }) => message);
+const removeLineNumbers = R__namespace.map((message) => {
+  if (message.origin) {
+    message.origin = message.origin.map(([file]) => [file]);
+  }
+  return message;
+});
+function formatter(options = {}) {
+  options = {
+    origins: true,
+    lineNumbers: true,
+    ...options
+  };
+  return {
+    catalogExtension: ".json",
+    serialize(catalog, { existing }) {
+      let outputCatalog = catalog;
+      if (options.origins === false) {
+        outputCatalog = removeOrigins(outputCatalog);
+      }
+      if (options.origins !== false && options.lineNumbers === false) {
+        outputCatalog = removeLineNumbers(outputCatalog);
+      }
+      const shouldUseTrailingNewline = existing === null || existing?.endsWith("\n");
+      const trailingNewLine = shouldUseTrailingNewline ? "\n" : "";
+      if (options.style === "minimal") {
+        outputCatalog = serializeMinimal(outputCatalog);
+      }
+      return JSON.stringify(outputCatalog, null, 2) + trailingNewLine;
+    },
+    parse(content) {
+      const catalog = JSON.parse(content);
+      if (options.style === "minimal") {
+        return deserializeMinimal(catalog);
+      }
+      return catalog;
+    }
+  };
+}
+
+exports.formatter = formatter;

package/dist/json.d.ts

@@ -0,0 +1,25 @@
+import { CatalogFormatter } from '@lingui/conf';
+
+type JsonFormatterOptions = {
+    /**
+     * Print places where message is used
+     *
+     * @default true
+     */
+    origins?: boolean;
+    /**
+     * Print line numbers in origins
+     *
+     * @default true
+     */
+    lineNumbers?: boolean;
+    /**
+     * Different styles of how information could be printed
+     *
+     * @default "lingui"
+     */
+    style?: "lingui" | "minimal";
+};
+declare function formatter(options?: JsonFormatterOptions): CatalogFormatter;
+
+export { JsonFormatterOptions, formatter };

package/dist/json.mjs

@@ -0,0 +1,52 @@
+import * as R from 'ramda';
+
+const serializeMinimal = R.map(
+  (message) => message.translation || ""
+);
+const deserializeMinimal = R.map((translation) => ({
+  translation,
+  obsolete: false,
+  message: null,
+  origin: []
+}));
+const removeOrigins = R.map(({ origin, ...message }) => message);
+const removeLineNumbers = R.map((message) => {
+  if (message.origin) {
+    message.origin = message.origin.map(([file]) => [file]);
+  }
+  return message;
+});
+function formatter(options = {}) {
+  options = {
+    origins: true,
+    lineNumbers: true,
+    ...options
+  };
+  return {
+    catalogExtension: ".json",
+    serialize(catalog, { existing }) {
+      let outputCatalog = catalog;
+      if (options.origins === false) {
+        outputCatalog = removeOrigins(outputCatalog);
+      }
+      if (options.origins !== false && options.lineNumbers === false) {
+        outputCatalog = removeLineNumbers(outputCatalog);
+      }
+      const shouldUseTrailingNewline = existing === null || existing?.endsWith("\n");
+      const trailingNewLine = shouldUseTrailingNewline ? "\n" : "";
+      if (options.style === "minimal") {
+        outputCatalog = serializeMinimal(outputCatalog);
+      }
+      return JSON.stringify(outputCatalog, null, 2) + trailingNewLine;
+    },
+    parse(content) {
+      const catalog = JSON.parse(content);
+      if (options.style === "minimal") {
+        return deserializeMinimal(catalog);
+      }
+      return catalog;
+    }
+  };
+}
+
+export { formatter };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@lingui/format-json",
+  "version": "4.0.0-next.2",
+  "description": "JSON format for Lingui Catalogs",
+  "main": "./dist/json.cjs",
+  "module": "./dist/json.mjs",
+  "types": "./dist/json.d.ts",
+  "license": "MIT",
+  "keywords": [
+    "i18n",
+    "lingui-format",
+    "lingui-formatter",
+    "json",
+    "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/conf": "4.0.0-next.2",
+    "ramda": "^0.28.0"
+  },
+  "devDependencies": {
+    "unbuild": "^1.1.2"
+  }
+}