HTMLPAGE Logo

代码规范

作者:HTMLPAGE
发布日期:2025-11-26
待分类

遵循业界最佳实践,生成符合规范的高质量代码

代码规范是保证生成内容可维护、可读与安全的基础。对于代码生成器与模板系统,建议从语法、样式与工程约定三方面建立规范。

核心要素

  • 代码格式:统一使用 Prettier/ESLint 在 CI 中强制格式化与语法校验。
  • 类型与契约:对输出 API 与模板上下文使用 TypeScript 类型描述,减少运行时错误。
  • 安全约束:在生成的代码中限制危险 API(如直接 eval)、对用户输入进行严格转义与校验。

工程实践

  • 在生成流水线中加入静态检查(lint、typecheck)、单元与集成测试,确保模板模板输出符合预期。
  • 对第三方依赖使用白名单并定期审计,避免把不受信任的包引入生成结果中。

发布与回滚策略

  • 为生成模板与导出包打版本号,并保留可回滚的历史快照以应对紧急修复。

相关链接:

微信中可直接分享当前页面