| name | ruff-linter |
| description | Pythonコードのリンタ、フォーマッタ、コードレビュー。Pythonファイル(.py)を編集・作成・修正した後に必ず実行する。ruffによる品質チェックとフォーマット、さらにコードレビューを行い問題があれば修正する。 |
Python コード品質チェック
Pythonコード修正後に実行する品質チェックとレビューのワークフロー。
必須ワークフロー
Pythonファイルを編集した後、以下を順番に実行：
1. フォーマット適用
uv run ruff format .
2. リンタ実行と自動修正
uv run ruff check --fix .
3. 残りのリンタエラー確認
uv run ruff check .
エラーがあれば手動で修正。
4. コードレビュー
変更したコードを確認し、以下の観点でレビュー：
- 可読性: 変数名・関数名は適切か
- ロジック: バグや edge case の見落としはないか
- セキュリティ: インジェクション等の脆弱性はないか
- パフォーマンス: 非効率な処理はないか
- テスト: テストが必要な変更か
問題があれば修正し、再度 1〜3 を実行。
コマンドリファレンス
| コマンド | 用途 |
|---|---|
uv run ruff format . |
フォーマット適用 |
uv run ruff format --check . |
フォーマット確認のみ |
uv run ruff check . |
リンタ実行 |
uv run ruff check --fix . |
リンタ + 自動修正 |
CI/CD
PRチェックでは以下を実行：
uv run ruff format --check .
uv run ruff check .