【IntelliJ IDEA】ソースコードを保存したときにローカルでの変更箇所のみフォーマットする方法

やりたいこと

cmd + s を押下したときに、以下を一括で実行できるようにしたい

• 不要なimport文を削除
• import文の順序を整理
• リポジトリにチェックインしていない変更箇所のみ
• コードを保存する

環境

• IntelliJ IDEA 2020.1.2 (Ultimate Edition)
• macOS 10.15.4

方法

フォーマットの設定

cmd + opt + shift + l を押下して「Reformat File dialog」を表示
Scopeを「Only VCS changed text」に設定して、Optionalの「Optimize imports」をチェックして、「Run」を押下

「Only VCS changed text」はバージョン管理されているプロジェクトかつローカルに変更がある場合のみ設定できるので、グレーアウトされている場合は、バージョン管理されているプロジェクトかどうか、ローカルに変更があるかどうかを確認する。

macroの登録

Editor -> Macros -> Start Macro Recordingを押下して、その後以下を実行

• cmd + shift + l (reformat file)
• cmd + s (save All)

Editor -> Macros -> Stop Macro Recordingを押下、その後、macroに名前をつけて保存

Keymapの設定

Preferences -> Keymap -> Macros -> 保存したmacroをクリック -> Add Keyboard Shortcut
「cmd + s」を入力してOK