はじめに
先日Node.jsの勉強中にnpmについて改めて学ぶ機会がありました。その際npmにサンプルのモジュールを公開したので、具体的なやり方をシェアします。
npmとは
Node Package Managerが正式な名称です。その名の通りNode.jsのパッケージを管理するためのツールです。ホームページは下記リンク先からアクセスできます。
npmはNode.jsをインストールする際にインストールされます。インストール済みの場合、下記コマンドでバージョンが表示されます。
npm --version
npmに自作モジュールを公開する方法
公開までの流れ
流れは下記の通りです。
- npmのアカウントを作成する。
- 公開したいモジュールを作成する。
- npmへログインする。
- npmへ公開する。
それでは1つずつ見ていきます。
npmのアカウントを作成する
まずはnpmのアカウントを作成します。下記リンク先からSign Upできます。
公開したいモジュールを作成する
npm initでpackage.jsonを作成します。package nameを聞かれるので、npmレポジトリ上に存在していない名前を入力します。あらかじめnpmのサイトで利用されていない名前であることを確認しておきましょう。
npm init
package.jsonができたら、private属性をpackage.jsonに追記して公開設定にします。
"private": false
次に、README.mdファイルを準備します。ここにはどういった動きをするモジュールなのか、プロジェクトの概要を記述しておきます。
npmへログインする
ターミナルを起動し、プロジェクトのルートで下記コマンドを入力します。ユーザーネーム、パスワード、メールアドレスを聞かれるので入力します。
npm login
npmへ公開
ログインができたら、下記コマンドで公開できます。
npm publish —access public
※—dry runオプションをつけることで、お試しで実行することができます(実際には公開されません)。
npm publish —access public —dry run
最後に
簡単ですがサンプルのモジュールをGitHub上にpushしたので、package.json等の参考までに見てください。
https://github.com/n199603/npm-study
以上、npmに自作モジュールを公開する方法でした。見ていただきありがとうございました。