建構器 · Nuxt Kit

Nuxt 有基於 webpack 和 vite 的建構器。您可以使用 extendWebpackConfig 和 extendViteConfig 函式來擴展傳遞給每個建構器的設定。您也可以透過 addVitePlugin、addWebpackPlugin 和 addBuildPlugin 新增其他外掛。

`extendWebpackConfig`

擴展 webpack 設定。當應用於客戶端和伺服器建構時，可以多次呼叫回呼函式。

類型

function extendWebpackConfig (callback: ((config: WebpackConfig) => void), options?: ExtendWebpackConfigOptions): void

export interface ExtendWebpackConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

請查看 webpack 網站以獲取有關其設定的更多資訊。

參數

`callback`

類型: (config: WebpackConfig) => void

必要: true

將以 webpack 設定物件呼叫的回呼函式。

`options`

類型: ExtendWebpackConfigOptions

預設: {}

要傳遞給回呼函式的選項。此物件可以具有以下屬性

dev (選填)
類型: boolean
預設: true
如果設定為 true，則在開發模式下建構時會呼叫回呼函式。
build (選填)
類型: boolean
預設: true
如果設定為 true，則在生產模式下建構時會呼叫回呼函式。
server (選填)
類型: boolean
預設: true
如果設定為 true，則在建構伺服器捆綁包時會呼叫回呼函式。
client (選填)
類型: boolean
預設: true
如果設定為 true，則在建構客戶端捆綁包時會呼叫回呼函式。
prepend (選填)
類型: boolean
如果設定為 true，則回呼函式將使用 unshift() 而不是 push() 來前置到陣列。

範例

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

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

`extendViteConfig`

擴展 Vite 設定。當應用於客戶端和伺服器建構時，可以多次呼叫回呼函式。

類型

function extendViteConfig (callback: ((config: ViteConfig) => void), options?: ExtendViteConfigOptions): void

export interface ExtendViteConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

請查看 Vite 網站以獲取有關其設定的更多資訊。

參數

`callback`

類型: (config: ViteConfig) => void

必要: true

將以 Vite 設定物件呼叫的回呼函式。

`options`

類型: ExtendViteConfigOptions

預設: {}

要傳遞給回呼函式的選項。此物件可以具有以下屬性

dev (選填)
類型: boolean
預設: true
如果設定為 true，則在開發模式下建構時會呼叫回呼函式。
build (選填)
類型: boolean
預設: true
如果設定為 true，則在生產模式下建構時會呼叫回呼函式。
server (選填)
類型: boolean
預設: true
如果設定為 true，則在建構伺服器捆綁包時會呼叫回呼函式。
client (選填)
類型: boolean
預設: true
如果設定為 true，則在建構客戶端捆綁包時會呼叫回呼函式。
prepend (選填)
類型: boolean
如果設定為 true，則回呼函式將使用 unshift() 而不是 push() 來前置到陣列。

範例

// https://github.com/Hrdtr/nuxt-appwrite
import { defineNuxtModule, extendViteConfig } from '@nuxt/kit'

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

`addWebpackPlugin`

將 webpack 外掛附加到設定。

類型

function addWebpackPlugin (pluginOrGetter: PluginOrGetter, options?: ExtendWebpackConfigOptions): void

type PluginOrGetter = WebpackPluginInstance | WebpackPluginInstance[] | (() => WebpackPluginInstance | WebpackPluginInstance[])

interface ExtendWebpackConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

請參閱 webpack 網站以獲取有關 webpack 外掛的更多資訊。您也可以使用此集合來尋找適合您需求的外掛。

參數

`pluginOrGetter`

類型: PluginOrGetter

必要: true

一個 webpack 外掛實例或一個 webpack 外掛實例陣列。如果提供了一個函式，則它必須傳回一個 webpack 外掛實例或一個 webpack 外掛實例陣列。

`options`

類型: ExtendWebpackConfigOptions

預設: {}

要傳遞給回呼函式的選項。此物件可以具有以下屬性

