@bildit-platform/template-parser

中文文档
0.1.0发布于 2026/10/26ISCTypeScriptESM + CJS近 30 天下载 1890

Lezer-based parser for BILDIT template expressions and group metadata.

原始使用文档
文档目录7 节
  1. Exports
  2. v1 usage
  3. v2 usage
  4. Build (Rollup)
  5. Run dedicated tests
  6. Regenerate parser after grammar changes
  7. Publish

@bildit-platform/template-parser

Parsers and transformers for BILDIT banner templates.

Exports

Entry pointTemplate syntax
@bildit-platform/template-parser/v1$(name:Type=default;option=value) expressions, parsed with a Lezer grammar
@bildit-platform/template-parser/v2JSDoc-annotated declarations in templates marked with // @template v2

There is no root export; import from /v1 or /v2.

v1 usage

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 usage

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 can be a string or a { raw } code object.
  • transformTemplate(code, codeType, metadata, components?): codeType: 'html' emits unquoted values. components is a Map of published components by name, used to inject Component fields. Throws when a field declares an invalid @mutates attribute.

The v2 implementation matches the bildit-cms API (replace-template-values-v2.js, parseMetadataV2.js, is-v2-syntax.js). See src/v2/parity.test.js.

Build (Rollup)

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

Build output is emitted to dist/, one ESM and one CJS tree with modules preserved:

  • dist/esm/v1.js, dist/esm/v2.js: ESM entry points (import)
  • dist/cjs/v1.js, dist/cjs/v2.js: CJS entry points (require)
  • dist/esm/v1/index.d.ts, dist/esm/v2/index.d.ts: type declarations

Run dedicated tests

Tests run against the built dist/ output, so build first:

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

Regenerate parser after grammar changes

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

Publish

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

版本与发布记录

@bildit-platform/template-parser 共发布 15 个版本,首次发布于 2026/03/06;过去 12 个月发布了 15 个版本。

版本发布日期距今
0.1.0latest2026/10/2612 天前
0.0.152026/06/045 个月前
0.0.142026/05/285 个月前
0.0.132026/05/125 个月前
0.0.122026/04/306 个月前
0.0.112026/04/286 个月前

关于 @bildit-platform/template-parser 的常见问题

@bildit-platform/template-parser 是什么?

Lezer-based parser for BILDIT template expressions and group metadata.

如何安装 @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 和提交记录判断。