npm パッケージを公開する

JavaScript Node.js

npm を公開するために npm レジストリを使用する。以下に使用するための流れをまとめておく。

  1. アカウント登録

    npm レジストリを使うためにアカウント登録を行う。 登録ページ にアクセスする。手順はこちらが参考になる。

  2. アカウント確認

    コマンド上で npm login を叩き、ログインできるかのテストをする。ユーザ名やパスワード、メールアドレス、２要素パスワードなどが聞かれるので回答する。

     % npm login
 npm WARN adduser `adduser` will be split into `login` and `register` in a future version. `adduser` will become an alias of `register`. `login` (currently an alias) will become its own command.
 npm notice Log in on https://registry.npmjs.org/
 Username: goruchan
 Password: 
 Email: (this IS public) 
 npm notice Please use the one-time password (OTP) from your authenticator application
 Enter one-time password: 
 Logged in as goruchan on https://registry.npmjs.org/.

    ログインが完了したら、コマンド上で npm whoami を叩きログインしたユーザ名が表示されることを確認する。

     % npm whoami
 goruchan

  3. パッケージファイルを生成する

    パッケージを作成するディレクトリに移動して、npm init　を叩いてパッケージファイル(package.json)を生成する。色々聞かれるが、name, version 属性は必須なので入力する。

  4. パッケージをパブリッシュする

    パッケージファイルを生成したディレクトリで、npm publish . を叩く。２要素認証を設定していると、認証を求められるので回答する。

  5. パブリッシュしたパッケージを使う

    適当なディレクトリで下記を実行して、npm が install されるかを確認する

     % npm install <作ったnpm名>

参考