npmのインストールと使用方法

toc目次

npmとは

npmとはNode.jsで動作するパッケージマネージャーです。

パッケージマネージャーとは

パッケージマネージャーは、ソフトウェアのインストール、更新、削除を容易に行えるようにするツールです。

パッケージマネージャーを導入するとスマートフォンのアプリのようにソフトウェアを一括で更新したり、現在のソフトウェア環境を別PCにコピーすることもできます。

npmのインストール

Node.jsをインストールするとnpmも導入されます。

npmの主な用語

用語 内容
package.json プロジェクトの情報が記録されるファイル
package-lock.json インストールしたパッケージの完全なバージョンが記録されるファイル
node_modules インストールしたモジュール本体が配置されるフォルダー
dependencies 本番環境で使用する(コードを実行する際に必要となる)パッケージ
devDependencies 開発環境で使用する(コードを実行する際に必要としない)パッケージ

npmを使用したパッケージのインストール方法

公式サイトからパッケージを検索します。

インストールしたいパッケージのページ右側のinstall欄のコマンドをコピーします。
React

コマンドプロンプトでコピーしたコマンドを実行します。
package.jsonを作成していない場合はインストール前にnpm initを実行する。)

#  package.jsonを作成(作成していない場合)
npm init -y

# Reactをインストール
npm i react

npmの主なコマンド

コマンド 内容
npm init カレントディレクトリにpackage.jsonを作成
npm i package.jsonの内容にしたがってインストール
npm i <package> パッケージをインストール
npm r <package> パッケージをアンインストール
npm up <package> パッケージをアップデート
npm up すべてのパッケージをアップデート
npm ls インストールしたパッケージ一覧を表示

以下コマンドを実行するとすべてのコマンドを参照できます。

# コマンドヘルプを表示
npm help npm

コマンド例

新規プロジェクト作成

# 対話形式でpackage.jsonファイルを作成
npm init

# デフォルトパラメータで(対話なしで)package.jsonファイルを作成
npm init -y

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

# グローバルインストール
npm i -g <package>

# dependenciesにインストール(ローカルインストール)
npm i <package>

# devDependenciesにインストール(ローカルインストール)
npm i -D <package>
🔖 グローバルインストール
パッケージはnpmのルート配下のnode_modulesにインストールされ、すべてのディレクトリでインストールしたパッケージを使用できます。
🔖 ローカルインストール
パッケージはコマンドを実行したディレクトリ配下のnode_modulesにインストールされ、対象のディレクトリでのみインストールしたパッケージを使用できます。

コードを実行する際に必要となるパッケージ(React、Angular等)はdependencies
コードを実行する際に必要とならないパッケージ(Mocha、Babel等)はdevDependenciesにインストールします。

プロジェクトの複製

インストールコマンドでパッケージ名を省略した場合はpackage.jsonに記載されたパッケージがインストールされます。

# package.jsonに記載されたパッケージをすべてインストール
npm i

# package.jsonの「dependencies」のみインストール
npm i --production

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

# ローカルインストールしたパッケージをアップデート
npm up <package>

# グローバルインストールしたパッケージをアップデート
npm up -g <package>

パッケージ名を省略した場合はすべてのパッケージをアップデートします。

# ローカルインストールしたすべてのパッケージをアップデート
npm up

# グローバルインストールしたすべてのパッケージをアップデート
npm up -g

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

# ローカルインストールしたパッケージをアンインストール
npm r <package>

# グローバルインストールしたパッケージをアンインストール
npm r -g <package>

パッケージ一覧を表示

# ローカルインストールしたパッケージ一覧を表示
npm ls --depth=0

# グローバルインストールしたパッケージ一覧を表示
npm ls -g --depth=0