🐕

Gitを汚さずにVSCodeの設定を保存する

に公開
VS Code
tech

VSCode(Visual Studio Code)では設定でいろいろカスタマイズすることができます。
しかし、単純に設定変更するとプロジェクトディレクトリ内に設定ファイルが保存されGitにコミットされてしまいます。複数人で開発する場合は他の人にも反映されてしまって困ります。

プロジェクトディレクトリだけに設定を反映する方法をまとめます。

ワークスペースとは

VSCodeでは複数ディレクトリをまとめたワークスペースを作成することができます。
ワークスペースごとに設定を保存できるので、これを利用します。

ワークスペースの作成

プロジェクトディレクトリを開く

VSCodeでワークスペースを作成するには、まず通常通りプロジェクトディレクトリを開きます。

ワークスペースを保存

ファイルメニュー -> 名前をつけてワークスペースを保存から、ワークスペースの実態として1ファイル(***.code-workspace)をプロジェクトディレクトリ外に保存します。

/
├─ sample.code-workspace // ワークスペースファイル
└─ sample_project_dir    // プロジェクトディレクトリ
   ├─ src
   │  └─ ...
   ├─ .git
   └─ ...

保存すると、エクスプローラーペインのディレクトリ名称に(ワークスペース)と追記されます。

設定変更

設定を開き、ワークスペースタブを選択してから設定を変更します。
設定自体は、上記で作成したワークスペースファイルに保存されます。

ワークスペースの利用

設定保存後、次回起動時はワークスペースファイルをVSCodeで開けば設定が反映された状態で利用できます。

まとめ

VSCodeでGit履歴に保存せず設定を変更するにはワークスペースを利用します。設定は任意の場所に保存するファイルに記載されるため、Gitに反映されることはありません。

Discussion