# @commercetools-docs/rmf-codegen 中文文档

规范地址：https://npmcn.com/package/%40commercetools-docs/rmf-codegen/

版本：13\.56\.0
npm 元数据更新时间：2026-09-29T09:31:15.930Z
中文译文更新时间：2026-11-10T12:03:21.222Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：52 MB，8 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：4 个
- 首次发布：2020-12-01T13:17:15.548Z
- 最新版本发布：2026-09-29T09:31:15.466Z
- 近 30 天下载量：4660（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：88（近 12 个月 7 个）

## 中文简介

为 Javascript 项目提供 RMF- Codegen

## 安装

```sh
npm install @commercetools-docs/rmf-codegen
```

也可以使用：`pnpm add @commercetools-docs/rmf-codegen`、`yarn add @commercetools-docs/rmf-codegen`、`bun add @commercetools-docs/rmf-codegen`

## README

# rMF-代码提供者软件包

此套件提供了 REST 建模框架 [rmf-代码](https://github.com/commercetools/rmf-codegen) CLI去javascript项目,没有单独的安装或版本选择步骤.

RMF-Codegen版本通过 `rmfCodegenVersion` 属性在 [软件包.json](https://npmcn.com/package/%40commercetools-docs/rmf-codegen/package.json) 并提及 [GitHub 发布版本 RMF-Codgen](https://github.com/commercetools/rmf-codegen/releases)。 。 。 .

> RMF-Codegen是一个java程序. Java 需要在命令行上可用以运行 `rmf-codegen` 命令. 二进制可执行文件是可能的,但尚未作为预建下载提供. [读更多...](https://github.com/commercetools/rmf-codegen#build-a-native-executable-with-graalvm)

## 先决条件

较新的 Java 8 `java` 需要在路径上安装和提供运行时间. `rmf-codegen` 在安装时自动下载.

`rmf-codegen` 之所以选取其他(本土JS和/或官方)RAML解析器,是因为事实证明它是唯一能够正确和可靠地在很短的时间内载入极其庞大的API定义,而其他人却完全没有载入相同的API定义.

## 使用量

典型的用法是把它列为发展依赖

`yarn add --dev @commercetools-docs/rmf-codegen`

然后在项目目录中运行

`npx rmf-codegen`

**见 [RMF-代码读取器](https://github.com/commercetools/rmf-codegen/blob/master/README.md) 对于所有可用的选项和特征。 或者为当前选项和细节参考捆绑的rmf-codegen的帮助输出 `npx rmf-codegen generate`**

您也可以通过 `npm install -g @commercetools-docs/rmf-codegen`,但为此它可能更适合使用由RMF-Codegen直接提供的安装脚本.

## 维修

更新 `rmf-codegen` 版本, 更新自定义 `rmfCodegenVersion` 属性在 `package.json`。 。 。 .

Rmf-codegen JAR 从 [项目的 GitHub 发布页面](https://github.com/commercetools/rmf-codegen/releases)。 。 。 .

为了帮助获得一个合适的版本, 在这里创建一个问题 - [https://github.com/commercialtools/rmf-codegen/issues (中文(中国大陆) )](https://github.com/commercetools/rmf-codegen/issues)。 。 。 .

## 常见问题

### @commercetools-docs/rmf-codegen 是什么？

为 Javascript 项目提供 RMF- Codegen

### 如何安装 @commercetools-docs/rmf-codegen？

在项目目录运行 npm install @commercetools-docs/rmf-codegen，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 rmf-codegen、raml-markdownlint，可以用 npx rmf-codegen 直接运行。

### @commercetools-docs/rmf-codegen 支持 TypeScript 吗？

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

### @commercetools-docs/rmf-codegen 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @commercetools-docs/rmf-codegen 可以商用吗？

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

### @commercetools-docs/rmf-codegen 的下载量有多少？

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

### @commercetools-docs/rmf-codegen 还在维护吗？

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