mcpField
P
project-setup

project-setup

github.com/ratacat開発5846 回インストール37 週間前に更新
リポジトリ

project-setup について

型チェック、Lint、フォーマット、テスト、コミット前チェック、CI の設定を案内するプロジェクトセットアップスキルです。Python と TypeScript のリファレンスを備え、既存プロジェクトでは段階的な移行を推奨します。

主な機能

  1. 01言語別のセットアップガイド
  2. 02型チェック・Lint・フォーマットの手順
  3. 03テストとコミット前チェックの実践
  4. 04CI と品質チェックリスト
  5. 05段階的な移行ガイド

活用シーン

  1. 01新しいソフトウェアプロジェクトの構築
  2. 02Python または 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

詳細

プロジェクトのセットアップ

基本原則

  • 厳格な型付け:strict モードを有効にし、コンパイル時に型でバグを検出します
  • 厳格なリント:デフォルトで厳格なルールを適用します。後から追加するより無効にするほうが簡単です
  • 自動フォーマット:自動化して一貫性を保ち、手動でのフォーマットは不要にします
  • 各段階でチェック:コミット前フックと CI を活用し、問題を早期に検出します
  • テストをコードの近くに配置:foo.ts → foo.test.ts とし、テスト対象を明確にします
  • 動作を重視:コードの仕組みではなく動作をテストし、外部との境界のみをモックします

ワークフロー

  1. 言語ガイド(Python、TypeScript)を reference/ で確認します
  2. ガイドがない場合は、WebSearch で「[language] project setup best practices」を検索します
  3. セットアップは次の順に進めます:型付け → リント → フォーマット → テスト → コミット前チェック → CI
  4. 既存のプロジェクトでは、同じ順序で段階的に移行します

リファレンスファイル

  • reference/python.md - uv、ruff、basedpyright、pytest
  • reference/typescript.md - pnpm、ESLint、Prettier、Vitest
  • reference/common-patterns.md - テストの考え方、CI パターン、セキュリティ

ツールの選定

エコシステムの標準であり、積極的にメンテナンスされ、デフォルトで厳格、高速で、エディター・CI・コミット前チェックとの連携に優れたツールを優先します。

品質チェックリスト

  • 型付け:最も厳格なモードを使用し、正当な理由なく any を使わない
  • リント:厳格なルールを適用し、警告をエラーとして扱う
  • フォーマット:保存時の自動フォーマットとコミット前チェックを設定する
  • テスト:テストをコードの近くに配置し、カバレッジを 80% 超にする
  • コミット前チェック:フォーマット、リント、型チェックを実施する
  • CI:同じチェックとカバレッジレポートを実施する
  • README:セットアップ手順を記載する
  • 初回のコミットですべてのチェックに合格する

コメント