Added plugin option

victorgarciaesgi · Dec 20, 2022 · 446f2da · 446f2da
1 parent f86720f
commit 446f2da
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 25 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -21,7 +21,7 @@
     "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 build:test && vitest run",
+    "test": "yarn dev:prepare && yarn build:test && vitest run",
     "test:watch": "yarn build:test && vitest"
   },
   "publishConfig": {

diff --git a/src/generators/nuxtHook.ts b/src/generators/nuxtHook.ts
@@ -3,6 +3,7 @@ import { Nuxt } from '@nuxt/schema/dist/index';
 import { NuxtRouteConfig } from '@nuxt/types/config/router';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
+import { ModuleOptions } from '../types';
 import { saveRouteFiles } from '../utils';
 import { constructRouteMap } from './main.generator';
 import {
@@ -13,31 +14,37 @@ import {
   createRuntimeRoutesFile,
 } from './output.generator';
 
-export function routeHook(outDir: string, routesObjectName: string, srcDir: string, nuxt: Nuxt) {
+export function routeHook(
+  { outDir, plugin, routesObjectName }: ModuleOptions,
+  srcDir: string,
+  nuxt: Nuxt
+) {
   try {
     extendPages(async (routes: NuxtRouteConfig[]) => {
       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);
+        if (plugin) {
+          const pluginName = '__typed-router.ts';
+          // const runtimeDir = resolve(
+          //   __dirname,
+          //   process.env.NUXT_BUILD_TYPE === 'stub' ? '../../dist/runtime' : './runtime'
+          // );
+          // const pluginPath = resolve(runtimeDir, pluginName);
 
-        // `addPlugin` not working, workaround with creating plugin in user srcDir `plugins` folder
+          // `addPlugin` not working, workaround with creating plugin in user srcDir `plugins` folder
 
-        nuxt.hook('build:done', async () => {
-          const pluginFolder = `${srcDir}/plugins`;
-          await saveRouteFiles(
-            pluginFolder,
-            srcDir,
-            pluginName,
-            createRuntimePluginFile(routesDeclTemplate)
-          );
-        });
+          nuxt.hook('build:done', async () => {
+            const pluginFolder = `${srcDir}/plugins`;
+            await saveRouteFiles(
+              pluginFolder,
+              srcDir,
+              pluginName,
+              createRuntimePluginFile(routesDeclTemplate)
+            );
+          });
+        }
 
         await Promise.all([
           saveRouteFiles(

diff --git a/src/module.ts b/src/module.ts
@@ -1,4 +1,5 @@
 import { defineNuxtModule } from '@nuxt/kit';
+import { Nuxt } from '@nuxt/schema';
 import { routeHook } from './generators/nuxtHook';
 import type { ModuleOptions } from './types';
 
@@ -14,11 +15,10 @@ export default defineNuxtModule<ModuleOptions>({
     outDir: `./generated`,
     routesObjectName: 'routerPagesNames',
   },
-  setup(moduleOptions, nuxt: any) {
+  setup(moduleOptions, nuxt: Nuxt) {
     const srcDir = nuxt.options.srcDir;
-    const { outDir, routesObjectName } = moduleOptions;
+    const { plugin = true, ...otherOptions } = moduleOptions;
 
-    nuxt.hook('pages:extend', () => routeHook(outDir!, routesObjectName!, srcDir, nuxt));
-    routeHook(outDir!, routesObjectName!, srcDir, nuxt);
+    nuxt.hook('pages:extend', () => routeHook({ ...otherOptions, plugin }, srcDir, nuxt));
   },
 });
diff --git a/src/types/config.types.ts b/src/types/config.types.ts
@@ -7,6 +7,9 @@ export interface ModuleOptions {
    * @default "routerPagesNames"
    * */
   routesObjectName?: string;
-  /** @deprecated */
-  stripAtFromName?: boolean;
+  /**
+   * Set to false if you don't want a plugin generated
+   * @default true
+   */
+  plugin?: boolean;
 }