mcpField
P
project-scaffold

project-scaffold

github.com/shipshitdev开发38113 次安装2 天前更新
代码仓库

关于 project-scaffold

project-scaffold 是用于创建新项目或为现有项目添加组件的脚手架技能。它可按需生成 AI 文档、NestJS 后端、NextJS 前端、Expo 移动端和 Plasmo 扩展,并支持单体仓库或独立仓库布局。

主要功能

  1. 01生成 AI 文档目录
  2. 02创建 NestJS 后端组件
  3. 03创建 NextJS 前端组件
  4. 04创建 Expo 移动端组件
  5. 05创建 Plasmo 浏览器扩展
  6. 06支持单体仓库和独立仓库

适用场景

  1. 01搭建新的全栈项目
  2. 02为现有项目添加前端或后端
  3. 03选择单体仓库或独立仓库结构

安装

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

$npx skills add https://github.com/shipshitdev/skills --skill project-scaffold

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

附带文件plugin.jsonscripts/scaffold.py

详细介绍

项目脚手架

用于创建新项目或向现有项目添加组件的统一项目脚手架工具。

用途

此技能提供统一的脚手架搭建方式,用于创建:

  • 用于 AI 优先开发的 .agents/ 文件夹结构
  • 使用 MongoDB、Swagger 和最佳实践的后端(NestJS)
  • 使用 Tailwind 和 @agenticindiedev/ui 的前端(NextJS)
  • 使用 React Native 和 Expo Router 的移动端应用(Expo)
  • 使用 React 和 Tailwind 的浏览器扩展(Plasmo)

适用场景

在以下情况下使用此技能:

  • 从零开始启动新项目
  • 向现有项目添加组件
  • 设置单体仓库或独立仓库
  • 需要在 Claude、Codex 和 Cursor 之间获得统一的脚手架搭建体验

用法

交互模式(推荐)
python3 scripts/scaffold.py

脚本会询问你:

  1. 项目名称
  2. 项目根路径
  3. 仓库结构(单体仓库或独立仓库)
  4. 要搭建的组件(均为可选):
    • .agent 文件夹
    • 后端(NestJS)
    • 前端(NextJS)
    • 移动端应用(Expo)
    • 扩展程序(Plasmo)
  5. 组织名称(用于单体仓库中的包)
在 Claude 中使用

用户请求搭建脚手架时,激活此技能并运行:

python3 scripts/scaffold.py

脚本会处理所有交互式提示。

功能

灵活的结构
  • 单体仓库:所有组件都在一个仓库中,并配置好工作区
  • 独立仓库:每个组件都位于自己的目录/仓库中
  • 现有项目:可向现有项目添加组件
组件选项

所有组件均为可选项——只搭建你需要的部分:

  • .agents/ 文件夹,包含完整的 AI 文档结构
  • 使用 NestJS、MongoDB 和 Swagger 的后端
  • 使用 NextJS 15、Tailwind 和 @agenticindiedev/ui 的前端
  • 使用 Expo Router 和 React Native 的移动端应用
  • 使用 Plasmo、React 和 Tailwind 的扩展程序
跨平台

可通过以下工具使用:

  • Claude Code
  • Codex
  • Cursor

生成的结构

单体仓库示例
myproject/
├── .agents/                  # AI documentation
├── package.json             # Workspace root
├── api/                     # NestJS backend
│   ├── .agents/
│   ├── apps/api/src/
│   └── package.json
├── frontend/                # NextJS apps
│   ├── .agents/
│   ├── apps/dashboard/
│   └── package.json
├── mobile/                  # Expo app
│   ├── .agents/
│   ├── app/
│   └── package.json
└── extension/               # Plasmo extension
    ├── .agents/
    ├── src/
    └── package.json
独立仓库示例
myproject-api/               # Backend only
├── .agents/
├── apps/api/src/
└── package.json

myproject-frontend/          # Frontend only
├── .agents/
├── apps/dashboard/
└── package.json

包含的关键模式

后端(NestJS)
  • 软删除:isDeleted: boolean
  • 多租户:始终按 organization 筛选
  • 集合模式:控制器 → 服务 → 模式
  • Swagger 文档
  • 包含 Dockerfile
前端(NextJS)
  • 路径别名:@components/、@services/、@hooks/
  • 使用 @agenticindiedev/ui 的 Tailwind CSS
  • TypeScript 严格模式
  • App Router 结构
移动端应用(Expo)
  • 使用 Expo Router 进行导航
  • TypeScript 配置
  • 平台专属配置
扩展程序(Plasmo)
  • React + TypeScript
  • 使用 @agenticindiedev/ui 的 Tailwind CSS
  • Manifest 配置
  • 弹出窗口组件

脚手架搭建后的后续步骤

  1. 安装依赖项:

    cd [project-root]
    bun install
    
  2. 启动开发:

    # Monorepo
    bun run dev:api
    bun run dev:frontend
    
    # Separate repos
    cd api && bun run start:dev
    cd frontend && bun run dev
    
  3. 自定义:

    • 根据你的编码规范更新 .agents/SYSTEM/RULES.md
    • 配置环境变量
    • 添加你的第一个功能

与现有技能集成

此技能集成了:

  • agent-folder-init:使用其脚本搭建 .agent 文件夹
  • fullstack-workspace-init:复用组件模板和模式

故障排除

找不到脚本:确保技能已安装在 ``

权限被拒绝:使脚本可执行:chmod +x scripts/scaffold.py

找不到 Python:确保已安装 Python 3,且其位于 PATH 中

未创建 Agent 文件夹:脚本会尝试使用 agent-folder-init 技能。若未找到,则会跳过 .agent 文件夹的创建。

评论

支持 Markdown