# @bildit-platform/template-parser 中文文档

规范地址：https://npmcn.com/package/%40bildit-platform/template-parser/

版本：0\.1\.0
npm 元数据更新时间：2026-10-26T15:18:11.243Z
中文译文更新时间：2026-11-08T05:34:01.257Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40bildit-platform/template-parser
原文对照：https://npmcn.com/package/%40bildit-platform/template-parser/?lang=original

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

- 包体积（解压后）：414 kB，94 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-03-06T14:14:39.524Z
- 最新版本发布：2026-10-26T15:18:10.743Z
- 近 30 天下载量：1890（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

基于Lezer的BILDIT模板表达式和组元数据解析器.

## 安装

```sh
npm install @bildit-platform/template-parser
```

也可以使用：`pnpm add @bildit-platform/template-parser`、`yarn add @bildit-platform/template-parser`、`bun add @bildit-platform/template-parser`

## README

# @ bildit- platform/ template- parser (英语)

BILDIT旗下模板的解析器和变压器.

## 出口

| 入境点 | 模板语法 |
| --- | --- |
| `@bildit-platform/template-parser/v1` | `$(name:Type=default;option=value)` 用勒泽语法解析的表达式 |
| `@bildit-platform/template-parser/v2` | JSDoc附加说明的声明,以模板标出 `// @template v2` |

没有根导出; 从 `/v1` 或者说 `/v2`。 。 。 .

## v1 使用量

```ts
import { parseTemplateMetadata, transformTemplate } from '@bildit-platform/template-parser/v1'

const metadata = parseTemplateMetadata('const title = $(title:String="Hello")')
const code = transformTemplate('const title = $(title:String="Hello")', { title: 'Hi' })
```

## v2 用途

```ts
import { isV2Template, parseTemplateMetadata, transformTemplate } from '@bildit-platform/template-parser/v2'

const source = `// @template v2
/**
 * Headline shown at the top of the banner.
 * @type String
 * @mutates content
 */
const title = $(title:String="Hello")
`

isV2Template(source) // true (marker in the first 10 lines, or metadata with `mutates`)

const metadata = parseTemplateMetadata(source)
// [{ name: 'title', type: 'String', defaultValue: 'Hello', mutates: [{ property: null, attribute: 'content' }], ... }]

const replaced = transformTemplate(source, 'jsx', [{ ...metadata[0], value: 'Hi' }])
// ... const title = "Hi"
```

-   `isV2Template(code, metadata?)`数字 : `code` 可以是字符串或字符串 `{ raw }` 代码对象.
-   `transformTemplate(code, codeType, metadata, components?)`数字 : `codeType: 'html'` 输出未引用的值. `components` 是一个 `Map` 用于注入的已公布组件名称 `Component` 字段。 当字段宣布无效时抛出 `@mutates` 属性.

V2 执行匹配 bildit- cms API(`replace-template-values-v2.js`, (中文(简体) ), `parseMetadataV2.js`, (中文(简体) ), `is-v2-syntax.js`) (中文(简体) ). 见 `src/v2/parity.test.js`。 。 。 .

## 构建( Rollup)

```bash
pnpm --filter @bildit-platform/template-parser build
```

构建输出向 `dist/`,保留了1个无害环境管理和1个CJS树模块:

-   `dist/esm/v1.js`, (中文(简体) ), `dist/esm/v2.js`无害环境管理的切入点`import`(中文(简体) )
-   `dist/cjs/v1.js`, (中文(简体) ), `dist/cjs/v2.js`CJS : 切入点(`require`(中文(简体) )
-   `dist/esm/v1/index.d.ts`, (中文(简体) ), `dist/esm/v2/index.d.ts`: 声明类型

## 运行专用测试

测试对已建 `dist/` 输出, 所以先构建 :

```bash
pnpm --filter @bildit-platform/template-parser build
pnpm --filter @bildit-platform/template-parser test
```

## 语法更改后再生成解析器

```bash
pnpm --filter @bildit-platform/template-parser run build:parser
```

## 发布

```bash
pnpm --filter @bildit-platform/template-parser publish --access public
```

## 常见问题

### @bildit-platform/template-parser 是什么？

基于Lezer的BILDIT模板表达式和组元数据解析器\.

### 如何安装 @bildit-platform/template-parser？

在项目目录运行 npm install @bildit-platform/template-parser，或使用 pnpm add / yarn add / bun add。

### @bildit-platform/template-parser 支持 TypeScript 吗？

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

### @bildit-platform/template-parser 支持 ESM 还是 CommonJS？

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

### @bildit-platform/template-parser 可以商用吗？

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

### @bildit-platform/template-parser 的下载量有多少？

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

### @bildit-platform/template-parser 还在维护吗？

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