Atomの設定同期(sync-settings)

この記事は...

エディタソフトAtomの設定を複数端末で同期するプラグイン sync-stettingsの導入手順の備忘録。記事執筆時点(2017年5月5日)での情報となります。

バージョン情報

• Atom 1.16.0
• sync-settings 0.8.1

導入手順

必要なモノ

• Atom
• sync-setting(プラグイン)
• GitHubアカウント

インストール

1. sync-settingのインストール
   • Atomのパッケージ管理画面よりsync-settingsをインストール

設定

1. Atomからsync-settingsの設定画面を開く
2. アクセストークン発行 (GitHub)
   • settings -> Developer setting -> Personal access tokens
   • 右上の Generate new token
   • scopeはgist のみで発行(Token descriptionはAtom sync-settings とか？)
3. トークンを登録(sync-settings)
   • sync-settings -> setting ->Personal Accses Token(一番上の欄)へ先ほど発行されたトークンをコピー
4. 新規gist作成(GitHub)
   • New gist画面へ
   • 本文にダミーの文字を打ち込み(空では作成できない)、gistを作成(Create secret gistがいいかな？¹)
5. gist IDの登録(sync-settings)
   • gistの個別ページ(遷移先ページ)からgist IDをコピー(URLの”ユーザーネーム”/の後の英数字文字列)
   • sync-settings -> setting ->Gist ID(2番目の欄)へ先ほどのgist IDをペースト

1. Open Sync Settings configuration in Atom Settings.
2. Create a new personal access token which has the gist scope and be sure to activate permissions: Gist -> create gists.
3. Copy the access token to Sync Settings configuration.
4. Create a new gist and save it.
5. Copy the gist id (last part of url after the username) to Sync Settings configuration.

使い方

バックアップ(アップロード)

二通り

• コマンドパレット(Ctrl + Shift + P(Win) / Cmd + Shift + P(Mac))より、Sync Setting:Buckupコマンド
• メニューバー -> Packages -> Syncronize Settings -> Buckup

完了後、Atomに通知が出るはずです。

レストア(ダウンロード)

二通り

• コマンドパレット(Ctrl + Shift + P(Win) / Cmd + Shift + P(Mac))より、Sync Setting:Restoreコマンド
• メニューバー -> Packages -> Syncronize Settings -> Restor

完了後、Atomに通知が出るはずです。設定の反映は再起動してみてください。

アップデートチェック

二通り

• コマンドパレット(Ctrl + Shift + P(Win) / Cmd + Shift + P(Mac))より、Sync Setting:Check Buckupコマンド
• メニューバー -> Packages -> Syncronize Settings -> Check for update buckup

完了後、Atomに通知が出るはずです。

補足

1．環境設定の中に同期したくない項目がある
Blacklisted keys を利用する。gistに保存されるsetting.jsonから対応するキーを確認し、Blacklisted keysに記入する。ネストされたキーは「.」でつなぎ(e.g. core.projectHome)、複数項目は「,」で並べて記述する。
ただし、この設定はアップロード対象から除外されるもので、ダウンロードはgist上のものが強制的に上書きされるため、注意が必要。初回アップロードの前に記述するか、gistから直接削除するなどで対策する。

---

---

1. Github Gists are by default public. If you don't want other people to easily find your gist (i.e. if you use certain packages, storing auth-tokens, a malicious party could abuse them), you should make sure to create a secret gist. ↩