# @aphrody/bun-plugin-yaml 中文文档

规范地址：https://npmcn.com/package/%40aphrody/bun-plugin-yaml/

版本：1\.4\.7
npm 元数据更新时间：2026-10-23T02:16:54.603Z
中文译文更新时间：2026-11-07T07:16:33.937Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aphrody/bun-plugin-yaml
原文对照：https://npmcn.com/package/%40aphrody/bun-plugin-yaml/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.1 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-08T20:54:52.687Z
- 最新版本发布：2026-10-23T02:16:54.427Z
- 近 30 天下载量：2017（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @aphrody/bun-plugin-yaml
```

也可以使用：`pnpm add @aphrody/bun-plugin-yaml`、`yarn add @aphrody/bun-plugin-yaml`、`bun add @aphrody/bun-plugin-yaml`

## README

# `@aphrody/bun-plugin-yaml`

Bun的官方YAML插件. 添加对 `.yml`编号 :`.yaml` 进口.

## 安装

```sh
bun add @aphrody/bun-plugin-yaml -d
```

## Bundler 用户

此插件可用于支持 `.yaml` 装入Bun的捆绑箱的装填器通过传入 `plugins` 数组 :

```ts
import yamlPlugin from "@aphrody/bun-plugin-yaml";

await Bun.build({
  entrypoints: ["./index.tsx"],
  // other config

  plugins: [yamlPlugin()],
});
```

您现在可以导入 `.yaml` 来自源代码的文件 :

```ts
import data from "./data.yaml";

export function Component() {
  return <div>{data.name}</div>;
}
```

报告的内容 `.yaml` 文件将包含在您的捆绑中.

## 运行时间使用情况

要用作运行时插件, 请创建一个注册插件的文件 :

```ts
// yaml.ts
import yamlPlugin from "@aphrody/bun-plugin-yaml";

Bun.plugin(yamlPlugin());
```

准备装入你的 `bunfig.toml`数字 :

```toml
preload = ["./yaml.ts"]
```

## 类型脚本

默认 VSCode/ TypeScript 无法识别 `.yaml` 进口。 为避免导入出错,请在您的 `tsconfig.json`数字 :

```json-diff
  {
    "compilerOptions": {
      "types": [
        // other packages, e.g. "@aphrody/bun-types",
+       "@aphrody/bun-plugin-yaml"
      ]
    }
  }
```

## 捐款

```bash
$ bun install # project setup
$ bun test # run tests
```

## 常见问题

### 如何安装 @aphrody/bun-plugin-yaml？

在项目目录运行 npm install @aphrody/bun-plugin-yaml，或使用 pnpm add / yarn add / bun add。

### @aphrody/bun-plugin-yaml 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aphrody/bun-plugin-yaml 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aphrody/bun-plugin-yaml 可以商用吗？

@aphrody/bun-plugin-yaml 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @aphrody/bun-plugin-yaml 的下载量有多少？

根据 npm 官方下载统计，@aphrody/bun-plugin-yaml 在 2026/10/06 – 2026/11/04 这 30 天内被下载 2,017 次，日均约 67 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aphrody/bun-plugin-yaml 还在维护吗？

最新版本 1\.4\.7 发布于 2026/10/23（15 天前）；至今共发布 10 个版本，其中过去 12 个月发布了 10 个；首次发布于 2026/10/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。