# @bpmn-io/element-templates-validator 中文文档

规范地址：https://npmcn.com/package/%40bpmn-io/element-templates-validator/

版本：2\.26\.0
npm 元数据更新时间：2026-08-20T13:00:20.751Z
中文译文更新时间：2026-11-08T13:06:52.641Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.9 MB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2021-04-07T13:15:45.821Z
- 最新版本发布：2026-08-20T13:00:20.546Z
- 近 30 天下载量：97193（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 16 个）

## 中文简介

基于 JSON Schema 验证元素模板

## 安装

```sh
npm install @bpmn-io/element-templates-validator
```

也可以使用：`pnpm add @bpmn-io/element-templates-validator`、`yarn add @bpmn-io/element-templates-validator`、`bun add @bpmn-io/element-templates-validator`

## README

# 元素模板验证器

[![CI](https://github.com/bpmn-io/element-templates-validator/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/element-templates-validator/actions/workflows/CI.yml)

根据 [杰森·斯克马](https://github.com/camunda/element-templates-json-schema)。 。 。 .

## 安装

```sh
npm i --save @bpmn-io/element-templates-validator
```

## 使用量

考虑到 [示例元素模板](https://npmcn.com/package/%40bpmn-io/element-templates-validator/test/fixtures/rpa-broken.json)数字 :

```js
import { validate } from '@bpmn-io/element-templates-validator';

import sample from './test/fixtures/rpa-broken.json';

const {
  valid,
  errors,
  warnings
} = validate(sample);

if (!valid) {
  console.error('Invalid JSON detected:', errors);
}
```

这将打印样本内错误和警告的详细信息:

```json
[
  {
    "keyword": "type",
    "dataPath": "",
    "schemaPath": "#/type",
    "params": {
      "type": "object"
    },
    "message": "must be object",
    "dataPointer": {
      "value": {
        "line": 0,
        "column": 0,
        "pos": 0
      },
      "valueEnd": {
        "line": 177,
        "column": 1,
        "pos": 4825
      }
    }
  }
  ...
]
```

您也可以通过字符串模板,以确保 `dataPointers` 中,错误反映了原字符串中的正确位置.

```js
import { validate } from '@bpmn-io/element-templates-validator';

import { readFileSync } from 'node:fs';

const sample = readFileSync('./test/fixtures/rpa-broken.json', 'utf-8');

const {
  valid,
  errors,
  warnings
} = validate(sample);

if (!valid) {
  console.error('Invalid JSON detected:', errors);
}
```

如果一个解析过的JSON对象通过,则 `dataPointers` 将假设源模板格式化为 `JSON.stringify(template, null, 2)`。 。 。 .

也可以同时验证多个对象. 在这种情况下,模板列表只支持对象,而不是字符串.

```js
import { validateAll } from '@bpmn-io/element-templates-validator';

import samples from './test/fixtures/multiple-errors.json';

const {
  valid,
  results
} = validateAll(samples);

if (!valid) {
  console.error('Invalid JSON objects detected:', results.filter(r => !r.valid));
}
```

## 许可证

麻省理工学院

## 常见问题

### @bpmn-io/element-templates-validator 是什么？

基于 JSON Schema 验证元素模板

### 如何安装 @bpmn-io/element-templates-validator？

在项目目录运行 npm install @bpmn-io/element-templates-validator，或使用 pnpm add / yarn add / bun add。

### @bpmn-io/element-templates-validator 支持 TypeScript 吗？

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

### @bpmn-io/element-templates-validator 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bpmn-io/element-templates-validator 可以商用吗？

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

### @bpmn-io/element-templates-validator 的下载量有多少？

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

### @bpmn-io/element-templates-validator 还在维护吗？

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