JavaScriptで開発する時、ライブラリをインストールして取り込んだ上で開発することがあります。
Node.jsで開発している場合は、npmでパッケージをインストールしてライブラリを使用します。
npmでのインストールは「ローカル」と「グローバル」のインストールがあります。
グローバルでインストールすれば、どのパスでもインストールしたパッケージを利用することができます。
ローカルでインストールすれば、インストールしたディレクトリ配下でパッケージを利用することができます。
ただ別プロジェクトに参画した時に別バージョンのパッケージが必要だったり、不要ライブラリがインストールされた状態になってしまうので、基本的にはローカルにパッケージをインストールした方がいいです。
今回は知識の整理の為に、npmパッケージインストール辺りを書いていきます。
まず Node.js npm とは 見出しへのリンク
まずJavaScript/Node.jsでの開発環境を前提としていますが、Node.js とは何でしょうか。
Node.js 見出しへのリンク
サーバーサイドでJavaScriptを動かすことができるプラットフォームです。 過去JavaScriptはブラウザ上のページに動きをつけることがメインでしたが、そのクライアントサイドエンジニアでもNode.jsがあることでサーバーサイドの開発をすることができます。
npm (node package manager) 見出しへのリンク
パッケージマネージャーのことです。 Node.jsのパッケージを管理するツールのことです。 あらかじめNode.jsで用意してある便利なツールを、npmでインストールして使用することができます。Node.jsをインストールしたらnpmを使えます。
npm コマンド 見出しへのリンク
インストール済パッケージの確認：local
npm list --depth 0
インストール済パッケージの確認：global
npm list --depth 0 -g
パッケージをインストール：local
開発時のみ利用するパッケージの場合、package.json の devDependencies に追記する必要ありなので、以下コマンドをたたいてローカルにインストールさせる。
npm install パッケージ名 --save-dev
ローカルでnpmパッケージインストールして利用する方法 見出しへのリンク
以下手順を記します。
開発するフォルダを作成する mkdir dev
npm init で初期化をする 初期化した上で package.json ファイルを作成する
インタラクティブ形式で各パラメータを設定する。 私はサンプルアプリなら以下パターンでよく登録する。
package name: (a) sample-apps
version: (1.0.0) 1.0.0
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
- dev ディレクトリ配下にpackage.jsonファイルが作成されていることを確認する
- ローカル環境にパッケージをインストールする
npm install --save-dev
- パッケージがインストールされたか確認する
npm list --depth 0
インストールするだけなら以上までが手順です。
インストールしたパッケージ自身を実行する場合は以下コマンドをたたきます。
npm start
その場合package.jsonを修正することを忘れずに。
※以下はbrowser-syncパッケージを利用する場合
"start": "browser-sync start --server --files='**/*'"
以上