Declare Nuxt module meta

Run this rule

pnpm nuxt doctor --rules nuxt/module/require-meta

Why it matters

@nuxt/kit identifies a module by meta.name: it installs the module only once and hasNuxtModule() looks it up by name. meta.configKey is the nuxt.config key that holds the module options and falls back to meta.name, so a scoped package name makes options awkward to set. meta.compatibility lets @nuxt/kit check the installed Nuxt version before setup and disable the module with a clear message. Doctor only asks for configKey when the module accepts options and meta.name is not already a usable key.

Recommended fix

Declare meta.name with the package name, a camelCase meta.configKey, and meta.compatibility with the supported Nuxt range.

Useful links

• Rule reference

Example

Declare module meta

Before

export default defineNuxtModule({
  setup(options, nuxt) { /* ... */ },
})

After

export default defineNuxtModule<ModuleOptions>({
  meta: { name: '@acme/nuxt-analytics', configKey: 'analytics', compatibility: { nuxt: '>=4.0.0' } },
  defaults: { enabled: true },
  setup(options, nuxt) { /* ... */ },
})