よく使うnpmコマンド一覧【備忘録】

npm-scriptsで頻繁に使用するnpmコマンドの意味と使い方を調査し、効果的に活用できるように備忘録として一覧にまとめました。

各コマンドについては、通常のオプションと短縮形式の両方を記載しています。
開発者がnpmを効率的に活用できるよう、参考にしてください。

INDEX

バージョンの確認

npm -v
npm --version

インストールされているnpmのバージョンを表示するコマンドです。
実行すると、カレントディレクトリ内の現在のnpmのバージョンが表示されます。

新しいnpmプロジェクトの初期化

npm-init

npm init

npmプロジェクトをセットアップするためのコマンドです。
実行すると対話型のプロジェクト初期化プロセスが始まり、プロジェクトのpackage.jsonファイルが作成されます。

対話型をスキップして作成

npm init -y

対話型では通常9つの質問がありますが、全ての設定をデフォルトの状態でpackage.json作成する場合は、-yオプションを追加します。
これにより全ての質問にyesで回答した状態でpackage.jsonが自動的に作成されます。

パッケージのインストール

npm-install

既存のプロジェクトの依存関係をインストール

npm i
npm install

プロジェクトのパッケージの依存関係をインストールするためのコマンドです。
package.jsonファイル、もしくはpackage-lock.jsonファイルに記載されたパッケージの依存関係がインストールされます。
これにより、プロジェクトが必要なパッケージを利用できるようになります。
主に既存プロジェクトに参加する場合などに、利用されます。

開発用のパッケージを指定してインストール

npm install -D <パッケージ名>
npm install --save-dev <パッケージ名>

などの開発時にのみ必要なパッケージをインストールするコマンドです。
package.jsonのdevDependenciesにパッケージが追加されます。

本番公開時に必要なパッケージを指定してインストール

npm i <パッケージ名>
npm install <パッケージ名>

公開時に必要なパッケージをインストールするコマンドです。
package.jsonのdependenciesにパッケージが追加されます。

パッケージのアンインストール

npm-uninstall

npm un <パッケージ名>
npm uninstall <パッケージ名>

プロジェクト内のパッケージをアンインストールするためのコマンドです。
package.jsonファイルのdependencies・devDependencyからも該当のパッケージが削除されます。
同時にnode_modulesからも依存関係が削除されます。

インストールされているパッケージを一覧で表示

npm-ls

npm ls
npm list

プロジェクトにインストールされているパッケージの一覧を表示するためのコマンドです。
これを使用すると、プロジェクトの依存関係のツリーを見ることができます。

プロジェクト内の古いパッケージを一覧表示

npm-outdated

npm outdated

プロジェクトにインストールされているパッケージの中で、古いものがないか最新のバージョンが利用可能なものを表示するためのコマンドです。

パッケージを更新

npm-update

npm up
npm update

プロジェクトのpackage.jsonに定義されているパッケージとその依存関係の両方を考慮し、全てのパッケージを最新のバージョンに更新するコマンドです。
また、依存関係が不足しているパッケージもインストールされます。

パッケージを指定してアップデート

npm up <パッケージ名>
npm update <パッケージ名>

指定したパッケージのみを最新のバージョンに更新するコマンドです。

おすすめの書籍