Atomの自作packageのアップデート方法
以前作ったAtomのpackage(プラグイン)に、半年前にissueが立ってて、最近になって他の人からも+1が続いたので修正しようと思ったものの、packageの開発方法とか完全に忘れてて、どうしたらいいのか分からなくて困ったので未来の自分のために残す。
過去に自作のpackageをリリースしてる前提です。
開発環境の準備
まず、環境を準備するために、apm develop
コマンドを実行する。
$ apm develop <package-name>
次のようなログが流れる。
Cloning https://github.com/<user-name>/<package-name> ✓ Installing modules ✓ /Users/<user-name>/.atom/dev/packages/<package-name> -> /Users/<user-name>/github/<package-name>
apm develop
コマンドを実行すると、GitHubからソースコード一式をCloneしてくる~/.atom
にdev
ディレクトリが作られ、packages
内に該当のpackageのショートカットができる- Cloneしてきたコード一式は、
~/github
以下に保存される
(クローン先を変更したい場合はATOM_REPOS_HOME
で変更できるらしい)
リンクの確認
apm links
を実行して確認すると、次のようにpackageがローカルの開発環境にリンクされているを確認できる。
$ apm links
/Users/<user-name>/.atom/dev/packages (1) └── <package-name> -> /Users/<user-name>/github/<package-name> /Users/<user-name>/.atom/packages (0) └── (no links)
開発環境に移動しておく。
$ cd /Users/<user-name>/github/<package-name>
devモードでAtomを起動
Atomのメニューから、[View] - [Developer] - [Open In Dev Mode...] でdevモードでAtomを起動する。
devモードにするとAtomが~/.atom/dev/packages
を見てくれるようになるので、つまりそこからリンクされているローカルの開発環境を見てくれるようになる。
packageの中身を修正する
ソースコードをいじったら、Atomのメニューから、[View] - [Developer] - [Reload Window] でエディタ上に修正内容を反映できる。
GitHubにpushする
master
にpushすればよいはず。
publishする
$ apm publish <version-type>
version-type
の部分は修正内容に合わせて、major
かminor
かpatch
を指定する。それに合わせてpackage.jsonのバージョンが自動で書き替わるので。
もし、次のようなメッセージが表示されたら、https://atom.io/accountでログインして、API tokenをコピーしてターミナルに貼り付けてEnterすればOK。
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.
これで、新しいバージョンのpackageがユーザーに自動で届きます。めでたし🎉