はじめに
本記事は、プログラミング初学者が、学習を進めていて疑問に思った点について調べた結果を備忘録も兼ねてまとめたものです。
そのため、記事の内容に誤りが含まれている可能性があります。ご容赦ください。
間違いを見つけた方は、お手数ですが、ご指摘いただけますと幸いです。
npmコマンド一覧
初期設定
$ npm init
package.json ファイルが生成されます。
パッケージのインストール
$ npm install パッケージ名
上記の代わりに以下のように記述することも可能です。
$ npm i パッケージ
$ npm add パッケージ
また、バージョンを指定してインストールする場合は以下の通りパッケージ名の後に@バージョンを記述します。
$ npm install パッケージ名@バージョン
以下のように記述することでグローバルインストールすることができます。
グローバルインストールをすることで、PC上のどのディレクトリからもコマンドが実行できる場所にインストールされます。
しかし、グローバルインストールをするとpackage.jsonにパッケージの情報が記載されず、他の人package.json渡して、npm install してもらっても開発環境が出来ないため、コマンドラインツールとして使用したいものなどに限ってグローバルインストールするようにした方が良いようです。
$ npm install -g パッケージ名
package.jsonへの依存関係の追記に関するオプションは以下の通りです。
package.jsonへ書き込みをしない場合
$ npm install パッケージ名 --no-save
package.jsonへ書き込みをする場合（npm v5以降はデフォルトで--saveするため記述する必要なし）
$ npm install パッケージ名 --save
package.jsonのoptionalDependenciesに依存するが必須ではないパッケージとして追記
$ npm install パッケージ --save-optional
package.jsonのdevDependenciesに開発に使用するパッケージとして追記
$ npm install パッケージ名 --save-dev
package.jsonに記述されたパッケージをインストールするには以下の通り記述します。
$ npm install
インストール済みパッケージ情報の表示
インストール済みのパッケージ一覧を表示します。
$ npm list
上記の代わりに以下のようにように記述することが出来ます。
$ npm ls
$ npm la
$ npm ll
グローバルインストール済みのパッケージ一覧を表示するには以下の通りです。
$ npm list -g
第一階層のみのパッケージを表示するには以下の通りです。
$ npm list --depth=0
パッケージのアップデート
package.jsonに記述されたパッケージをアップデート
$ npm update
指定したパッケージをアップデート
```:ターミナル
$ npm update パッケージ名
$ npm update パッケージ名 -g
インストール済みのパッケージに最新バージョンがあるか確認する
```:ターミナル
$ npm outdated
$ npm outdated -g
パッケージのアンインストール
$ npm uninstall パッケージ名
$ npm uninstall パッケージ名 -g
上記の記述の代わりに以下のように記述することも可能です。
$ npm un パッケージ名
$ npm unlink パッケージ名
$ npm remove パッケージ名
$ npm rm パッケージ名
$ npm r パッケージ名
package.jsonにアンインストールしたパッケージ情報を反映するには以下のように記述します。
$ npm uninstall --save
$ npm uninstall --save-optional
$ npm uninstall --save-dev
未使用のパッケージを削除
package.jsonに記述されていないnode_modules内のパッケージを全て削除
$ npm prune
npmリポジトリからパッケージ情報を表示
キーワードに関連するパッケージを検索
$ npm search パッケージ名
パッケージの詳細情報を表示
$ npm view パッケージ名
上記の記述の代わりに以下のように記述することも可能です。
$ npm v パッケージ名
$ npm info パッケージ名
$ npm show パッケージ名
パッケージのインストールパスを表示
$ npm root
$ npm root -g
パッケージのコマンドパスを表示
$ npm bin
$ npm bin -g