nuxt-typed-router 1.1.1 → 1.2.1

package/README.md

@@ -1,4 +1,4 @@
-# 🚗🚦 Typed Router for Nuxt 3
+# 🚗🚦 Typed Router for Nuxt
 
 [npm-version-src]: https://img.shields.io/npm/v/nuxt-typed-router.svg
 [npm-version-href]: https://www.npmjs.com/package/nuxt-typed-router
@@ -11,7 +11,7 @@
 [![npm downloads][npm-total-downloads-src]][npm-downloads-href]
 <img src='https://img.shields.io/npm/l/simple-graphql-to-typescript.svg'>
 
-> Provide a type safe router to Nuxt 3 with auto-generated typed definitions for route names and autocompletion for route params
+> Provide a type safe router to Nuxt with auto-generated typed definitions for route names and autocompletion for route params
 
 - 🏎 Provides a hook `useTypedRouter` that returns an alias of `$typedRouter` and also a typed list of your routes
 - 🚚 Expose a global method `$typedRouter` (clone of vue-router), but typed with the routes defined in `pages` directory
@@ -21,6 +21,11 @@
 
 Demo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
 
+## Compatibility:
+
+- Nuxt 3
+- Nuxt 2 (via [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2))
+
 <br/>
 <p align="center">
   <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/medias/in-action.gif?raw=true"/>
@@ -83,7 +88,7 @@ interface ModuleOptions {
 The module will generate 4 files each time you modify the `pages` folder :
 
 - `~/<outDir>/__routes.ts` with the global object of the route names inside.
-- `~/<outDir>/__useTypedRouter.ts` Composable tu simply access your typed routes
+- `~/<outDir>/__useTypedRouter.ts` Composable to simply access your typed routes
 - `~/<outDir>/typed-router.d.ts` containing the global typecript definitions and exports
 - `~/plugins/__typed_router.ts` Plugin that will inject `$typedRouter` and `$routesList` (`@nuxt/kit` has problems registering plugin templates so this is a workaround)
 

package/dist/module.json

@@ -2,8 +2,8 @@
   "name": "nuxt-typed-router",
   "configKey": "nuxtTypedRouter",
   "compatibility": {
-    "nuxt": "^3.0.0",
+    "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "1.1.1"
+  "version": "1.2.1"
 }

package/dist/module.mjs

@@ -274,7 +274,7 @@ const staticDeclarations = `
     ): Promise<NavigationFailure | void | undefined>;
   }
   
-  declare module 'nuxt3/dist/app/nuxt' {
+  declare module 'nuxt/dist/app/nuxt' {
     export interface NuxtApp {
       $typedRouter: TypedRouter;
       $routesList: RouteListDecl;
@@ -415,11 +415,15 @@ const module = defineNuxtModule({
   meta: {
     name: "nuxt-typed-router",
     configKey: "nuxtTypedRouter",
-    compatibility: { nuxt: "^3.0.0", bridge: false }
+    compatibility: { nuxt: "^3.0.0-rc.1", bridge: false }
+  },
+  defaults: {
+    outDir: `./generated`,
+    routesObjectName: "routerPagesNames"
   },
   setup(moduleOptions, nuxt) {
     const srcDir = nuxt.options.srcDir;
-    const { outDir = `./generated`, routesObjectName = "routerPagesNames" } = moduleOptions;
+    const { outDir, routesObjectName } = moduleOptions;
     nuxt.hook("pages:extend", () => routeHook(outDir, routesObjectName, srcDir, nuxt));
     routeHook(outDir, routesObjectName, srcDir, nuxt);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "scripts": {
@@ -51,28 +51,28 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "npm:@nuxt/kit-edge@latest",
+    "@nuxt/kit": "^3.0.0-rc.9",
     "chalk": "^4.1.2",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
     "mkdirp": "^1.0.4",
     "pathe": "^0.2.0",
-    "prettier": "^2.5.1"
+    "prettier": "^2.7.1"
   },
   "devDependencies": {
     "@nuxt/module-builder": "latest",
     "@nuxt/types": "^2.15.8",
     "@nuxtjs/eslint-config-typescript": "latest",
-    "@types/lodash-es": "^4.14.178",
+    "@types/lodash-es": "^4.17.6",
     "@types/mkdirp": "^1.0.2",
-    "@types/node": "^16.11.12",
-    "@types/prettier": "^2.4.3",
+    "@types/node": "^17.0.23",
+    "@types/prettier": "^2.7.0",
     "cross-env": "^7.0.3",
-    "eslint": "8.8.0",
-    "eslint-config-prettier": "^8.3.0",
-    "nuxt3": "latest",
-    "typescript": "^4.5.1",
-    "vitest": "^0.2.5",
-    "vue-router": "^4.0.12"
+    "eslint": "8.23.0",
+    "eslint-config-prettier": "^8.5.0",
+    "nuxt": "^3.0.0-rc.9",
+    "typescript": "^4.6.3",
+    "vitest": "^0.22.1",
+    "vue-router": "^4.1.5"
   }
 }