← 中文资源

简体中文版本

构建脚手架代码生成 CLI

构建脚手架代码生成 CLI:完整覆盖 project scaffolding,含 Template loader、Variable prompt 与测试的端到端实现。

阅读英文原文

项目概述

本项目实现一个面向 project scaffolding 的完整系统,核心要解决的问题是 generating a runnable project skeleton from a template so new services start consistent。整体由 Template loader、Variable prompt、File renderer、Hook runner、Output writer 五个模块组成,每个模块单一职责、可独立测试,最后通过集成测试验证端到端正确性。设计上把 a template that hardcodes a path and generates files outside the target directory 作为第一类需求先行处理,而非事后再补。

架构与关键决策

数据模型为 a template tree of files with placeholder variables, rendered with user-supplied values and post-processed by hooks。Template loader 定义其余阶段共同依赖的数据形状并在边界处校验输入;Variable prompt 承载 project scaffolding 的正确性逻辑;File renderer 专门处理 a template that hardcodes a path and generates files outside the target directory,在失败路径上给出明确的拒绝、重试或降级策略;Hook runner 提供可观测性,每次操作输出带关联 id 的结构化事件;Output writer 在过载时按既定方式降级,避免过载演变为数据损坏。配置与代码分离,使风险变更可经 diff 审阅。

实施与测试

按五个阶段依次实现 Template loader、Variable prompt、File renderer、Hook runner、Output writer,每阶段配套聚焦单测。集成测试组合各模块并驱动真实 project scaffolding 场景:先验证正常路径,再刻意触发 a template that hardcodes a path and generates files outside the target directory 并断言系统降级而非损坏。所有依赖均在进程内或被桩替换,用例在 CI 中确定可复现。

限制与后续

  • 单区域设计,多区域复制超出范围。
  • Template loader 默认进程内,未水平共享。
  • 无鉴权层,假定部署在强制身份的边缘之后。

代码示例

# setup for scaffold-codegen-cli
pnpm init
pnpm add commander ejs glob
pnpm add -D typescript tsx vitest
scaffold_codegen_cli/
├── src/index.ts
├── src/template-loader.ts
├── src/variable-prompt.ts
├── tests/scaffold_codegen_cli.test.ts
└── package.json
// Template loader: project scaffolding core
export function templateloader(input: TemplateloaderInput): TemplateloaderResult {
  // Build the template loader that anchors project scaffolding and defines the core data shape.
  return processTemplateloader(input);
}
// Variable prompt — handles project scaffolding Add the variable prompt so
export class Variableprompt {
  constructor(private opts: VariablepromptOptions) {}
  async run(ctx: Context): Promise<VariablepromptOutput> {
    return this.execute(ctx);
  }
}
// File renderer: project scaffolding stage
export const filerenderer = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};
// Hook runner for project scaffolding
export async function hookrunner(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}
// Output writer: project scaffolding finalization
export function outputwriter(state: State): Result {
  validate(state);
  return finalize(state);
}
# run the project scaffolding test suite
pnpm vitest run