npm の 使い方

0 件のコメント

npm の基本的な使い方をまとめておきます。

目次

プロジェクト の 初期化

現在のディレクトリをルートディレクトリとして package.json を作成します。 package.json には今から作ろうとしているプロジェクトで利用するパッケージ情報 (以下の インストール を行った情報) が記載されます。

基本的には質問に答えて入力していくだけで package.json が初期化されます。 もし、すでに package.json が存在している場合、記載されているパッケージ情報に従って必要なパッケージをダウンロードおよび配置設定します。

npm init

package.json に依存関係を保存する場合、インストール時に --save オプションを付与して保存します。

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

パッケージ名 %PACKAGE_NAME% を指定して現在のプロジェクトにパッケージをインストールします。 --save オプションを付けると、 package.json に依存関係情報を書き込みます。

npm install %PACKAGE_NAME%
npm install %PACKAGE_NAME% --global

ローカルインストール と グローバルインストール

パッケージインストール先は 「ローカル」 と 「グローバル」 の2種類があります。 --global または -g オプションを付けるかどうかでローカルインストールとグローバルインストールを切り替えられます。 それぞれの違いは以下の通りです。

ローカルインストール (--global オプションなし)

  • 現在のプロジェクトの依存関係として取り込む ( Node.js の require で使う) 場合はローカルインストールします
  • インストール先は現在のプロジェクト配下に作られる node_modules フォルダ配下にインストールされます
  • コマンドとして実行する場合はパスを通して実行する必要があります

グローバルインストール (--global オプションあり)

  • コマンドラインツール (e.g. bower, grunt, jshint) はグローバルインストールします
  • インストール先はデフォルトなら以下の場所
    C:\Users\<UserName>\AppData\Roaming\npm\node_modules
  • パスが通っているので実行はコマンドをそのまま叩けば実行できる

パッケージ の アンインストール

インストール済みのパッケージを削除します。

npm uninstall %PACKAGE_NAME%

インストール済み パッケージ の 一覧表示

インストールされているパッケージの一覧を表示します。

npm ls

パッケージ の 更新

インストールされているパッケージに新しいバージョンがあれば更新を行います。

npm update %PACKAGE_NAME%

よく使うコマンドに絞ってまとめてみました。 とりあえずここに記載のコマンドが理解できていれば何とかはなるかと思います。