nuxt-typed-router 1.2.3 → 1.2.5

package/README.md

@@ -58,7 +58,7 @@ First, register the module in the `nuxt.config.ts`
 
 ```ts
 export default defineNuxtConfig({
-  buildModules: ['nuxt-typed-router'],
+  modules: ['nuxt-typed-router'],
   nuxtTypedRouter: {
     // options
   },

package/dist/module.d.ts

@@ -9,8 +9,11 @@ interface ModuleOptions {
      * @default "routerPagesNames"
      * */
     routesObjectName?: string;
-    /** @deprecated */
-    stripAtFromName?: boolean;
+    /**
+     * Set to false if you don't want a plugin generated
+     * @default true
+     */
+    plugin?: boolean;
 }
 
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "1.2.3"
+  "version": "1.2.5"
 }

package/dist/module.mjs

@@ -96,13 +96,17 @@ const routeParamExtractRegxp = /:(\w+)/;
 function extractRouteParamsFromPath(path, previousParams) {
   const params = path.match(routeParamExtractRegxp) ?? [];
   params?.shift();
-  let allMergedParams = params.map((m) => ({
-    key: m,
-    type: "string | number",
-    required: true
-  }));
+  let allMergedParams = params.map(
+    (m) => ({
+      key: m,
+      type: "string | number",
+      required: true
+    })
+  );
   if (previousParams?.length) {
-    allMergedParams = allMergedParams.concat(previousParams.map((m) => ({ ...m, required: false })));
+    allMergedParams = allMergedParams.concat(
+      previousParams.map((m) => ({ ...m, required: false }))
+    );
   }
   return allMergedParams;
 }
@@ -165,15 +169,17 @@ function walkThoughRoutes({
     output.routesObjectTemplate += `${nameKey}:{`;
     output.routesDeclTemplate += `"${nameKey}":{`;
     const allRouteParams = extractRouteParamsFromPath(route.path, previousParams);
-    childrenChunks?.map((routeConfig, index) => walkThoughRoutes({
-      route: routeConfig,
-      level: level + 1,
-      siblings: extractUnMatchingSiblings(route, siblings),
-      parentName: nameKey,
-      previousParams: allRouteParams,
-      output,
-      isLast: isItemLast(childrenChunks, index)
-    }));
+    childrenChunks?.map(
+      (routeConfig, index) => walkThoughRoutes({
+        route: routeConfig,
+        level: level + 1,
+        siblings: extractUnMatchingSiblings(route, siblings),
+        parentName: nameKey,
+        previousParams: allRouteParams,
+        output,
+        isLast: isItemLast(childrenChunks, index)
+      })
+    );
     output.routesObjectTemplate += "},";
     output.routesDeclTemplate += `}${isLast ? "" : ","}`;
   } else if (route.name) {
@@ -226,7 +232,7 @@ const staticDeclarations = `
     TypedLocationAsRelativeRaw<T> &
     RouteLocationOptions;
   
-  export interface TypedRouter {
+  interface _TypedRouter {
     /**
      * Remove an existing route by its name.
      *
@@ -273,19 +279,10 @@ const staticDeclarations = `
       to: TypedRouteLocationRaw<T>
     ): Promise<NavigationFailure | void | undefined>;
   }
-  
-  declare module 'nuxt/dist/app/nuxt' {
-    export interface NuxtApp {
-      $typedRouter: TypedRouter;
-      $routesList: RouteListDecl;
-    }
-  }
 
-  declare module '@vue/runtime-core' {
-    interface ComponentCustomProperties {
-      $typedRouter: TypedRouter;
-      $routesList: RouteListDecl;
-    }
+  export interface TypedRouter extends _TypedRouter {}
+  declare global {
+    export interface TypedRouter extends _TypedRouter {}
   }
   `;
 
@@ -294,12 +291,13 @@ function createRuntimePluginFile(routesDeclTemplate) {
   ${signatureTemplate}
   import { defineNuxtPlugin } from '#app';
 
-  export default defineNuxtPlugin((nuxtApp) => {
+  export default defineNuxtPlugin(() => {
+    const router = useRouter();
     const routesList = ${routesDeclTemplate};
 
     return {
       provide: {
-        typedRouter: nuxtApp.$router,
+        typedRouter: router as TypedRouter,
         routesList,
       },
     };
@@ -379,31 +377,62 @@ function createTypedRouteListExport(routesList) {
 }
 function createTypedRouteParamsExport(routesParams) {
   return `export type TypedRouteParams = {
-    ${routesParams.map(({ name, params }) => `"${name}": ${params.length ? `{
+    ${routesParams.map(
+    ({ name, params }) => `"${name}": ${params.length ? `{
           ${params.map(({ key, required, type }) => `"${key}"${required ? "" : "?"}: ${type}`).join(",\n")}
-        }` : "never"}`).join(",\n")}
+        }` : "never"}`
+  ).join(",\n")}
   }`;
 }
 
-function routeHook(outDir, routesObjectName, srcDir, nuxt) {
+function routeHook({ outDir, plugin, routesObjectName }, srcDir, nuxt) {
   try {
     extendPages(async (routes) => {
       if (routes.length) {
         const { routesDeclTemplate, routesList, routesObjectTemplate, routesParams } = constructRouteMap(routes);
-        const pluginName = "__typed-router.ts";
-        nuxt.hook("build:done", async () => {
-          const pluginFolder = `${srcDir}/plugins`;
-          await saveRouteFiles(pluginFolder, srcDir, pluginName, createRuntimePluginFile(routesDeclTemplate));
-        });
+        if (plugin) {
+          const pluginName = "__typed-router.ts";
+          nuxt.hook("build:done", async () => {
+            const pluginFolder = `${srcDir}/plugins`;
+            await saveRouteFiles(
+              pluginFolder,
+              srcDir,
+              pluginName,
+              createRuntimePluginFile(routesDeclTemplate)
+            );
+          });
+        }
         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,
+            "__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"))}`));
+        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"))}`
+          )
+        );
       }
     });
   } catch (e) {
@@ -423,9 +452,8 @@ const module = defineNuxtModule({
   },
   setup(moduleOptions, nuxt) {
     const srcDir = nuxt.options.srcDir;
-    const { outDir, routesObjectName } = moduleOptions;
-    nuxt.hook("pages:extend", () => routeHook(outDir, routesObjectName, srcDir, nuxt));
-    routeHook(outDir, routesObjectName, srcDir, nuxt);
+    const { plugin = true, ...otherOptions } = moduleOptions;
+    nuxt.hook("pages:extend", () => routeHook({ ...otherOptions, plugin }, srcDir, nuxt));
   }
 });
 

package/dist/types.d.ts

@@ -7,4 +7,4 @@ declare module '@nuxt/schema' {
 }
 
 
-export { default } from './module'
+export { ModuleOptions, default } from './module'

package/package.json

@@ -1,30 +1,29 @@
 {
   "name": "nuxt-typed-router",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
-  "scripts": {
-    "play": "nuxi dev playground",
-    "play:build": "nuxi build playground",
-    "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 prepack && yarn play:build",
-    "test": "yarn build:test && vitest run",
-    "test:watch": "yarn build:test && vitest"
-  },
+  "main": "./dist/module.cjs",
+  "types": "./main.d.ts",
   "exports": {
     ".": {
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
     }
   },
-  "main": "./dist/module.cjs",
-  "types": "./main.d.ts",
   "files": [
     "dist",
     "main.d.ts"
   ],
+  "scripts": {
+    "prepack": "nuxt-module-build",
+    "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"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -51,28 +50,28 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.0.0-rc.9",
-    "chalk": "^4.1.2",
+    "@nuxt/kit": "3.0.0",
+    "chalk": "^5.2.0",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
     "mkdirp": "^1.0.4",
-    "pathe": "^0.2.0",
-    "prettier": "^2.7.1"
+    "pathe": "1.0.0",
+    "prettier": "2.8.1"
   },
   "devDependencies": {
-    "@nuxt/module-builder": "latest",
+    "@nuxt/module-builder": "^0.2.1",
     "@nuxt/types": "^2.15.8",
-    "@nuxtjs/eslint-config-typescript": "latest",
+    "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@types/lodash-es": "^4.17.6",
     "@types/mkdirp": "^1.0.2",
     "@types/node": "^17.0.23",
-    "@types/prettier": "^2.7.0",
+    "@types/prettier": "^2.7.2",
     "cross-env": "^7.0.3",
-    "eslint": "8.23.0",
+    "eslint": "8.30.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"
+    "nuxt": "3.0.0",
+    "typescript": "^4.9.4",
+    "vitest": "^0.26.1",
+    "vue-router": "^4.1.6"
   }
 }