プラグイン Settings Syncで設定やスニペットファイルのバックアップを取る

Visual Studio Codeでファイルやスニペットファイルのバックアップが取れるプラグイン Settings Sync の使い方をご紹介します。

このプラグインはGithubのGist(コードスニペットなどを管理するサービス)を利用しており、VSCodeの設定ファイルなどをGistにバックアップ(保管)、もしくはリストア(復元)することができます。

Settings Sync [Visual Studio Code – Marketplace]

こんなシチュエーションで使える

  • 複数台のマシンで設定を共有したい
  • パソコンまたはVSCodeをクリーンインストールしたが、以前の設定を復元したい

プラグインの導入とバックアップされるもの

まずはプラグインをインストールしましょう。

拡張機能の画面で「Settings Sync」で検索します。

このプラグインでバックアップが取れるファイルは以下のとおりです。

  • 設定ファイル
  • キーボードショートカット
  • Launch ファイル(デバッグ等で使用するファイル)
  • 各種スニペット
  • 拡張機能と拡張機能設定ファイル
  • ワークスペースフォルダ

これ以外にも自分で指定した任意のファイルをバックアップに含めることもできます(後述)

Githubにてトークンを発行

まずGithubのアカウントが必要になるので、事前に取得しておいてください。

Github右上のアカウントの欄からSettings を選択します。

Gistの性質上、有料プランでない限りファイルが誰でも閲覧できてしまうので、導入は考えてからにしましょう。

設定ファイルは当人にしか関係のないものなので、見られても大丈夫だと思いますが、一応気に留めておきましょう。

次にDevelopers settings ページへ移動します。

次にPersonal access tokensページへ移動し、ページ右上のGenerate new tokenボタンをクリックします。

メール認証が必要な場合があるので、その場合はメールをチェックし認証を行ってください。

再びPersonal access tokensのページへ移動し、各種設定を行います。

  • Token description : 任意でトークンの用途などを簡潔に書いておけばOK
  • gist : チェックを入れる

設定は以上で最後にGenerate tokenボタンをクリックしてください。

次の画面でトークンが表示されるので、コピーします。

バックアップ

VSCodeに戻りバックアップを実行してみましょう。

コマンドパレット(Ctrl + Shift + Pで起動)で「sync」と検索し、[Sync : 設定をアップロード]という項目を選択してください。

初回はGithubの個人アクセストークンの入力を求められるので、コピーしたトークンを貼り付けてください。

設定は以上で、アップロードが開始されます。

出力パネルにバックアップの詳細が出力され、最後に「Done.」の表記が出たら完了です。

設定を変更したら自動でアップロードする

手動で同期するのが面倒くさいという方は自動アップロードがおすすめです。

Ctrl(Cmd) + Shift + Pでコマンドパレットを立ち上げ、「Sync」と検索したら、[Sync : 詳細なオプション]を選択します。

次のコマンドで[設定変更時の自動アップロード ON / OFF 切り替え]を選択してください。

以上で自動同期が可能となります。

設定のダウンロード

coming soon…

おまけ: Settings syncの設定ファイルも同期するw