---
title: "在 Nuxt 中使用 Vite 插件"
description: "了解如何将 Vite 插件集成到你的 Nuxt 项目中。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/guide/recipes/vite-plugin"
---
# 在 Nuxt 中使用 Vite 插件

> 了解如何将 Vite 插件集成到你的 Nuxt 项目中。

虽然 Nuxt 模块提供了丰富的功能，但有时某个特定的 Vite 插件可能更直接地满足你的需求。

首先，我们需要安装 Vite 插件，在本例中，我们将使用 `@rollup/plugin-yaml`：

::code-group{sync="pm"}
```bash [npm]
npm install @rollup/plugin-yaml
```

```bash [yarn]
yarn add @rollup/plugin-yaml
```

```bash [pnpm]
pnpm add @rollup/plugin-yaml
```

```bash [bun]
bun add @rollup/plugin-yaml
```

```bash [deno]
deno add npm:@rollup/plugin-yaml
```
::

接下来，我们需要将其导入并添加到我们的 [`nuxt.config.ts`](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/nuxt-config) 文件中：

```ts [nuxt.config.ts]
import yaml from '@rollup/plugin-yaml'

export default defineNuxtConfig({
  vite: {
    plugins: [
      yaml(),
    ],
  },
})
```

现在我们已经安装并配置好了 Vite 插件，可以开始在项目中直接使用 YAML 文件了。

例如，我们可以有一个存储配置信息的 `config.yaml`，并在 Nuxt 组件中导入这份数据：

::code-group
```yaml [data/hello.yaml]
greeting: "Hello, Nuxt with Vite!"
```

```vue [components/Hello.vue]
<script setup>
import config from '~/data/hello.yaml'
</script>

<template>
  <h1>{{ config.greeting }}</h1>
</template>
```
::

## 在 Nuxt 模块中使用 Vite 插件

如果你正在开发 Nuxt 模块并需要添加 Vite 插件，应使用 [`addVitePlugin`](https://nuxt.zhcndoc.com/docs/3.x/api/kit/builder#addviteplugin) 工具：

```ts [modules/my-module.ts]
import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'
import yaml from '@rollup/plugin-yaml'

export default defineNuxtModule({
  setup () {
    addVitePlugin(yaml())
  },
})
```

对于 Nuxt 5+ 中的特定环境插件，请使用 `applyToEnvironment()` 方法：

```ts [modules/my-module.ts]
import { addVitePlugin, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    addVitePlugin(() => ({
      name: 'my-client-plugin',
      applyToEnvironment (environment) {
        return environment.name === 'client'
      },
      // 插件配置
    }))
  },
})
```

::important
如果你编写的代码需要访问已解析的 Vite 配置，应在你的 Vite 插件内部使用 `config` 和 `configResolved` 钩子，而不是使用 Nuxt 的 `vite:extend`、`vite:extendConfig` 和 `vite:configResolved`。
::

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/api/kit/builder#addviteplugin"}
在 Nuxt Kit 文档中阅读有关 `addVitePlugin` 的更多内容。
::


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.