构建器 · Nuxt Kit

Nuxt 基于 webpack 和 vite 拥有构建器。您可以使用 extendWebpackConfig 和 extendViteConfig 函数扩展传递给每个构建器的配置。您还可以通过 addVitePlugin、addWebpackPlugin 和 addBuildPlugin 添加其他插件。

`extendWebpackConfig`

扩展 webpack 配置。当应用于客户端和服务器构建时，可以多次调用回调函数。

类型

function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void

export interface ExtendWebpackConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

请查看 webpack 网站了解有关其配置的更多信息。

参数

`callback`

类型: (config: WebpackConfig) => void

必需: true

一个回调函数，该函数将使用 webpack 配置对象调用。

`options`

类型: ExtendWebpackConfigOptions

默认: {}

传递给回调函数的选项。此对象可以具有以下属性

dev（可选）
类型: boolean
默认: true
如果设置为 true，则在开发模式下构建时将调用回调函数。
build（可选）
类型: boolean
默认: true
如果设置为 true，则在生产模式下构建时将调用回调函数。
server（可选）
类型: boolean
默认: true
如果设置为 true，则在构建服务器包时将调用回调函数。
client（可选）
类型: boolean
默认: true
如果设置为 true，则在构建客户端包时将调用回调函数。
prepend（可选）
类型: boolean
如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

示例

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

export default defineNuxtModule({
  setup() {
    extendWebpackConfig((config) => {
      config.module?.rules.push({
        test: /\.txt$/,
        use: 'raw-loader'
      })
    })
  }
})

`extendViteConfig`

扩展 Vite 配置。当应用于客户端和服务器构建时，可以多次调用回调函数。

类型

function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void

export interface ExtendViteConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

请查看 Vite 网站了解有关其配置的更多信息。

参数

`callback`

类型: (config: ViteConfig) => void

必需: true

一个回调函数，该函数将使用 Vite 配置对象调用。

`options`

类型: ExtendViteConfigOptions

默认: {}

传递给回调函数的选项。此对象可以具有以下属性

dev（可选）
类型: boolean
默认: true
如果设置为 true，则在开发模式下构建时将调用回调函数。
build（可选）
类型: boolean
默认: true
如果设置为 true，则在生产模式下构建时将调用回调函数。
server（可选）
类型: boolean
默认: true
如果设置为 true，则在构建服务器包时将调用回调函数。
client（可选）
类型: boolean
默认: true
如果设置为 true，则在构建客户端包时将调用回调函数。
prepend（可选）
类型: boolean
如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

示例

// https://github.com/Hrdtr/nuxt-appwrite
import { defineNuxtModule, extendViteConfig } from '@nuxt/kit'

export default defineNuxtModule({
  setup() {
    extendViteConfig((config) => {
      config.optimizeDeps = config.optimizeDeps || {}
      config.optimizeDeps.include = config.optimizeDeps.include || []
      config.optimizeDeps.include.push('cross-fetch')
    })
  }
})

`addWebpackPlugin`

将 webpack 插件附加到配置中。

类型

function addWebpackPlugin (pluginOrGetter: PluginOrGetter, options?: ExtendWebpackConfigOptions): void

type PluginOrGetter = WebpackPluginInstance | WebpackPluginInstance[] | (() => WebpackPluginInstance | WebpackPluginInstance[])

interface ExtendWebpackConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

请参阅 webpack 网站了解有关 webpack 插件的更多信息。您还可以使用此集合来查找适合您需求的插件。

参数

`pluginOrGetter`

类型: PluginOrGetter

必需: true

一个 webpack 插件实例或 webpack 插件实例数组。如果提供了函数，则它必须返回一个 webpack 插件实例或 webpack 插件实例数组。

`options`

类型: ExtendWebpackConfigOptions

默认: {}

传递给回调函数的选项。此对象可以具有以下属性

dev（可选）
类型: boolean
默认: true
如果设置为 true，则在开发模式下构建时将调用回调函数。
build（可选）
类型: boolean
默认: true
如果设置为 true，则在生产模式下构建时将调用回调函数。
server（可选）
类型: boolean
默认: true
如果设置为 true，则在构建服务器包时将调用回调函数。
client（可选）
类型: boolean
默认: true
如果设置为 true，则在构建客户端包时将调用回调函数。
prepend（可选）
类型: boolean
如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

