Atomの設定をGitHub経由で同期する「sync-settings」

高機能テキストエディタAtomは、パッケージをインストールすることで様々な機能を拡張することができます。

ここで、複数のPCを所有していて、それぞれに入っているAtomに同じ設定をしたい場合があります。

そんな時にいちいち同じパッケージをインストールしたりするのは面倒です。

そこで今回は、Atomの設定をGitHub経由で同期する方法を紹介していきたいと思います。

準備するもの

• Atom
• GitHubアカウント（Gistを使用します）

※GitHubアカウントの作成方法についての説明は省略します。

ちなみにAtomのインストール方法については以下の記事を参考にしてみてください（Windows10、Ubuntu、LinuxMint等で参考になると思います）

LinuxMintにAtomをインストール→日本語化まで

Windows10にAtomをインストール

同期準備

sync-settingsパッケージインストール

まずはAtomでsync-settingsパッケージをインストールします。

メニューバーから[編集]→[環境設定]を選択します。

「sync-settings」で検索し、インストールします。

しかし、ここでインストールが完了すると警告メッセージが表示されます。

パーソナルアクセストークンやGistIDが必要みたいです。

ちなみにsync-settingsの設定画面の表示方法は、Packagesからsync-settingsを探し、「Settings」をクリックします。

設定画面では、下の画像のようにパーソナルアクセストークンやGistIDを入力する箇所があります。

パーソナルアクセストークンやGistIDを取得したら、ここに入力することになります。

というわけでこれらを取得していきます。

パーソナルアクセストークン取得

そして、ページ下部にある「Generate token」ボタンをクリックします。

すると、下のような画面が表示されるので、赤で囲っているボタンをクリックしてIDをコピーします（この画面は二度と表示できないみたいなので必ずコピーしてください）

コピーしたIDをsync-settingsの設定画面の赤で囲っている箇所に入力します。

GistID取得

Create a new Gistのページにアクセスし、GistIDを取得します。

ファイル名も内容も適当なものを入力します。

入力できたら「Create public gist」ボタンを押します。

（非公開にしたい場合は「Create secret gist」をクリックします）

表示された画面のURLに着目します。

URLは「https://gist.github.com/ユーザ名/XXXXX」のようになっているはずです。

このユーザ名の後の「XXXXX」の部分がGistIDになります。

ということで、この「XXXXX」の部分をコピーして、下の画面（sync-settingsの設定画面）の赤で囲っている箇所に貼り付けます。

長かったですが、準備はとりあえず終わりました。

次は共有方法です。

Atom設定共有方法

GistにAtom設定をアップロード

「Ctrl + Shift + p」でコマンドパレットを開き、「sync」と入力します。

下の画面のように候補が出てくるので「Sync Settings: Backup」を選択します。

しばらくすると、以下のようなアップロード成功メッセージが表示されます。

これでアップロードは完了です。

GistからAtom設定をダウンロード

Atom設定を共有したいPC（共有先PC）では、前節と同様の手順でsync-settingsをインストールし、すでに取得しているパーソナルアクセストークンやGistIDを入力します。

「Ctrl + Shift + p」でコマンドパレットを開き、「sync」と入力します。

下の画面のように候補が出てくるので「Sync Settings: Restore」を選択します。

下の画像のような表示になれば、あとは完了するのを待つだけです。

（ちなみに私の場合、共有元PCはLinuxMint、共有先PCはWindowsです）

青色のメッセージが全て消えれば同期完了です。