Posted at

VScodeの設定共有(SettingSync)


概要

拡張の機能 "SettingSync" を利用することで、VScodeの設定を複数の端末で共有できる。

ただいくつかの点で躓いた 1ので、手順をまとめておいた。


必要なもの


  • GitHubアカウント

  • SettingSync (VScode拡張機能)

SettingSyncは、アップロード側・ダウンロード側の両方にインストールする。


設定手順

VScodeにSettingSyncをインストールし、GitHubアカウントを準備した段階から始める。


準備1


  1. VScode上で Alt+Shift+Uでアップロードをする。

  2. 下記のGitHubのページに飛ばされるので、tokenの説明(例:VScode設定共有など)とgistにチェックを入力。Githubpage.png

  3. ページにあるGenerate tokenをクリック。

  4. 生成されたtokenをテキストファイルなどに保存する。tokenpage.png


アップロード


  1. VScodeへ戻り、tokenを入力

  2. アップロード情報が出力され、Doneが表示されれば完了。


準備2


  1. https://gist.github.com/ユーザー名 に行くとcloudSettingsがあるので選択。ない場合はアップロードに失敗している。無題2.png


  2. cloudSettingsのURLの最後の文字列がGistIDなので保存する。https://gist.github.com/ユーザー名/"この部分がGistID"



ダウンロード


  1. ダウンロードしたいVScodeへ移動して、Alt+Shift+Dでダウンロードする。

  2. tokenとGistIDを入力するとダウンロードが始まる。Done表示で完了。


tokenとGistIDの変更をしたい場合

設定時のミスやtokenの再生成など行った場合は下記のファイルのjsonを変更すること。

詳細はSettingSyncのページを参照のこと。


tokenの変更



  1. Ctrl+Shift+Pでコマンドパレットを開いてSyncと入力。


  2. Advanced Optionsを選択し、続けてEdit Extension Local SettingssyncLocalSettings.jsonを開く。


  3. "token":~の部分を変更する。


GitsIDの変更



  1. setting.jsonを開く。


  2. "sync.gist":~の部分を変更する。


参考にさせていただいたサイト

VSCode の設定を同期する「Settings Sync」を使ってみた

Settings Syncの設定方法(Gist IDってなんやねん)





  1. GistIDとGithubのアカウント名を混同して設定をしてしまった。