Visual Studio Codeでタブ幅とインデントを設定する方法

VS Codeの設定でEditor: Tab Sizeを変更すると、タブ幅を指定できます。Editor: Insert Spacesはインデントに空白を使うかを決め、Editor: Detect Indentationは開いたファイルのインデントを優先するための設定です。既存の文字は別の操作で変換します。

タブ幅と挿入する文字の違い

editor.tabSizeはタブ間隔を列数で指定します。インデント幅も既定ではこの値に従います。editor.indentSizeに別の数値を指定すると変わる場合があります。

editor.insertSpacesをオンにすると空白、オフにするとタブ文字でインデントします。すでに入力されている文字はそのままです。

ユーザーまたはワークスペースの既定値を設定する

  1. コマンドパレットでPreferences: Open Settings (UI)を実行します。個人の既定値はUser、開いているプロジェクトだけならWorkspaceを選びます。
  2. editor.tabSizeを検索して2にします。空白を使うプロジェクトではeditor.insertSpacesをオンにします。
  3. 既存のファイルにも同じ設定を適用する必要があればeditor.detectIndentationをオフにします。ファイルを開き直し、ステータスバーのSpaces: 2を確認します。

単一フォルダーのワークスペースでは、以下の項目を.vscode/settings.jsonに追加できます。外側の波括弧は一組にし、同じキーがあれば値を更新します。

{
  "editor.tabSize": 2,
  "editor.insertSpaces": true,
  "editor.detectIndentation": false
}

例ではプロジェクト内で空白二つを使い、自動検出をオフにします。試す前に設定値を控え、戻すときは変更した値だけを復元するか、追加したキーを削除します。

現在のファイルの設定と変換

  1. ステータスバーのSpacesまたはTab Sizeをクリックします。Indent Using SpacesかIndent Using Tabsを選び、現在のファイルで新しく入れるインデントの幅を選択します。
  2. 既存の行頭を変更するにはConvert Indentation to SpacesまたはConvert Indentation to Tabsを選びます。コピーで試し、確認後に対象ファイルへ適用して保存します。
  3. editor.renderWhitespaceを一時的にallにすると、タブと空白の違いを確認できます。確認後は元に戻します。

たとえば、行頭にタブが一つあるreturn 1;をタブ幅2で空白に変換すると、行頭が空白二つになります。

MicrosoftのVS Codeインデントガイド

設定が反映されないときの確認

まずステータスバーを確認します。自動検出が有効なら、ファイルのインデントが既定値より優先されます。無効でも値が違う場合は、Workspaceや[javascript]などの言語別設定、editor.indentSizeを確認します。

保存時にだけ変わる場合は、プロジェクトのフォーマッター設定を確認します。エディターとは異なる規則を使っている可能性があります。

VS Code設定の優先順位