fix(config): make module defaults overridable by vuetify:registerModule hooks & layers (#290) (#375)

* refactor(config): extract finalizeConfiguration with MODULE_DEFAULTS as lowest priority (#290)

* fix(config): drop Nuxt defaults() so module defaults are overridable by hooks/layers (#290)

* fix(config): drop dead disableVuetifyStyles default, add layer + deep-merge tests (#290)

Author: AndreyYolkin

packages/vuetify-nuxt-module/src/module.ts

@@ -92,24 +92,6 @@ export default defineNuxtModule<ModuleOptions>({
     },
     version,
   },
-  /**
-   * Default configuration options of the Nuxt module
-   */
-  defaults: () => ({
-    vuetifyOptions: {
-      labComponents: false,
-      directives: false,
-    },
-    moduleOptions: {
-      importComposables: true,
-      includeTransformAssetsUrls: true,
-      styles: true,
-      disableVuetifyStyles: false,
-      rulesConfiguration: {
-        fromLabs: true,
-      },
-    },
-  }),
   /**
    * Sets up the Vuetify Nuxt module.
    *

packages/vuetify-nuxt-module/src/utils/layers.ts

@@ -3,6 +3,42 @@ import type { FontIconSet, IconFontName, InlineModuleOptions, VuetifyModuleOptio
 import defu from 'defu'
 import { loadVuetifyConfiguration } from './config'
 
+/**
+ * Module defaults — applied as the LOWEST-priority `defu` argument so that
+ * `vuetify:registerModule` hooks and layers can override them, while the app's
+ * explicit `nuxt.config` values (the defu base) still win (#290).
+ */
+export const MODULE_DEFAULTS: InlineModuleOptions = {
+  moduleOptions: {
+    importComposables: true,
+    includeTransformAssetsUrls: true,
+    styles: true,
+    rulesConfiguration: {
+      fromLabs: true,
+    },
+  },
+  vuetifyOptions: {
+    labComponents: false,
+    directives: false,
+  },
+}
+
+/**
+ * Merge collected configuration entries — `[app, ...hooks, ...layers]` — applying
+ * MODULE_DEFAULTS last. `app` is the defu base (#231); ordering is not reversed (#218);
+ * icons `sets` are deduped across entries (#214/#217).
+ */
+export function finalizeConfiguration (moduleOptions: InlineModuleOptions[]): InlineModuleOptions {
+  if (moduleOptions.length > 1) {
+    const [app, ...rest] = moduleOptions
+    const configuration = <InlineModuleOptions>defu(app, ...rest, MODULE_DEFAULTS)
+    // dedupe icons sets: fix #214 and #217 — reverse so the last (app) wins
+    dedupeIcons(configuration, moduleOptions.toReversed())
+    return configuration
+  }
+  return <InlineModuleOptions>defu(moduleOptions[0] ?? {}, MODULE_DEFAULTS)
+}
+
 /**
  * Merges project layer with registered vuetify modules
  */
@@ -65,25 +101,9 @@ export async function mergeVuetifyModules (options: VuetifyModuleOptions, nuxt:
   //   for example, adding a layer with inlined vuetify options:
   //   nuxt will merge the conf for us (see issue #214 and #217)
   // - if the layer is configured using an external file, then we need to merge the configuration
-  if (moduleOptions.length > 1) {
-    const [app, ...rest] = moduleOptions
-    // we don't need to reverse (defu second arg are the defaults): fix #218
-    const configuration = <InlineModuleOptions>defu(app, ...rest)
-    // dedupe icons sets: fix #214 and #217
-    // we need to reverse the modules to override the icons from bottom to top layer
-    dedupeIcons(configuration, moduleOptions.toReversed())
-    return {
-      configuration,
-      vuetifyConfigurationFilesToWatch,
-    }
-  } else {
-    return {
-      configuration: {
-        moduleOptions: options.moduleOptions,
-        vuetifyOptions: resolvedOptions.config,
-      } satisfies InlineModuleOptions,
-      vuetifyConfigurationFilesToWatch,
-    }
+  return {
+    configuration: finalizeConfiguration(moduleOptions),
+    vuetifyConfigurationFilesToWatch,
   }
 }
 

packages/vuetify-nuxt-module/test/merge-modules.test.ts

@@ -0,0 +1,78 @@
+import type { InlineModuleOptions } from '../src/types'
+import { describe, expect, it } from 'vitest'
+import { finalizeConfiguration, MODULE_DEFAULTS } from '../src/utils/layers'
+
+const app = (o: Partial<InlineModuleOptions>): InlineModuleOptions => ({ moduleOptions: {}, vuetifyOptions: {}, ...o })
+
+describe('finalizeConfiguration', () => {
+  it('applies module defaults when nothing overrides them', () => {
+    const c = finalizeConfiguration([app({})])
+    expect(c.moduleOptions!.styles).toBe(true)
+    expect(c.moduleOptions!.importComposables).toBe(true)
+    expect(c.vuetifyOptions!.directives).toBe(false)
+    expect(c.vuetifyOptions!.labComponents).toBe(false)
+  })
+
+  it('lets a hook/layer override a defaulted moduleOptions field (#290)', () => {
+    const c = finalizeConfiguration([
+      app({ moduleOptions: {} }),
+      { moduleOptions: { styles: 'none' }, vuetifyOptions: {} },
+    ])
+    expect(c.moduleOptions!.styles).toBe('none')
+  })
+
+  it('keeps the app explicit value above hooks/layers (#231)', () => {
+    const c = finalizeConfiguration([
+      app({ moduleOptions: { styles: false } }),
+      { moduleOptions: { styles: 'none' }, vuetifyOptions: {} },
+    ])
+    expect(c.moduleOptions!.styles).toBe(false)
+  })
+
+  it('orders hooks above layers (existing push order)', () => {
+    const c = finalizeConfiguration([
+      app({ moduleOptions: {} }),
+      { moduleOptions: { styles: 'none' }, vuetifyOptions: {} },
+      { moduleOptions: { styles: false }, vuetifyOptions: {} },
+    ])
+    expect(c.moduleOptions!.styles).toBe('none')
+  })
+
+  it('lets a hook override a defaulted vuetifyOptions field', () => {
+    const c = finalizeConfiguration([
+      app({ vuetifyOptions: {} }),
+      { moduleOptions: {}, vuetifyOptions: { directives: true } },
+    ])
+    expect(c.vuetifyOptions!.directives).toBe(true)
+  })
+
+  it('dedupes icons sets across entries (#214/#217)', () => {
+    const c = finalizeConfiguration([
+      app({ vuetifyOptions: { icons: { defaultSet: 'mdi', sets: [{ name: 'mdi' }] } } as any }),
+      { moduleOptions: {}, vuetifyOptions: { icons: { sets: [{ name: 'fa' }] } } as any },
+    ])
+    const names = (c.vuetifyOptions!.icons!.sets as Array<{ name: string }>).map(s => s.name).toSorted()
+    expect(names).toEqual(['fa', 'mdi'])
+  })
+
+  it('MODULE_DEFAULTS does not leak icons (dedupe only sees app+rest)', () => {
+    expect((MODULE_DEFAULTS.vuetifyOptions as any)?.icons).toBeUndefined()
+  })
+
+  it('lets a layer (not just a hook) override a defaulted moduleOptions field (#290)', () => {
+    const c = finalizeConfiguration([
+      app({ moduleOptions: {} }), // app — no explicit styles
+      { moduleOptions: {}, vuetifyOptions: {} }, // hook — no styles
+      { moduleOptions: { styles: 'none' }, vuetifyOptions: {} }, // layer — overrides default
+    ])
+    expect(c.moduleOptions!.styles).toBe('none')
+  })
+
+  it('deep-merges rulesConfiguration: a hook provides configFile, default fills fromLabs (#290)', () => {
+    const c = finalizeConfiguration([
+      app({ moduleOptions: {} }),
+      { moduleOptions: { rulesConfiguration: { configFile: 'my-rules.ts' } }, vuetifyOptions: {} },
+    ])
+    expect(c.moduleOptions!.rulesConfiguration).toEqual({ configFile: 'my-rules.ts', fromLabs: true })
+  })
+})