Atomの便利なパッケージ管理方法 – GitHubやスターを利用して他の開発環境でも使えるようにしておく

Atomと言えばGitHub製の開発者向けエディタで、今まさにホットなツールのひとつとして盛り上がってきています。私も御多分に洩れず、先日長年使ってきたSublime TextからAtomに乗り換え、『Atom(GitHub製エディタ)に乗り換えて最初にやっておきたいこと』といった記事を書きました。今回も引き続き最初にやっておきたいこととして、Atomのパッケージや設定ファイルを管理する便利な方法を紹介したいと思います。

Atomの設定が完了したら、同じ設定下のAtomを他の環境でも使いたくなるはずです。他の環境で使うたびに、設定ファイルをいじって、パッケージを検索して、インストールしてなどを繰り返していたら日が暮れてしまします。そこで、やっておきたいのがパッケージや設定ファイルの管理となります。方法はいくつかあり、GitHubを利用する方法とAtomのスターを利用する方法が主流となるでしょうか。まずは、GitHubを利用する方法から紹介していきます。

atom github製エディタ GitHub · Build software better, together.

Git環境を導入する

Gitをインストールする

まずGitを導入する必要があります。まだGitをインストールしていない場合は、Gitの公式サイトからダウンロードするなり、以下を参考にご自身の環境にGitをインストールしてください。(Xcodeが入っていれば、一緒にインストールされています。)

リポジトリを作成する

Gitをインストールしたら、.atom用のリポジトリを作成します。.atomディレクトリに移動して、[git init]コマンドを実行するとリポジトリが作成されます。

$ cd .atom
$ git init

.gitignoreでGitで管理しないディレクトリやファイルを指定する

.gitignoreに記載したディレクトリやファイルはGitでの管理の対象外となります。

.atomディレクトリ内に「.gitignore」ファイルを作成します。

$ touch .gitignore

自分の場合は、以下のディレクトリやファイルをGitの対象から外しました。これらはキャッシュファイルだったり、パッケージやテーマそのものだったりします。

$ vim .gitignore

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

GitHubにリモートリポジトリを作成する

Atomの設定ファイル(dotfile)を置くためのリモートリポジトリをGitHub上に作ります。詳細は省きます。以下を参考にしてください。

パッケージやテーマの管理はどうするのか?

Gitの準備は整ったので、作成したGitHubのリモートリポジトリを利用することで、Atom環境の同期が行えるようになります。ただお気付きの方もいると思いますが、.gitignoreにpackagesディレクトリを記述したため、このままではパッケージやテーマの再現ができません

現状、パッケージやテーマの管理の方法は2通りあります。

  • 「パッケージリスト」を作って管理する方法
  • 「Star」で管理する方法

以下にそれらの方法を紹介していきます。

「パッケージリスト」を作ってパッケージを管理する

例えば、Node.jsのパッケージ管理ツールであるnpmでは、パッケージ管理ファイルであるpackage.jsonに依存関係にあるパッケージを登録しておくことで、[npm install]コマンドを使って、他の環境にも同じパッケージをインストールすることができます。

パッケージリストを作る

Atomでもこれと同じようなことができます。以下のコマンドを実行することで、任意のファイルにインストール済みのパッケージとテーマの一覧を書き込んでおくことができます。txtファイルのファイル名は任意です

$ apm list --installed --bare > packages.txt
packages.txtファイルにインストール済みのパッケージとテーマを書き込む

「パッケージリスト」に記載のパッケージをインストールする

[apm install]コマンドに-packages-file」オプションをつけて、パッケージを記載したファイルを指定して実行すると、パッケージリストに記載のパッケージやテーマを一括でインストールすることができます。

$ apm install --packages-file packages.txt
Installing atom-color-highlight@3.0.9 to /Users/maechabin/.atom/packages ✓
Installing atom-jade@0.1.0 to /Users/maechabin/.atom/packages ✓
Installing autocomplete-plus@2.16.3 to /Users/maechabin/.atom/packages ✓
Installing file-icons@1.5.5 to /Users/maechabin/.atom/packages ✓
Installing git-plus@4.5.0 to /Users/maechabin/.atom/packages ✓
Installing japanese-wrap@0.2.7 to /Users/maechabin/.atom/packages ✓
Installing linter@0.12.2 to /Users/maechabin/.atom/packages ✓
Installing linter-eslint@0.5.6 to /Users/maechabin/.atom/packages ✓
Installing minimap@4.8.0 to /Users/maechabin/.atom/packages ✓
Installing monokai@0.14.0 to /Users/maechabin/.atom/packages ✓
Installing preview@0.14.0 to /Users/maechabin/.atom/packages ✓
Installing script@2.23.0 to /Users/maechabin/.atom/packages ✓
Installing term2@0.9.5 to /Users/maechabin/.atom/packages ✓
Installing test-status@0.30.0 to /Users/maechabin/.atom/packages ✓

npmとの違いは、パッケージのインストール/アンインストール時に自動的にパッケージリストに書き込まれる訳でなはなく、あくまでも上記のコマンドを実行しないとパッケージリストに書き込まれないということです。ここは注意が必要です。次に紹介する方法はもっと簡単にパッケージを管理することができます。

「Star」でパッケージを管理する

Atomのパッケージやテーマはスター(Star)」で管理することもできます。atom.ioにてパッケージやテーマの詳細ページに行くと、「スター」を押すことができるようになっています。これは一般的には「いいね」や「お気に入り」といった意味で使われるものです。スターの数でそのパッケージやテーマがどれだけ支持されているかの指標にもなっています。

