Node.js 用に作った自作モジュールを npm に登録して公開する方法

phi phi on Node.js

Node.js 6連投. 第4弾!

Node.js 用に作った自作モジュールを npm に登録して公開する方法についてまとめました.

今後日本のレンタルサーバーでも Node.js を使えるようになってくると思うので 今のうちに Node.js 用に色々とモジュールを作っておくのもアリなのかなとおもいます.

すごく簡単なのでぜひやってみてください. あと何かモジュールを公開したら教えてくれると嬉しいです.

ユーザー登録

npm へのユーザー登録の方法について解説します.

下記のコマンドを実行するだけです.

npm adduser  

実行すると, ユーザー名やら email, パスワードなどを聞かれるのでその都度入力して下さい. それだけで登録できます.

この情報は ~/.npmrc というファイルに保存されます. 忘れた際の確認に使ってください.

npm モジュールの情報ファイルの作成

npm モジュールの情報は package.json というファイルに保存します. 直に作ってもいいのですが, npm コマンド経由で対話的に作ることもできます.

下記のコマンドを実行すると

npm init  

対話が始まります. モジュールの名前や概要, git リポジトリの場所など色々と聞かれるので 入力してください.

(none) って書かれているやつは基本何も入力しなくても問題ないです.

全ての入力が終わるとカレントディレクトリに package.json ファイルが出力されていると思います.

必要に応じて直に書き換えても問題ありません.

package.js のプロパティ

ざっくり把握しているプロパティについて紹介します. 下記以外にもまだまだ沢山あります. 詳しく知りたい方はこちらをどうぞ.

Name Description
name モジュール名
version バージョン
author 作者
description モジュールの概要
homepage モジュール用のホームページURL
main エントリポイント. 最初に読み込むスクリプトです.
keywords 検索用のキーワードです
license ライセンスです. MIT とか指定しとけば無難
engines サポートしているエンジン

npm への登録, 公開

npm への登録, 公開方法について解説します.

package.json のあるディレクトリに移動して下記のコマンドを実行します.

npm publish  

すると npm カラフルな文字が色々と表示されてアップロードが開始されます.

たったこれだけ完了です.

うまくアップロードできたかどうかは

npm info モジュール名  

で確認できます. うまくアップロードできていればモジュールの情報が表示されます.

これで全世界だれでもどこでも

npm install モジュール名  

であなたのモジュールをインストールできるようになります.

Reference

なにか本気で Node.js 用モジュール作ってみっかなぁ~

どういったのが需要あるんだろ??