VScodeの設定共有（SettingSync）

概要

拡張の機能 "SettingSync" を利用することで、VScodeの設定を複数の端末で共有できる。
ただいくつかの点で躓いた ¹ので、手順をまとめておいた。

2021/1/19追記
設定共有が公式の機能として提供されています！
これから設定される方は次の記事を参考にどうぞ

• Setting Sync in Visual Studio Code (公式ドキュメント)
• Visual Studio Code公式の設定同期を利用する

2019/12/9追記
設定方法が変更されてこの記事の内容よりも簡単になりました！
これから設定される方は次の記事を参考にどうぞ

• 【最新版】VSCodeの設定を共有しよう【Settings Sync】

必要なもの

• GitHubアカウント
• SettingSync (VScode拡張機能)

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

設定手順

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

準備１

1. VScode上で Alt+Shift+Uでアップロードをする。
2. GitHubのページに飛ばされるので、tokenの説明(例:VScode設定共有など)とgistにチェックを入力。
3. ページ下にあるGenerate tokenをクリック。
4. 生成されたtokenをテキストファイルなどに保存する。

アップロード

1. VScodeへ戻り、tokenを入力
2. アップロード情報が出力され、Doneが表示されれば完了。

準備２

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

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 SettingsでsyncLocalSettings.jsonを開く。
3. "token":~の部分を変更する。

GitsIDの変更

1. setting.jsonを開く。
2. "sync.gist":~の部分を変更する。

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

VSCode の設定を同期する「Settings Sync」を使ってみた
Settings Syncの設定方法（Gist IDってなんやねん）

---

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