npm に package を公開する手順をまとめました。 何度かやってはいるのですが…都度調べなおしているような気がしたので、一度まとめておくことにしました。
あらかじめ npm のアカウントは持っている前提で、以下の記事は記載しています。
モジュール作成 (package.json)
package.json
の記載内容で注意しておきたい項目は以下の通りです。
- name
- パッケージ名を指定します。 名前空間のプレフィックス含めて214文字以内。 使える文字はアルファベット(a-z)、数字(0-9)、ハイフン(-)、ドット(.)、アンダースコア(_)、チルダ(~)
- version
- セマンティックバージョニングに従ったバージョン文字列を指定します。
- main
- エントリーポイントとなる JavaScript へのパスを指定します。
- private
- 名前空間付きのパッケージ公開する場合、
false
を意図的に指定します。 どちらにせよ、一般公開するのでfalse
指定になりますが…。
パッケージ公開
npm のアカウントがあり、すでに公開したいパッケージも準備できていれば、いよいよ公開です。 以下の手順で npm に公開できます。
-
パッケージ公開したいモジュールのルートディレクトリへ移動
cd -d "C:\work\sample"
-
npm へ ログイン
npm login
-
パッケージ公開
npm publish --access public
パッケージ非公開 (削除)
パッケージ公開してから 24時間以内 であれば非公開(削除)することができます。 24時間を過ぎるとnpmの運営へ連絡しないと削除できませんのでご注意ください。
ここでは公開から 24時間以内 という条件下で非公開(削除)する方法を載せます。
-
パッケージ公開したいモジュールのルートディレクトリへ移動
cd -d "C:\work\sample"
-
npm へ ログイン
npm login
-
パッケージ非公開
npm unpublish --force
今回は npm パッケージ を 公開 または 非公開 する方法をまとめました。 非公開は 24時間以内 という制約がありあまり使えるものではありませんが…参考になったでしょうか?
今後もよく使うけどブログにない記事あれば追加していきたいと思います!!
最後に… このブログに興味を持っていただけた方は、 ぜひ 「Facebookページ に いいね!」または 「Twitter の フォロー」 お願いします!!