构建器

源文件
Nuxt Kit 提供了一套实用工具，帮助您使用构建器。这些函数允许您扩展 Vite 和 webpack 配置。

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

extendViteConfig

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

此钩子现已弃用，我们建议改用带有 config 钩子的 Vite 插件。

使用

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

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

类型

function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void
有关 Vite 配置的更多信息，请查看 Vite 网站。

参数

callback: 一个回调函数，将以 Vite 配置对象作为参数调用。

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

属性类型必需描述
开发booleanfalse如果设置为 true，则在开发模式下构建时将调用回调函数。
buildbooleanfalse如果设置为 true，则在生产模式下构建时将调用回调函数。
服务器booleanfalse如果设置为 true，则在构建服务器包时将调用回调函数。
clientbooleanfalse如果设置为 true，则在构建客户端包时将调用回调函数。
prependbooleanfalse如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

extendWebpackConfig

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

使用

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

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

类型

function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void
有关其配置的更多信息，请查看 webpack 网站。

参数

callback: 一个回调函数，将以 webpack 配置对象作为参数调用。

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

属性类型必需描述
开发booleanfalse如果设置为 true，则在开发模式下构建时将调用回调函数。
buildbooleanfalse如果设置为 true，则在生产模式下构建时将调用回调函数。
服务器booleanfalse如果设置为 true，则在构建服务器包时将调用回调函数。
clientbooleanfalse如果设置为 true，则在构建客户端包时将调用回调函数。
prependbooleanfalse如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

addVitePlugin

将 Vite 插件添加到配置中。

使用

import { addVitePlugin, defineNuxtModule } 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))
  },
})

类型

function addVitePlugin (pluginOrGetter: VitePlugin | VitePlugin[] | (() => VitePlugin | VitePlugin[]), options?: ExtendViteConfigOptions): void
请参阅Vite 网站了解有关 Vite 插件的更多信息。您还可以使用此仓库查找适合您需求的插件。

参数

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

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

属性类型必需描述
开发booleanfalse如果设置为 true，则在开发模式下构建时将调用回调函数。
buildbooleanfalse如果设置为 true，则在生产模式下构建时将调用回调函数。
服务器booleanfalse如果设置为 true，则在构建服务器包时将调用回调函数。
clientbooleanfalse如果设置为 true，则在构建客户端包时将调用回调函数。
prependbooleanfalse如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

addWebpackPlugin

将 webpack 插件添加到配置中。

使用

import EslintWebpackPlugin from 'eslint-webpack-plugin'
import { addWebpackPlugin, defineNuxtModule } 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 })
  },
})

类型

function addWebpackPlugin (pluginOrGetter: WebpackPluginInstance | WebpackPluginInstance[] | (() => WebpackPluginInstance | WebpackPluginInstance[]), options?: ExtendWebpackConfigOptions): void
请参阅webpack 网站了解有关 webpack 插件的更多信息。您还可以使用此集合查找适合您需求的插件。

参数

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

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

属性类型必需描述
开发booleanfalse如果设置为 true，则在开发模式下构建时将调用回调函数。
buildbooleanfalse如果设置为 true，则在生产模式下构建时将调用回调函数。
服务器booleanfalse如果设置为 true，则在构建服务器包时将调用回调函数。
clientbooleanfalse如果设置为 true，则在构建客户端包时将调用回调函数。
prependbooleanfalse如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。

addBuildPlugin

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

类型

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

参数

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

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

属性类型必需描述
开发booleanfalse如果设置为 true，则在开发模式下构建时将调用回调函数。
buildbooleanfalse如果设置为 true，则在生产模式下构建时将调用回调函数。
服务器booleanfalse如果设置为 true，则在构建服务器包时将调用回调函数。
clientbooleanfalse如果设置为 true，则在构建客户端包时将调用回调函数。
prependbooleanfalse如果设置为 true，则回调函数将使用 unshift() 而不是 push() 添加到数组的开头。