npmで依存関係をインストールする方法

npmで現在のディレクトリのpackage.json依存関係をインストールする方法

日本語説明

npmは、Node.jsのプロジェクトでパッケージ管理を行うツールです。package.jsonファイルには、プロジェクトで使用される依存関係（他のパッケージ）がリストされています。

現在のディレクトリに依存関係をインストールするには、以下のコマンドを使用します

npm install

このコマンドを実行すると、package.jsonファイルに指定された依存関係が、node_modulesというフォルダにダウンロードされ、インストールされます。

詳細

• package.json: プロジェクトのメタデータや依存関係情報が含まれるファイルです。
• node_modules: インストールされた依存関係が格納されるフォルダです。
• npm install: 基本的なコマンドで、現在のディレクトリのpackage.jsonファイルを解析し、依存関係をインストールします。

例

もし、package.jsonファイルが次のような内容であれば、npm installを実行すると、expressとlodashというパッケージがインストールされます。

{
  "name": "my-project",
  "version": "1.0.0",
  "dependencies": {
    "express": "^4.18.2",
    "lodash": "^4.17.21"
  }
}

注意

• 特定のバージョン
  npm install <パッケージ名>@<バージョン番号>で、指定されたバージョンをインストールします。
• グローバルインストール
  npm install -g <パッケージ名>で、グローバルにパッケージをインストールし、任意のプロジェクトで使用できます。
• 特定の依存関係をインストール
  npm install <パッケージ名>で、指定されたパッケージのみをインストールできます。

npmで依存関係をインストールする際のコード例

package.jsonの作成と編集

まず、プロジェクトのルートディレクトリにpackage.jsonファイルを作成します。このファイルに、プロジェクトに必要な依存関係を記述します。

// package.json
{
  "name": "my-project",
  "version": "1.0.0",
  "description": "My first Node.js project",
  "dependencies": {
    "express": "^4.18.2",
    "lodash": "^4.17.21"
  }
}

• dependencies: 依存関係のリスト
• description: プロジェクトの説明
• version: プロジェクトのバージョン
• name: プロジェクトの名前

この例では、ExpressフレームワークとLodashライブラリを依存関係として指定しています。

依存関係のインストール

作成したpackage.jsonファイルがあるディレクトリで、以下のコマンドを実行します。

npm install

このコマンドを実行すると、node_modulesというフォルダが作成され、指定した依存関係のパッケージがダウンロードされてインストールされます。

インストールされたパッケージの使用

インストールされたパッケージは、require()関数を使ってコード内で使用できます。

// index.js
const express = require('express');
const _ = require('lodash');

const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send(_.upperCase('Hello World!'));
});

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

この例では、ExpressでWebサーバーを立ち上げ、LodashのupperCase関数を使って文字列を大文字に変換しています。

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

特定のパッケージのみをインストールしたい場合は、以下のコマンドを使用します。

npm install <パッケージ名>

例えば、Lodashだけをインストールしたい場合は、次のようにします。

npm install lodash

全ての依存関係のアンインストール

npm uninstall

• package-lock.jsonファイル: npm installを実行すると、このファイルが生成されます。このファイルは、インストールされたパッケージの正確なバージョンを記録しており、他の開発環境で同じ環境を再現するために使用されます。
• ^や~は、バージョン指定の記号です。これらの意味については、npmのドキュメントを参照してください。

npmは、Node.jsのプロジェクトでパッケージを管理する上で非常に重要なツールです。package.jsonファイルに依存関係を記述し、npm installコマンドを実行することで、簡単にプロジェクトに必要なパッケージをインストールすることができます。

より詳細な情報については、npmの公式ドキュメントを参照してください

• npm scripts
  package.jsonにスクリプトを定義し、npmコマンドで実行
• 開発環境用依存関係
  devDependencies
• 特定のバージョン
  npm install <パッケージ名>@<バージョン番号>
• グローバルインストール
  npm install -g <パッケージ名>

npm以外の依存関係インストール方法とその特徴

npmはNode.jsのパッケージ管理で最も一般的なツールですが、他にも様々な方法で依存関係を管理することができます。それぞれの方法には特徴があり、プロジェクトの規模や状況に応じて使い分けることが重要です。

yarn

• デメリット
  
• メリット
  
  • 高速なインストール
  • 安定性
  • より厳密なロックファイル管理
• コマンド
  
  • yarn install: npm installと同様、依存関係をインストールします。
  • yarn add <パッケージ名>: 特定のパッケージを追加します。
• 特徴
  npmの高速版として知られ、並列処理やオフラインキャッシュなど、より高速で安定したインストールを実現します。また、ロックファイルの管理もより厳密に行い、依存関係の競合を最小限に抑えます。

pnpm

• デメリット
  
• メリット
  
  • ディスク容量の節約

Bun

• デメリット
  
• メリット
  
  • JavaScriptランタイムとパッケージマネージャーが一体化
• コマンド
  
• 特徴
  JavaScriptランタイムでありながら、パッケージマネージャーも内蔵しています。npm互換のレジストリからパッケージをインストールでき、非常に高速なインストールが可能です。

手動によるインストール

• デメリット
  
  • 手間がかかる
  • バージョン管理が複雑になる
• メリット
  
  • パッケージの構造を深く理解できる
  • 特定のバージョンを固定したい場合に有効
• 特徴
  npmなどのパッケージマネージャーを使わず、パッケージのソースコードを直接ダウンロードしてプロジェクトに組み込む方法です。

どのツールを選ぶべきか

• 機能
  BunはJavaScriptランタイムとパッケージマネージャーが一体化しており、開発効率を向上させることができます。
• ディスク容量
  pnpmはディスク容量の節約に優れています。
• 安定性
  npmは最も成熟したツールであり、安定性が高いです。
• 高速性
  yarnやpnpmはnpmよりも高速なインストールが可能です。

プロジェクトの規模、開発チームのスキル、そしてプロジェクトの要件に合わせて、最適なツールを選択することが重要です。

npm以外にも、yarn、pnpm、Bunなどの優れたパッケージマネージャーが存在します。それぞれのツールには特徴があり、プロジェクトに最適なツールを選ぶことで、開発効率を向上させることができます。

• 複数のプロジェクトで異なるパッケージマネージャーを使用する場合、設定の管理が複雑になる可能性があります。
• 各ツールのバージョンや機能は、随時更新されるため、最新の情報を確認することをおすすめします。

• ワークスペース
  npm workspacesやyarn workspacesを使用することで、一つのワークスペース内に複数のプロジェクトを作成し、依存関係を共有することができます。
• monorepo
  LernaやTurborepoなどのツールを使用することで、複数のプロジェクトを一つのリポジトリで管理し、依存関係を共有することができます。