なにができるの？
sync-settingsはAtomの設定をクラウド(GitHub)経由で同期します。
(Windows8.1や10～Mac間で動作することを確認しています)
以下のものが同期されるようです。
- 初期化スクリプト
- インストールしたパッケージ
- パッケージの設定
- キーマップ
- スニペット
(バージョン0.4.0では正しく動作しない模様)v0.6.0で同期を確認
執筆時点('15/6/16)では、同期は手動操作で実行します。（自動同期はロードマップには含まれているようです）
('16/02/05)v0.6.0では更新のチェックが行われるようです。詳しくは記事の後ろのほうに追記しました。
確認した環境
この記事はWindows8.1、MacOSX10、sync-setting v0.4.0で確認しております。
（'16/2/5に更新された内容についてはWindows10、sync-setting v0.6.0で再確認しました）
導入
準備するもの
GitHubのgistを経由しているため、GitHubのアカウントが必須になります。
インストール方法
Atomの設定画面からパッケージsync-settingsをインストールします。
またはコマンドラインよりapm install sync-settingsを実行します。
設定方法
- GitHubのNew Personal access token画面からアクセストークンを作成します。Select scopesは
gistのみチェックを入れれば動くことを確認しています - 作成されたトークンをコピーし、Atomの
sync-settingsの設定画面のPersonal Access Tokenにペーストします - GitHubのnew gist画面を開き、(空では作成できないため)適当なテキストを入力のうえ
Create secret Gistボタンを押します。 - 上の操作で遷移した画面のURLからgistのID("ユーザー名/"の後に続く英数字部分)をコピーし、Atomの
sync-settings設定画面のGist idにペーストします。
同期の実行
設定のバックアップ（アップロード）方法
設定をバックアップ（アップロード）するには、以下のいずれかを実行します
-
Ctrl-Alt-U(Win,Mac共通)押下 -
Ctrl+Shift+P(Win)/Cmd-Shift-P(Mac) 押下でコマンドパレットを表示したうえ、Sync Settings: Backupを実行 - メニューバーの
Packages > Synchronize Settings > Backupを実行
アップロードが完了すると、Atom上に通知が表示されるかと思います。
先の手順で作成したGistを開くと、アップロードされた設定を確認することができます。
（先の手順で作成したダミーファイルはもう不要なので消していいです）
設定のリストア（ダウンロード）方法
Gistにバックアップしている環境設定を、別環境にダウンロードして設定反映する方法になります。
リストア（ダウンロード）は環境によってはAtomがしばらく固まってしまう場合もあるようなので、なんの作業も行っていない時に行った方がよさそうです。
設定をリストアするには、以下のいずれかを実行します
-
Ctrl-Alt-D(Win,Mac共通)押下 -
Ctrl+Shift+P(Win)/Cmd-Shift-P(Mac) 押下でコマンドパレットを表示したうえ、Sync Settings: Restoreを実行 - メニューバーの
Packages > Synchronize Settings > Restoreを実行
しばらく待っていると、Atom上に通知が表示されるはずです。
通知完了後、Atomを再起動して設定画面を開けば、設定やパッケージが同期されていることが確認できるかと思います。
Atom起動時のバックアップ更新確認
Atom起動時にgistのバックアップの確認が行われ、更新されている場合には以下のダイアログが表示されます。
sync-settings: Your settings are out of date.
[Backup] [View backup] [Restore] [Dismiss]
- [Backup] バックアップを行う（サーバの設定は上書きされます）
- [View backup] gistのページを開く。ダイアログは開かれたまま。
- [Restore] リストアを行う
- [Dismiss] 無視してダイアログを閉じる。（次回のAtom起動時に再びダイアログが表示される）
(v0.6.0)「Check of update backup」が動作しない件
v0.6.0時点において、「Check of update backup」メニューは私の環境では動作している様子がありませんでした。
コマンドパレットにSync Settings: Check of update backupが存在しなかったことから、未実装かバグが疑われます。
注意点
- フォント設定も同期されてしまうため、同期先のマシンに存在しないフォント設定にされてしまう恐れがあります。フォントを入れるなりフォント複数指定するなりの対応が考えられます。
- Atom正規の方法以外でインストールしたパッケージ(例. pronama-chan)は、さすがに設定同期後に自動インストールされたりはしません。設定そのものは同期されているので、手動でパッケージをインストールしておけば同期の恩恵は受けられます。
-
執筆時のバージョン(追記 '16/02/05)0.4.0では、スニペットのダウンロード先が誤っており(正:snippets.cson → 誤:snippets.coffee)、正しく動作していませんでした。v0.6.0で正常動作を確認しています
残件
- Gistを作成するためにダミーテキストを使用していますが、もっといい手段があるかも？
（追記 2016/02/05）
更新が遅れてしまいましたが、v0.6.0より「Upload」「Download」がそれぞれ「Backup」「Restore」と名称変更されていましたので、記事本文を修正しました。
M-ISO様、コメント指摘ありがとうございました。
また、スニペットの同期が正常に行われるようになっていたのを確認し、Atom起動時にバックアップ更新確認が行われるようになっておりましたので、そちらの内容も修正および追記しました。