【要約】VS CodeでPythonにRuffを入れたら保存時の整形がかなり楽だった [Zenn_Python] | Summary by TechDistill
> Source: Zenn_Python
Execute Primary Source
// Problem
Python開発において、コードの品質維持とレビューの効率化が課題となる。開発者が個別に整形を行うと、以下のような問題が発生する。
- ・未使用のimport文が残存し、コードの可読性を下げる。
- ・importの順序がバラバラになり、差分（diff）がノイズとなる。
- ・関数定義の改行位置などが個人に依存し、チーム内でスタイルが不一致になる。
// Approach
開発者は、VS Codeの拡張機能とワークスペース設定を活用して、自動整形環境を構築する。具体的には以下のステップを実施する。
- ・VS CodeにAstral Software製のRuff拡張機能をインストールする。
- ・.vscode/settings.jsonを作成し、以下の設定を記述する。
1."editor.defaultFormatter": "charliermarsh.ruff"
2."editor.formatOnSave": true
3."source.fixAll.ruff": "explicit"
4."source.organizeImports.ruff": "explicit"
5."ruff.lineLength": 100
- ・作成した.vscode/settings.jsonをGit管理下に置き、チーム全体で共有する。
// Result
この導入により、保存操作のみでコードの最適化が完結する。開発者およびチーム全体に以下の改善をもたらした。
- ・未使用importの自動削除と、import順の整理が自動で行われる。
- ・関数定義や改行位置が適切なスタイルに整う。
- ・PR（プルリクエスト）におけるフォーマット差分のノイズが大幅に減少する。
- ・チーム全員が同一の整形ルールを適用でき、コードの統一性が向上する。
Senior Engineer Insight
> 開発体験（DX）の向上とレビューコストの削減を両立する、極めて実戦的な手法である。Ruffの高速性は、保存時の待ち時間を最小化し、開発フローを阻害しない。重要なのは、設定を「個人の好み」と「プロジェクトの規約」に切り分け、後者のみをGit管理することだ。これにより、エディタの差異による不毛な議論を回避できる。大規模開発においても、CIでのチェックと併用することで、極めて堅牢なコード品質を維持できるだろう。