Atomパッケージのスター数

「Star」のついたパッケージを一括でインストールする

実はAtomでは、このスターのついたパッケージやテーマを一括でインストールすることができるようになっています。この方法を使えば、上記で紹介したパッケージリストを用意する必要はなくなります。そのためにも自分のAtomにインストールしたパッケージやテーマには必ずスターをつけておくようにします。

[apm stars -install]コマンドを実行すると、スターをつけたパッケージ全てを一括でインストールすることができます。すごくお手軽ですね。

$ apm stars --install
Installing atom-color-highlight to /Users/maechabin/.atom/packages ✓
Installing atom-jade to /Users/maechabin/.atom/packages ✓
Installing autocomplete-plus to /Users/maechabin/.atom/packages ✓
Installing file-icons to /Users/maechabin/.atom/packages ✓
Installing git-plus to /Users/maechabin/.atom/packages ✓
Installing japanese-wrap to /Users/maechabin/.atom/packages ✓
Installing linter to /Users/maechabin/.atom/packages ✓
Installing linter-eslint to /Users/maechabin/.atom/packages ✓
Installing minimap to /Users/maechabin/.atom/packages ✓
Installing monokai to /Users/maechabin/.atom/packages ✓
Installing preview to /Users/maechabin/.atom/packages ✓
Installing script to /Users/maechabin/.atom/packages ✓
Installing term2 to /Users/maechabin/.atom/packages ✓
Installing test-status to /Users/maechabin/.atom/packages ✓

インストール済みのパッケージに一括でスターをつける

すごく便利な機能となりますが、毎回インストールする度にatom.ioにアクセスしてスターをつけるのは面倒だったりします。そこで紹介したいのが[apm star]コマンド(こちらはstarは単数系)です。以下のように-installed」オプションをつけて実行すると、インストール済みのパッケージやテーマに一括でスターをつけてくれます。これまでずっとスターをつけていなかった場合にも大変役立ちます。

以下のようにコマンドを実行すると、Tokenを聞かれるので、[Enter]を押すとAtom.ioに飛びます。

$ apm star --installed

Welcome to Atom!

Before you can publish packages, you'll need an API token.

Visit your account page on Atom.io https://atom.io/account,
copy the token and paste it below when prompted.

Press [Enter] to open your account page on Atom.io.
Token>

atom.ioのユーザーページにて、Tokenをコピーします。(Atomのアカウントを取得しておく必要があります。)

Atomアカウントのコピー

再びターミナルに戻って、コピーしたTokenを貼り付けて[Enter]を押すと、インストール済みのパッケージとテーマに順々にスターが付いていきます。

Token> [コピーしたTokenを貼り付け]
Saving token to Keychain ✓
⭐  Starring atom-color-highlight ✓
⭐  Starring atom-jade ✓
⭐  Starring autocomplete-plus ✓
⭐  Starring file-icons ✓
⭐  Starring git-plus ✓
⭐  Starring japanese-wrap ✓
⭐  Starring linter ✓
⭐  Starring linter-eslint ✓
⭐  Starring minimap ✓
⭐  Starring monokai ✓
⭐  Starring preview ✓
⭐  Starring script ✓
⭐  Starring term2 ✓
⭐  Starring test-status ✓ 

アンインストールしたパッケージのスターを外す

パッケージやテーマをアンインストールした場合は、スターを外しておく必要があります。atom.io上で直接スターを外してもよいですが、[apm unstar パッケージ名]でスターを外すことができます。

$ apm unstar atom-color-highlight 
👟 ⭐  Unstarring atom-color-highlight ✓

パッケージの管理に「リスト」を使うか、「スター」を使うかはそれぞれの好みによると思います。リストで管理する場合はその都度更新しておく必要がありますし、スターで管理する場合もその都度スターを付けたり外したりおく必要があります。またスターで管理する場合は、インストールしてなくても、スターをつけたものは全てインストールされるので注意が必要です。

まとめ

以上のような方法でパッケージやテーマを管理し、併せてGitHubのリモートリポジトリを利用することで、会社や自宅など複数の場所で同じ環境の下でAtomを使えるようになります。冒頭でも述べた通り、前回『Atom(GitHub製エディタ)に乗り換えて最初にやっておきたいこと』という記事を書きましたが、今回の内容もAtomを使い始めたら、やっておきたいことのひとつとなります。ぜひAtomの有効活用に役立てていただければと思います。

なお、GitHubリポジトリへのディレクトリやファイルのアップロードの仕方や、GitHubリポジトリからダウンロードして環境を再現する方法など、GitHubの詳細な使い方などはご存知の方も多いと思うので省略しました。

パッケージやテーマの再現だけであれば、GitHubを使わなくても「スター」を使うことで行えたりするので、いろいろ試しながら自分に合った方法を見つけてもらえればと思います。

ちなみに自分のAtomの設定ファイルが置いてあるGitHubリポジトリは以下となります。

最後に、参考にさせてもらったサイトなどを紹介しておきます。

[参考サイト]

それから、『WEB+DB PRESS』のAtomの特集記事の内容が大変詳しくて、こちらもとても参考になると思うので紹介しておきます。

WEB+DB PRESS Vol.86
  • 『WEB+DB PRESS Vol.86』
  • 著者: 結城洋志, 沖元謙治, 足永拓郎, 林健太郎, 大竹智也, 内田誠悟, その他
  • 出版社: 技術評論社
  • 発売日: 2014年4月23日
  • ISBN: 4774172480

コメント一覧

  • 必須

コメント