mcpField
P
project-scaffolder

project-scaffolder

github.com/patricio0312rev开发63275 次安装41 周前更新
代码仓库

关于 project-scaffolder

project-scaffolder 是面向开发者的技能,可为多种指定技术栈生成起始仓库,涵盖项目结构、基础代码和设置文档。

主要功能

  1. 01选择技术栈并匹配模板
  2. 02生成目录结构与基础代码
  3. 03配置工具和包管理文件
  4. 04生成常用脚本与 README
  5. 05可选添加 Docker 和 CI 模板

适用场景

  1. 01启动 Next.js 或 FastAPI 项目
  2. 02创建已配置代码检查与格式化的起始项目
  3. 03准备带设置说明的仓库

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/patricio0312rev/skills --skill project-scaffolder

安装后在 Claude Code 中输入/project-scaffolder确认已加载。

附带文件references/templates.md

详细介绍

项目脚手架生成器

使用适用于任何技术栈的最佳实践规范,生成可用于生产环境的入门仓库。

核心工作流

  1. 确定技术栈:询问用户指定技术栈,或根据上下文推断(Next.js、Vite、Nest、FastAPI 等)
  2. 选择模板:使用 references/templates.md 选择合适的项目结构
  3. 生成结构:创建完整的文件夹树和所有必要文件
  4. 添加基础代码:加入可运行的“hello world”路由/页面作为概念验证
  5. 配置工具:添加 package.json/requirements.txt、tsconfig、lint 配置和格式化配置
  6. 创建脚本:包含 dev、build、test 和部署脚本
  7. 编写设置文档:生成全面的 README,包含设置步骤和后续操作

主要交付内容

每个生成脚手架的项目都必须包含:

  • 文件夹树:结构清晰的 src/、lib/、config/、tests/ 目录结构
  • 基础代码:可运行的 hello world 端点或页面
  • 包文件:package.json、requirements.txt、Cargo.toml 等
  • 配置:TypeScript、ESLint、Prettier 和环境文件(.env.example)
  • 脚本:用于常见任务的 npm 脚本或 Makefile
  • README:设置说明、技术栈概览和后续步骤
  • Git 设置:针对该技术栈配置的 .gitignore

特定技术栈模式

各技术栈的详细模式请参阅 references/templates.md:

  • Next.js App Router
  • Vite + React
  • NestJS
  • FastAPI
  • Express + TypeScript
  • Vue + Vite
  • SvelteKit

最佳实践

  • 在支持的情况下使用绝对导入(@/ 别名)
  • 包含环境变量模板
  • 添加基本错误处理和日志设置
  • 在 tsconfig 中配置路径映射
  • 可选:添加用于容器化的 Docker 文件
  • 可选:添加 GitHub Actions 或 CI 工作流模板

渐进式增强

从最小可行结构开始,然后添加:

  • 数据库设置(Prisma、TypeORM、SQLAlchemy)
  • 身份验证脚手架(NextAuth、Passport、JWT)
  • API 客户端设置(Axios、Fetch 封装)
  • 状态管理(Zustand、Redux、Pinia)
  • 测试设置(Jest、Vitest、Pytest)

输出结构

先展示完整的项目树,然后在正确位置创建所有文件。始终说明创建了哪些内容,以及运行项目的后续步骤。

评论

支持 Markdown