nuxt-typed-router 1.0.5 → 1.1.1

package/README.md

@@ -18,6 +18,9 @@
 - 🚦 Provides auto-completion and errors for route params in `push` and `replace` methods
 
 <br/>
+
+Demo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
+
 <br/>
 <p align="center">
   <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/medias/in-action.gif?raw=true"/>
@@ -46,7 +49,7 @@ npm install -D nuxt-typed-router@legacy
 
 # Configuration
 
-First, register the module in the `nuxt.config.[js|ts]`
+First, register the module in the `nuxt.config.ts`
 
 ```ts
 import TypedRouter from 'nuxt-typed-router';
@@ -77,15 +80,15 @@ interface ModuleOptions {
 
 # Generated files
 
-The module will create 2 files:
+The module will generate 4 files each time you modify the `pages` folder :
 
-- `__routes.ts` with the global object of the route names inside.
-- `typed-router.d.ts` containing the global typecript definitions and exports
+- `~/<outDir>/__routes.ts` with the global object of the route names inside.
+- `~/<outDir>/__useTypedRouter.ts` Composable tu 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)
 
 # Usage in Vue/Nuxt
 
-## Check out this demo and clone it! [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
-
 <br/>
 
 ### **_Requirements_**
@@ -122,7 +125,7 @@ Given this structure
         │   └── login.vue
         └── ...
 
-The generated file will look like this
+The generated route list will look like this
 
 ```ts
 export const routerPagesNames = {
@@ -154,11 +157,12 @@ export type TypedRouteList =
 
 # Usage with `useTypedRouter` hook
 
-`useTypedRouter` is an exported composable from nuxt-typed-router. It contains a clone of `vue-router` but with stritly typed route names and params type-check
+`useTypedRouter` is an exported composable from nuxt-typed-router. It contains a clone of `vue-router` but with strictly typed route names and params type-check
 
 ```vue
 <script lang="ts">
-import { useTypedRouter } from 'nuxt-typed-router/hook';
+// The path here is `~/generated` because I set `outDir: './generated'` in my module options
+import { useTypedRouter } from '~/generated';
 
 export default defineComponent({
   setup() {
@@ -210,7 +214,7 @@ Exemple with `pinia` store here
 
 ```ts
 import pinia from 'pinia';
-import { useTypedRouter } from 'nuxt-typed-router/hook';
+import { useTypedRouter } from '~/generated';
 
 export const useFooStore = defineStore('foo', {
   actions: {

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "1.0.5"
+  "version": "1.1.1"
 }

package/dist/module.mjs

@@ -1,10 +1,10 @@
 import { extendPages, defineNuxtModule } from '@nuxt/kit';
-import { fileURLToPath } from 'url';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
-import { resolve, dirname } from 'pathe';
 import prettier from 'prettier';
 import fs from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'pathe';
 import mkdirp from 'mkdirp';
 import { camelCase } from 'lodash-es';
 
@@ -35,9 +35,11 @@ async function formatOutputWithPrettier(template) {
   }
 }
 
-async function saveRouteFiles(outDir, fileName, content) {
+dirname(fileURLToPath(import.meta.url));
+async function saveRouteFiles(outDir, srcDir, fileName, content) {
   try {
-    const outputFile = resolve(process.cwd(), `${outDir}/${fileName}`);
+    const processedOutDir = resolve(srcDir, outDir);
+    const outputFile = resolve(process.cwd(), `${processedOutDir}/${fileName}`);
     const formatedContent = await formatOutputWithPrettier(content);
     if (fs.existsSync(outputFile)) {
       await writeFile(outputFile, formatedContent);
@@ -128,14 +130,16 @@ function startGeneratorProcedure({
   output,
   routesConfig
 }) {
-  const rootSiblingsRoutes = routesConfig.map((route) => route.path);
-  routesConfig.forEach((route, index) => walkThoughRoutes({
-    route,
-    level: 0,
-    output,
-    siblings: rootSiblingsRoutes,
-    isLast: isItemLast(routesConfig, index)
-  }));
+  routesConfig.forEach((route, index) => {
+    const rootSiblingsRoutes = routesConfig.filter((rt) => rt.chunkName !== route.chunkName);
+    walkThoughRoutes({
+      route,
+      level: 0,
+      output,
+      siblings: rootSiblingsRoutes,
+      isLast: isItemLast(routesConfig, index)
+    });
+  });
   output.routesObjectTemplate += "}";
   output.routesDeclTemplate += "}";
 }
@@ -192,8 +196,12 @@ function walkThoughRoutes({
 }
 
 const signatureTemplate = `/** 
-  * Generated by nuxt-typed-router. Do not modify 
-  * */`;
+  * ---------------------
+  * \u{1F697}\u{1F6A6} Generated by nuxt-typed-router. Do not modify !
+  * ---------------------
+  * */
+ 
+`;
 const staticDeclImports = `
 import type {
   NavigationFailure,
@@ -203,15 +211,6 @@ import type {
   RouteQueryAndHash,
 } from 'vue-router';
 import type { TypedRouteList } from './__routes'
-
-// -- Unbuild CommonJS Shims --
-import __cjs_url__ from 'url';
-import __cjs_path__ from 'path';
-import __cjs_mod__ from 'module';
-const __filename = __cjs_url__.fileURLToPath(import.meta.url);
-const __dirname = __cjs_path__.dirname(__filename);
-const require = __cjs_mod__.createRequire(import.meta.url);
-
 `;
 const staticDeclarations = `
   type TypedRouteParamsStructure = {
@@ -227,7 +226,7 @@ const staticDeclarations = `
     TypedLocationAsRelativeRaw<T> &
     RouteLocationOptions;
   
-  interface TypedRouter {
+  export interface TypedRouter {
     /**
      * Remove an existing route by its name.
      *
@@ -288,18 +287,11 @@ const staticDeclarations = `
       $routesList: RouteListDecl;
     }
   }
-  declare module 'nuxt-typed-router/hook' {
-    declare const useTypedRouter: () => {
-      /** Export of $router with type check */
-      router: TypedRouter,
-      /** Contains a typed dictionnary of all your route names (for syntax sugar) */
-      routes: RouteListDecl
-    };
-  }
   `;
 
 function createRuntimePluginFile(routesDeclTemplate) {
   return `
+  ${signatureTemplate}
   import { defineNuxtPlugin } from '#app';
 
   export default defineNuxtPlugin((nuxtApp) => {
@@ -316,10 +308,24 @@ function createRuntimePluginFile(routesDeclTemplate) {
 }
 function createRuntimeHookFile(routesDeclTemplate) {
   return `
-  import { getCurrentInstance } from 'vue';
-  import { useNuxtApp } from 'nuxt3';
+  ${signatureTemplate}
+  import { useNuxtApp } from '#app';
+  import { TypedRouter, RouteListDecl } from './typed-router';
 
-  export const useTypedRouter = () => {
+  /** Returns instances of $typedRouter and $routesList fully typed to use in your components or your Vuex/Pinia store
+   * 
+   * @exemple
+   * 
+   * \`\`\`ts
+   * const { router, routes } = useTypedRouter();
+   * \`\`\`
+   */
+  export const useTypedRouter = (): {
+    /** Export of $router with type check */
+    router: TypedRouter,
+    /** Contains a typed dictionnary of all your route names (for syntax sugar) */
+    routes: RouteListDecl
+  } => {
     const { $router } = useNuxtApp();
 
     const routesList = ${routesDeclTemplate};
@@ -327,11 +333,18 @@ function createRuntimeHookFile(routesDeclTemplate) {
     return {
       router: $router,
       routes: routesList,
-    };
+    } as any;
   };
 
   `;
 }
+function createRuntimeIndexFile() {
+  return `
+  ${signatureTemplate}
+  export * from './__routes';
+  export * from './__useTypedRouter';
+  `;
+}
 function createRuntimeRoutesFile({
   routesList,
   routesObjectTemplate,
@@ -372,22 +385,22 @@ function createTypedRouteParamsExport(routesParams) {
   }`;
 }
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
 function routeHook(outDir, routesObjectName, srcDir, nuxt) {
   try {
     extendPages(async (routes) => {
       if (routes.length) {
         const { routesDeclTemplate, routesList, routesObjectTemplate, routesParams } = constructRouteMap(routes);
         const pluginName = "__typed-router.ts";
-        const runtimeDir = resolve(__dirname, process.env.NUXT_BUILD_TYPE === "stub" ? "../../dist/runtime" : "./runtime");
-        const pluginPath = resolve(runtimeDir, pluginName);
         nuxt.hook("build:done", async () => {
           const pluginFolder = `${srcDir}/plugins`;
-          await saveRouteFiles(pluginFolder, pluginName, createRuntimePluginFile(routesDeclTemplate));
+          await saveRouteFiles(pluginFolder, srcDir, pluginName, createRuntimePluginFile(routesDeclTemplate));
         });
-        await saveRouteFiles(runtimeDir, "useTypedRouter.mjs", createRuntimeHookFile(routesDeclTemplate));
-        await saveRouteFiles(outDir, `__routes.ts`, createRuntimeRoutesFile({ routesList, routesObjectTemplate, routesObjectName }));
-        await saveRouteFiles(outDir, `typed-router.d.ts`, createDeclarationRoutesFile({ routesDeclTemplate, routesList, routesParams }));
+        await Promise.all([
+          saveRouteFiles(outDir, srcDir, "__useTypedRouter.ts", createRuntimeHookFile(routesDeclTemplate)),
+          saveRouteFiles(outDir, srcDir, `__routes.ts`, createRuntimeRoutesFile({ routesList, routesObjectTemplate, routesObjectName })),
+          saveRouteFiles(outDir, srcDir, `typed-router.d.ts`, createDeclarationRoutesFile({ routesDeclTemplate, routesList, routesParams })),
+          saveRouteFiles(outDir, srcDir, "index.ts", createRuntimeIndexFile())
+        ]);
         console.log(logSymbols.success, `[typed-router] Routes definitions generated`);
       } else {
         console.log(logSymbols.warning, chalk.yellow(`[typed-router] No routes defined. Check if your ${chalk.underline(chalk.bold("pages"))} folder exists and remove ${chalk.underline(chalk.bold("app.vue"))}`));
@@ -404,13 +417,9 @@ const module = defineNuxtModule({
     configKey: "nuxtTypedRouter",
     compatibility: { nuxt: "^3.0.0", bridge: false }
   },
-  defaults: {
-    routesObjectName: "routerPagesNames",
-    stripAtFromName: false
-  },
   setup(moduleOptions, nuxt) {
     const srcDir = nuxt.options.srcDir;
-    const { outDir = `${srcDir}/generated`, routesObjectName } = moduleOptions;
+    const { outDir = `./generated`, routesObjectName = "routerPagesNames" } = 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.0.5",
+  "version": "1.1.1",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "scripts": {
@@ -9,26 +9,21 @@
     "prepack": "nuxt-module-build",
     "build:local": "nuxt-module-build --stub && cross-env NUXT_BUILD_TYPE=stub nuxi dev playground",
     "init:build": "nuxt-module-build --stub && nuxi prepare playground",
-    "build:test": "cross-env NUXT_BUILD_TYPE=stub yarn init:build && yarn prepack && yarn play:build",
-    "test": "yarn build:test && jest",
-    "test:reset": "yarn test --updateSnapshot"
+    "build:test": "cross-env NUXT_BUILD_TYPE=stub yarn prepack && yarn play:build",
+    "test": "yarn build:test && vitest run",
+    "test:watch": "yarn build:test && vitest"
   },
   "exports": {
     ".": {
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
-    },
-    "./hook": {
-      "import": "./hook.mjs"
     }
   },
   "main": "./dist/module.cjs",
   "types": "./main.d.ts",
   "files": [
     "dist",
-    "main.d.ts",
-    "hook.mjs",
-    "hook.d.ts"
+    "main.d.ts"
   ],
   "publishConfig": {
     "access": "public"
@@ -65,31 +60,19 @@
     "prettier": "^2.5.1"
   },
   "devDependencies": {
-    "@babel/plugin-transform-runtime": "^7.16.10",
-    "@babel/preset-env": "^7.16.11",
     "@nuxt/module-builder": "latest",
-    "@nuxt/test-utils": "^0.2.2",
     "@nuxt/types": "^2.15.8",
     "@nuxtjs/eslint-config-typescript": "latest",
-    "@types/jest": "^27.4.0",
-    "@types/lodash": "^4.14.178",
+    "@types/lodash-es": "^4.14.178",
     "@types/mkdirp": "^1.0.2",
     "@types/node": "^16.11.12",
     "@types/prettier": "^2.4.3",
-    "babel-jest": "^27.4.6",
-    "copyfiles": "^2.4.0",
-    "core-js": "^3.20.3",
     "cross-env": "^7.0.3",
     "eslint": "8.8.0",
     "eslint-config-prettier": "^8.3.0",
-    "jest": "^27.4.7",
     "nuxt3": "latest",
-    "path": "^0.12.7",
-    "playwright": "^1.18.1",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^27.1.3",
     "typescript": "^4.5.1",
-    "unbuild": "^0.6.9",
+    "vitest": "^0.2.5",
     "vue-router": "^4.0.12"
   }
 }

package/dist/runtime/typed-router.d.ts

@@ -1,12 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {};
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/typed-router.mjs

@@ -1,12 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {};
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/useTypedRouter.d.ts

@@ -1,13 +0,0 @@
-import { getCurrentInstance } from 'vue';
-import { useNuxtApp } from 'nuxt3';
-
-export const useTypedRouter = () => {
-  const { $router } = useNuxtApp();
-
-  const routesList = {};
-
-  return {
-    router: $router,
-    routes: routesList,
-  };
-};

package/dist/runtime/useTypedRouter.mjs

@@ -1,13 +0,0 @@
-import { getCurrentInstance } from 'vue';
-import { useNuxtApp } from 'nuxt3';
-
-export const useTypedRouter = () => {
-  const { $router } = useNuxtApp();
-
-  const routesList = {};
-
-  return {
-    router: $router,
-    routes: routesList,
-  };
-};

package/hook.d.ts

@@ -1,4 +0,0 @@
-/** @deprecated Do not import or use. Dummy export to fool Typescript into thinking it's a module */
-declare const doNotImportItsToFoolTypescript = 'foo';
-
-export { doNotImportItsToFoolTypescript };

package/hook.mjs

@@ -1 +0,0 @@
-export { useTypedRouter } from './dist/runtime/useTypedRouter.mjs';