hacknug · Nov 10, 2026 · Nov 10, 2026
diff --git a/.nuxtrc b/.nuxtrc
@@ -1 +1 @@
-setups.@nuxt/test-utils="4.1.0"
+setups.@nuxt/test-utils="4.2.0"
diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -8,19 +8,28 @@ import { defu } from 'defu'
 import { compodium } from '@compodium/core'
 import type { PluginOptions } from '@compodium/core'
 
-export type ModuleOptions = Omit<PluginOptions, 'mainPath' | 'componentDirs' | 'rootDir' | '_nuxt' | '_rootDirs' | 'baseUrl' | 'tsconfigPath'>
+export type ModuleOptions = Omit<PluginOptions, 'mainPath' | 'componentDirs' | 'rootDir' | '_nuxt' | '_rootDirs' | 'baseUrl' | 'tsconfigPath'> & {
+  /**
+   * Enable the module
+   * @default true
+   */
+  enabled: boolean
+}
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: '@compodium/nuxt',
     configKey: 'compodium'
   },
   defaults: {
+    enabled: true,
     dir: 'compodium/',
     includeLibraryCollections: true
   },
 
   async setup(options, nuxt) {
+    if (!options.enabled) return
+
     const { resolve, resolvePath: resolveModulePath } = createResolver(import.meta.url)
 
     const coreTypesEntry = await resolveModulePath('@compodium/core')

diff --git a/packages/nuxt/test/disabled.nuxt.test.ts b/packages/nuxt/test/disabled.nuxt.test.ts
@@ -0,0 +1,31 @@
+import { dirname } from 'pathe'
+import { describe, it, expect } from 'vitest'
+import { setup, $fetch, fetch, url } from '@nuxt/test-utils/e2e'
+import { fileURLToPath } from 'node:url'
+import { joinURL } from 'ufo'
+
+describe('disabled module', async () => {
+  const rootDir = fileURLToPath(joinURL(dirname(import.meta.url), './fixtures/disabled'))
+
+  await setup({
+    rootDir,
+    dev: true,
+    setupTimeout: 30000
+  })
+
+  it('renders the app', async () => {
+    const html = await $fetch('/')
+    expect(html).toContain('<div>disabled</div>')
+  })
+
+  it('does not mount the renderer', async () => {
+    const response = await fetch(url('/__compodium__/renderer'))
+    expect(await response.text()).not.toContain('compodium-default-preview')
+  })
+
+  it('does not install the API', async () => {
+    const response = await fetch(url('/__compodium__/api/collections'))
+    expect(response.headers.get('content-type')).toContain('text/html')
+    expect(await response.text()).not.toContain('pascalName')
+  })
+})
diff --git a/packages/nuxt/test/fixtures/disabled/app/app.vue b/packages/nuxt/test/fixtures/disabled/app/app.vue
@@ -0,0 +1,3 @@
+<template>
+  <div>disabled</div>
+</template>
diff --git a/packages/nuxt/test/fixtures/disabled/nuxt.config.ts b/packages/nuxt/test/fixtures/disabled/nuxt.config.ts
@@ -0,0 +1,6 @@
+export default defineNuxtConfig({
+  modules: ['../../../src/module'],
+  compodium: {
+    enabled: false
+  }
+})
diff --git a/packages/nuxt/test/fixtures/disabled/package.json b/packages/nuxt/test/fixtures/disabled/package.json
@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "name": "disabled",
+  "type": "module"
+}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		setups.@nuxt/test-utils="4.1.0"
		setups.@nuxt/test-utils="4.2.0"