できない.dev

VSCode の Format on Save が効かない

editor.formatOnSave が有効でも既定フォーマッタが設定されていないか競合する拡張があると保存時の整形が走らない。
言語ごとの defaultFormatter を明示し、Prettier 等を導入する。

公開: 更新:

要約

保存時の整形が走らない原因は、フォーマッタが選ばれていないか、拡張機能の競合で別のフォーマッタが優先されているかのどちらかである。
editor.formatOnSave を有効化したうえで 言語ごとの editor.defaultFormatter を明示すれば、9 割は片付く。

解決策

1. 設定を明示する

.vscode/settings.json:

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode"
}

ワークスペース設定はユーザ設定より優先される。
チームで揃えるならリポジトリにコミットする。

2. 言語ごとに切り分ける

{
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }
}

言語ごとに既定フォーマッタを指定するのは、公式の Formatting ドキュメント(新しいタブで開く) でも案内されている正攻法である。

3. 実際に走るフォーマッタを確認

Ctrl+Shift+P から Format Document With... を実行すると、現在のファイルで使えるフォーマッタ一覧と既定値が表示される。
期待外のものが既定なら歯車から差し替える。

4. ESLint と Prettier を分離する

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  }
}

codeActionsOnSave は保存時アクション、formatOnSave はフォーマット整形と役割が違う。
両方有効にする場合は ESLint で lint fix → Prettier で整形の順に流れる。

よくある原因

  1. formatOnSave 自体がオフになっている。
    ユーザ設定で true にしていても、ワークスペース設定が false で上書きしている。
  2. defaultFormatter が無いか、剥がれている。
    Prettier 拡張を入れ直したときや、別 PC と同期したときに設定が消える。
  3. 言語スコープで上書きしている。
    [typescript] / [json] で別のフォーマッタを指定していると、想定とずれる。
  4. 保存時アクションの順序がぶつかっている。
    editor.codeActionsOnSave の ESLint fixAll と Prettier が両方走り、結果が上書きされる。