nuxt-typed-router 2.1.0-beta.4 → 2.1.1

package/README.md

@@ -18,11 +18,11 @@
 
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route names and autocompletion for route params
 
-- Provides types check and autocomplete to `NuxtLink`
-  - Provides types check for `useRouter` and `useRoute` 
-  - Supports routes defined in `config.extendRoutes`
-  - Supports optional params and catchAll routes
-  - Infer route params based on route name
+- `NuxtLink` route autocomplete and params type-check 
+- `useRouter` and `useRoute`  route autocomplete and params type-check
+- Supports optional params and catchAll routes
+- Infer route params based on route name
+- Supports routes defined in `config.extendRoutes`
 
 <br/>
 
@@ -59,6 +59,8 @@ Demo repo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nu
 yarn add -D nuxt-typed-router
 # or
 npm install -D nuxt-typed-router
+# or
+pnpm install -D nuxt-typed-router
 ```
 
 ### Nuxt 2 legacy
@@ -86,8 +88,8 @@ export default defineNuxtConfig({
 
 1. Clone this repository
 2. Install dependencies using `pnpm`
-3. Build project for local tests `pnpm build:local`
-4. Start dev playground `pnpm play`
+3. Build project for local tests `pnpm run test`
+4. Start dev playground `pnpm run prepack && pnpm run dev`
 5. Build project for deploy `pnpm prepack`
 
 ## 📑 License

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.1.0-beta.4"
+  "version": "2.1.1"
 }

package/dist/module.mjs

@@ -214,7 +214,9 @@ function createTypedRouteParamsExport(routesParams) {
   return `export type TypedRouteParams = {
     ${routesParams.map(
     ({ name, params }) => `"${name}": ${params.length ? `{
-          ${params.map(({ key, required }) => `"${key}"${required ? "" : "?"}: string | number`).join(",\n")}
+                ${params.map(
+      ({ key, required, catchAll }) => `"${key}"${required ? "" : "?"}: (string | number)${catchAll ? "[]" : ""}`
+    ).join(",\n")}
         }` : "never"}`
   ).join(",\n")}
   }`;
@@ -327,7 +329,7 @@ function createRuntimeUseTypedRouterFile(routesDeclTemplate) {
    * @exemple
    * 
    * \`\`\`ts
-   * const { router, routes } = useRouter();
+   * const router = useRouter();
    * \`\`\`
    */
   export function useRouter(): TypedRouter {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.1.0-beta.4",
+  "version": "2.1.1",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -20,10 +20,11 @@
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
-    "build:test": "cross-env NUXT_BUILD_TYPE=stub yarn prepack && yarn dev:build",
-    "test": "yarn dev:prepare && yarn build:test && vitest run",
-    "test:watch": "yarn build:test && vitest",
-    "docs:dev": "cd docs && yarn dev",
+    "build:test": "cross-env NUXT_BUILD_TYPE=stub pnpm run prepack && pnpm run dev:build",
+    "test:fixtures": "nuxt-module-build --stub && nuxi prepare test/fixtures/simple && vitest run --dir test",
+    "test:types": "nuxi prepare test/fixtures/simple && cd test/fixtures/simple && vue-tsc --noEmit",
+    "test": "pnpm run dev:prepare && pnpm run test:fixtures && pnpm run test:types",
+    "docs:dev": "cd docs && pnpm run dev",
     "docs:build": "npm run dev:prepare && cd docs && nuxi generate"
   },
   "publishConfig": {
@@ -77,6 +78,7 @@
     "nuxt": "3.0.0",
     "typescript": "^4.9.4",
     "vitest": "^0.27.2",
-    "vue-router": "^4.1.6"
+    "vue-router": "^4.1.6",
+    "vue-tsc": "^1.0.24"
   }
 }