# @alexlafroscia/yaml-merge 中文文档

规范地址：https://npmcn.com/package/%40alexlafroscia/yaml-merge/

版本：4\.1\.0
npm 元数据更新时间：2022-06-12T14:29:00.821Z
中文译文更新时间：2026-11-05T18:39:22.502Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：5.4 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2016-12-12T19:00:36.885Z
- 最新版本发布：2021-06-25T15:07:25.323Z
- 近 30 天下载量：58946（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

用于合并 YAML 文件的超简单工具

## 安装

```sh
npm install @alexlafroscia/yaml-merge
```

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

## README

# `yaml-merge`

![Verify](https://github.com/alexlafroscia/yaml-merge/workflows/Verify/badge.svg)

用于合并YAML文件的超简单工具.

## 安装

### 对于命令行

```bash
npm install -g @alexlafroscia/yaml-merge
```

### 供通过节点使用

```bash
npm install --save @alexlafroscia/yaml-merge
```

## 使用量

`yaml-merge` 使用一系列 `yaml` 文件并把它们从左到右合并。 这意味着第一个文件将被第二个文件的属性所覆盖,而第三个文件的属性所覆盖,等等.

### 命令行

当从命令行使用此工具时, 输出文件将只写到 `STDOUT`

```bash
yaml-merge test/fixtures/basic/a.yml test/fixtures/basic/b.yml
a:
  foo: bar
b:
  foo: bar
```

这样,就可以将输出吹入任何你想要的. 例如,这将写入新的 `yaml` 文件为 `output.yml`

```bash
yaml-merge test/fixtures/basic/a.yml test/fixtures/basic/b.yml > output.yml
```

所提供的文件名称将相对于当前目录解决 。 因此,你提供了与文件相对的路径,或者一个绝对路径-- 要么方法有效.

### 作为节点包

`yaml-merge` 还提供a `node` 软件包,可以用于程序化获取输出文件.

```javascript
const resolve = require('path').resolve;
const merge = require('@alexlafroscia/yaml-merge');

const output = merge(resolve('relative/path/to/file.yml'), '/Users/you/some/other/file.yml');
console.log(output); // Prints out the resulting YAML as a string
```

## 常见问题

### @alexlafroscia/yaml-merge 是什么？

用于合并 YAML 文件的超简单工具

### 如何安装 @alexlafroscia/yaml-merge？

在项目目录运行 npm install @alexlafroscia/yaml-merge，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 yaml-merge，可以用 npx yaml-merge 直接运行。

### @alexlafroscia/yaml-merge 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/alexlafroscia\_\_yaml-merge 是否存在。

### @alexlafroscia/yaml-merge 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @alexlafroscia/yaml-merge 可以商用吗？

@alexlafroscia/yaml-merge 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @alexlafroscia/yaml-merge 的下载量有多少？

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

### @alexlafroscia/yaml-merge 还在维护吗？

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