npmの基本コマンド | Node.js | JavaScript 超完全入門基本から発展までのすべて

INDEX

npmとは？

npmは、Node.jsで利用される代表的なパッケージ管理ツールです。npmを使うことで、JavaScriptのライブラリや開発ツールを簡単にインストール、管理、更新できます。

フロントエンド開発ではビルドツールやフレームワークの管理に使われ、バックエンド開発ではWebサーバー用のライブラリなどを導入する際に使われます。

npmは、通常Node.jsをインストールすると一緒にインストールされます。まずは、npmが正しく使える状態になっているか確認しましょう。

以下のコマンドをターミナルまたはコマンドプロンプトに入力します。


npm -v

npmのバージョン番号が表示されれば、npmはインストールされています。

あわせてNode.jsのバージョンも確認しておくとよいでしょう。


node -v

npmでよく使う基本的なコマンドを以下にまとめます。これらを覚えておくと、パッケージ管理をスムーズに行えます。

コマンド	説明
`npm init`	新しいプロジェクトを初期化します。`package.json`ファイルが作成されます。
`npm init -y`	質問に答えず、初期設定のまま`package.json`を作成します。
`npm install`	`package.json`に書かれている依存パッケージをインストールします。
`npm install パッケージ名`	指定したパッケージをプロジェクトにインストールします。例: `npm install express`
`npm install --save-dev パッケージ名`	開発時だけ使うパッケージをインストールします。例: テストツールやビルドツールなど。
`npm install -g パッケージ名`	パッケージをグローバルにインストールします。
`npm update`	インストール済みのパッケージを更新します。
`npm uninstall パッケージ名`	指定したパッケージを削除します。
`npm list`	インストールされているパッケージの一覧を表示します。
`npm outdated`	古くなっているパッケージを確認します。
`npm run スクリプト名`	`package.json`に定義したスクリプトを実行します。

新しいNode.jsプロジェクトを作成する際には、まずnpm initコマンドを使ってプロジェクトを初期化します。


npm init

このコマンドを実行すると、プロジェクト名、バージョン、説明、エントリーポイントなどを入力する画面が表示されます。入力が完了すると、package.jsonファイルが作成されます。

質問に答えず、初期設定のまま作成したい場合は、次のようにします。


npm init -y

パッケージをプロジェクトにインストールするには、npm installコマンドを使用します。

たとえば、expressパッケージをインストールする場合は、次のようにします。


npm install express

これにより、プロジェクト内にnode_modulesフォルダが作成され、expressがインストールされます。また、package.jsonの依存関係にも記録されます。

テストツールやコード整形ツールなど、開発時だけ使うパッケージは--save-devを付けてインストールします。


npm install --save-dev jest

このようにインストールしたパッケージは、package.jsonのdevDependenciesに記録されます。

npmでは、package.jsonにスクリプトを登録して実行できます。


{
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  }
}

登録したスクリプトは、次のように実行します。


npm run start
npm test

testなど一部のスクリプトは、npm run testではなくnpm testのように短く書くこともできます。

package.jsonは、プロジェクトの情報や依存パッケージ、実行スクリプトなどを管理するための重要なファイルです。

npmを使うプロジェクトでは、基本的にこのファイルを中心にパッケージを管理します。

npmでパッケージをインストールすると、node_modulesフォルダとpackage-lock.jsonファイルが作成されます。

項目	説明
`node_modules`	実際にインストールされたパッケージが保存されるフォルダです。
`package-lock.json`	インストールされたパッケージの正確なバージョン情報を記録するファイルです。

node_modulesは容量が大きくなりやすいため、Gitなどで管理する場合は通常アップロードしません。一方、package-lock.jsonは同じ環境を再現するために重要なので、基本的には管理対象に含めます。