周辺知識

npm コマンド(まとめ)

Node.js で動くライブラリをインストールするには npm コマンドを実行します。

Node.jsを使って開発をしていると npm コマンドをよく使います。

しかし、実際は何となく書いてある通りのコマンドを実行していたりして、意味をちゃんと理解してなかったりします。

今回は npm コマンドについてまとめてみました。

 

動作確認

npm が入っているかの確認。


$ npm --version

 

ポイント

Node.js が入っているかの確認。


$ node -v

 

初期化

カレントディレクトリに package.json を作成します。


$ npm init

このコマンドを入力するとプロジェクト名やバージョンなどを聞かれます。答えていくと package.json が作成されます。

なお、Laravelではデフォルトで作成されます。

 

インストール編

npm install パッケージ名


# 以下すべて同じコマンド
$ npm install パッケージ名
$ npm i パッケージ名

カレントディレクトリに指定のパッケージをインストールするコマンドです。

カレントフォルダの node_modules フォルダに配置されます。

npm install -g パッケージ名


# 以下すべて同じコマンド
$ npm install -g パッケージ名
$ npm install --global パッケージ名

-gオプションは指定されたパッケージをグローバルな領域にインストールするコマンドです。

バージョンは関係なく、どのプロジェクトでも利用する場合に使います。

npm install --save パッケージ名

インストールしたパッケージの情報を自動で package.json に書いてくれるオプションです。

実際によく使うのはこっち。


# 以下すべて同じコマンド
$ npm install --save パッケージ名
$ npm install -save パッケージ名
$ npm install -S パッケージ名

コマンドを実行したあと package.json を見ると以下のように追記されているのがわかります。


  "dependencies": {
    :
    "express": "^4.16.4"
  }

POINT!
--save-dev というオプションを使うと dependencies ではなく devDependencies として追加されます。

npm install(パッケージ名なし)


$ npm install

npm install にパッケージ名を入れずに実行すると、package.json の内容に従って、package をインストールします。

試しに node_modeules ディレクトリを削除してみてください。

node_modules が再度作成されて、package.json に記述されているパッケージが再びインストールされます。
package.json は通常 Gitの管理下にあるファイルなので、このファイルを共有してnpm installコマンドを実行して開発環境をメンバーと合わせます。

Gitでの管理方法

node_modules は npm install で自動生成されるディレクトリですので、Git で管理する必要はありません。.gitignore に追加しておきます。


# .gitignore
node_modules/

ちなみにLaravelで自動生成される .gitignore にはデフォルトで記述されています。

 

アンインストール編

基本形


# 以下すべて同じコマンド
$ npm uninstall パッケージ名
$ npm un パッケージ名
$ npm unlink パッケージ名
$ npm rm パッケージ名
$ npm r パッケージ名

 
package.json の dependencies 欄の記述も削除


$ npm uninstall --save パッケージ名

 
アンインストール時に package.json の devDependencies 欄の記述も削除します。


# 以下すべて同じコマンド
$ npm uninstall --save-dev パッケージ名
$ npm uninstall -D パッケージ名

 
グローバルでインストールしたパッケージの削除


$ npm uninstall -g パッケージ名

 

インストール済みパッケージの確認


# パッケージインストールリスト
$ npm list
# グローバルでインストールされているモジュール一覧
$ npm list -g

 

パッケージのアップデート

パッケージのアップデート


$ npm up

以上です。

本庄マサノリ

仕事でLaravelを使っています。気づいたことや新しい発見など情報を発信していきます。メールはこちら

 

-周辺知識