astro-react-i18next 0.2.0 → 0.3.1

package/README.md

@@ -48,6 +48,7 @@ The initialization function accepts an optional configuration object with the fo
 | `prefixDefaultLocale` | `boolean`                                      | Whether to prefix the default locale with the locale code.                         | `false`      |
 | `localesDir`          | `string`                                       | The directory where the locale files are stored, relative to the public directory. | `"locales"`  |
 | `domains`             | `{ domain: string; defaultLocale: string; }[]` | An array of domains for language selection.                                        | `[]`         |
+| `reservedRoutes`      | `string[]`                                     | An array of routes excluded from locale handling.                                  | `["/api"]`   |
 
 Here is an example of how to configure the integration:
 
@@ -63,8 +64,6 @@ export default defineConfig({
 +   reactI18next({
 +     defaultLocale: "en-US",
 +     locales: ["en-US", "fr-FR", "zh-TW"],
-+     defaultNamespace: "app",
-+     namespaces: ["app"],
 +   }),
   ],
 });
@@ -84,8 +83,6 @@ export default defineConfig({
     reactI18next({
       defaultLocale: "en-US",
       locales: ["en-US", "fr-FR", "zh-TW"],
-      defaultNamespace: "app",
-      namespaces: ["app"],
     }),
   ],
 + output: "server",
@@ -190,12 +187,12 @@ The integration provides utility functions to help manage locales and translatio
 
 All utility functions are available in the `astro-react-i18next/utils` module.
 
-| Function                                           | Description                                              | Returns                                                                                                                              |
-| -------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| `getLocaleConfig()`                                | Returns the locale configuration object.                 | `{ defaultLocale: string; locales: string[]; prefixDefaultLocale: boolean; domains: { domain: string; defaultLocale: string; }[]; }` |
-| `getLocalizedPathname(pathname = "", locale = "")` | Returns the localized pathname for the specified locale. | `string`                                                                                                                             |
-| `buildStaticPaths()`                               | Generates static paths for each locale.                  | `{ params: { locale: string \| undefined; }; }[]`                                                                                    |
-| `changeLocale(nextLocale = "", shallow = true)`    | Changes the current locale.                              |                                                                                                                                      |
+| Function                                           | Description                                              | Returns                                                                                                                                                        |
+| -------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `getLocaleConfig()`                                | Returns the locale configuration object.                 | `{ defaultLocale: string; locales: string[]; prefixDefaultLocale: boolean; domains: { domain: string; defaultLocale: string; }[]; reservedRoutes: string[]; }` |
+| `getLocalizedPathname(pathname = "", locale = "")` | Returns the localized pathname for the specified locale. | `string`                                                                                                                                                       |
+| `buildStaticPaths()`                               | Generates static paths for each locale.                  | `{ params: { locale: string \| undefined; }; }[]`                                                                                                              |
+| `changeLocale(nextLocale = "", shallow = true)`    | Changes the current locale.                              |                                                                                                                                                                |
 
 ## Developing locally
 

package/dist/index.d.ts

@@ -10,13 +10,14 @@ interface AstroReactI18nextOptions {
         domain: string;
         defaultLocale: string;
     }[];
+    reservedRoutes?: string[];
 }
 type MergedAstroReactI18nextOptions = {
     [key in keyof AstroReactI18nextOptions]-?: AstroReactI18nextOptions[key];
 };
 declare module "i18next" {
     interface InitOptions {
-        astroReactI18next: MergedAstroReactI18nextOptions;
+        astroReactI18next: Pick<MergedAstroReactI18nextOptions, "defaultLocale" | "locales" | "prefixDefaultLocale" | "domains" | "reservedRoutes">;
     }
 }
 export default function AstroReactI18nextIntegration(options?: AstroReactI18nextOptions): AstroIntegration;

package/dist/index.js

