GitHub製テキストエディタAtomの設定ファイルとパッケージをGitHubで管理する方法

2017年2月16日

TOOL

今回はAtomの設定ファイルとパッケージ&テーマをGitHubで管理する方法を紹介します。
なおGitのインストールとGitHubアカウントは作成済みとして話を進めたいと思いますので、わからない方は別途検索をお願い致します。

なぜGitHubで管理するの?

GitHubで管理する主なメリットは以下の2点。

  • 自分オリジナルの設定をバックアップすることができる
  • 他の環境でもすぐに同じ設定で使用することができる

Atom設定ファイルにGitを導入

リポジトリの作成

Atomの設定ファイルは.atomディレクトリ内に保存されています。
このディレクトリにGitのリポジトリを作成しましょう。

$ cd .atom
$ git init

.gitignoreの作成

.atomディレクトリ内に.gitignoreファイルを作成し、Git管理しないディレクトリとファイルを指定しましょう。
以下はそのサンプルで、キャッシュやパッケージファイルを除外しています。

.atom/.gitignore
.apm/
.node-gyp/
packages/
compile-cache/
storage/

パッケージリスト

上で.gitignore作成した際、パッケージファイルをGit管理から除外してしまっています。なぜでしょうか。

実はパッケージファイルをまとめてGitHubにpushすること自体は可能ですが、環境によってはものすごいデータ量となってしまいます。
わざわざ大量のデータを管理しなくてもAtomには便利な機能「パッケージリスト」がある為、これを使用するためGit管理から除外しました。

パッケージリストの作成

それでは.atomディレクトリ内で以下のコマンドを実行しパッケージリストを作成しましょう。
packages.txtファイルに現在インストール済みのパッケージとテーマの一覧を書き込んでくれます。

$ apm list --installed --bare > packages.txt

パッケージリスト作成の注意点

今後パッケージを追加したり削除した場合は、手動で毎回上記コマンドを実行してパッケージリストを作成し直さないといけない点に注意してください。
自動でpackage.txtが書き換えられることはありません。

パッケージリスト内のパッケージをインストールする

パッケージリストに書かれているパッケージたちをインストールするには.atomディレクトリ内で以下のコマンドを実行してください。

$ apm install --packages-file packages.txt

GitHubに作成したリモートリポジトリにpushする

GitHubに作成したリポジトリにpushする方法は以下を参考に。

$ git add .
$ git commit -m 'first commit'
$ git remote add origin https://github.com/[USER_NAME]/[REPOSITORY_NAME].git
git push -u origin master

packages.txtを手動で作成しないといけない点は多少面倒ではありますが、これでひとまずAtomの設定ファイルとパッケージ(packages.txt)をGitHub管理下に置くことができました。