# @artsy/changelog 中文文档

规范地址：https://npmcn.com/package/%40artsy/changelog/

版本：0\.1\.0
npm 元数据更新时间：2026-06-26T12:40:22.048Z
中文译文更新时间：2026-11-08T01:09:29.244Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40artsy/changelog
原文对照：https://npmcn.com/package/%40artsy/changelog/?lang=original
项目主页：https://github.com/artsy/artsy-changelog#readme
源码仓库：https://github.com/artsy/artsy-changelog

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

- 包体积（解压后）：6.7 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-06-26T12:40:21.381Z
- 最新版本发布：2026-06-26T12:40:21.695Z
- 近 30 天下载量：1949（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

Artsy PR-description changelog 段落的共享解析器(由 eigen 和 leave-lookout 使用).

## 安装

```sh
npm install @artsy/changelog
```

也可以使用：`pnpm add @artsy/changelog`、`yarn add @artsy/changelog`、`bun add @artsy/changelog`

## README

# @ artsy/ changelog

Arty的PR-description changlog Convention的共享解析器. 使用单一的真相来源 两者 [基根语name](https://github.com/artsy/eigen) (危险+) `generate-changelog`和 [释放- 注意](https://github.com/artsy/release-lookout) (发布-认证PR描述).

Artsy PRs 声明释放笔记为 四 `####`\- 公关机构的头部:

```
#### Cross-platform user-facing changes
#### iOS user-facing changes
#### Android user-facing changes
#### Dev changes
```

此套件将原始的PR正文分解为结构化的结果. 这是故意的 **免费 I/O** —— 说 获取 PR / 确定范围由每个消费者决定 .

## 使用量

```ts
import { parsePRDescription, changelogTemplateSections } from "@artsy/changelog"

const result = parsePRDescription(pr.body)

switch (result.type) {
  case "no_changes": // PR contains `#nochangelog`
    break
  case "error": // no changelog sections found / all empty
    break
  case "changes":
    result.crossPlatformUserFacingChanges // string[]
    result.iOSUserFacingChanges
    result.androidUserFacingChanges
    result.devChanges
    break
}
```

## API 密码

-   `parsePRDescription(body: string): ParseResult` - 分析一个公关机构.
-   `ParseResult` —— 说 `{ type: "no_changes" } | { type: "error" } | ({ type: "changes" } & ParseResultChanges)`。 。 。 .
-   `changelogTemplateSections` ——节-键-节-标题地图.

## 发展

```sh
yarn        # install
yarn test   # jest
yarn build  # tsc → dist
```

## 常见问题

### @artsy/changelog 是什么？

Artsy PR-description changelog 段落的共享解析器\(由 eigen 和 leave-lookout 使用\)\.

### 如何安装 @artsy/changelog？

在项目目录运行 npm install @artsy/changelog，或使用 pnpm add / yarn add / bun add。

### @artsy/changelog 支持 TypeScript 吗？

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

### @artsy/changelog 支持 ESM 还是 CommonJS？

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

### @artsy/changelog 可以商用吗？

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

### @artsy/changelog 的下载量有多少？

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

### @artsy/changelog 还在维护吗？

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