模块依赖

使用版本约束和配置合并声明对其他模块的依赖。

如果你的模块依赖于其他模块，你可以使用 moduleDependencies 选项来声明它们。Nuxt 随后会确保这些模块按正确顺序安装，验证你提供的任何版本约束，并合并你为它们提供的配置。

基本用法

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

const resolver = createResolver(import.meta.url)

export default defineNuxtModule<ModuleOptions>({
  meta: {
    name: 'my-module',
  },
  moduleDependencies: {
    '@nuxtjs/tailwindcss': {
      // 你可以为该模块指定版本约束
      version: '>=6',
      // 任何应覆盖 `nuxt.options` 的配置
      overrides: {
        exposeConfig: true,
      },
      // 任何应被设置的配置。它会覆盖模块默认值，但
      // 不会覆盖 `nuxt.options` 中设置的任何配置
      defaults: {
        config: {
          darkMode: 'class',
          content: {
            files: [
              resolver.resolve('./runtime/components/**/*.{vue,mjs,ts}'),
              resolver.resolve('./runtime/*.{mjs,js,ts}'),
            ],
          },
        },
      },
    },
  },
  setup (options, nuxt) {
    // 我们可以注入包含 Tailwind 指令的 CSS 文件
    nuxt.options.css.push(resolver.resolve('./runtime/assets/styles.css'))
  },
})
moduleDependencies 选项替代了已弃用的 installModule 函数。

每个条目的键用于标识要依赖的模块。你可以使用 npm 包名、本地模块目录的路径，或者像 ~ 或 @ 这样的 Nuxt 别名。

依赖本地模块

当依赖位于 modules/ 目录 内时，请使用文件路径来声明该依赖：

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  moduleDependencies: {
    // 相对于项目根目录的路径
    './modules/my-local-module': {},
    // 或者使用 Nuxt 别名
    '~/modules/another-local-module': {},
  },
  // ...
})
相对路径是从你项目的 rootDir 解析的，而不是从声明依赖的文件所在位置解析。位于 modules/foo.ts 的模块引用 modules/bar.ts 时必须使用 './modules/bar'，而不是 './bar'。使用像 ~/modules/bar 这样的 Nuxt 别名可以避免这种歧义。

选项

moduleDependencies 中的每个条目都接受以下字段：

  • version: 一个 semver 范围。如果解析后的模块版本不满足该范围，Nuxt 会抛出错误。版本检查仅在依赖能够解析为 package.json 时生效，因此对于项目本地模块而言它们不会起作用。
  • overrides: 应用于 nuxt.options 之上的配置，优先级高于用户配置。
  • defaults: 应用于 nuxt.options 之下的配置。用户配置优先于这些配置。
  • optional: 如果为 true，当模块缺失时不会自动安装该模块。如果该模块已在其他地方安装，overrides 和 defaults 仍然会应用。