SKILL.md
readonly只读
name
codegen
description
用于 json-render 的代码生成工具。在根据 UI 规范生成代码、构建自定义代码导出器、遍历规范或为 @json-render/codegen 序列化属性时使用。
@json-render/codegen
与框架无关的工具,用于从 json-render UI 树生成代码。使用这些工具为 Next.js、Remix 或其他框架构建自定义代码导出器。
安装
npm install @json-render/codegen
树遍历
import {
traverseSpec,
collectUsedComponents,
collectStatePaths,
collectActions,
} from "@json-render/codegen";
// 深度优先遍历规范
traverseSpec(spec, (element, key, depth, parent) => {
console.log(`${" ".repeat(depth * 2)}${key}: ${element.type}`);
});
// 获取所有使用的组件类型
const components = collectUsedComponents(spec);
// Set { "Card", "Metric", "Button" }
// 获取所有引用的状态路径
const statePaths = collectStatePaths(spec);
// Set { "analytics/revenue", "user/name" }
// 获取所有操作名称
const actions = collectActions(spec);
// Set { "submit_form", "refresh_data" }
序列化
import {
serializePropValue,
serializeProps,
escapeString,
type SerializeOptions,
} from "@json-render/codegen";
// 序列化单个值
serializePropValue("hello");
// { value: '"hello"', needsBraces: false }
serializePropValue({ $state: "/user/name" });
// { value: '{ $state: "/user/name" }', needsBraces: true }
// 序列化 JSX 的属性
serializeProps({ title: "Dashboard", columns: 3, disabled: true });
// 'title="Dashboard" columns={3} disabled'
// 转义字符串中的代码
escapeString('hello "world"');
// 'hello \"world\"'
SerializeOptions
interface SerializeOptions {
quotes?: "single" | "double";
indent?: number;
}
类型
import type { GeneratedFile, CodeGenerator } from "@json-render/codegen";
const myGenerator: CodeGenerator = {
generate(spec) {
return [
{ path: "package.json", content: "..." },
{ path: "app/page.tsx", content: "..." },
];
},
};
构建自定义生成器
import {
collectUsedComponents,
collectStatePaths,
traverseSpec,
serializeProps,
type GeneratedFile,
} from "@json-render/codegen";
import type { Spec } from "@json-render/core";
export function generateNextJSProject(spec: Spec): GeneratedFile[] {
const files: GeneratedFile[] = [];
const components = collectUsedComponents(spec);
// 生成 package.json、组件文件、主页面...
return files;
}






