feat(config): add option to enable disable the module.

Author: sadjow

playground/nuxt.config.ts

@@ -5,6 +5,8 @@ export default defineNuxtConfig({
     },
   },
   modules: ["../src/module"],
-  utm: {},
+  utm: {
+    enabled: true,
+  },
   devtools: { enabled: true },
 });

src/module.ts

@@ -1,19 +1,23 @@
 import { defineNuxtModule, addPlugin, createResolver } from "@nuxt/kit";
 
-// Module options TypeScript interface definition
-export interface ModuleOptions {}
+export interface ModuleOptions {
+  enabled: boolean;
+}
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: "utm",
     configKey: "utm",
   },
-  // Default configuration options of the Nuxt module
-  defaults: {},
-  setup() {
+  defaults: {
+    enabled: true,
+  },
+  setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
 
-    // Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
-    addPlugin(resolver.resolve("./runtime/plugin"));
+    if (options.enabled) {
+      // Do not add the extension since the `.ts` will be transpiled to `.mjs` after `npm run prepack`
+      addPlugin(resolver.resolve("./runtime/plugin"));
+    }
   },
 });