框架脚手架搭建Skill

项目脚手架的搭建规范(结构、依赖、配置分离)。当新项目起步需要搭建工程骨架、依赖管理、多环境配置时使用。

Sky-Cube e15a77a 1.6 KB Updated

File contents

框架脚手架搭建Skill

适用场景

新项目/新服务起步,搭建可直接进入业务开发的工程骨架。

执行步骤

  1. 确定技术栈与构建工具(Maven/Gradle/pnpm/vite 等),锁定版本策略。
  2. 建立标准目录结构:按语言生态惯例 + 分层约定(Controller/Service/DAO 或 routes/services)。
  3. 配置依赖:核心依赖 + 版本统一管理(BOM/workspace 锁文件)。
  4. 配置分离:application-{env} / .env.{env},密钥一律走环境变量,不入仓库。
  5. 补齐基础件:统一响应包装、全局异常处理、日志、健康检查、配置读取。
  6. 输出启动说明与开发规范入口(README 引导)。

规范要点

  • 目录结构一次定好,后续不轻易变更;按职责分层,禁止所有代码堆一个包。
  • 依赖版本锁定,禁止使用模糊版本范围(如 ^1.0.0 改精确版本或锁文件兜底)。
  • 日志统一框架与格式(含 traceId 传递),禁止 System.out 散落打印。
  • 全局异常处理器必须兜底,返回统一错误结构,不泄露堆栈给客户端。
  • 脚手架自带健康检查端点与基础监控埋点。

输出模板

## 目录结构(树形 + 各目录职责)
## 依赖清单(名称/版本/用途)
## 配置说明(每项中文说明,敏感项标注来源)
## 启动方式

自检清单

  • 目录结构分层清晰
  • 依赖版本锁定
  • 密钥与代码分离
  • 统一异常/响应/日志三件套就绪
  • 启动说明完整

Sky-Cube/fullflow-dev-agent/tree/main/.claude/skills/scaffold-setup commit e15a77ab17

Frequently asked questions

npx skillmds@latest add sky-cube/skill-11