VSCodeのユーザー設定、ワークスペース設定、デフォルト設定のかんたん解説

RuboCopをインストールしてコマンドを実行するために、設定を記述しようとした時のこと。

「なんかSettingいっぱいある。。。」
どうやら、VSCodeには設定を行う場所として「User」、「Workspace」、そして「Default」の3種類があるようです。それぞれの設定の違いについて簡単にまとめてみました。

1. User Settings (ユーザー設定)

ユーザー設定は、VSCode全体に適用される設定です。複数のプロジェクトにまたがって適用されます。一般的な設定を行う場合に使用します。

場所	適用範囲
settings.json (ユーザー設定)	全プロジェクト

使用例:

setting.json

{
  "editor.formatOnSave": true,
  "ruby.format": "rubocop"
}

2. Workspace Settings (ワークスペース設定)

特定のプロジェクト（ワークスペース）にのみ適用される設定です。
プロジェクトごとに異なる設定を行いたい場合に使用します。

場所	適用範囲
.vscode/settings.json (ワークスペース設定)	現在開いているプロジェクト

使用例:

setting.json

{
  "editor.formatOnSave": true,
  "ruby.format": "rubocop"
}

3. Default Settings (デフォルト設定)

デフォルト設定は、VSCodeの初期設定です。
これらの設定は変更できませんが、ユーザー設定やワークスペース設定で上書きすることができます。

場所	適用範囲
VSCode内部（settings.jsonには表示されない）	VSCodeの初期設定

ユーザーが直接編集することはできません。

推奨される設定方法

基本的には、ユーザー設定（User Settings）に行うことをお勧めします。 これにより、すべてのプロジェクトに対して一貫した設定が適用されます。特定のプロジェクトに対して異なる設定が必要な場合は、そのプロジェクトのワークスペース設定（Workspace Settings）を使用します。

ユーザー設定の手順

1. コマンドパレットを開くCtrl + Shift + P または Cmd + Shift + P
2. 「Preferences: Open User Settings (JSON)」 を選択。
3. 開いたsettings.jsonに設定を追加。
   ワークスペース設定の手順
   プロジェクトのルートディレクトリに .vscode フォルダを作成。
   .vscode フォルダ内に settings.json ファイルを作成。
   settings.json に設定を追加。

{
  "editor.formatOnSave": true,
  "ruby.format": "rubocop"
}