♻️

知っておいたほうがよいnpmコマンドとオプション

2024/12/18に公開

はじめに

npmとは、Node Package Managerの略で、Node.jsのパッケージ管理ツールです。
本稿ではnpmを利用する上で知っておいた方がよいコマンドを紹介します。

npmのコマンドの詳細については下記の公式ドキュメントを参照してください。

https://docs.npmjs.com/cli/v10/commands/npm

コマンド

コマンド 概要
npm init package.jsonを生成する
npm install package.jsonに記録されたパッケージをインストールする
npm install パッケージ 指定されたパッケージをインストールする
npm install --save-dev パッケージ 指定されたパッケージを開発用途でインスールする
npm update パッケージ 指定されたパッケージを更新する
npm uninstall パッケージ 指定されたパッケージをアンインストールする
npm list インストール済みのパッケージをリスト表示する
npm search キーワード キーワードでパッケージを検索する
npm info パッケージ 指定されたパッケージの情報を表示
npm install -g npm npm本体を更新する

npm install パッケージとnpm installの違い
npm install パッケージでインストールされたパッケージはpackage.jsonに記録され、後からnpm install (引数なし)でまとめ復元できます。

オプション

-vまたは--version

npmのバージョン情報を表示します。

使用例
npm -v

--saveまたは-S

インストールしたパッケージをpackage.jsonのdependenciesに追加します。
以前のnpmでは--saveオプションをつけなければdependencies追加されなかったのですが、現在のnpmで指定しなくてもdependenciesに追加されるので、ほぼ不要なオプションです。

使用例
npm install パッケージ --save

--save-devまたは-D

インストールしたパッケージをpackage.jsonのdevDependenciesに追加します。パッケージが開発用途であることを示します。
npm install --productionで開発パッケージを除いたパッケーだけを一括インストールできます。

使用例
npm install パッケージ --save-dev

--globalまたは-g

グローバルパッケージを指定します。グローバルパッケージはすべてのプロジェクトから利用することができます。

使用例
npm install パッケージ -g
npm uninstall パッケージ -g
npm list -g

Discussion