nuxt-typed-router 3.0.1 → 3.0.3

package/README.md

@@ -89,10 +89,10 @@ export default defineNuxtConfig({
 
 # Roadmap
 
-- [ ] Add `path` autocomplete with TS string templates
-- [ ] Enforce strong params typing depending of origin route
-- [ ] Add support for `validate` in `definePageMeta`
+- [x] Add `path` autocomplete with TS string templates
+- [x] Add support for `validate` and `redirect` in `definePageMeta`
 - [x] Add `strict` option to prevent path navigation
+- [ ] Enforce strong params typing depending of origin route
 
 
 ## Development

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.0.1"
+  "version": "3.0.3"
 }

package/dist/module.mjs

@@ -20,6 +20,7 @@ class ModuleOptionsStore {
     this.rootDir = "";
     this.i18n = false;
     this.i18nOptions = null;
+    this.i18nLocales = [];
   }
   updateOptions(options) {
     if (options.plugin != null)
@@ -32,10 +33,21 @@ class ModuleOptionsStore {
       this.rootDir = options.rootDir;
     if (options.i18n != null)
       this.i18n = options.i18n;
-    if (options.i18nOptions != null)
+    if (options.i18nOptions != null) {
       this.i18nOptions = options.i18nOptions;
-    if (options.experimentalPathCheck != null)
+      if (options.i18nOptions.locales) {
+        this.i18nLocales = options.i18nOptions.locales.map((l) => {
+          if (typeof l === "string") {
+            return l;
+          } else {
+            return l.code;
+          }
+        });
+      }
+    }
+    if (options.experimentalPathCheck != null) {
       this.experimentalPathCheck = options.experimentalPathCheck;
+    }
   }
   getResolvedStrictOptions() {
     let resolved;
@@ -785,7 +797,7 @@ function createTypeUtilsRuntimeFile() {
 
 function createi18nRouterFile() {
   const { router } = moduleOptionStore.getResolvedStrictOptions();
-  const { i18nOptions, experimentalPathCheck } = moduleOptionStore;
+  const { i18nOptions, experimentalPathCheck, i18nLocales } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -798,7 +810,7 @@ function createi18nRouterFile() {
       `import type {TypedLocalePathParameter, RouteNameFromLocalePath} from './__paths';`
     )}
 
-  export type I18nLocales = ${i18nOptions?.locales?.length ? i18nOptions.locales.map((loc) => `"${loc}"`).join("|") : "string"};
+  export type I18nLocales = ${i18nLocales?.length ? i18nLocales.map((loc) => `"${loc}"`).join("|") : "string"};
 
   export interface TypedToLocalePath {
     <T extends RoutesNamesList, P extends string>(
@@ -1395,6 +1407,42 @@ function extractChunkMain(chunkName) {
   return chunkArray?.join("/");
 }
 
+function hasi18nSibling(source, route) {
+  const { i18n, i18nOptions, i18nLocales } = moduleOptionStore;
+  if (i18n && i18nOptions?.strategy !== "no_prefix") {
+    const separator = i18nOptions?.routesNameSeparator ?? "___";
+    return source.some((rt) => {
+      return route.name?.match(new RegExp(`^(${rt.name})${separator}[a-zA-Z]+`, "g")) || rt.path !== "/" && route.path?.match(new RegExp(`/?[${i18nLocales?.join("|")}]${rt.path}`, "g"));
+    });
+  }
+  return false;
+}
+function modifyRoutePrefixDefaultIfI18n(route) {
+  const { i18n, i18nOptions } = moduleOptionStore;
+  if (i18n && route.name) {
+    const separator = i18nOptions?.routesNameSeparator ?? "___";
+    if (i18nOptions?.strategy === "prefix_and_default") {
+      const routeDefaultRegXp = new RegExp(
+        `([a-zA-Z-]+)${separator}[a-zA-Z]+${separator}default`,
+        "g"
+      );
+      const match = routeDefaultRegXp.exec(route.name);
+      if (match) {
+        const [_, routeName] = match;
+        route.name = routeName;
+      }
+    } else if (i18nOptions?.strategy === "prefix_except_default") {
+      const defaultLocale = i18nOptions.defaultLocale;
+      const routeDefaultNameRegXp = new RegExp(`^([a-zA-Z-]+)${separator}${defaultLocale}`, "g");
+      const match = routeDefaultNameRegXp.exec(route.name);
+      if (match) {
+        const [_, routeName] = match;
+        route.name = routeName;
+      }
+    }
+  }
+}
+
 function createKeyedName(route, parent) {
   const splittedPaths = route.path.split("/");
   const parentPath = splittedPaths[splittedPaths.length - 1];
@@ -1414,31 +1462,6 @@ function createNameKeyFromFullName(route, level, parentName) {
   const keyName = route.path === "" ? "index" : camelCase(splitted.join("-")) || "index";
   return keyName;
 }
-function hasi18nSibling(source, route) {
-  const { i18n, i18nOptions } = moduleOptionStore;
-  if (i18n) {
-    const separator = i18nOptions?.routesNameSeparator ?? "___";
-    return source.some((rt) => {
-      return route.name?.match(new RegExp(`^(${rt.name})${separator}[a-zA-Z]+`, "g")) || rt.path !== "/" && route.path?.match(new RegExp(`/?[a-zA-Z]+${rt.path}`, "g"));
-    });
-  }
-  return false;
-}
-function modifyRoutePrefixDefaultIfI18n(route) {
-  const { i18n, i18nOptions } = moduleOptionStore;
-  if (i18n && route.name && i18nOptions?.strategy === "prefix_and_default") {
-    const separator = i18nOptions?.routesNameSeparator ?? "___";
-    const routeDefaultRegXp = new RegExp(
-      `([a-zA-Z-]+)${separator}[a-zA-Z]+${separator}default`,
-      "g"
-    );
-    const match = routeDefaultRegXp.exec(route.name);
-    if (match) {
-      const [_, routeName] = match;
-      route.name = routeName;
-    }
-  }
-}
 function walkThoughRoutes({
   route,
   level,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -19,6 +19,7 @@
     "prepack": "nuxt-module-build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
+    "prepare:playground": "nuxi prepare playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground && pnpm run test:prepare-fixtures",
     "build:test": "cross-env NUXT_BUILD_TYPE=stub pnpm run prepack && pnpm run dev:build",
     "test:prepare-fixtures": "nuxi prepare test/fixtures/simple && nuxi prepare test/fixtures/withOptions && nuxi prepare test/fixtures/complex",
@@ -30,7 +31,7 @@
     "docs:dev": "cd docs && pnpm run dev",
     "docs:build": "npm run dev:prepare && cd docs && nuxi generate",
     "typecheck": "tsc --noEmit",
-    "release": "pnpm test && standard-version && git push --follow-tags && npm publish"
+    "release": "bumpp && npm publish && git push --follow-tags"
   },
   "publishConfig": {
     "access": "public"
@@ -70,7 +71,7 @@
     "prettier": "2.8.4"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.1.6",
+    "@nuxt/devtools": "^0.2.4",
     "@nuxt/module-builder": "^0.2.1",
     "@nuxt/test-utils": "^3.2.2",
     "@nuxt/types": "^2.16.0",
@@ -84,16 +85,17 @@
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
     "@vue/test-utils": "^2.3.0",
+    "bumpp": "9.0.0",
+    "changelogithub": "0.12.7",
     "cross-env": "^7.0.3",
-    "eslint": "8.34.0",
+    "eslint": "8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-vue": "^9.9.0",
-    "nuxt": "3.2.2",
-    "playwright": "1.31.0",
-    "standard-version": "^9.5.0",
+    "nuxt": "3.2.3",
+    "playwright": "1.31.1",
     "tsd": "^0.25.0",
     "typescript": "^4.9.5",
-    "vitest": "^0.28.5",
+    "vitest": "^0.29.1",
     "vue-eslint-parser": "^9.1.0",
     "vue-router": "^4.1.6",
     "vue-tsc": "^1.1.7"