npmパッケージ公開のHello World (初めてのパッケージ公開)

この投稿では、npmパッケージを初めて公開するための練習として、必要最低限のファイル構成でパッケージ公開する方法を説明します。

ここで説明するのは、あくまで「練習」であって、実践ではファイル構成や手順がもっと複雑になります。極小のパッケージ公開を体験することで、実践に移しやすくなればと思います。

最低限のファイル構成

• package.jsonがただ一つ有ればいい

最低限のファイル構成

.
└── package.json

0 directories, 1 file

最低限のpackage.json

• nameとversionだけ有ればいい。

package.json

{
  "name": "@suin/test-1",
  "version": "0.0.1"
}

注意: 一度公開したname+versionは公開停止(unpublish)したとしても再利用できないので、試す場合は使えなくなっても困らないnameとversionにしてください。試す場合は、自分のscope(@ユーザ名/パッケージ名の形式)で行うようにし、NPMのグローバルスコープを汚さないようにしましょう。

最低限の公開手順

• npm publish --access publicを実行します。
  • --access publicを付けないと非公開パッケージとしてNPMに登録できますが、課金ユーザ限定の機能です。

$ npm publish --access public
npm notice
npm notice 📦  @suin/test-1@0.0.0
npm notice === Tarball Contents ===
npm notice 71B package.json
npm notice === Tarball Details ===
npm notice name:          @suin/test-1
npm notice version:       0.0.0
npm notice package size:  163 B
npm notice unpacked size: 71 B
npm notice shasum:        f9226fd47994a2eeb0c4dbd450c85097cf2d0bcb
npm notice integrity:     sha512-UdTvCTfjd/Nzd[...]UFWLtaf6/cXyA==
npm notice total files:   1
npm notice
+ @suin/test-1@0.0.0

---

最後までお読みくださりありがとうございました。Twitterでは、Qiitaに書かない技術ネタなどもツイートしているので、よかったらフォローお願いします→Twitter@suin