テストコマンド - Hol1kgmg/link-list-share-app GitHub Wiki
テストコマンド
このドキュメントでは、プロジェクトで使用可能なテストコマンドについて説明します。
ESLint
コードの品質を保つために、ESLintを使用してコードの静的解析を行います。
コンテナの起動
まず、Dockerコンテナを起動します:
docker compose up -d
ESLintの実行
Dockerコンテナ内で以下のコマンドを実行します:
docker compose exec frontend npm run lint
GitHub Actionsでの自動実行
プルリクエストが作成された際に、自動的にESLintチェックが実行されます。 チェックは以下の条件で実行されます:
main
ブランチへのプルリクエスト- フロントエンドのコード(
frontend/**
)が変更された場合 - ワークフローファイル(
.github/workflows/**
)が変更された場合
テスト結果の確認
成功時
✔ No ESLint warnings or errors
エラー時
エラーが発生した場合は、以下のような形式でエラー内容が表示されます:
./components/toppage/markdown-preview.tsx
14:15 Error: 'node' is defined but never used. @typescript-eslint/no-unused-vars
トラブルシューティング
依存関係の更新が必要な場合
docker compose exec frontend npm install
コンテナの再起動が必要な場合
docker compose down
docker compose up -d
コンテナのログを確認する場合
docker compose logs frontend
注意事項
- ESLintの設定は
frontend/.eslintrc.json
で管理されています - 特定のルールを無効化する必要がある場合は、該当するファイルの該当行にコメントを追加してください
- チーム全体で一貫したコードスタイルを維持するため、ESLintの警告やエラーは可能な限り修正してください
- すべてのコマンドはDockerコンテナ内で実行されます