@@ -8,7 +8,8 @@ var DEFAULT_OPTIONS = {
   namespaces: ["common"],
   prefixDefaultLocale: false,
   localesDir: "locales",
-  domains: []
+  domains: [],
+  reservedRoutes: ["/api"]
 };
 function buildI18nextInitScript({
   backendType,
@@ -63,7 +64,13 @@ function buildI18nextInitScript({
         backend: {
           loadPath: "${path.join(basePath, mergedOptions.localesDir || "")}/{{lng}}/{{ns}}.json",
         },
-        astroReactI18next: ${JSON.stringify(mergedOptions)},
+        astroReactI18next: ${JSON.stringify({
+    defaultLocale: mergedOptions.defaultLocale,
+    locales: mergedOptions.locales,
+    prefixDefaultLocale: mergedOptions.prefixDefaultLocale,
+    domains: mergedOptions.domains,
+    reservedRoutes: mergedOptions.reservedRoutes
+  })},
         ${i18nextOptions}
       });
   `;
@@ -73,7 +80,20 @@ function buildLocaleRestorationScript(mergedOptions) {
     window.addEventListener("DOMContentLoaded", () => {
       const defaultLocale = "${mergedOptions.defaultLocale}";
       const locales = ${JSON.stringify(mergedOptions.locales)};
-      let detectedLocale = window.location.pathname.split("/")[1];
+      const reservedRoutes = ${JSON.stringify(mergedOptions.reservedRoutes)};
+      const pathname = window.location.pathname;
+
+      if (
+        reservedRoutes.some(
+          (route) =>
+            pathname === route ||
+            pathname.startsWith(route + "/"),
+        )
+      ) {
+        return;
+      }
+
+      let detectedLocale = pathname.split("/")[1];
 
       if (!locales.includes(detectedLocale)) {
         detectedLocale = defaultLocale;

package/dist/middleware-server.js

@@ -4,13 +4,9 @@ import i18n2 from "i18next";
 // src/utils.ts
 import i18n from "i18next";
 function getLocaleConfig() {
-  const { defaultLocale, locales, prefixDefaultLocale, domains } = i18n.options.astroReactI18next;
-  return {
-    defaultLocale,
-    locales,
-    prefixDefaultLocale,
-    domains
-  };
+  return JSON.parse(
+    JSON.stringify(i18n.options.astroReactI18next)
+  );
 }
 function getLocalizedPathname(pathname = "", locale = "") {
   const { defaultLocale, locales, prefixDefaultLocale } = getLocaleConfig();
@@ -26,8 +22,14 @@ function getLocalizedPathname(pathname = "", locale = "") {
 }
 
 // src/middleware-server.ts
+var ASTRO_RESERVED_ROUTES = ["/_astro", "/_actions", "/_server-islands"];
 async function onRequest(context, next) {
-  const { defaultLocale, locales, domains } = getLocaleConfig();
+  const { defaultLocale, locales, domains, reservedRoutes } = getLocaleConfig();
+  if ([...ASTRO_RESERVED_ROUTES, ...reservedRoutes].some(
+    (route) => context.url.pathname === route || context.url.pathname.startsWith(route + "/")
+  )) {
+    return next();
+  }
   const localesByDomain = Object.fromEntries(
     domains.map((domain) => [domain.domain, domain.defaultLocale])
   );

package/dist/middleware-static.js

@@ -4,13 +4,9 @@ import i18n2 from "i18next";
 // src/utils.ts
 import i18n from "i18next";
 function getLocaleConfig() {
-  const { defaultLocale, locales, prefixDefaultLocale, domains } = i18n.options.astroReactI18next;
-  return {
-    defaultLocale,
-    locales,
-    prefixDefaultLocale,
-    domains
-  };
+  return JSON.parse(
+    JSON.stringify(i18n.options.astroReactI18next)
+  );
 }
 
 // src/middleware-static.ts

package/dist/utils.d.ts

@@ -1,12 +1,5 @@
-export declare function getLocaleConfig(): {
-    defaultLocale: string;
-    locales: string[];
-    prefixDefaultLocale: boolean;
-    domains: {
-        domain: string;
-        defaultLocale: string;
-    }[];
-};
+import i18n from "i18next";
+export declare function getLocaleConfig(): typeof i18n.options.astroReactI18next;
 export declare function getLocalizedPathname(pathname?: string, locale?: string): string;
 export declare function buildStaticPaths(): {
     params: {

package/dist/utils.js

@@ -1,13 +1,9 @@
 // src/utils.ts
 import i18n from "i18next";
 function getLocaleConfig() {
-  const { defaultLocale, locales, prefixDefaultLocale, domains } = i18n.options.astroReactI18next;
-  return {
-    defaultLocale,
-    locales,
-    prefixDefaultLocale,
-    domains
-  };
+  return JSON.parse(
+    JSON.stringify(i18n.options.astroReactI18next)
+  );
 }
 function getLocalizedPathname(pathname = "", locale = "") {
   const { defaultLocale, locales, prefixDefaultLocale } = getLocaleConfig();

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "astro-react-i18next",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Integrates i18next and react-i18next seamlessly into your Astro website to provide robust i18n support for React components.",
   "keywords": [
     "astro-integration",
     "withastro",
+    "seo",
+    "l10n",
     "i18n",
     "i18next",
-    "react"
+    "react",
+    "localization",
+    "internationalization"
   ],
   "author": "jeremyxgo",
   "license": "MIT",
@@ -32,30 +36,38 @@
     "build": "node ./build.js && tsc",
     "prepare": "husky"
   },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,mjs,astro,json,md}": "prettier --write",
+    "*.{js,jsx,ts,tsx,mjs,astro}": "eslint --fix --max-warnings 0"
+  },
   "dependencies": {
-    "i18next": "^24.0.2",
-    "i18next-browser-languagedetector": "^8.0.0",
+    "i18next": "^24.2.2",
+    "i18next-browser-languagedetector": "^8.0.4",
     "i18next-fs-backend": "^2.6.0",
-    "i18next-http-backend": "^3.0.1",
-    "react-i18next": "^15.1.2"
+    "i18next-http-backend": "^3.0.2",
+    "react-i18next": "^15.4.1"
   },
   "devDependencies": {
-    "@types/node": "^22.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "@typescript-eslint/parser": "^8.16.0",
-    "astro": "^4.16.16",
-    "astro-eslint-parser": "^1.1.0",
-    "esbuild": "^0.24.0",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.0",
+    "@eslint/js": "^9.22.0",
+    "@types/node": "^22.13.10",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "astro": "^5.4.2",
+    "esbuild": "^0.25.0",
+    "eslint": "^9.22.0",
+    "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-astro": "^1.3.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-perfectionist": "^4.10.0",
+    "eslint-plugin-react": "^7.37.4",
+    "globals": "^16.0.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.4.1",
+    "lint-staged": "^15.4.3",
+    "prettier": "^3.5.3",
     "prettier-plugin-astro": "^0.14.1",
-    "typescript": "^5.7.2"
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.0"
   },
   "engines": {
     "node": "^18.17.1 || ^20.3.0 || >=21.0.0"