SuperAPI AI 工具集

codegen

编程与开发

查看项目

更新于 10-16 07:30

技能介绍

@json-render/codegen 是一组与框架无关的实用工具,用于从 json-render 的 UI 树(spec)中生成代码。可以用它来构建面向 Next.js、Remix 或其他框架的自定义代码导出器。

用途

该包面向需要从 json-render UI 规格生成代码的开发者,通常用于以下场景:根据 UI spec 生成代码、构建自定义的代码导出器、遍历 spec、或为 props 做序列化。

安装

npm install @json-render/codegen

主要能力

树遍历

可以从包中导入 traverseSpec、collectUsedComponents、collectStatePaths、collectActions:

  • traverseSpec(spec, callback):按深度优先遍历 spec,回调参数为 element、key、depth、parent。
  • collectUsedComponents(spec):返回所有使用到的组件类型,示例返回 Set { "Card", "Metric", "Button" }。
  • collectStatePaths(spec):返回所有被引用的状态路径,示例返回 Set { "analytics/revenue", "user/name" }。
  • collectActions(spec):返回所有动作名称,示例返回 Set { "submit_form", "refresh_data" }。

序列化

可以导入 serializePropValue、serializeProps、escapeString 以及 SerializeOptions 类型:

  • serializePropValue("hello") 返回 { value: '"hello"', needsBraces: false }。
  • serializePropValue({ $state: "/user/name" }) 返回 { value: '{ $state: "/user/name" }', needsBraces: true }。
  • serializeProps({ title: "Dashboard", columns: 3, disabled: true }) 返回 'title="Dashboard" columns={3} disabled'。
  • escapeString('hello "world"') 返回 'hello "world"'。

SerializeOptions 接口包含两个可选字段:quotes("single" | "double")与 indent(number)。

类型

可以导入 GeneratedFile 与 CodeGenerator 类型。示例中的 CodeGenerator 实现包含 generate(spec) 方法,返回文件数组,每项含 path 与 content,例如 app/page.tsx 与 package.json。

使用方式:构建自定义生成器

示例展示了如何组合使用这些工具:导入 collectUsedComponents、collectStatePaths、traverseSpec、serializeProps 以及 GeneratedFile 类型,并从 @json-render/core 导入 Spec 类型;定义 generateNextJSProject(spec: Spec): GeneratedFile[] 函数,内部收集组件后生成 package.json、组件文件、主页面等文件并返回。

适用场景

适合需要自行编写代码导出逻辑的开发者,例如把 json-render 的界面规格转换为 Next.js 或 Remix 项目文件,或在此基础上实现其他框架的导出器。

限制

资料中未提供该包的具体版本、许可协议、运行时依赖要求、对各框架的官方适配说明,也未提供收费、价格或性能相关的信息,这些内容暂未提供。