rollup-plugin-gettext 0.1.0

package/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 Kisaragi Hiu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# rollup-plugin-gettext
+
+Import PO or MO files when using Rollup or Vite, parsing translation catalogs through [gettext-parser](https://github.com/smhg/gettext-parser).
+
+This does not handle extraction or translating at runtime.
+
+## Config
+
+```typescript
+// vite.config.js or rollup.config.js
+import { mo, po } from "rollup-plugin-gettext";
+export default {
+  plugins: [mo(), po()] // order doesn't matter, pick either or both
+}
+```
+
+```typescript
+// astro.config.js
+import { mo, po } from "rollup-plugin-gettext";
+export default {
+  vite: {
+    plugins: [mo(), po()] // order doesn't matter, pick either or both
+  }
+}
+```
+
+To get types for the data imported with this plugin, add a `/// <reference types="rollup-plugin-gettext/types />"` to a global declaration file or to the file where you're importing them, or put `"rollup-plugin-gettext/types"` into `lib` in `tsconfig.json`.
+
+## Usage
+
+```typescript
+import de from "./locale/de.po"
+import de from "po:./locale/de.po"
+import de from "./locale/de.mo"
+import de from "mo:./locale/de.mo"
+```
+
+This is equivalent to `(await import("gettext-parser")).po.parse(readFileSync("./locale/de.po"))`, except Vite/Rollup will bundle the value making it usable eg. on the client side.
+
+Note that using MO files doesn't really have a difference in performance here.
+
+Or, more usefully:
+
+```typescript
+import translations1 from "po:./dir/with/po/files"
+import translations2 from "mo:./dir/with/mo/files"
+```
+
+this will import each of the PO files in the directory, and make them available as an object with keys being their basenames without extensions, and values being `{messages: GetTextTranslations}`. (“messages” is temporary and will be removed. That's a gettext domain but it's not actually read from anything.)
+
+The translations imported this way can be passed directly into the `@kemdict/gettext` runtime.
+
+## Options
+
+- po:
+  - parserOptions: options to pass to the PO file parser from `gettext-parser`.
+
+    This is a nested object *just in case* it turns out the plugin could use some other options. (Currently this just has `defaultCharset` and `validation` in it, see the docs for `gettext-parser`.)
+
+- mo:
+  - defaultCharset: passed into the MO file parser from `gettext-parser`.
+
+## Acknowledgements
+
+- I referenced [@miyaneee/rollup-plugin-json5](https://github.com/Miyaneee/rollup-plugin-json5) for how a Rollup plugin like this should be structured (that plugin seems to also be based on @rollup/json)
+- I referenced @rollup/data-uri and [rollup-plugin-glob-import](https://github.com/gjbkz/rollup-plugin-glob-import) as well as @rollup/image for how to load data
+- https://github.com/figma/vite-plugin-yaml for how to set up types

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { type GetTextPoParserOptions } from "gettext-parser";
+import type { Plugin } from "rollup";
+interface MoPluginOptions {
+    defaultCharset?: string;
+}
+interface PoPluginOptions {
+    parserOptions?: GetTextPoParserOptions;
+}
+export declare function po(options?: PoPluginOptions): Plugin;
+export declare function mo(options?: MoPluginOptions): Plugin;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAIA,OAAO,EAGH,KAAK,sBAAsB,EAE9B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,UAAU,eAAe;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,UAAU,eAAe;IACrB,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,wBAAgB,EAAE,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CAyExD;AAED,wBAAgB,EAAE,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CAqExD"}

package/dist/index.js

@@ -0,0 +1,132 @@
+import path from "node:path";
+import fs from "node:fs/promises";
+import { dataToEsm } from "@rollup/pluginutils";
+import { po as poParser, mo as moParser, } from "gettext-parser";
+export function po(options = {}) {
+    const parsedMap = new Map();
+    return {
+        name: "po",
+        // This is just for a directory of PO files. A single PO file gets the
+        // standard resolution.
+        resolveId: {
+            filter: { id: /^po:/ },
+            // handle prefixed directory imports and prefixed file imports
+            async handler(source, importer) {
+                if (!importer)
+                    return null;
+                const fullpath = path.join(path.dirname(importer), source.slice("po:".length));
+                try {
+                    // prefixed directories
+                    const files = await fs.readdir(fullpath);
+                    const catalogs = {};
+                    for (const file of files) {
+                        if (!file.endsWith(".po"))
+                            continue;
+                        const content = await fs.readFile(path.join(fullpath, file), {
+                            encoding: "utf8",
+                        });
+                        const key = path.basename(file, ".po");
+                        catalogs[key] = poParser.parse(content);
+                    }
+                    if (Object.keys(catalogs).length === 0) {
+                        return null;
+                    }
+                    parsedMap.set(fullpath, catalogs);
+                    return fullpath + "?gettext-po-dir";
+                }
+                catch (e) {
+                    if (e.code !== "ENOTDIR")
+                        return null;
+                    // prefixed files, we need to resolve this here for
+                    // absolute paths
+                    return fullpath + "?gettext-po-file";
+                }
+            },
+        },
+        load: {
+            filter: {
+                id: /(?:\.po|\?gettext-po-dir|\?gettext-po-file)$/,
+            },
+            async handler(id) {
+                // 3 cases:
+                const parsed = id.endsWith("?gettext-po-dir")
+                    ? // 1: prefixed directory imports, which would have the ID
+                        // resolved like this in our resolveId
+                        parsedMap.get(id.slice(0, -1 * "?gettext-po-dir".length))
+                    : poParser.parse(await fs.readFile(id.endsWith("?gettext-po-file")
+                        ? // 2: prefixed file imports, strip the prefix
+                            id.slice(0, -1 * "?gettext-po-file".length)
+                        : // 3: unprefixed file imports, use the file
+                            // path directly
+                            id, { encoding: "utf8" }), options.parserOptions);
+                return dataToEsm(parsed, {
+                    preferConst: true,
+                    compact: true,
+                    namedExports: false,
+                });
+            },
+        },
+    };
+}
+export function mo(options = {}) {
+    const parsedMap = new Map();
+    return {
+        name: "mo",
+        resolveId: {
+            filter: { id: /^mo:/ },
+            async handler(source, importer) {
+                if (!importer)
+                    return null;
+                const fullpath = path.join(path.dirname(importer), source.slice("mo:".length));
+                try {
+                    // prefixed directories
+                    const files = await fs.readdir(fullpath);
+                    const catalogs = {};
+                    for (const file of files) {
+                        if (!file.endsWith(".mo"))
+                            continue;
+                        const content = await fs.readFile(path.join(fullpath, file));
+                        const key = path.basename(file, ".mo");
+                        catalogs[key] = moParser.parse(content, options.defaultCharset);
+                    }
+                    if (Object.keys(catalogs).length === 0) {
+                        return null;
+                    }
+                    parsedMap.set(fullpath, catalogs);
+                    return fullpath + "?gettext-mo-dir";
+                }
+                catch (e) {
+                    if (e.code !== "ENOTDIR")
+                        return null;
+                    // prefixed files, we need to resolve this here for
+                    // absolute paths
+                    return fullpath + "?gettext-mo-file";
+                }
+            },
+        },
+        load: {
+            filter: {
+                id: /(?:\.mo|\?gettext-mo-dir|\?gettext-mo-file)$/,
+            },
+            async handler(id) {
+                // 3 cases:
+                const parsed = id.endsWith("?gettext-mo-dir")
+                    ? // 1: prefixed directory imports, which would have the ID
+                        // resolved like this in our resolveId
+                        parsedMap.get(id.slice(0, -1 * "?gettext-mo-dir".length))
+                    : moParser.parse(await fs.readFile(id.endsWith("?gettext-mo-file")
+                        ? // 2: prefixed file imports, strip the prefix
+                            id.slice(0, -1 * "?gettext-mo-file".length)
+                        : // 3: unprefixed file imports, use the file
+                            // path directly
+                            id), options.defaultCharset);
+                return dataToEsm(parsed, {
+                    preferConst: true,
+                    compact: true,
+                    namedExports: false,
+                });
+            },
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EACH,EAAE,IAAI,QAAQ,EACd,EAAE,IAAI,QAAQ,GAGjB,MAAM,gBAAgB,CAAC;AAWxB,MAAM,UAAU,EAAE,CAAC,UAA2B,EAAE;IAC5C,MAAM,SAAS,GAAG,IAAI,GAAG,EAA+C,CAAC;IACzE,OAAO;QACH,IAAI,EAAE,IAAI;QACV,sEAAsE;QACtE,uBAAuB;QACvB,SAAS,EAAE;YACP,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACtB,8DAA8D;YAC9D,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ;gBAC1B,IAAI,CAAC,QAAQ;oBAAE,OAAO,IAAI,CAAC;gBAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CACtB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAC7B,CAAC;gBACF,IAAI,CAAC;oBACD,uBAAuB;oBACvB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzC,MAAM,QAAQ,GAAwC,EAAE,CAAC;oBACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;4BAAE,SAAS;wBACpC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EACzB;4BACI,QAAQ,EAAE,MAAM;yBACnB,CACJ,CAAC;wBACF,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;wBACvC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC5C,CAAC;oBACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrC,OAAO,IAAI,CAAC;oBAChB,CAAC;oBACD,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBAClC,OAAO,QAAQ,GAAG,iBAAiB,CAAC;gBACxC,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,IAAK,CAAsB,CAAC,IAAI,KAAK,SAAS;wBAAE,OAAO,IAAI,CAAC;oBAC5D,mDAAmD;oBACnD,iBAAiB;oBACjB,OAAO,QAAQ,GAAG,kBAAkB,CAAC;gBACzC,CAAC;YACL,CAAC;SACJ;QACD,IAAI,EAAE;YACF,MAAM,EAAE;gBACJ,EAAE,EAAE,8CAA8C;aACrD;YACD,KAAK,CAAC,OAAO,CAAC,EAAE;gBACZ,WAAW;gBACX,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBACzC,CAAC,CAAC,yDAAyD;wBACzD,sCAAsC;wBACtC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;oBAC3D,CAAC,CAAC,QAAQ,CAAC,KAAK,CACV,MAAM,EAAE,CAAC,QAAQ,CACb,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;wBAC3B,CAAC,CAAC,6CAA6C;4BAC7C,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC;wBAC7C,CAAC,CAAC,2CAA2C;4BAC3C,gBAAgB;4BAChB,EAAE,EACR,EAAE,QAAQ,EAAE,MAAM,EAAE,CACvB,EACD,OAAO,CAAC,aAAa,CACxB,CAAC;gBACR,OAAO,SAAS,CAAC,MAAM,EAAE;oBACrB,WAAW,EAAE,IAAI;oBACjB,OAAO,EAAE,IAAI;oBACb,YAAY,EAAE,KAAK;iBACtB,CAAC,CAAC;YACP,CAAC;SACJ;KACJ,CAAC;AACN,CAAC;AAED,MAAM,UAAU,EAAE,CAAC,UAA2B,EAAE;IAC5C,MAAM,SAAS,GAAG,IAAI,GAAG,EAA+C,CAAC;IACzE,OAAO;QACH,IAAI,EAAE,IAAI;QACV,SAAS,EAAE;YACP,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACtB,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ;gBAC1B,IAAI,CAAC,QAAQ;oBAAE,OAAO,IAAI,CAAC;gBAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CACtB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EACtB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAC7B,CAAC;gBACF,IAAI,CAAC;oBACD,uBAAuB;oBACvB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzC,MAAM,QAAQ,GAAwC,EAAE,CAAC;oBACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;4BAAE,SAAS;wBACpC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAC5B,CAAC;wBACF,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;wBACvC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAC1B,OAAO,EACP,OAAO,CAAC,cAAc,CACzB,CAAC;oBACN,CAAC;oBACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrC,OAAO,IAAI,CAAC;oBAChB,CAAC;oBACD,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBAClC,OAAO,QAAQ,GAAG,iBAAiB,CAAC;gBACxC,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,IAAK,CAAsB,CAAC,IAAI,KAAK,SAAS;wBAAE,OAAO,IAAI,CAAC;oBAC5D,mDAAmD;oBACnD,iBAAiB;oBACjB,OAAO,QAAQ,GAAG,kBAAkB,CAAC;gBACzC,CAAC;YACL,CAAC;SACJ;QACD,IAAI,EAAE;YACF,MAAM,EAAE;gBACJ,EAAE,EAAE,8CAA8C;aACrD;YACD,KAAK,CAAC,OAAO,CAAC,EAAE;gBACZ,WAAW;gBACX,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBACzC,CAAC,CAAC,yDAAyD;wBACzD,sCAAsC;wBACtC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;oBAC3D,CAAC,CAAC,QAAQ,CAAC,KAAK,CACV,MAAM,EAAE,CAAC,QAAQ,CACb,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;wBAC3B,CAAC,CAAC,6CAA6C;4BAC7C,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC;wBAC7C,CAAC,CAAC,2CAA2C;4BAC3C,gBAAgB;4BAChB,EAAE,CACX,EACD,OAAO,CAAC,cAAc,CACzB,CAAC;gBACR,OAAO,SAAS,CAAC,MAAM,EAAE;oBACrB,WAAW,EAAE,IAAI;oBACjB,OAAO,EAAE,IAAI;oBACb,YAAY,EAAE,KAAK;iBACtB,CAAC,CAAC;YACP,CAAC;SACJ;KACJ,CAAC;AACN,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "rollup-plugin-gettext",
+  "description": "Rollup loader for PO and MO files via gettext-parser",
+  "version": "0.1.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kemdict/gettext.git"
+  },
+  "homepage": "https://github.com/kemdict/gettext#readme",
+  "bugs": {
+    "url": "https://github.com/kemdict/gettext/issues"
+  },
+  "author": "Kisaragi Hiu <mail@kisaragi-hiu.com>",
+  "license": "MIT",
+  "files": ["dist", "types.d.ts", "README.md", "LICENSE", "package.json"],
+  "keywords": ["rollup-plugin", "vite-plugin", "gettext"],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./types.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "rollup": ">=4.38.0"
+  },
+  "dependencies": {
+    "@rollup/pluginutils": "^5.3.0",
+    "gettext-parser": "^9.0.0"
+  },
+  "devDependencies": {
+    "publint": "^0.3.17",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}

package/types.d.ts

@@ -0,0 +1,41 @@
+// The imports here cannot be top level, since that turns this file into a
+// module and the module declarations below into module augmentations.
+declare module "*.po" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: GetTextTranslations;
+    export default value;
+}
+declare module "*.mo" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: GetTextTranslations;
+    export default value;
+}
+// Our patterns here overlap with each other.
+// Should "po:foo.po" match "*.po" or "po:*"?
+// I need it to match as "*.po", but typescript favors "po:*", as it favors
+// favors matches with longer prefixes:
+// https://github.com/microsoft/TypeScript/blob/01c23d68b1/src/compiler/core.ts#L2410
+//
+// Declaring "po:*.po" here will make sure "po:foo.po" gets the single-file
+// type. It seems that when two patterns have the same prefix length, the one
+// that is declared first is the one that is used.
+declare module "po:*.po" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: GetTextTranslations;
+    export default value;
+}
+declare module "mo:*.mo" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: GetTextTranslations;
+    export default value;
+}
+declare module "po:*" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: Record<string, GetTextTranslations>;
+    export default value;
+}
+declare module "mo:*" {
+    import { GetTextTranslations } from "gettext-parser";
+    const value: Record<string, GetTextTranslations>;
+    export default value;
+}