模块

源文件
Nuxt Kit 提供了一套工具，帮助您创建和使用模块。您可以使用这些工具来创建自己的模块或重用现有模块。

模块是 Nuxt 的基石。Kit 提供了一套工具，帮助您创建和使用模块。您可以使用这些工具来创建自己的模块或重用现有模块。例如，您可以使用 defineNuxtModule 函数来定义模块，并使用 moduleDependencies 选项指定依赖项。

defineNuxtModule

定义一个 Nuxt 模块，自动将默认值与用户提供的选项合并，安装所有提供的钩子，并调用可选的设置函数以实现完全控制。

使用

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  defaults: {
    enabled: true,
  },
  setup (options) {
    if (options.enabled) {
      console.log('My Nuxt module is enabled!')
    }
  },
})

类型

export function defineNuxtModule<TOptions extends ModuleOptions> (
  definition?: ModuleDefinition<TOptions, Partial<TOptions>, false> | NuxtModule<TOptions, Partial<TOptions>, false>,
): NuxtModule<TOptions, TOptions, false>

export function defineNuxtModule<TOptions extends ModuleOptions> (): {
  with: <TOptionsDefaults extends Partial<TOptions>> (
    definition: ModuleDefinition<TOptions, TOptionsDefaults, true> | NuxtModule<TOptions, TOptionsDefaults, true>
  ) => NuxtModule<TOptions, TOptionsDefaults, true>
}

参数

定义：一个模块定义对象或一个模块函数。模块定义对象应包含以下属性

属性类型必需描述
metaModuleMetafalse模块的元数据。它定义了模块名称、版本、配置键和兼容性。
defaultsT | ((nuxt: Nuxt) => T)false模块的默认选项。如果提供了一个函数，它将以 Nuxt 实例作为第一个参数被调用。
schemaTfalse模块选项的 Schema。如果提供，选项将应用于 Schema。
hooksPartial<NuxtHooks>false要为模块安装的钩子。如果提供，模块将安装钩子。
moduleDependenciesRecord<string, ModuleDependency> | ((nuxt: Nuxt) => Record<string, ModuleDependency>)false对其他模块的依赖，带有版本约束和配置。可以是一个对象或一个接收 Nuxt 实例的函数。参见示例。
onInstall(nuxt: Nuxt) => Awaitable<void>false模块首次安装时调用的生命周期钩子。需要定义 meta.name 和 meta.version。
onUpgrade(options: T, nuxt: Nuxt, previousVersion: string) => Awaitable<void>false模块升级到新版本时调用的生命周期钩子。需要定义 meta.name 和 meta.version。
setup(this: void, resolvedOptions: T, nuxt: Nuxt) => Awaitable<void | false | ModuleSetupInstallResult>false模块的设置函数。如果提供，模块将调用设置函数。

示例

使用 configKey 使您的模块可配置

定义 Nuxt 模块时，您可以设置 configKey 来指定用户应如何在他们的 nuxt.config 中配置模块。

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  defaults: {
    // Module options
    enabled: true,
  },
  setup (options) {
    if (options.enabled) {
      console.log('My Nuxt module is enabled!')
    }
  },
})

用户可以在 nuxt.config 中相应键下为该模块提供选项。

export default defineNuxtConfig({
  myModule: {
    enabled: false,
  },
})

定义模块兼容性要求

如果您正在开发 Nuxt 模块并使用仅在特定 Nuxt 版本中支持的 API，强烈建议包含 compatibility.nuxt。

export default defineNuxtModule({
  meta: {
    name: '@nuxt/icon',
    configKey: 'icon',
    compatibility: {
      // Required nuxt version in semver format.
      nuxt: '>=3.0.0', // or use '^3.0.0'
    },
  },
  setup () {
    const resolver = createResolver(import.meta.url)
    // Implement
  },
})

如果用户尝试使用不兼容 Nuxt 版本的模块，他们将在控制台中收到警告。

 WARN  Module @nuxt/icon is disabled due to incompatibility issues:
 - [nuxt] Nuxt version ^3.1.0 is required but currently using 3.0.0

使用 .with() 实现已解析选项的类型安全

当您需要为已解析/合并的模块选项提供类型安全时，可以使用 .with() 方法。这使得 TypeScript 能够正确推断模块默认值与设置函数接收到的最终已解析选项之间的关系。

import { defineNuxtModule } from '@nuxt/kit'

// Define your module options interface
interface ModuleOptions {
  apiKey: string
  baseURL: string
  timeout?: number
  retries?: number
}

export default defineNuxtModule<ModuleOptions>().with({
  meta: {
    name: '@nuxtjs/my-api',
    configKey: 'myApi',
  },
  defaults: {
    baseURL: 'https://api.example.com',
    timeout: 5000,
    retries: 3,
  },
  setup (resolvedOptions, nuxt) {
    // resolvedOptions is properly typed as:
    // {
    //   apiKey: string          // Required, no default provided
    //   baseURL: string         // Required, has default value
    //   timeout: number         // Optional, has default value
    //   retries: number         // Optional, has default value
    // }

    console.log(resolvedOptions.baseURL) // ✅ TypeScript knows this is always defined
    console.log(resolvedOptions.timeout) // ✅ TypeScript knows this is always defined
    console.log(resolvedOptions.retries) // ✅ TypeScript knows this is always defined
  },
})

