WindowsでVisual Studio Codeの設定や拡張機能を一括でバックアップ&リストアする

WindowsでVisual Studio Codeの設定や拡張機能を一括でバックアップ&リストアする

開発環境を買い替えたり、チーム内で VSCode の設定をシェアしたい時の設定同期のやり方

拡張機能の「Setting Sync」が使える環境の人はそちらを使ったほうがおすすめ

今回は設定ファイルのみをそこそこ手軽にバックアップして、リストアしたいときの方法

やり方

Windows の場合、設定を合わせるなら

  • C:\Users\ユーザー名\AppData\Roaming\Code\User\settings.json
  • C:\Users\ユーザー名.vscode\extensions

の上記ファイルとディレクトリをコピーすればいいらしい

settings.json はそのままコピーして、拡張機能はコマンドラインから行うようにしてみる

任意のディレクトリに vscode_backup.bat みたいなファイルを作って、下記内容を記述する

vscode_backup.bat

copy %APPDATA%\Code\User\settings.json .\settings.json
code --list-extensions >> vscode_extensions.txt

上記内容を保存したらクリックして実行してみると、

  • settings.json
  • vscode_extensions.txt

の 2 ファイルができていると思うので、次に vscode_restore.bat みたいなファイル名でファイルを作って、下記内容を記述する

vscode_restore.bat

copy /Y .\settings.json %APPDATA%\Code\User\settings.json
for /f %%n in (vscode_extensions.txt) do (
    code --install-extension %%n
)

上記内容を保存したら、バックアップ時にできた 2 ファイルがあるディレクトリと同じディレクトリで実行すると、拡張機能のインストールと、settings.json の上書きが行われる

他のプラットフォームでも同じように使いたい場合は適宜コマンドの修正が必要(※結局 Setting Sync が使えるに越したこと無い)