示例

// https://github.com/nuxt-modules/eslint
import EslintWebpackPlugin from 'eslint-webpack-plugin'
import { defineNuxtModule, addWebpackPlugin } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'nuxt-eslint',
    configKey: 'eslint',
  },
  defaults: nuxt => ({
    include: [`${nuxt.options.srcDir}/**/*.{js,jsx,ts,tsx,vue}`],
    lintOnStart: true,
  }),
  setup(options, nuxt) {
    const webpackOptions = {
      ...options,
      context: nuxt.options.srcDir,
      files: options.include,
      lintDirtyModulesOnly: !options.lintOnStart
    }
    addWebpackPlugin(new EslintWebpackPlugin(webpackOptions), { server: false })
  }
})

`addVitePlugin`

将 Vite 插件附加到配置中。

类型

function addVitePlugin (pluginOrGetter: PluginOrGetter, options?: ExtendViteConfigOptions): void

type PluginOrGetter = VitePlugin | VitePlugin[] | (() => VitePlugin | VitePlugin[])

interface ExtendViteConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

请参阅 Vite 网站了解有关 Vite 插件的更多信息。您还可以使用此存储库来查找适合您需求的插件。

参数

`pluginOrGetter`

类型: PluginOrGetter

必需: true

一个 Vite 插件实例或 Vite 插件实例数组。如果提供了函数，则它必须返回一个 Vite 插件实例或 Vite 插件实例数组。

`options`

类型: ExtendViteConfigOptions

默认: {}

传递给回调函数的选项。此对象可以具有以下属性

dev（可选）
类型: boolean
默认: true
如果设置为 true，则在开发模式下构建时将调用回调函数。
build（可选）
类型: boolean
默认: true
如果设置为 true，则在生产模式下构建时将调用回调函数。
server（可选）
类型: boolean
默认: true
如果设置为 true，则在构建服务器包时将调用回调函数。
client（可选）
类型: boolean
默认: true
如果设置为 true，则在构建客户端包时将调用回调函数。
prepend（可选）
类型: boolean
如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

示例

// https://github.com/yisibell/nuxt-svg-icons
import { defineNuxtModule, addVitePlugin } from '@nuxt/kit'
import { svg4VuePlugin } from 'vite-plugin-svg4vue'

export default defineNuxtModule({
  meta: {
    name: 'nuxt-svg-icons',
    configKey: 'nuxtSvgIcons',
  },
  defaults: {
    svg4vue: {
      assetsDirName: 'assets/icons',
    },
  },
  setup(options) {
    addVitePlugin(svg4VuePlugin(options.svg4vue))
  },
})

`addBuildPlugin`

addWebpackPlugin 和 addVitePlugin 的构建器无关版本。如果存在，它会将插件添加到 webpack 和 vite 配置中。

类型

function addBuildPlugin (pluginFactory: AddBuildPluginFactory, options?: ExtendConfigOptions): void

interface AddBuildPluginFactory {
  vite?: () => VitePlugin | VitePlugin[]
  webpack?: () => WebpackPluginInstance | WebpackPluginInstance[]
}

interface ExtendConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

参数

`pluginFactory`

类型: AddBuildPluginFactory

必需: true

一个工厂函数，返回一个具有 vite 和/或 webpack 属性的对象。这些属性必须是返回 Vite 插件实例或 Vite 插件实例数组和/或 webpack 插件实例或 webpack 插件实例数组的函数。

`options`

类型: ExtendConfigOptions

默认: {}

传递给回调函数的选项。此对象可以具有以下属性

dev（可选）
类型: boolean
默认: true
如果设置为 true，则在开发模式下构建时将调用回调函数。
build（可选）
类型: boolean
默认: true
如果设置为 true，则在生产模式下构建时将调用回调函数。
server（可选）
类型: boolean
默认: true
如果设置为 true，则在构建服务器包时将调用回调函数。
client（可选）
类型: boolean
默认: true
如果设置为 true，则在构建客户端包时将调用回调函数。
prepend（可选）
类型: boolean
如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

日志记录

Nuxt Kit 提供了一组实用工具来帮助您进行日志记录。这些函数允许您记录带有额外功能的消息。

示例

Nuxt Kit 实用工具的使用示例。