最近よく使う npm のコマンドと、その処理内容を書いていこうと思います。
init
> npm init
- プロジェクト情報の入力を対話形式で始める。
- 入力した情報は
package.json
に保存される。
install パッケージ名
--save
> npm install --save パッケージ名
- アプリ実行時に必要となるパッケージをインストールする。
- パッケージの情報は、
package.json
のdependencies
に保存される。 - 実行時のパッケージとしては、フレームワーク(express, etc) などがあげられる。
--save-dev
> npm install --save-dev パッケージ名
- 開発時に必要となるパッケージをインストールする。
- パッケージの情報は、
package.json
のdevDependencies
に保存される。 - 開発時のパッケージとしては、テスト用のライブラリや、コンパイラ(sass, less, etc)などがあげられる。
-g(--global)
> npm install -g パッケージ名
- 色々なプロジェクトで使うパッケージをインストールする。
- インストールしたパッケージは、PATH が通ってコマンドとして使えるようになる。
- ビルドシステムの gulp-cli などは、グローバルでインストールする。
- インストールは1回で大丈夫だが、プロジェクト単位でもインストールが必要なパッケージもある。(例:
gulp の場合は
> npm install --save-dev gulp
も必要。)
install
> npm install
package.json
の内容(dependencies
,devDependencies
)に従って、依存するパッケージをインストールする。
install の補足
- インストールしたパッケージは、
node_modules
ディレクトリ に追加される。 node_modules
配下は、バージョン管理対象外にすると良さそう。node_modules
はファイルが多すぎるのと、package.json
があれば再インストール(> npm install
)できるため。