Webクライアント開発でよく使うnpmコマンド、npmの知識のメモ

もくじ


初期化

コマンド

npm init

動作

開発するパッケージの名前や説明文などが記載されたpackage.jsonファイルを生成する。


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

コマンド

npm install

次のように略記できる。

npm i

動作

package.jsonファイルの「dependencies 」と「devDependencies」に記載されているnpmパッケージ(と、それが依存しているすべてのパッケージ)をすべてnode_modulesフォルダにダウンロードする。


コマンド

npm install -g パッケージ名

次のように複数のパッケージ名の指定も可能。

npm install -g パッケージ名A パッケージ名B パッケージ名C

次のように略記できる。

npm i -g パッケージ名
npm i -g パッケージ名A パッケージ名B パッケージ名C

動作

グローバル領域にパッケージ(と、それが依存しているすべてのパッケージ)をインストールする。グローバル領域にインストールしたパッケージは、PC内の任意のディレクトリから使える。


コマンド

npm install --save パッケージ名

次のように複数のパッケージ名の指定も可能

npm install --save パッケージ名A パッケージ名B パッケージ名C

次のように略記できる。

npm i パッケージ名
npm i パッケージ名A パッケージ名B パッケージ名C

動作

指定したnpmパッケージ(と、それが依存するすべてのパッケージ)をnode_modulesフォルダにインストールし、package.jsonファイルの「dependencies」にパッケージ名を記載する。


コマンド

npm install --save-dev パッケージ名

次のように複数のパッケージ名の指定も可能

npm install --save-dev パッケージ名A パッケージ名B パッケージ名C

次のように略記できる。

npm i -D パッケージ名
npm i -D パッケージ名A パッケージ名B パッケージ名C

動作

指定したnpmパッケージ(と、それが依存するすべてのパッケージ)をnode_modulesフォルダにインストールし、package.jsonファイルの「devDependencies」にパッケージ名を記載する。


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

コマンド

npm uninstall パッケージ名

次のように略記できる。

npm un パッケージ名

–saveや–save-devなどのオプションは、インストールするときと同様。

動作

指定したnpmパッケージをアンインストールする。package.jsonからもパッケージ名が削除される。指定したオプション(–saveや–save-devなど)により、「dependencies」「devDependencies」などのうちどこからパッケージ名を削除するかが決まる。


現在の状態表示

コマンド

npm --version

次のように略記できる。

npm -v

動作

パスが通っているnpmのバージョン番号を表示する。


コマンド

npm list -g --depth=0

動作

グローバル環境にインストールされているnpmパッケージの一覧を表示する。


コマンド

npm list --depth=0

動作

ローカル環境(開発するソフトのpackage.jsonと同じディレクトリにあるnode_modulesディレクトリ)にインストールされているnpmパッケージの一覧を表示する。


dependenciesとdevDependenciesの違い

dependenciesは、開発しているソフトウェアが動作する上で必要なパッケージのことを指す。

devDependenciesは、ソフトウェアを開発する上で必要なパッケージを指す。

例えば、開発したソフトウェアを「mochi_package」という名前で公開した場合、このパッケージを利用する人が

npm i mochi_package

などのコマンドを使ってインストールすると、

  • dependenciesに記載されているパッケージも、mochi_packageが依存するパッケージとして同時にインストールされる。
  • devDependenciesに記載されているパッケージはインストールされない

一方で、mochi_package自体をクローンやフォークして開発する人は、mochi_packageプロジェクトのpackage.jsonファイルのあるディレクトリで

npm i

を実行すると、dependencies、devDependencies双方のパッケージがインストールされる。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です