Sublime Textエディタの設定を複数PC環境で同期させる方法

Sublime Textは、パッケージを入れることにより、自分に合った環境を作ることができる自由度の高いエディターです。

やろうと思えば使用制限もないに等しく無料で自由に使えます。また、購入したとしても、個人1人で利用するならば、仕事利用であったとしても複数環境にインストールして利用しても良いという太っ腹なライセンスになっています。

僕はこのSublime Textを購入して、現在2台のパソコンにインストールして使用しています。

ただ、複数PCでの利用となると、インストールしたパッケージなどを手動で同期させる作業が、とても煩わしく感じます。2台で、これだけ面倒なのですから、3台、4台環境で利用している人は、さらに面倒くさいことでしょう。

こんな悩みを、解決する方法を、先日当サイトのコメントで教えてもらいました。

今回は、Windowsのシンボリックリンク機能とDropboxの同期機能を利用して、複数Windows環境間のSublime Textの設定を同期する方法を紹介したいと思います。

photo by Ian Lamont

Sublime Textの設定をDropboxを利用して同期する

今回は、「Sublime Textの設定フォルダ」を「Dropboxの同期フォルダ」内に置いて複数環境間で設定ファイルの同期を行います。

Sublime Text側には、設定ファイルとリンクしたシンボリックリンクを設置して設定を読み込みます。

内容を図にするとこんな感じです。

一見では、よくわからないと思うので、以下で詳しく説明します。

仕組みとしては以下のような感じです。

Sublime Textの設定をDropbox内のフォルダに移動
Sublime Text設定部分にシンボリックリンクを作りDropboxに移動した設定とリンクする
Sublime Textが設定ファイルを使うときは、シンボリックリンクを介してDropbox内の設定ファイルが使われる
設定ファイルに変更があるとDropboxで同期する

シンボリックリンクとは

シンボリックリンクとは、実際にファイルやフォルダを操作出来るショートカットのようなものです。

シンボリックリンクとは、特定のファイルやディレクトリを指し示す別のファイルを作成し、それを通じて本体を参照できるようにする仕組み。
リンクは本体と同じディレクトリに置いても良いが、通常は別の場所から参照できるようにするために作成される。
IT用語辞典

簡単な図にするとこんな感じかと思います。

通常のショートカットを設定しても、アプリケーション側からはファイル操作することはできません。

けれど、シンボリックリンクだとリンク先のフォルダやファイルの内容を読み込んだり操作したりすることができるようになります。

シンボリックリンクの設定方法

シンボリックリンクを設定するには、Windowsの場合だと、管理者権限つきでコマンドプロンプト等を起動して、以下のようなコマンドを使います。

mklink /d "シンボリックリンクの作成先パス" "リンク元ディレクトリのパス"

mklinkコマンドに、以下の順番でパラメーターを指定します。

/dディレクトリのシンボリックリンクを作成する。
シンボリックリンクの作成先パスシンボリックリンクを作成する場所のパスを指定します。既にディレクトリが存在している場合は、エラーになります。
リンク元ディレクトリのパスシンボリックリンクがリンクされる元となるフォルダを指定します。このフォルダは、存在している必要があります。

シンボリックリンク作成コマンド「mklink」の詳しい仕様は、以下を参照してください。

参考 Mklink

Sublime Textの設定を同期する方法

前置きはここまでで、ここからWindows環境で、Dropboxを利用したSublime Text設定を同期する方法を具体的に書きたいと思います。

なお今回は、「Windows環境」＋「Sublime Text3インストール版」を利用した場合の例を書きたいと思います。

設定の主な手順

今回の設定には、主な手順として以下のことをする必要があります。

Dropboxへの登録＆アプリのインストール
Dropboxフォルダ内にSublimeText3フォルダを作成
Dropboxフォルダ内にSublime Textの設定ファイルを移動
Sublime Text3の設定ファイルの代わりにシンボリックリンクを作成

Dropboxの設定

まず、Dropboxに登録していない場合は、Dropboxに登録する必要があります。

登録後は、Windows 版 Dropboxをダウンロードしてインストールする必要があります。

インストール後は、アカウント情報を利用してアプリにログインしてください。

Dropboxのフォルダ位置は、デフォルト状態でもOKですし、場所の変更方法などは、検索すると出てくるので割愛します。

Dropboxフォルダ内にSublimeText3フォルダを作成

次に、Dropboxフォルダ内に「SublimeText3」というフォルダを作成します。

この、「SublimeText3」フォルダ以下に「Sublime Textの設定」ファイルが格納されます。

Sublime Textの設定ファイルを移動

上記で作成した、Dropboxフォルダ内にある「SublimeText3」フォルダに、Sublime Text3で利用している設定フォルダを移動します。

移動するフォルダは、Sublime Text3インストールデフォルト状態で以下の2つです。

C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Installed Packages
C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Packages

とりあえず、万が一失敗してもいいように、1度この2つのファイルは、何処かにコピーしてバックアップしておいてください。

で、上記の2つのファイルを「Dropbox\SublimeText3」フォルダ直下に移動（コピーではなく移動）します。

こんな感じで配置します。

Sublime Text3設定フォルダ側は、「Installed Packages」、「Packages」フォルダを移動したので当然以下のような状態になります。

シンボリックリンクの作成

最後に、設定ファイルがなくなった「Sublime Text3設定フォルダ」の中に、Dropboxフォルダに移動した「Installed Packages」、「Packages」へのシンボリックリンクを作成します。

これを行わないと、Sublime Textの動作に不具合が出てしまいます。

シンボリックリンクを作成するには、コマンドを打つ必要があるので、Windowsデフォルトで附属しているコマンドプロンプトを利用したいと思います。

まず、コマンドプロンプトは、「管理者として実行」を選択して実行してください。

管理者権限で実行すると、以下のようにタイトルバーに「管理者」と表示されます。

この状態で、先程のシンボリックリンク作成のコマンドを入力します。

mklink /d "シンボリックリンクの作成先パス" "リンク元ディレクトリのパス"

具体的な例としては、以下のようなコマンドになります。

mklink /d “C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Installed Packages” “C:\Users\ユーザー名\Dropbox\SublimeText3\Installed Packages”
mklink /d “C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Packages” “C:\Users\ユーザー名\Dropbox\SublimeText3\Packages”

上記は、Sublime Textのデフォルトインストール状態のパスで、Dropboxもインストール後デフォルトの状態のパスの例になっています。

上記コマンドを、コマンドプロンプトで実行すると、以下のように結果が表示されます。

mklink /d "C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Installed Packages" "C:\Users\ユーザー名\Dropbox\SublimeText3\Installed Packages"
C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Installed Packages <<===>> C:\Users\ユーザー名\Dropbox\SublimeText3\Installed Packages のシンボリック リンクが作成されました

mklink /d "C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Packages" "C:\Users\ユーザー名\Dropbox\SublimeText3\Packages"
C:\Users\ユーザー名\AppData\Roaming\Sublime Text 3\Packages <<===>> C:\Users\ユーザー名\Dropbox\SublimeText3\Packages のシンボリック リンクが作成されました

このように実行すると、Sublime Text3の設定フォルダ内に以下のようなシンボリックリンクが作成されます。