Node Package Manager (npm)

npmバージョン

$ npm --version
5.6.0

概要

Node.js アプリのパッケージ管理マネージャー

以下の機能を持つ

• パッケージの作成 (npm init)
• パッケージのインストール (npm install or npm i)
• パッケージのアンインストール (npm uninstall)
• スクリプトの実行 (npm run-script or npm run)
• 開発環境の表示・設定(npm root, npm config, npm adduser, ...)

パッケージの作成 (npm init)

使い方

パッケージの作成

$ cd hello_world
$ npm init

{
  "name": "hello_world",
  "version": "1.0.0",
  "description": "My first node app",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

• package.jsonが生成される
• オプション
  • -y 対話環境のスキップ

package.json

キー	説明
name	パッケージ名
version	パッケージバージョン
description	パッケージについての説明 (オプション)
main	エントリーファイル。 他のパッケージからインポート(require)された際、mainファイルの module.exports が返り値となる。 実行モジュールの場合は、省略可能。(ただし省略しなければ node . で実行する事ができる。)
dependencies	依存関係にあるパッケージの登録
devDependencies	開発時のみに使用する依存関係パッケージの登録
optionalDependencies	ある環境においてのみ必要となる依存関係パッケージの登録
scriipt	スクリプトの登録

パッケージのインストール (npm install)

使い方1 パッケージのインストール

その他のパッケージのインストール

$ npm install `library`

• npm i と省略が可能

オプション

オプション名	簡略スタイル	説明
--global	-g	グローバル領域へのインストール
--save-prod	-P	インストールしたパッケージを dpendencies に追加する。(デフォルト値、version5以前の --save からの置き換え)
--save-dev	-D	インストールしたパッケージを devDependencies に追加する。
--save-optional	-O	インストールしたパッケージを optionalDepencies に追加する。
--no-save		dependenciesへの追加を防止する。

使い方2 再インストール

再インストール

npm install

ライブラリーを指定しなければ、package.jsonを元に再インストールする。

パッケージのアンインストール (npm uninstall)

$ npm uninstall `library`

• -g オプションをつけるとグローバル領域から削除される

スクリプトの実行 (npm run-script)

スクリプトの実行

$ npm run script_name

• スクリプト名が、 "start" の場合は、runを省略可。 npm start でOK。
• スクリプトの定義において、node_module配下のツールはパスが不要。

スクリプトの登録

package.jsonの scripts キーに定義する。

package.json

...
scripts: {
	"start: "node .",   // mainファイルは実行される
	"build": "webpack", // node_modules配下のツールはパスが不要
	"develop": "webpack -w"
},

開発環境の表示・設定

node_modulesパスの表示 (npm root)

有効な node_moduels フォルダパスを表示する。

node_modulesパスの取得

$ npm root

• -g オプションをつけるとグローバル領域の node_modules フォルダのパスが出力される

公式リファレンス

参考サイト

[Qiita] ちゃんと使い分けてる? dependenciesいろいろ。