빌더

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 설정에 대한 더 많은 정보는 Vite 웹사이트를 참고하세요.

파라미터

callback: Vite 설정 객체와 함께 호출될 콜백 함수입니다.

options: 콜백 함수에 전달할 옵션입니다. 이 객체는 다음과 같은 속성을 가질 수 있습니다:

속성	타입	필수여부	설명
`dev`	`boolean`	`false`	`true`로 설정하면 개발 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`build`	`boolean`	`false`	`true`로 설정하면 프로덕션 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`server`	`boolean`	`false`	`true`로 설정하면 서버 번들을 빌드할 때 콜백 함수가 호출됩니다.
`client`	`boolean`	`false`	`true`로 설정하면 클라이언트 번들을 빌드할 때 콜백 함수가 호출됩니다.
`prepend`	`boolean`	`false`	`true`로 설정하면 콜백 함수가 배열에 `push()` 대신 `unshift()`로 앞에 추가됩니다.

`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 설정에 대한 더 많은 정보는 webpack 웹사이트를 참고하세요.

파라미터

callback: webpack 설정 객체와 함께 호출될 콜백 함수입니다.

options: 콜백 함수에 전달할 옵션입니다. 이 객체는 다음과 같은 속성을 가질 수 있습니다:

속성	타입	필수여부	설명
`dev`	`boolean`	`false`	`true`로 설정하면 개발 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`build`	`boolean`	`false`	`true`로 설정하면 프로덕션 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`server`	`boolean`	`false`	`true`로 설정하면 서버 번들을 빌드할 때 콜백 함수가 호출됩니다.
`client`	`boolean`	`false`	`true`로 설정하면 클라이언트 번들을 빌드할 때 콜백 함수가 호출됩니다.
`prepend`	`boolean`	`false`	`true`로 설정하면 콜백 함수가 배열에 `push()` 대신 `unshift()`로 앞에 추가됩니다.

`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 플러그인 인스턴스 또는 인스턴스 배열을 반환해야 합니다.

options: 콜백 함수에 전달할 옵션입니다. 이 객체는 다음과 같은 속성을 가질 수 있습니다:

속성	타입	필수여부	설명
`dev`	`boolean`	`false`	`true`로 설정하면 개발 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`build`	`boolean`	`false`	`true`로 설정하면 프로덕션 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`server`	`boolean`	`false`	`true`로 설정하면 서버 번들을 빌드할 때 콜백 함수가 호출됩니다.
`client`	`boolean`	`false`	`true`로 설정하면 클라이언트 번들을 빌드할 때 콜백 함수가 호출됩니다.
`prepend`	`boolean`	`false`	`true`로 설정하면 콜백 함수가 배열에 `push()` 대신 `unshift()`로 앞에 추가됩니다.

`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 플러그인 인스턴스 또는 인스턴스 배열을 반환해야 합니다.

options: 콜백 함수에 전달할 옵션입니다. 이 객체는 다음과 같은 속성을 가질 수 있습니다:

속성	타입	필수여부	설명
`dev`	`boolean`	`false`	`true`로 설정하면 개발 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`build`	`boolean`	`false`	`true`로 설정하면 프로덕션 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`server`	`boolean`	`false`	`true`로 설정하면 서버 번들을 빌드할 때 콜백 함수가 호출됩니다.
`client`	`boolean`	`false`	`true`로 설정하면 클라이언트 번들을 빌드할 때 콜백 함수가 호출됩니다.
`prepend`	`boolean`	`false`	`true`로 설정하면 콜백 함수가 배열에 `push()` 대신 `unshift()`로 앞에 추가됩니다.

`addBuildPlugin`

addVitePlugin과 addWebpackPlugin의 빌더 독립적 버전입니다. Vite와 webpack 설정이 모두 존재할 경우 두 곳 모두에 플러그인을 추가합니다.

타입

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

파라미터

pluginFactory: vite 및/또는 webpack 속성을 가진 객체를 반환하는 팩토리 함수입니다. 이 속성들은 Vite 플러그인 인스턴스 또는 인스턴스 배열, 그리고/또는 webpack 플러그인 인스턴스 또는 인스턴스 배열을 반환하는 함수여야 합니다.

options: 콜백 함수에 전달할 옵션입니다. 이 객체는 다음과 같은 속성을 가질 수 있습니다:

속성	타입	필수여부	설명
`dev`	`boolean`	`false`	`true`로 설정하면 개발 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`build`	`boolean`	`false`	`true`로 설정하면 프로덕션 모드에서 빌드할 때 콜백 함수가 호출됩니다.
`server`	`boolean`	`false`	`true`로 설정하면 서버 번들을 빌드할 때 콜백 함수가 호출됩니다.
`client`	`boolean`	`false`	`true`로 설정하면 클라이언트 번들을 빌드할 때 콜백 함수가 호출됩니다.
`prepend`	`boolean`	`false`	`true`로 설정하면 콜백 함수가 배열에 `push()` 대신 `unshift()`로 앞에 추가됩니다.