如果不使用 .with()，则 resolvedOptions 参数的类型将为原始 ModuleOptions 接口，其中 timeout 和 retries 可能是 undefined，即使提供了默认值。.with() 方法使 TypeScript 能够理解默认值使这些属性在已解析选项中成为非可选的。

使用生命周期钩子进行模块安装和升级

您可以定义生命周期钩子，这些钩子在模块首次安装或升级到新版本时运行。这些钩子对于执行一次性设置任务、数据库迁移或清理操作非常有用。

要使生命周期钩子生效，您必须在模块定义中同时提供 meta.name 和 meta.version。钩子使用这些值来跟踪模块在项目的 .nuxtrc 文件中的安装状态。

生命周期钩子在主 setup 函数之前运行，如果钩子抛出错误，它会被记录但不会停止构建过程。

onInstall 仅在模块首次添加到项目时运行一次。

onUpgrade 每次模块版本增加时（使用 semver 比较）运行一次，但每个版本只运行一次。

示例
import { defineNuxtModule } from '@nuxt/kit'
import semver from 'semver'

export default defineNuxtModule({
  meta: {
    name: 'my-awesome-module',
    version: '1.2.0', // Required for lifecycle hooks
    configKey: 'myAwesomeModule',
  },
  defaults: {
    apiKey: '',
    enabled: true,
  },

  onInstall (nuxt) {
    // This runs only when the module is first installed
    console.log('Setting up my-awesome-module for the first time!')

    // You might want to:
    // - Create initial configuration files
    // - Set up database schemas
    // - Display welcome messages
    // - Perform initial data migration
  },

  onUpgrade (options, nuxt, previousVersion) {
    // This runs when the module is upgraded to a newer version
    console.log(`Upgrading my-awesome-module from ${previousVersion} to 1.2.0`)

    // You might want to:
    // - Migrate configuration files
    // - Update database schemas
    // - Clean up deprecated files
    // - Display upgrade notes

    if (semver.lt(previousVersion, '1.1.0')) {
      console.log('⚠️  Breaking changes in 1.1.0 - please check the migration guide')
    }
  },

  setup (options, nuxt) {
    // Regular setup logic runs on every build
    if (options.enabled) {
      // Configure the module
    }
  },
})

指定模块依赖项

您可以使用 moduleDependencies 选项来声明对其他模块的依赖。这提供了一种可靠的方式来确保正确的设置顺序、版本兼容性和配置管理。

moduleDependencies 选项可以是一个对象或一个接收 Nuxt 实例的函数

示例
import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
  },
  moduleDependencies: {
    '@nuxtjs/tailwindcss': {
      // Specify a version constraint (semver format)
      version: '>=6.0.0',
      // Configuration that overrides user settings
      overrides: {
        exposeConfig: true,
      },
      // Configuration that sets defaults but respects user settings
      defaults: {
        config: {
          darkMode: 'class',
        },
      },
    },
    '@nuxtjs/fontaine': {
      // Optional dependencies won't be installed but ensure that options
      // can be set if they _are_ installed
      optional: true,
      defaults: {
        fonts: [
          {
            family: 'Roboto',
            fallbacks: ['Impact'],
          },
        ],
      },
    },
  },
  setup (options, nuxt) {

  },
})

您还可以使用函数根据 Nuxt 配置动态确定依赖项

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
  },
  moduleDependencies (nuxt) {
    const dependencies: Record<string, any> = {
      '@nuxtjs/tailwindcss': {
        version: '>=6.0.0',
      },
    }

    // Conditionally add dependencies based on Nuxt config
    if (nuxt.options.experimental?.someFeature) {
      dependencies['@nuxtjs/fontaine'] = {
        optional: true,
      }
    }

    return dependencies
  },
  setup (options, nuxt) {
    // Your setup logic runs after all dependencies are initialized
  },
})

installModule

已弃用：请改用 defineNuxtModule 中的 moduleDependencies 选项。installModule 函数将在未来的版本中删除（或可能变为非阻塞）。

以编程方式安装指定的 Nuxt 模块。当您的模块依赖于其他模块时，这很有帮助。您可以将模块选项作为对象传递给 inlineOptions，它们将被传递给模块的 setup 函数。

使用

import { defineNuxtModule, installModule } from '@nuxt/kit'

export default defineNuxtModule({
  async setup () {
    // will install @nuxtjs/fontaine with Roboto font and Impact fallback
    await installModule('@nuxtjs/fontaine', {
      // module configuration
      fonts: [
        {
          family: 'Roboto',
          fallbacks: ['Impact'],
          fallbackName: 'fallback-a',
        },
      ],
    })
  },
})

类型

async function installModule (moduleToInstall: string | NuxtModule, inlineOptions?: any, nuxt?: Nuxt)

参数

属性类型必需描述
moduleToInstallstring | NuxtModuletrue要安装的模块。可以是带有模块名称的字符串，也可以是模块对象本身。
inlineOptionsanyfalse一个包含模块选项的对象，将传递给模块的 setup 函数。
nuxtNuxtfalseNuxt 实例。如果未提供，将通过 useNuxt() 调用从上下文中检索。

示例

import { defineNuxtModule, installModule } from '@nuxt/kit'

export default defineNuxtModule({
  async setup (options, nuxt) {
    // will install @nuxtjs/fontaine with Roboto font and Impact fallback
    await installModule('@nuxtjs/fontaine', {
      // module configuration
      fonts: [
        {
          family: 'Roboto',
          fallbacks: ['Impact'],
          fallbackName: 'fallback-a',
        },
      ],
    })
  },
})