npmめも

a.md

npmとは？

(n)ode (p)ackage (m)anager nodeプログラムのインストールやパブリッシュ、モジュール依存関係の管理などを行えるコマンドラインツール。

package registryに対するユーザー設定の編集

$ npm adduser

package registry内のモジュールの検索、情報の表示

$ npm search <keyword>
$ npm view <pkg>
$ npm docs <pkg>
$ npm bugs <pkg>

モジュールのインストール、依存関係の解決、アンインストール

$ npm install <pkg>
$ npm install
$ npm uninstall <pkg>

モジュールのパッケージ(tgz形式)

$ npm pack

package registryへのパブリッシュ(公開)、削除、属性情報の更新

$ npm publish
$ npm unpublish
$ npm deprecate

package.jsonの生成、管理

$ npm init
$ npm version

モジュールの実行管理

$ npm start
$ npm stop
$ npm restart
$ npm test

package.json

プロジェクトに関する情報を記述するjsonファイル。初期作成はnpm initで。

$ npm init

• プロジェクト情報の記述
• プログラム実行のエントリポイント(main)
• コマンドライン実行設定(bin)
• npm start|restart|stop|testでの起動シェル(scripts)
• config値の記述(config)

npm startとpackage.jsonのscripts要素

以下環境変数は慣習的にフレームワークやモジュールで利用される。

• NODE_ENV
• NODE_DEBUG

また標準のモジュール探索パス以外からモジュールを読み込みたい場合に利用する環境変数が以下。

• NODE_PATH

これらをモジュールの起動方法に標準的に組み込むにあたっては、ドキュメント書くよりpackage.jsonに 記述してしまってnpm startをルールとしてしまったほうがよい。

• package.json

:
"scripts": {
  "start": "NODE_ENV=production NODE_PATH=lib node --harmony_typeof --harmony"
},
:

参考

• http://d.hatena.ne.jp/Jxck/20120410/1334071898
• http://kysnm.hatenablog.com/entry/20111225/1324828008