@open-xchange/vite-plugin-i18next-gettext 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.2] - 2024-07-26
+
+- fix: match po files against relative module path
+- docs: mention `i18next-plugin-pofile-backend` package
+- chore: remove old license headers
+- chore: bump deps
+
 ## [0.0.1] - 2024-07-26
 
 - initial release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OX Software 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

@@ -8,6 +8,8 @@ This plugin has the following responsibilities:
 - When building the project, `.po` files will be converted to and written as i18next-compatible JSON files into the bundle.
 - When building the project, the source code will be scanned for translation strings (`t` function calls), and a `.pot` file containing all strings will be generated into the output directory.
 
+This plugin is designed to work together with the i18next plugin `@open-xchange/i18next-plugin-pofile-backend` that will load the `.po` files into the i18next instance.
+
 ## Usage
 
 ### Vite
@@ -45,48 +47,3 @@ export default defineConfig(() => {
 | `srcFiles` | `string\|string[]` | _required_ | Glob pattern(s) for all source files to be scanned for UI strings. |
 | `potFile` | `string` | _required_ | Path to the `.pot` file to be generated when building the project, relative to the build output directory. |
 | `projectName` | `string` | _required_ | The project name to be inserted into the `.pot` file under the key "Project-Id-Version". |
-
-### Source Code
-
-Import the `.po` files directly when setting up i18next, for example:
-
-```ts
-// src/@types/globals.d.ts
-
-declare module "*.po" {
-  import { ResourceKey } from "i18next"
-  const resource: ResourceKey
-  export default resource
-}
-```
-
-```ts
-// src/hooks/useTranslation.ts
-
-import i18next from "i18next"
-import type { BackendModule, ReadCallback } from "i18next"
-
-class POFileBackend implements BackendModule {
-
-  // type needs to be provided statically (expected by i18next runtime), and as instance prop (for typings only)
-  static readonly type = "backend"
-  readonly type = "backend"
-
-  init(): void {
-    // nothing to do
-  }
-
-  async read(lang: string, _ns: string, cb: ReadCallback): Promise<void> {
-    try {
-      const module = await import(`./i18n/${lang}.po`) as typeof import("*.po")
-      cb(null, module.default)
-    } catch (error) {
-      cb(error as Error, null)
-    }
-  }
-}
-
-i18next.use(POFileBackend)
-
-export default useTranslation
-```

package/dist/index.js

@@ -1,9 +1,4 @@
-/*
-* Copyright (C) Open-Xchange GmbH, Germany <info@open-xchange.com>
-*
-* This program is proprietary software and licensed to you under Open-Xchange
-* GmbH's Software License Agreement.
-*/
+import { sep, relative, posix } from "node:path";
 import { readFile } from "node:fs/promises";
 import pm from "picomatch";
 import converter from "gettext-converter";
@@ -34,7 +29,8 @@ export default function vitePluginI18nextGettext(options) {
         }),
         // convert `.po` files to i18next JSON v4
         async load(id) {
-            if (!pm.isMatch(id, options.poFiles)) {
+            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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/vite-plugin-i18next-gettext",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "Vite integration of i18next using gettext",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/vite-plugin-i18next-gettext"
@@ -21,8 +21,14 @@
     "lint-staged": {
         "*.{js,ts,json}": "yarn lint"
     },
+    "dependencies": {
+        "gettext-converter": "1.3.0",
+        "i18next-parser": "9.0.0",
+        "picomatch": "4.0.2",
+        "vinyl-fs": "4.0.0"
+    },
     "devDependencies": {
-        "@open-xchange/linter-presets": "0.1.9",
+        "@open-xchange/linter-presets": "0.1.10",
         "@types/node": "20.14.12",
         "@types/vinyl-fs": "3.0.5",
         "eslint": "9.7.0",
@@ -36,11 +42,5 @@
     },
     "resolutions": {
         "semver": "^7.6.2"
-    },
-    "dependencies": {
-        "gettext-converter": "1.3.0",
-        "i18next-parser": "9.0.0",
-        "picomatch": "4.0.2",
-        "vinyl-fs": "4.0.0"
     }
 }