Сборщик

Утилиты Nuxt Kit для расширения конфигураций Vite и webpack и подключения плагинов.

Nuxt собирает приложение через Vite и/или webpack. Конфигурацию расширяют extendViteConfig и extendWebpackConfig; плагины добавляют addVitePlugin, addWebpackPlugin и универсальный addBuildPlugin.

`extendViteConfig`

Расширяет конфигурацию Vite. Коллбэк может вызываться несколько раз — отдельно для клиентского и серверного бандлов.

Этот хук устарел; предпочтительнее плагин Vite с хуком config или, для настроек под окружение, хук applyToEnvironment.

Использование

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

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

Для настроек под конкретное окружение в Nuxt 5+ используйте addVitePlugin():

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

export default defineNuxtModule
({
  setup
 () {
    // глобальная конфигурация (все окружения)
    addVitePlugin
(() => ({
      name
: 'my-global-plugin',
      config
 (config
) {
        config
.optimizeDeps
 ||= {}
        config
.optimizeDeps
.include
 ||= []
        config
.optimizeDeps
.include
.push
('cross-fetch')
      },
    }))

    // только клиентское окружение
    addVitePlugin
(() => ({
      name
: 'my-client-plugin',
      applyToEnvironment
 (environment
) {
        return environment
.name
 === 'client'
      },
      configEnvironment
 (name
, config
) {
        config
.optimizeDeps
 ||= {}
        config
.optimizeDeps
.include
 ||= []
        config
.optimizeDeps
.include
.push
('client-only-package')
      },
    }))
  },
})

Важно: хук config выполняется до applyToEnvironment и меняет общую конфигурацию. Для правок под окружение используйте configEnvironment.

Тип

function extendViteConfig (callback
: ((config
: ViteConfig
) => void), options
?: ExtendViteConfigOptions
): void
Function implementation is missing or not immediately following the declaration.

Полное описание опций 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 в конфигурацию.

В Nuxt 5+ у плагинов с опциями server: false или client: false не вызываются хуки config и configResolved. Для плагинов под окружение используйте applyToEnvironment().

Использование

import { addVitePlugin
, defineNuxtModule
 } from '@nuxt/kit'
import { svg4VuePlugin
 } from 'vite-plugin-svg4vue'
Cannot find module 'vite-plugin-svg4vue' or its corresponding type declarations.

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

    // или плагин только для одного окружения
    addVitePlugin
(() => ({
      name
: 'my-client-plugin',
      applyToEnvironment
 (environment
) {
        return environment
.name
 === 'client'
      },
      // ... остальная часть клиентского плагина
    }))
  },
})

Тип

function addVitePlugin (pluginOrGetter
: VitePlugin
 | VitePlugin
[] | (() => VitePlugin
 | VitePlugin
[]), options
?: ExtendViteConfigOptions
): void
Function implementation is missing or not immediately following the declaration.

Плагины Vite — в документации; подборка — awesome-vite.

Параметры

pluginOrGetter: экземпляр плагина Vite, массив или функция, возвращающая плагин(ы). Функция может быть асинхронной или возвращать Promise — удобно для ленивой подгрузки:

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

export default defineNuxtModule
({
  setup
 () {
    // ленивая загрузка — импорт только при реальной сборке
    addVitePlugin
(() => import('my-vite-plugin').then
(r
 => r
.default()))
Cannot find module 'my-vite-plugin' or its corresponding type declarations.
  },
})

options: когда подключать плагин (те же флаги, что у extendViteConfig):

Свойство	Тип	Обязательно	Описание
`dev`	`boolean`	`false`	При `true` — в режиме разработки.
`build`	`boolean`	`false`	При `true` — при сборке для продакшена.
`server`	`boolean`	`false`	При `true` — при сборке серверного бандла. Устарело в Nuxt 5+ — используйте `applyToEnvironment()`.
`client`	`boolean`	`false`	При `true` — при сборке клиентского бандла. Устарело в Nuxt 5+ — используйте `applyToEnvironment()`.
`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 — в документации; подборка — awesome-webpack.

Параметры

pluginOrGetter: экземпляр плагина webpack, массив или функция, возвращающая плагин(ы). Функция может быть асинхронной или возвращать Promise для ленивой подгрузки.

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 (и при необходимости rspack) — функции, возвращающие плагин(ы) соответствующего сборщика.

options: в каких режимах подключать плагины:

Свойство	Тип	Обязательно	Описание
`dev`	`boolean`	`false`	При `true` — в режиме разработки.
`build`	`boolean`	`false`	При `true` — при сборке для продакшена.
`server`	`boolean`	`false`	При `true` — при сборке серверного бандла.
`client`	`boolean`	`false`	При `true` — при сборке клиентского бандла.
`prepend`	`boolean`	`false`	При `true` — через `unshift()`, иначе `push()`.

Был ли материал полезен?

Сообщить об ошибке или Редактировать на GitHub

Логирование

Утилиты Nuxt Kit для структурированного вывода в консоль при разработке модулей.

Примеры

Практические примеры вызовов утилит Nuxt Kit.