@open-xchange/vite-plugin-i18next-gettext 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.4.0` – 2026-Mar-13
+
+- added: support for Vite 8
+
 ## `1.3.1` – 2025-Sep-29
 
 - chore: bump dependencies
@@ -31,7 +35,7 @@
 
 ## `1.0.3` – 2025-May-05
 
-- chore: use "@open-xchange/i18next-po-parser" to generate POT file
+- chore: use '@open-xchange/i18next-po-parser' to generate POT file
 
 ## `1.0.2` – 2025-Feb-24
 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
+
+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

@@ -17,8 +17,8 @@ Add the plugin to your Vite configuration:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import i18nextPlugin from "@open-xchange/vite-plugin-i18next-gettext"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import i18nextPlugin from '@open-xchange/vite-plugin-i18next-gettext'
 
 export default defineConfig(() => {
 
@@ -28,10 +28,10 @@ export default defineConfig(() => {
     // ...
 
     i18nextPlugin({
-      poFiles: "i18n/*.po",
-      srcFiles: "src/**/*.{js,jsx,ts,tsx}",
-      potFile: "dist/[NAMESPACE].pot",
-      projectName: "My Project",
+      poFiles: 'i18n/*.po',
+      srcFiles: 'src/**/*.{js,jsx,ts,tsx}',
+      potFile: 'dist/[NAMESPACE].pot',
+      projectName: 'My Project',
     }),
   ],
 })
@@ -44,4 +44,4 @@ export default defineConfig(() => {
 | `poFiles` | `string\|string[]` | _required_ | Glob pattern(s) for all PO files containing the translations. |
 | `srcFiles` | `string\|string[]` | _required_ | Glob pattern(s) for all source files to be scanned for UI strings. |
 | `potFile` | `string` | _required_ | Path to the POT files to be 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. |
-| `projectName` | `string` | _required_ | The project name to be inserted into the POT file under the key "Project-Id-Version". May contain the placeholder `[NAMESPACE]` |
+| `projectName` | `string` | _required_ | The project name to be inserted into the POT file under the key 'Project-Id-Version'. May contain the placeholder `[NAMESPACE]` |

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import type { Plugin } from "vite";
+import { type Plugin } from 'vite';
 /**
- * Configuration options for the plugin "@open-xchange/vite-plugin-i18next-gettext".
+ * Configuration options for the plugin '@open-xchange/vite-plugin-i18next-gettext'.
  */
 export interface VitePluginI18nextGettextOptions {
     /**
@@ -8,7 +8,7 @@ export interface VitePluginI18nextGettextOptions {
      *
      * @example
      * {
-     *   poFiles: "i18n/*.po",
+     *   poFiles: 'i18n/*.po',
      *   // ...
      * }
      */
@@ -18,27 +18,26 @@ export interface VitePluginI18nextGettextOptions {
      *
      * @example
      * {
-     *   srcFiles: "src/*.{js,ts}",
+     *   srcFiles: 'src/*.{js,ts}',
      *   // ...
      * }
      */
     srcFiles: string | string[];
     /**
-     * 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.
+     * 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/[NAMESPACE].pot",
+     *   potFile: 'i18n/[NAMESPACE].pot',
      *   // ...
      * }
      */
     potFile: string;
     /**
      * The project name to be inserted into the POT files under the key
-     * "Project-Id-Version". May contain the placeholder `[NAMESPACE]`.
+     * 'Project-Id-Version'. May contain the placeholder `[NAMESPACE]`.
      */
     projectName: string;
 }

package/dist/index.js

@@ -1,10 +1,12 @@
-import { sep, relative, posix } from "node:path";
-import { readFile } from "node:fs/promises";
-import pm from "picomatch";
-import converter from "gettext-converter";
-import { parseSourceFiles } from "@open-xchange/i18next-po-parser";
+import { sep, relative, posix } from 'node:path';
+import { readFile } from 'node:fs/promises';
+import { version } from 'vite';
+import pm from 'picomatch';
+import converter from 'gettext-converter';
+import { parseSourceFiles } from '@open-xchange/i18next-po-parser';
 // constants ==================================================================
-export const PROJECT_NAME = "@open-xchange/vite-plugin-i18next-gettext";
+export const PROJECT_NAME = '@open-xchange/vite-plugin-i18next-gettext';
+const VITE_VERSION = parseInt(version.split('.')[0], 10);
 // plugin =====================================================================
 /**
  * Vite plugin for using i18next with gettext `.po` files under the hood.
@@ -20,11 +22,9 @@ export default function vitePluginI18nextGettext(options) {
         name: PROJECT_NAME,
         // register esbuild loader for PO files (load as plain text)
         config: () => ({
-            optimizeDeps: {
-                esbuildOptions: {
-                    loader: { ".po": "text" },
-                },
-            },
+            optimizeDeps: (VITE_VERSION >= 8) ?
+                { rolldownOptions: { moduleTypes: { '.po': 'text' } } } :
+                { esbuildOptions: { loader: { '.po': 'text' } } },
         }),
         // convert PO files to i18next JSON v4
         async load(id) {
@@ -33,24 +33,24 @@ export default function vitePluginI18nextGettext(options) {
                 return;
             }
             // read the PO file and convert it to i18next JSON
-            const data = await readFile(id, { encoding: "utf8" });
-            const json = converter.po2i18next(data, { compatibilityJSON: "v4" });
+            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: "" } };
+            const code = `export default ${JSON.stringify(json)}`;
+            return { code, map: { mappings: '' } };
         },
         // parse source files and create POT files per namespace
         async generateBundle() {
             // parse all source files, extract translations, collect into POT catalogs
             const catalogs = await parseSourceFiles({ 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')");
+            if ((catalogs.size > 1) && !options.potFile.includes('[NAMESPACE]')) {
+                this.error('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 });
+                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.3.1",
+  "version": "1.4.0",
   "description": "Vite integration of i18next using gettext",
   "repository": {
     "type": "git",
@@ -11,34 +11,36 @@
   "engines": {
     "node": ">=20.18"
   },
-  "packageManager": "yarn@4.10.3",
   "type": "module",
   "exports": "./dist/index.js",
   "files": [
     "dist",
     "CHANGELOG.*"
   ],
-  "scripts": {
-    "prepack": "yarn build && yarn lint",
-    "clean": "premove dist",
-    "build": "yarn clean && tsc --project src/tsconfig.json",
-    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
-  },
   "dependencies": {
-    "@open-xchange/i18next-po-parser": "^1.2.1",
-    "gettext-converter": "^1.3.0",
+    "@open-xchange/i18next-po-parser": "^1.2.3",
+    "gettext-converter": "^1.3.1",
     "picomatch": "^4.0.3"
   },
   "devDependencies": {
-    "@open-xchange/linter-presets": "^1.9.6",
-    "@types/node": "^24.5.2",
-    "eslint": "^9.36.0",
-    "jiti": "^2.6.0",
-    "premove": "^4.0.0",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.7"
+    "@types/picomatch": "^4.0.2",
+    "@vitest/coverage-v8": "^4.1.0",
+    "vite": "^8.0.0",
+    "vite-v6": "npm:vite@^6.4.1",
+    "vite-v7": "npm:vite@^7.3.1",
+    "vite-v8": "npm:vite@^8.0.0",
+    "vitest": "^4.1.0",
+    "@open-xchange/vitest-vite-plugin-utils": "^0.0.1",
+    "@open-xchange/linter-presets": "^1.18.4"
   },
   "peerDependencies": {
-    "vite": "^6.0.0 || ^7.0.0"
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsc --project src/tsconfig.json",
+    "clean": "premove dist",
+    "coverage": "vitest run --coverage",
+    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint .",
+    "test": "vitest run"
   }
 }