@open-xchange/vite-plugin-i18next-gettext 1.0.3 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.1.0` – 2025-May-05
+
+- added: generate separate POT files per i18next namespace
+
 ## `1.0.3` – 2025-May-05
 
 - chore: use "@open-xchange/i18next-po-parser" to generate POT file
@@ -30,11 +34,11 @@
 
 ## `0.0.3` – 2024-Aug-12
 
-- fix: bump `i18next-parser` (<https://github.com/i18next/i18next-parser/issues/1045>)
+- fixed: bump `i18next-parser` (<https://github.com/i18next/i18next-parser/issues/1045>)
 
 ## `0.0.2` – 2024-Jul-26
 
-- fix: match po files against relative module path
+- fixed: match po files against relative module path
 - docs: mention `i18next-plugin-pofile-backend` package
 - chore: remove old license headers
 - chore: bump deps

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import type { Plugin } from "vite";
  */
 export interface VitePluginI18nextGettextOptions {
     /**
-     * Glob pattern(s) for all `.po` files containing the translations.
+     * Glob pattern(s) for all PO files containing the translations.
      *
      * @example
      * {
@@ -24,19 +24,21 @@ export interface VitePluginI18nextGettextOptions {
      */
     srcFiles: string | string[];
     /**
-     * Path to the `.pot` file to be generated when building the project,
-     * relative to the build output directory.
+     * Path to the POT files generated when building the project, relative to
+     * the build output directory. Should contain the placeholder `$NAMESPACE`
+     * if the project contains translation strings in different i18next
+     * namespaces.
      *
      * @example
      * {
-     *   potFile: "i18n/main.pot",
+     *   potFile: "i18n/$NAMESPACE.pot",
      *   // ...
      * }
      */
     potFile: string;
     /**
-     * The project name to be inserted into the `.pot` file under the key
-     * "Project-Id-Version".
+     * The project name to be inserted into the POT files under the key
+     * "Project-Id-Version". May contain the placeholder `$NAMESPACE`.
      */
     projectName: string;
 }

package/dist/index.js

@@ -18,7 +18,7 @@ export const PROJECT_NAME = "@open-xchange/vite-plugin-i18next-gettext";
 export default function vitePluginI18nextGettext(options) {
     return {
         name: PROJECT_NAME,
-        // register esbuild loader for `.po` files (load as plain text)
+        // register esbuild loader for PO files (load as plain text)
         config: () => ({
             optimizeDeps: {
                 esbuildOptions: {
@@ -26,23 +26,32 @@ export default function vitePluginI18nextGettext(options) {
                 },
             },
         }),
-        // convert `.po` files to i18next JSON v4
+        // convert PO files to i18next JSON v4
         async load(id) {
             const relPath = relative(process.cwd(), id).replaceAll(sep, posix.sep);
             if (!pm.isMatch(relPath, options.poFiles)) {
                 return;
             }
-            // read the `.po` file and convert it to i18next JSON
+            // read the PO file and convert it to i18next JSON
             const data = await readFile(id, { encoding: "utf8" });
             const json = converter.po2i18next(data, { compatibilityJSON: "v4" });
             // generate a module that exports a _stringified_ JSON object
             const code = `export default ${JSON.stringify(json)};`;
             return { code, map: { mappings: "" } };
         },
-        // parse source files and create a `.pot` file
+        // parse source files and create POT files per namespace
         async generateBundle() {
-            const source = await parse({ project: options.projectName, files: options.srcFiles });
-            this.emitFile({ type: "asset", fileName: options.potFile, source });
+            // parse all source files, extract translations, collect into POT catalogs
+            const catalogs = await parse({ project: options.projectName, files: options.srcFiles });
+            // warn when writing multiple POT files to same file location
+            if ((catalogs.size > 1) && !options.potFile.includes("$NAMESPACE")) {
+                this.warn("multiple POT files written to same file location (missing placeholder '$NAMESPACE' in option 'potFile')");
+            }
+            // add all POT files as assets to the bundle
+            for (const [namespace, source] of catalogs) {
+                const fileName = options.potFile.replaceAll("$NAMESPACE", namespace);
+                this.emitFile({ type: "asset", fileName, source });
+            }
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-i18next-gettext",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Vite integration of i18next using gettext",
   "repository": {
     "type": "git",
@@ -25,7 +25,7 @@
     "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
   },
   "dependencies": {
-    "@open-xchange/i18next-po-parser": "^0.0.1",
+    "@open-xchange/i18next-po-parser": "^0.0.2",
     "gettext-converter": "^1.3.0",
     "picomatch": "^4.0.2"
   },