SuperAPI AI 工具集

scaffold

编程与开发

查看项目

更新于 10-13 17:06

技能介绍

用途

Scaffold 用于为新项目生成脚手架与样板代码,提供常见项目类型的最佳实践默认配置。它通过决策树和选择矩阵,帮助开发者确定语言、框架、数据库、ORM/查询层与部署目标的组合。

主要能力

  • 项目类型决策树:覆盖 API / 后端服务(REST、GraphQL、gRPC)、Web 应用(SSR 全栈、SPA、静态站点)、CLI 工具、库/包、Monorepo 五大类,并为每类列出可选语言与框架。
  • 技术栈选择矩阵:按项目类型列出语言、框架、数据库、ORM/查询、部署目标。
  • 快速脚手架命令:提供 Python(uv + FastAPI)、Node.js(create-next-app、Vite)、Go(go mod + Gin)、Rust(cargo + clap)、Monorepo(create-turbo)等初始化命令。
  • 目录结构模板:给出 FastAPI、Express/Fastify、Next.js App Router、Python Typer、Go Cobra、npm 包、PyPI 包、Turborepo + pnpm、Cargo Workspaces 的完整目录结构示例。
  • 配置文件模板:包含 .editorconfig、pyproject.toml、strict 模式 tsconfig.json 示例。
  • 初始化检查清单:涵盖版本控制、CI/CD、Docker、代码质量、测试、编辑器配置、文档。
  • 常见陷阱表:列出问题、产生原因与预防方式。

使用方式

根据决策树判断项目类型,参照选择矩阵确定技术栈,运行对应的脚手架命令生成基础结构,再按目录结构模板补齐分层,最后对照检查清单补充配置与文档。

提供的命令示例包括:

# FastAPI with uv
mkdir my-api && cd my-api
uv init --python 3.12
uv add fastapi uvicorn sqlalchemy alembic psycopg2-binary pydantic-settings
uv add --dev pytest pytest-asyncio httpx ruff mypy
# Next.js 14+
npx create-next-app@latest my-app --typescript --tailwind --eslint --app --src-dir --import-alias "@/*"
# Go
mkdir my-api && cd my-api
go mod init github.com/user/my-api
go get github.com/gin-gonic/gin
go get github.com/jmoiron/sqlx
go get github.com/lib/pq
# Rust CLI
cargo init my-cli
cd my-cli
cargo add clap --features derive
cargo add serde --features derive
cargo add anyhow tokio --features tokio/full
# Monorepo (Turborepo)
npx create-turbo@latest my-monorepo

适用场景

  • 新建后端 API、Web 应用、CLI 工具、库/包或 Monorepo 时快速获得标准结构。
  • 团队统一目录分层、配置与质量工具约定。
  • 对照检查清单避免遗漏 .env.example、锁文件、健康检查端点等常见项。

组合与限制

可与 docker-ops、ci-cd-ops、testing-ops、python-env、typescript-ops 等技能组合,分别处理容器、流水线、测试、环境与类型配置。参考文件包括 references/api-templates.md、references/frontend-templates.md、references/tooling-templates.md。

本文档为脚手架指南,未提供收费、价格、平台依赖或运行效果保证等信息;具体命令能否执行取决于本地环境,相关说明暂未提供。