npm (JavaScript のパッケージマネージャ) の概要 • Node.js によるシェルスクリプティング

6 npm (JavaScript のパッケージマネージャ) の概要

6.1 npm パッケージマネージャ
6.2 npm のヘルプの取得
- 6.2.1 コマンドラインでヘルプを取得
- 6.2.2 オンラインでヘルプを取得
6.3 一般的な npm コマンド
6.4 npm コマンドの省略形

6.1 npm パッケージマネージャ

npm レジストリは JavaScript パッケージをホストするための事実上の標準です。それらのパッケージには特定の形式があり、npm パッケージと呼ばれます。

したがって、JavaScript エコシステムでは、パッケージマネージャは npm レジストリまたは他のソースから npm パッケージをインストールするためのコマンドラインツールです。

最もポピュラーなパッケージマネージャは npm と呼ばれ、Node.js にバンドルされています。その名前は元々「Node Package Manager」の頭文字を取ったものです。その後、npm と npm レジストリが Node.js パッケージだけでなく使用されるようになったため、「npm is not a package manager」と定義が変更されました (ソース)。

yarn や pnpm などの他のポピュラーなパッケージマネージャもあります。これらのすべてのパッケージマネージャは既定で npm レジストリを使用します。

npm install など、いくつかのサブコマンドを提供するシェルコマンド npm を介して npm を使用します。

6.2 npm のヘルプの取得

6.2.1 コマンドラインでヘルプを取得

npm コマンドを使用して、そのコマンド自体について説明できます。一方で、npm の後に、または npm コマンドの後に使用できる -h オプションがあります。簡単な説明が提供されます

npm -h        # brief explanation of `npm`
npm <cmd> -h  # brief explanation of `npm <cmd>`

一方で、npm help コマンドがあり、より長い説明が提供されます

npm help         # brief explanation of `npm` (same as `npm -h`)
npm help npm     # longer explanation of `npm`
npm help <cmd>   # longer explanation of `npm <cmd>`
npm help <topic> # longer explanation of <topic>

ヘルプのトピックには次のものがあります

folders
npmrc
package.json

6.2.2 オンラインでヘルプを取得

公式 npm ドキュメントはオンラインでも利用できます。

6.3 一般的な npm コマンド

一般的なコマンドを以下に示します。

npm initは、現在のディレクトリをパッケージになるよう「初期化」します。つまり、その中に package.json ファイルを作成します。このコマンドは §14.3.1 「パッケージのディレクトリの設定」で説明されています。
npm installは、npm パッケージをグローバルまたはローカルにインストールします。これは §13 「npm パッケージのインストールと bin スクリプトリの起動」で説明されています。
npm publishは、レジストリにパッケージをパブリッシュします。新しいパッケージを作成するか、既存のパッケージをアップデートします。これは §14.5.3 「npm publish: npm レジストリにパッケージをアップロードする」で説明されています。
npm run (npm run-scriptの省略形)は、パッケージスクリプトを実行します。パッケージスクリプトは §15 「npm パッケージスクリプトによるクロスプラットフォームタスクの起動」で説明されています。
npm uninstallは、グローバルまたはローカルにインストールされたパッケージを削除します。

npm versionは、Node.js と npm のさまざまなコンポーネントのバージョンを記録したオブジェクト process.versions を出力します

{
  'my-package': '1.0.0', // current package
  npm: '8.15.0',
  node: '18.7.0',
  v8: '10.2.154.13-node.9',
  uv: '1.43.0', // libuv
  ···
  tz: '2022a', // version of tz database
  unicode: '14.0', // version of Unicode standard
  ···
}

npxでは、インストールせずにパッケージでbinスクリプトを実行できます。§13.4「npx: npmパッケージでbinスクリプトを実行する（インストール不要）」で説明しています。

npmのマニュアルには、npmコマンドのすべての一覧があります。

6.4 npmコマンドの略語

多くのnpmコマンドに略語があります。たとえば

短い	長い
`npm i`	`npm install`
`npm rm`	`npm uninstall`
`npm run`	`npm run-script`

npmのマニュアルは、説明されている各npmコマンドについて、すべてのエイリアス（略語を含む）も一覧します。