mcpField
P
project-setup

project-setup

github.com/ratacat开发5846 次安装37 周前更新
代码仓库

关于 project-setup

指导团队配置类型检查、代码检查、格式化、测试、提交前检查和 CI 的项目设置技能。提供 Python 与 TypeScript 参考，并建议现有项目按步骤渐进迁移。

主要功能

  1. 01按语言提供配置指导
  2. 02规划类型检查、代码检查与格式化
  3. 03测试和提交前检查实践
  4. 04CI 与质量检查清单
  5. 05渐进式迁移指导

适用场景

  1. 01搭建新的软件项目
  2. 02统一 Python 或 TypeScript 检查
  3. 03添加测试和提交前钩子
  4. 04逐步完善现有项目的检查流程

安装

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

$npx skills add https://github.com/ratacat/claude-skills --skill project-setup

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

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

reference/
common-patterns.md
python.md
typescript.md

详细介绍

项目设置

核心原则

  • 强类型：启用严格模式；类型可在编译时捕获错误
  • 严格 lint：默认采用严格规则；禁用规则比之后添加规则更容易
  • 自动格式化：自动且一致；无需手动格式化
  • 各阶段均执行检查：提交前钩子 + CI；及早发现问题
  • 测试与代码同目录：foo.ts → foo.test.ts；测试内容一目了然
  • 聚焦行为：测试代码的行为，而非实现方式；仅模拟外部边界

工作流

  1. 查看 reference/ 中的语言指南（Python、TypeScript）
  2. 如果没有指南：WebSearch "[language] project setup best practices"
  3. 按以下顺序进行设置：类型检查 → lint → 格式化 → 测试 → 提交前检查 → CI
  4. 对于现有项目：按相同顺序逐步迁移

参考文件

  • reference/python.md - uv、ruff、basedpyright、pytest
  • reference/typescript.md - pnpm、ESLint、Prettier、Vitest
  • reference/common-patterns.md - 测试理念、CI 模式、安全

工具选择

优先选择符合以下条件的工具：生态标准、维护活跃、默认严格、速度快、集成良好（编辑器 + CI + 提交前检查）。

质量检查清单

  • 类型检查：采用最严格模式；未经说明不得使用 any
  • lint：严格规则，将警告视为错误
  • 格式化：保存时自动格式化 + 提交前格式化
  • 测试：测试与代码同目录，覆盖率 >80%
  • 提交前检查：格式化、lint、类型检查
  • CI：执行相同检查 + 覆盖率报告
  • README：设置说明
  • 首次提交时所有检查均通过

评论

支持 Markdown