构建器

Nuxt Kit 提供了一组实用工具，帮助您处理构建器。这些函数允许您扩展 Vite 和 webpack 配置。

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

`extendViteConfig`

扩展 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 网站，了解更多关于其配置的信息。

参数

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

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

属性	类型	必需	描述
`dev`	`boolean`	`false`	如果设置为 `true`，回调函数将在开发模式下构建时调用。
`build`	`boolean`	`false`	如果设置为 `true`，回调函数将在生产模式下构建时调用。
`server`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建服务端捆绑包时调用。
`client`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建客户端捆绑包时调用。
`prepend`	`boolean`	`false`	如果设置为 `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: 传递给回调函数的选项。此对象可以具有以下属性：

属性	类型	必需	描述
`dev`	`boolean`	`false`	如果设置为 `true`，回调函数将在开发模式下构建时调用。
`build`	`boolean`	`false`	如果设置为 `true`，回调函数将在生产模式下构建时调用。
`server`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建服务端捆绑包时调用。
`client`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建客户端捆绑包时调用。
`prepend`	`boolean`	`false`	如果设置为 `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: 传递给回调函数的选项。此对象可以具有以下属性：

属性	类型	必需	描述
`dev`	`boolean`	`false`	如果设置为 `true`，回调函数将在开发模式下构建时调用。
`build`	`boolean`	`false`	如果设置为 `true`，回调函数将在生产模式下构建时调用。
`server`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建服务端捆绑包时调用。
`client`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建客户端捆绑包时调用。
`prepend`	`boolean`	`false`	如果设置为 `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: 传递给回调函数的选项。此对象可以具有以下属性：

属性	类型	必需	描述
`dev`	`boolean`	`false`	如果设置为 `true`，回调函数将在开发模式下构建时调用。
`build`	`boolean`	`false`	如果设置为 `true`，回调函数将在生产模式下构建时调用。
`server`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建服务端捆绑包时调用。
`client`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建客户端捆绑包时调用。
`prepend`	`boolean`	`false`	如果设置为 `true`，回调函数将使用 `unshift()` 前置到数组，而不是 `push()`。

`addBuildPlugin`

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

类型

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

参数

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

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

属性	类型	必需	描述
`dev`	`boolean`	`false`	如果设置为 `true`，回调函数将在开发模式下构建时调用。
`build`	`boolean`	`false`	如果设置为 `true`，回调函数将在生产模式下构建时调用。
`server`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建服务端捆绑包时调用。
`client`	`boolean`	`false`	如果设置为 `true`，回调函数将在构建客户端捆绑包时调用。
`prepend`	`boolean`	`false`	如果设置为 `true`，回调函数将使用 `unshift()` 前置到数组，而不是 `push()`。

Report an issue or Edit this page on GitHub

日志

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

示例

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