npm

npm とは

npm(Node Package Manager) とは、Node.js のパッケージを管理するシステムです。

npm は Node.js をインストールすると合わせて、インストールされます。

yarn とは

Meta 社(旧Facebook)が開発したパッケージ管理システムで、npm と互換性があります。

コマンド

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

npm install パッケージ名

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

npm uninstall パッケージ名

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

npm list

バージョンの確認

npm --version

npm 自体のアップデート

npm install -g npm

--save オプションとは?

パッケージのインストール時、package.json の dependencies に追加してくれる機能ですが、npm のバージョンが 5.0.0 以降からは install 時には save してくれるため、npm v5 以降を利用の場合は不要です。

表示

npm warn deprecated

deprecated :

非推奨

アップデート

パッケージをアップデートするには、「 npm install 'package' 」を一つずつ実行するか、package.json のバージョンを変更し、「 npm i 」をすることになります。

最新のバージョンにまとめて変更するには、「 npm-check-updates 」をインストールして実行するのが簡単にできる方法です。

npm install -g npm-check-updates

最新バージョンがあるか調べるには「 ncu 」コマンドを実行します。

ncu

実行すると以下の検索結果が表示されます。

「 package.json 」を最新のバージョン情報に編集するには、以下のコマンドを実行します。

ncu -u

実行すると以下の検索結果が表示されます。

最後に「 package.json 」のファイルをインストールします。

npm istall

最後に「 package.json 」と 「 package-lock.json 」が更新されているか確認をします。

npx の場合は、以下のようにします。

npx npm-check-updates
npx npm-check-updates -u
npm install

package.json と package.lock.json

package.json は、「 npm install 」でインストールする範囲を記述します。

package.lock.json は、実際にインストールされているパッケージのバージョン情報が記載されます。

「 npm Docs 」には、セマンティック バージョニング仕様に沿った、package.jsonファイルに更新されたバージョン番号をつけて、新しいバージョンを公開することを推奨しています。

それぞれのバージョン意味は、以下の4つがあります。

ステータス ステージ ルール バージョンサンプル
New product:最初のリリース 新製品 1.0.0から始める 1.0.0
Patch release:下位互換性のあるバグ修正 パッチリリース 3桁目を増やす
下位互換性のある新機能 マイナーリリース 中間の桁を増加し、最後の桁をゼロにリセットします 1.1.0
下位互換性を損なう変更 メジャーリリース 最初の桁を増やし、中間と最後の桁をゼロにリセットします 2.2.0

package.json のバージョン指定方法

バージョンの数字のみ指定

記載したバージョンのみインストール

x または *

x, *を記載した箇所のバージョン更新します。

  • * : すべてのバージョンを更新
  • 1.x:1.0.0 以上 2.0.0 未満を更新
  • 1.2.x:1.2.0 以上 1.3.0 未満を更新

~

コンパレータでマイナー バージョンが指定されている場合は、パッチ レベルの変更を許可します。指定されていない場合は、マイナー レベルの変更を許可します。

特定のバージョンより大きいバージョンをすべて同じマイナー範囲に含めます。

~2.2.0

^

メジャーバージョンの更新をせずに最新バージョンに更新します。