Visual Studio Code(VS Code)-エディタ設定の完全ガイド

1. はじめに:VS Code設定の重要性

Visual Studio Code(VS Code)は、軽量でありながら強力な機能を持つエディタとして、世界中の開発者に愛用されています。しかし、その真価を発揮するためには、自身の開発スタイルやプロジェクトの要件に合わせてエディタ設定を適切にカスタマイズすることが不可欠です。

本ガイドでは、VS Codeの基本的な設定方法から、生産性を高めるための必須設定、チーム開発で役立つワークスペース設定、さらには複数デバイス間での設定同期の方法までを、完全に解説します。


2. 設定画面へのアクセス方法

VS Codeの設定は、主にGUI(グラフィカルユーザーインターフェース)とJSONファイル(settings.json)の2つの方法で編集できます。

2-1. GUIによる設定(推奨)

初心者の方や設定項目を検索しながら変更したい場合に最も推奨される方法です。

  1. 設定画面を開く:
    • 左下のアクティビティバーにある**歯車アイコン(管理)**をクリックし、「設定」を選択します。
    • または、ショートカットキーを使用します。
      • Windows / Linux: Ctrl + ,
      • Mac: Cmd + ,
  2. 設定の検索:
    • 開いた設定タブの検索バーに、変更したい設定のキーワード(例: autosavefont size)を入力して絞り込みます。

2-2. JSONファイル(settings.json)による設定

より細かく、テキストベースで設定を管理したい場合に利用します。

  1. GUIの設定画面の右上にある「設定を開く(JSON)」アイコン({ }のマーク)をクリックすると、現在のユーザー設定が記述された settings.json ファイルが開きます。
  2. このファイルに直接JSON形式で設定を記述することで、GUIでは設定できない隠れたオプションを含め、すべての設定を編集できます。

3. 基本設定:開発効率を向上させる必須項目

ここでは、すべての開発者におすすめする、生産性を高めるための重要な設定項目を紹介します。

設定項目settings.jsonでのプロパティ推奨設定と効果
自動保存files.autoSaveafterDelay または onWindowChange
コード編集後の保存忘れを防ぎ、常に最新の状態で実行・コミットできるようにします。
保存時の自動整形editor.formatOnSavetrue (有効)。
ファイルを保存するたびに、設定されたフォーマッター(Prettierなど)がコードを自動的に整形し、コードスタイルを統一します。
インデントスタイルeditor.insertSpaces
editor.tabSize
true(スペースを使用)、4または2(タブ幅)。
プロジェクトのコーディング規約に合わせます。ほとんどのWeb開発ではスペース2または4が主流です。
空白文字の可視化editor.renderWhitespaceboundary または all
スペース、タブ、改行などの見えない文字を記号で表示し、インデントミスや不要な末尾の空白を防ぎます。
括弧の対応線editor.guides.bracketPairstrue (有効)。
対応する括弧を線で結び、ネストが深いコードの可読性を大幅に向上させます。
フォントサイズeditor.fontSize1416 程度。
長時間作業しても目が疲れない適切なサイズに調整します。
ミニマップeditor.minimap.enabledfalse(無効)に設定する開発者もいます。
右側に表示されるコード全体のプレビューです。画面を広く使いたい場合は無効にすると良いでしょう。

【settings.jsonでの記述例】

JSON

{
    // 自動保存を1000ms(1秒)後に行う
    "files.autoSave": "afterDelay",
    "files.autoSaveDelay": 1000,
    
    // ファイル保存時にコードを自動整形
    "editor.formatOnSave": true,
    
    // インデントはスペースを使用し、幅は2に設定
    "editor.insertSpaces": true,
    "editor.tabSize": 2,
    
    // 空白文字を可視化(単語間の単一スペースを除く)
    "editor.renderWhitespace": "boundary",
    
    // 括弧のガイドラインを有効化
    "editor.guides.bracketPairs": true,
    
    // フォントサイズの設定
    "editor.fontSize": 15,
    
    // ミニマップを無効化
    "editor.minimap.enabled": false
}

4. 設定の適用範囲:ユーザー設定 vs. ワークスペース設定

VS Codeの設定には、適用範囲の異なる2つのレベルがあります。これらを理解することで、個人環境とチーム環境を適切に分離できます。

4-1. ユーザー設定(大域的設定)

  • 適用範囲: ユーザーが使用するすべてのVS Codeウィンドウ、すべてのプロジェクトに適用されます。
  • 用途: テーマ、フォント、キーバインド、エディタ全体の挙動など、個人の好みに関する設定。
  • 保存場所: OSごとの設定ファイル(settings.json

4-2. ワークスペース設定(プロジェクト固有の設定)

  • 適用範囲: 特定のフォルダ(プロジェクト)を開いている間のみ適用されます。
  • 用途: チーム開発におけるプロジェクト固有のコーディング規約(インデント幅、フォーマッターの設定、特定の拡張機能の有効/無効)など。
  • 保存場所: プロジェクトフォルダ内の .vscode/settings.json

💡 設定の優先度

ワークスペース設定は、ユーザー設定よりも優先されます。

プロジェクトに合わせたワークスペース設定を用意することで、ユーザーが個人の設定を変えなくても、そのプロジェクトを開いた時だけ自動的に規約通りの環境に切り替えることができます。


5. 環境の同期:Settings Syncの活用

複数のPCやOS(Windows, Mac, Linux)でVS Codeを使用する場合、設定や拡張機能を手動で統一するのは手間がかかります。VS Codeに標準搭載されている**設定の同期(Settings Sync)**機能を使えば、この問題を解決できます。

5-1. 設定の同期で同期できる項目

以下の項目が、GitHubアカウントまたはMicrosoftアカウントを介してクラウドに保存・同期されます。

  • 設定 (settings.jsonの内容)
  • キーボードショートカット
  • 拡張機能
  • UIの状態(テーマ、サイドバーの配置など)
  • ユーザースニペット

5-2. 同期設定の手順

  1. サインイン:
    • VS Codeの左下の**歯車アイコン(管理)**をクリックし、「設定の同期をオンにする」を選択します。
  2. 項目選択とサインイン:
    • 同期したい項目(通常はすべて)にチェックを入れ、「サインインしてオンにする」をクリックします。
    • 「GitHubでサインイン」または「Microsoftでサインイン」を選択し、ブラウザで認証を完了させます。
  3. 同期の開始:
    • 認証が完了すると、設定がクラウドにアップロードされます。
  4. 同期先のPCでの設定:
    • 別のPCでVS Codeを起動し、同様に「設定の同期をオンにする」を選択します。
    • 同じアカウントでサインインすることで、自動的に以前の設定と拡張機能がダウンロードされ、環境が統一されます。

6. まとめ

VS Codeのカスタマイズは、開発効率を向上させるための重要なステップです。

  • まずは自動保存保存時の自動整形などの基本設定を有効化しましょう。
  • プロジェクトごとに環境を統一したい場合は、.vscode/settings.jsonワークスペース設定を記述しましょう。
  • 複数のデバイスを使う場合は、Settings Syncを活用して常に最新の環境を維持しましょう。

これらの設定をマスターし、快適で効率的な開発環境を構築してください。