VS Codeのワークスペース機能を使い始めて開発効率が上がった話
VS Codeをお使いのみなさん、下記のような悩みをお持ちの方はいらっしゃいますか?
「複数のブランチで開発をしていて、タブが多くなり見通しが悪い」
「作業ブランチ毎に関連ファイルを開くのが手間に感じる」
私はこのような悩みを抱えていたのですが、VS Codeのワークスペース機能を使うことで、これらの手間が激減しました。
最近知ったばかりではありますが、私なりのVS Codeのワークスペース機能の使い方とおすすめの設定をご紹介します。
やりかた
Step1. ワークスペースを開く
まず、コマンドパレットを開き、 Duplicate Workspace in New Window を選択します。
すると、新しくVS Codeのウィンドウが起動します。
Step2. ワークスペースを保存する
次に、メニューバーのファイルタブから、「名前をつけてワークスペースを保存」を押し、任意の名前をつけて .code-workspace 拡張子のファイルを保存します。
おすすめのファイル名は、作業ブランチ名と合わせることです。こうすることで、ワークスペースのファイル名と作業ブランチ名と一対一対応するので、どのワークスペースファイルが何のために存在しているかが明確になるためです。
Step3. 保存したワークスペースを開く
保存したワークスペースを開く際は、下記の2通り存在します。
ターミナルから開く場合は、codeコマンドと組み合わせることでVS Codeの起動とワークスペースを開くのをコマンド一発で可能です。
code example.code-workspace
すでにVS Codeが起動している場合は、メニューバーのファイルタブから「ファイルでワークスペースを開く」から保存した.code-workspace拡張子のファイルを選択することでも可能です。
参考: https://code.visualstudio.com/docs/editor/workspaces
おすすめのGitの設定
このワークスペース機能を使うと、.code-workspaceのファイルが量産されます。Gitでリポジトリを管理している場合、このファイルの差分が発生するため、コミットしないようGitの設定を修正するのがおすすめです。
まず、素直に .gitignore に下記のように定義する方法があります。
# .gitignore
*.code-workspace
しかし、 .gitignore はプロジェクト固有のファイルを無視するための設定ファイルのため、個人の設定を反映すべきではない場合が存在します。
そんなときは、.git/info/excludeファイルに設定を追記しましょう。
# ./git/info/exclude
*.code-workspace
これで、Gitの管理下から指定の拡張子のファイルを自動的に外すことができ、コミット時のストレスが軽減するはずです。
Discussion