@kemdict/gettext 0.1.2 → 0.2.0

package/README.md

@@ -66,7 +66,7 @@ gettext('The world is a funny place')
 
 ```js
 import Gettext from '@kemdict/gettext'
-import { loadTranslations } from '@kemdict/gettext/loaders'
+import { loadTranslations } from '@kemdict/gettext/loaders-node'
 const gt = new Gettext({
   // this reads and parses all .po files under path/to/locales
   // their filenames are the locale names ('de.po' creates an entry for 'de')
@@ -124,7 +124,7 @@ Translate a string with context like pgettext.
 
 Translate a string with context and plural handling like npgettext.
 
-### Loaders ("@kemdict/gettext/loaders.js")
+### Loaders that require Node-compatible environments ("@kemdict/gettext/loaders-node.js")
 
 #### bindtextdomain(domain, ...localesDirs) → Record<string, GetTextTranslations>
 
@@ -146,6 +146,12 @@ pgettext("@title:window", "Choose Folder") // 選擇資料夾 in zh_TW
 
 Load PO files from `dir`. `dir` should contain one PO file for each locale, like `<dir>/zh_TW.po`, `<dir>/de.po`, `<dir>/sv.po`, and so on.
 
+### Loaders that don't ("@kemdict/gettext/loaders.js")
+
+#### loadTranslationsFromObject(obj) → Record<string, GetTextTranslations>
+
+Take an object like the result of doing `import.meta.glob("*.po", { eager: true, query: "?raw" })` in Vite, then return an object mapping language codes to parsed translations. There should be one entry for each locale, like `zh_TW.po`, `de.po`, `sv.po`, and so on.
+
 ## License
 
 MIT

package/lib/loaders-node.js

@@ -0,0 +1,54 @@
+/** @import {Catalog, Locale} from "./gettext.js" */
+
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { po, mo } from "gettext-parser";
+
+/**
+ * Load MO translations the directories `localesDirs`.
+ *
+ * These directories should be arranged similar to /usr/share/locale, like
+ * <dir>/<locale>/LC_MESSAGES/<domain>.mo.
+ *
+ * @param {string} domain
+ * @param {...string} localesDirs
+ */
+export function bindtextdomain(domain, ...localesDirs) {
+    /** @type Record<Locale, Catalog> */
+    const catalogs = {};
+    for (const localesDir of localesDirs) {
+        if (!fs.existsSync(localesDir)) continue;
+        for (const locale of fs.readdirSync(localesDir)) {
+            const localePath = path.join(localesDir, locale);
+            if (!fs.statSync(localePath).isDirectory()) continue;
+            const messagesPath = path.join(localePath, "LC_MESSAGES");
+            if (!fs.existsSync(messagesPath)) continue;
+            if (!fs.statSync(messagesPath).isDirectory()) continue;
+            const domainPath = path.join(messagesPath, `${domain}.mo`);
+            if (!fs.existsSync(domainPath)) continue;
+
+            const translations = mo.parse(fs.readFileSync(domainPath));
+            catalogs[locale] = translations;
+        }
+    }
+    return catalogs;
+}
+
+/**
+ * Load PO translations from `dir`.
+ * `dir` should be structured like <dir>/<locale>.po.
+ * @param {string} dir
+ */
+export function loadTranslations(dir) {
+    /** @type Record<Locale, Catalog> */
+    const catalogs = {};
+    for (const file of fs.readdirSync(dir)) {
+        if (file.endsWith(".po")) {
+            const translations = po.parse(
+                fs.readFileSync(path.join(dir, file)),
+            );
+            catalogs[file.slice(0, -3)] = translations;
+        }
+    }
+    return catalogs;
+}

package/lib/loaders.js

@@ -1,53 +1,23 @@
 /** @import {Catalog, Locale} from "./gettext.js" */
 
-import * as fs from "node:fs";
-import * as path from "node:path";
-import { po, mo } from "gettext-parser";
+import { po } from "gettext-parser";
 
 /**
- * Load MO translations the directories `localesDirs`.
- *
- * These directories should be arranged similar to /usr/share/locale, like
- * <dir>/<locale>/LC_MESSAGES/<domain>.mo.
- *
- * @param {string} domain
- * @param {...string} localesDirs
+ * Load PO translations from an object mapping file paths to content strings,
+ * such as those from Vite's import.meta.glob.
+ * @param {Record<string, string | { default: string }>} obj
  */
-export function bindtextdomain(domain, ...localesDirs) {
+export function loadTranslationsFromObject(obj) {
     /** @type Record<Locale, Catalog> */
     const catalogs = {};
-    for (const localesDir of localesDirs) {
-        if (!fs.existsSync(localesDir)) continue;
-        for (const locale of fs.readdirSync(localesDir)) {
-            const localePath = path.join(localesDir, locale);
-            if (!fs.statSync(localePath).isDirectory()) continue;
-            const messagesPath = path.join(localePath, "LC_MESSAGES");
-            if (!fs.existsSync(messagesPath)) continue;
-            if (!fs.statSync(messagesPath).isDirectory()) continue;
-            const domainPath = path.join(messagesPath, `${domain}.mo`);
-            if (!fs.existsSync(domainPath)) continue;
-
-            const translations = mo.parse(fs.readFileSync(domainPath));
-            catalogs[locale] = translations;
-        }
-    }
-    return catalogs;
-}
-
-/**
- * Load PO translations from `dir`.
- * `dir` should be structured like <dir>/<locale>.po.
- * @param {string} dir
- */
-export function loadTranslations(dir) {
-    /** @type Record<Locale, Catalog> */
-    const catalogs = {};
-    for (const file of fs.readdirSync(dir)) {
+    for (const [file, content] of Object.entries(obj)) {
         if (file.endsWith(".po")) {
-            const translations = po.parse(
-                fs.readFileSync(path.join(dir, file)),
-            );
-            catalogs[file.slice(0, -3)] = translations;
+            const actualContent =
+                typeof content === "string" ? content : content.default;
+            const translations = po.parse(actualContent);
+            // We don't have access to node:path.basename here.
+            const basename = file.replace(/^.*[\/\\]/, "").slice(0, -3);
+            catalogs[basename] = translations;
         }
     }
     return catalogs;

package/lib/plural-data.js

@@ -155,6 +155,12 @@ export const pluralFuncTable = {
     "(n>2)": (n) => n > 2,
 };
 
+// Extra plurals, which should be submitted somewhere but no one (including me)
+// has bothered yet
+const extraPlurals = {
+    nan: "nplurals=1; plural=0;",
+};
+
 // from Gettext's plural-table.c
 // prettier-ignore
 const pluralTable = {
@@ -234,12 +240,10 @@ const cldrPlurals = {
  * @param {string} locale - The locale to look up.
  */
 export function localePluralForms(locale) {
-    // Try gettext's first
-    for (const [langs, value] of Object.entries(pluralTable)) {
-        if (langs.split(" ").includes(locale)) return value;
-    }
-    // Then try CLDR
-    for (const [langs, value] of Object.entries(cldrPlurals)) {
-        if (langs.split(" ").includes(locale)) return value;
+    // Try our extras first, then gettext's plural-table, then finally cldr
+    for (const table of [extraPlurals, pluralTable, cldrPlurals]) {
+        for (const [langs, value] of Object.entries(table)) {
+            if (langs.split(" ").includes(locale)) return value;
+        }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kemdict/gettext",
   "description": "A JavaScript implementation of gettext, a localization framework",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -22,6 +22,10 @@
       "types": "./types/gettext.d.ts",
       "default": "./lib/gettext.js"
     },
+    "./loaders-node.js": {
+      "types": "./types/loaders-node.d.ts",
+      "default": "./lib/loaders-node.js"
+    },
     "./loaders.js": {
       "types": "./types/loaders.d.ts",
       "default": "./lib/loaders.js"

package/types/loaders-node.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Load MO translations the directories `localesDirs`.
+ *
+ * These directories should be arranged similar to /usr/share/locale, like
+ * <dir>/<locale>/LC_MESSAGES/<domain>.mo.
+ *
+ * @param {string} domain
+ * @param {...string} localesDirs
+ */
+export function bindtextdomain(domain: string, ...localesDirs: string[]): Record<string, import("gettext-parser").GetTextTranslations>;
+/**
+ * Load PO translations from `dir`.
+ * `dir` should be structured like <dir>/<locale>.po.
+ * @param {string} dir
+ */
+export function loadTranslations(dir: string): Record<string, import("gettext-parser").GetTextTranslations>;
+//# sourceMappingURL=loaders-node.d.ts.map

package/types/loaders-node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loaders-node.d.ts","sourceRoot":"","sources":["../lib/loaders-node.js"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,uCAHW,MAAM,kBACH,MAAM,EAAA,gEAqBnB;AAED;;;;GAIG;AACH,sCAFW,MAAM,gEAchB"}

package/types/loaders.d.ts

@@ -1,17 +1,9 @@
 /**
- * Load MO translations the directories `localesDirs`.
- *
- * These directories should be arranged similar to /usr/share/locale, like
- * <dir>/<locale>/LC_MESSAGES/<domain>.mo.
- *
- * @param {string} domain
- * @param {...string} localesDirs
+ * Load PO translations from an object mapping file paths to content strings,
+ * such as those from Vite's import.meta.glob.
+ * @param {Record<string, string | { default: string }>} obj
  */
-export function bindtextdomain(domain: string, ...localesDirs: string[]): Record<string, import("gettext-parser").GetTextTranslations>;
-/**
- * Load PO translations from `dir`.
- * `dir` should be structured like <dir>/<locale>.po.
- * @param {string} dir
- */
-export function loadTranslations(dir: string): Record<string, import("gettext-parser").GetTextTranslations>;
+export function loadTranslationsFromObject(obj: Record<string, string | {
+    default: string;
+}>): Record<string, import("gettext-parser").GetTextTranslations>;
 //# sourceMappingURL=loaders.d.ts.map

package/types/loaders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loaders.d.ts","sourceRoot":"","sources":["../lib/loaders.js"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,uCAHW,MAAM,kBACH,MAAM,EAAA,gEAqBnB;AAED;;;;GAIG;AACH,sCAFW,MAAM,gEAchB"}
+{"version":3,"file":"loaders.d.ts","sourceRoot":"","sources":["../lib/loaders.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,gDAFW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,gEAgBtD"}

package/types/plural-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plural-data.d.ts","sourceRoot":"","sources":["../lib/plural-data.js"],"names":[],"mappings":"AAuOA;;;GAGG;AACH,0CAFW,MAAM,sBAWhB;AA/OD;;;;;uBAKuB;AAEvB;;;;;GAKG;AACH,8BAFS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CA2IjC;yBArJY,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;6BAClD;IACR,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAA;CACpB"}
+{"version":3,"file":"plural-data.d.ts","sourceRoot":"","sources":["../lib/plural-data.js"],"names":[],"mappings":"AA6OA;;;GAGG;AACH,0CAFW,MAAM,sBAShB;AAnPD;;;;;uBAKuB;AAEvB;;;;;GAKG;AACH,8BAFS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CA2IjC;yBArJY,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;6BAClD;IACR,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAA;CACpB"}