npm パッケージ一覧確認
npmでユーザーインストールパッケージをリストする方法 (日本語)
npm (Node Package Manager) は、JavaScriptプロジェクトで外部のライブラリやツールを管理するためのツールです。これらパッケージのインストール状況を確認するには、以下のコマンドを使用します。
npm listコマンド
npm list
このコマンドは、現在のプロジェクトディレクトリにインストールされているパッケージとそのバージョンを表示します。
npm list -g
このコマンドは、グローバルにインストールされているパッケージをリストします。グローバルインストールされたパッケージは、システム全体で使用できるようになります。
npm list --depth=0コマンド
npm list --depth=0
このコマンドは、直接インストールされているパッケージのみを表示し、依存関係は表示しません。
npm ls
これは、npm listコマンドのエイリアスです。
例
npm list
出力:
├── [email protected]
└── [email protected]
この例では、現在のプロジェクトに axios と lodash パッケージがインストールされていることがわかります。
注意
--depthオプションは、表示する依存関係の深さを指定します。-gフラグを使用すると、グローバルインストールされたパッケージをリストします。
npmでインストールされたパッケージ一覧を確認するコード例
ターミナルでのコマンド実行 (最も一般的)
npm list
このコマンドをプロジェクトのルートディレクトリで実行すると、そのプロジェクトにインストールされているすべてのnpmパッケージとそのバージョンが表示されます。
npm list -g
このコマンドは、グローバルにインストールされたパッケージの一覧を表示します。
Node.jsスクリプトでの実行
Node.jsの組み込みモジュールであるchild_processを使用して、上記のコマンドをプログラムから実行することができます。
const { exec } = require('child_process');
exec('npm list', (error, stdout, stderr) => {
if (error) {
console.error(`error: ${error.message}`);
return;
}
if (stderr) {
console.error(`stderr: ${stderr}`);
return;
}
console.log(stdout );
});
npmプログラムの直接利用 (上級者向け)
npmのAPIを直接利用することも可能ですが、一般的には上記の方法で十分です。
パッケージマネージャーを利用した確認 (例: yarn)
yarnなどの他のパッケージマネージャーを使用している場合は、そのパッケージマネージャー固有のコマンドでパッケージ一覧を確認します。
各コマンドの解説
exec('npm list'): Node.jsのchild_processモジュールを使用して、npm listコマンドを実行npm list -g: グローバルにインストールされたパッケージ一覧を表示
- npmのバージョンによっては、表示形式やオプションが異なる場合があります。
npm lsはnpm listのエイリアスです。--depthオプションを指定することで、表示する依存関係の深さを調整できます。例えば、npm list --depth=0とすると、直接インストールされたパッケージのみが表示されます。
コード例の意味
上記のコードは、Node.jsのchild_processモジュールを使用して、ターミナルでnpm listコマンドを実行するのと同じことをプログラムで行っています。exec関数に実行したいコマンドを渡し、コールバック関数で実行結果を受け取ります。
- コマンドの実行には、ターミナルと同様の権限が必要になる場合があります。
- npmがグローバルにインストールされている必要があります。
- Node.jsの環境が整っている必要があります。
npm outdatedコマンドを使うと、インストールされているパッケージの最新バージョンを確認できます。package.jsonファイルには、プロジェクトで使用しているパッケージとそのバージョンが記述されています。
npmでインストールされたパッケージ一覧を確認するには、ターミナルでnpm listコマンドを実行するか、Node.jsのスクリプトからchild_processモジュールを使って実行します。これらの方法を使いこなすことで、プロジェクトの依存関係を管理しやすくなります。
npm のプログラム API を直接利用する
npm は、Node.js で書かれたプログラムであり、その内部の機能を直接呼び出すことができます。npm のドキュメントを参照し、パッケージに関する情報を取得する API を利用することで、より柔軟な処理が可能になります。
const npm = require('npm');
npm.load({}, (err) => {
if (err) return console.error(err);
npm.commands.list({}, (err, list) => {
if (err) return console.error(err);
console.log(list);
});
});
package.json ファイルを直接解析する
プロジェクトのルートディレクトリにある package.json ファイルには、インストールされているパッケージの情報が記述されています。Node.js の fs モジュールなどを利用してこのファイルを解析することで、パッケージ一覧を取得できます。
const fs = require('fs');
fs.readFile('package.json', 'utf8', (err, data) => {
if (err) {
console.error(err);
return;
}
const packageJson = JSON.parse(data);
console.log(packageJson.dependencies); // dependencies オブジェクトに依存関係が記載
});
npm CLI ツールのオプションを活用する
npm list コマンドには、様々なオプションが用意されており、より詳細な情報を取得することができます。
--long: 詳細な情報を表示します。--json: JSON形式で出力します。
npm list --depth=0 --json
サードパーティ製のツールを利用する
npm パッケージの一覧を管理したり、可視化したりするためのサードパーティ製のツールも存在します。例えば、npm-check は、インストールされているパッケージの最新バージョンをチェックするツールです。
IDE やコードエディタの機能を利用する
Visual Studio Code や WebStorm などの IDE やコードエディタには、npm パッケージの管理機能が組み込まれているものがあります。これらの機能を利用することで、プロジェクトで使用されているパッケージを簡単に確認できます。
どの方法を選ぶべきか？
- IDE の活用
IDE の機能を利用することで、視覚的にパッケージの情報を確認できます。 - 自動化
定期的にパッケージのバージョンをチェックしたい場合は、サードパーティ製のツールやスクリプトを作成します。 - 詳細な情報
--depthや--jsonなどのオプションを組み合わせることで、より詳細な情報を取得できます。 - プログラムからのアクセス
Node.js のスクリプトからパッケージ情報を取得したい場合は、npm のプログラム API を利用するか、package.jsonを解析します。 - シンプルな一覧表示
ターミナルでnpm listを実行するのが最も簡単です。
npmでインストールされたパッケージ一覧を確認する方法には、様々な方法があります。それぞれの方法にはメリットとデメリットがあり、どのような方法を選ぶかは、目的や状況によって異なります。
- セキュリティ上の観点から、定期的にパッケージのアップデートを行うことを推奨します。
- npm のバージョンや設定によっては、表示される情報が異なる場合があります。
package-lock.jsonファイルには、インストールされたパッケージの正確なバージョンが記録されています。
javascript node.js npm