dev (選填)
類型: boolean
預設: true
如果設定為 true，則在開發模式下建構時會呼叫回呼函式。
build (選填)
類型: boolean
預設: true
如果設定為 true，則在生產模式下建構時會呼叫回呼函式。
server (選填)
類型: boolean
預設: true
如果設定為 true，則在建構伺服器捆綁包時會呼叫回呼函式。
client (選填)
類型: boolean
預設: true
如果設定為 true，則在建構客戶端捆綁包時會呼叫回呼函式。
prepend (選填)
類型: boolean
如果設定為 true，則回呼函式將使用 unshift() 而不是 push() 來前置到陣列。

範例

// https://github.com/nuxt-modules/eslint
import EslintWebpackPlugin from 'eslint-webpack-plugin'
import { defineNuxtModule, addWebpackPlugin } 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 })
  }
})

`addVitePlugin`

將 Vite 外掛附加到設定。

類型

function addVitePlugin (pluginOrGetter: PluginOrGetter, options?: ExtendViteConfigOptions): void

type PluginOrGetter = VitePlugin | VitePlugin[] | (() => VitePlugin | VitePlugin[])

interface ExtendViteConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

請參閱 Vite 網站以獲取有關 Vite 外掛的更多資訊。您也可以使用此儲存庫來尋找適合您需求的外掛。

參數

`pluginOrGetter`

類型: PluginOrGetter

必要: true

一個 Vite 外掛實例或一個 Vite 外掛實例陣列。如果提供了一個函式，則它必須傳回一個 Vite 外掛實例或一個 Vite 外掛實例陣列。

`options`

類型: ExtendViteConfigOptions

預設: {}

要傳遞給回呼函式的選項。此物件可以具有以下屬性

dev (選填)
類型: boolean
預設: true
如果設定為 true，則在開發模式下建構時會呼叫回呼函式。
build (選填)
類型: boolean
預設: true
如果設定為 true，則在生產模式下建構時會呼叫回呼函式。
server (選填)
類型: boolean
預設: true
如果設定為 true，則在建構伺服器捆綁包時會呼叫回呼函式。
client (選填)
類型: boolean
預設: true
如果設定為 true，則在建構客戶端捆綁包時會呼叫回呼函式。
prepend (選填)
類型: boolean
如果設定為 true，則回呼函式將使用 unshift() 而不是 push() 來前置到陣列。

範例

// https://github.com/yisibell/nuxt-svg-icons
import { defineNuxtModule, addVitePlugin } 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))
  },
})

`addBuildPlugin`

addWebpackPlugin 和 addVitePlugin 的建構器不可知版本。如果它們存在，它將把外掛新增到 webpack 和 vite 設定中。

類型

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

interface AddBuildPluginFactory {
  vite?: () => VitePlugin | VitePlugin[]
  webpack?: () => WebpackPluginInstance | WebpackPluginInstance[]
}

interface ExtendConfigOptions {
  dev?: boolean
  build?: boolean
  server?: boolean
  client?: boolean
  prepend?: boolean
}

參數

`pluginFactory`

類型: AddBuildPluginFactory

必要: true

一個工廠函式，傳回具有 vite 和/或 webpack 屬性的物件。這些屬性必須是傳回 Vite 外掛實例或 Vite 外掛實例陣列，和/或 webpack 外掛實例或 webpack 外掛實例陣列的函式。

`options`

類型: ExtendConfigOptions

預設: {}

要傳遞給回呼函式的選項。此物件可以具有以下屬性

dev (選填)
類型: boolean
預設: true
如果設定為 true，則在開發模式下建構時會呼叫回呼函式。
build (選填)
類型: boolean
預設: true
如果設定為 true，則在生產模式下建構時會呼叫回呼函式。
server (選填)
類型: boolean
預設: true
如果設定為 true，則在建構伺服器捆綁包時會呼叫回呼函式。
client (選填)
類型: boolean
預設: true
如果設定為 true，則在建構客戶端捆綁包時會呼叫回呼函式。
prepend (選填)
類型: boolean
如果設定為 true，則回呼函式將使用 unshift() 而不是 push() 來前置到陣列。

日誌記錄

Nuxt Kit 提供了一組工具來幫助您使用日誌記錄。這些函式允許您記錄具有額外功能的訊息。

範例

使用中的 Nuxt Kit 工具範例。