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')
    })
  },
})

型

// @errors: 2391
import type { UserConfig as ViteConfig } from 'vite'
import type { ExtendViteConfigOptions } from '@nuxt/kit'
// ---cut---
function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void

パラメータ

callback: Viteの設定オブジェクトと共に呼び出されるコールバック関数。

options: コールバック関数に渡すオプション。このオブジェクトは以下のプロパティを持つことができます：

extendWebpackConfig

webpackの設定を拡張します。コールバック関数は、クライアントとサーバーのビルドの両方に適用されるときに、複数回呼び出すことができます。

使用法

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

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

型

// @errors: 2391
import type { Configuration as WebpackConfig } from 'webpack'
import type { ExtendWebpackConfigOptions } from '@nuxt/kit'
// ---cut---
function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void

パラメータ

callback: webpackの設定オブジェクトと共に呼び出されるコールバック関数。

options: コールバック関数に渡すオプション。このオブジェクトは以下のプロパティを持つことができます：

addVitePlugin

Viteプラグインを設定に追加します。

使用法

// @errors: 2307
// ---cut---
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))
  },
})

型

// @errors: 2391
import type { Plugin as VitePlugin } from 'vite'
import type { ExtendViteConfigOptions } from '@nuxt/kit'
// ---cut---
function addVitePlugin (pluginOrGetter: VitePlugin | VitePlugin[] | (() => VitePlugin | VitePlugin[]), options?: ExtendViteConfigOptions): void

パラメータ

pluginOrGetter: ViteプラグインインスタンスまたはViteプラグインインスタンスの配列。関数が提供された場合、それはViteプラグインインスタンスまたはViteプラグインインスタンスの配列を返す必要があります。

options: コールバック関数に渡すオプション。このオブジェクトは以下のプロパティを持つことができます：

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 })
  },
})

型

// @errors: 2391
import type { WebpackPluginInstance } from 'webpack'
import type { ExtendWebpackConfigOptions } from '@nuxt/kit'
// ---cut---
function addWebpackPlugin (pluginOrGetter: WebpackPluginInstance | WebpackPluginInstance[] | (() => WebpackPluginInstance | WebpackPluginInstance[]), options?: ExtendWebpackConfigOptions): void

パラメータ

pluginOrGetter: webpackプラグインインスタンスまたはwebpackプラグインインスタンスの配列。関数が提供された場合、それはwebpackプラグインインスタンスまたはwebpackプラグインインスタンスの配列を返す必要があります。

options: コールバック関数に渡すオプション。このオブジェクトは以下のプロパティを持つことができます：

addBuildPlugin

addVitePluginとaddWebpackPluginのビルダーに依存しないバージョンです。Viteとwebpackの設定が存在する場合、両方にプラグインを追加します。

型

// @errors: 2391
import type { ExtendConfigOptions } from '@nuxt/kit'
import type { Plugin as VitePlugin } from 'vite'
import type { WebpackPluginInstance } from 'webpack'
import type { RspackPluginInstance } from '@rspack/core'
interface AddBuildPluginFactory {
  vite?: () => VitePlugin | VitePlugin[]
  webpack?: () => WebpackPluginInstance | WebpackPluginInstance[]
  rspack?: () => RspackPluginInstance | RspackPluginInstance[]
}
// ---cut---
function addBuildPlugin (pluginFactory: AddBuildPluginFactory, options?: ExtendConfigOptions): void

パラメータ

pluginFactory: viteおよび/またはwebpackプロパティを持つオブジェクトを返すファクトリ関数。これらのプロパティは、ViteプラグインインスタンスまたはViteプラグインインスタンスの配列、および/またはwebpackプラグインインスタンスまたはwebpackプラグインインスタンスの配列を返す関数でなければなりません。

options: コールバック関数に渡すオプション。このオブジェクトは以下のプロパティを持つことができます：