ServBayでnpm(Node.jsパッケージマネージャー)を有効化・使用する方法
npm
(Node Package Manager)は、Node.jsの公式パッケージマネージャーであり、世界最大級のオープンソースソフトウェアライブラリの一つです。Node.jsの開発者にとって、npm
はプロジェクト内の依存関係のインストール・共有・管理を簡単に実現する不可欠なツールです。ServBayの統合環境を使えば、npm
をすぐに活用して開発を始められます。
前提条件
npm
を使う前に、ServBayでNode.jsをインストールする必要があります。
- ServBayアプリを起動します。
- 「パッケージ」(Packages)パネルに移動します。
- Node.jsパッケージを見つけて、インストール済み&稼働中であることを確認します。
ServBayがNode.js環境を自動で設定し、その中にnpm
も含まれます。
npmがインストール済みかの確認
ServBay経由でインストールされたNode.jsにはすでにnpm
が同梱されており、デフォルトで有効になっています。ターミナルを使ってnpm
が正しくインストールされ利用可能かをサッと確認できます。
お使いのターミナルアプリ(例:macOSのターミナル)を起動します。
次のコマンドで
npm
のバージョンを確認します:bashnpm -v
1コマンドが正常に実行され、バージョン番号(例:
10.2.0
やそれ以上)が表示されれば、npm
が正しくインストールされていて現行環境で利用可能です。bash# 出力例 10.2.0
1
2もし「command not found: npm」等のエラーが表示された場合は、ServBayでNode.jsパッケージが正しくインストールされているか、ServBayの環境変数がロードされているかをご確認ください(通常はターミナルやPCを再起動すれば環境変数問題が解決します)。
npmのアップデート
ServBayでインストールしたNode.jsには基本的に安定版のnpm
が付属していますが、npm
自体はNode.jsから独立して頻繁にアップデートされます。常に最新機能や修正を利用するには、npm
自身を以下のコマンドで更新できます:
npm install -g npm@latest
このコマンドは最新バージョンのnpm
をグローバルにインストールします。-g
フラグはグローバルインストールを意味し、任意の場所で新しいnpmコマンドが利用可能になります。
アップデート後、再びnpm -v
でバージョンを確認しましょう:
npm -v
npmの主な機能と基本的な使い方
npm
の強みは、豊富なオープンソースエコシステムと、便利な依存関係管理にあります。以下に、日々の開発でよく使われるコマンドとその用途を示します。
新規Node.jsプロジェクトの初期化
空のディレクトリで新しくNode.jsプロジェクトを始める際、npm init
でpackage.json
ファイルを作成できます。このファイルは、プロジェクトのメタデータ、依存情報、さまざまなスクリプトなどを記録する要となります。
cd /Applications/ServBay/www/my-new-project.servbay.demo
npm init
2
npm init
は、プロジェクト名、バージョン、説明、エントリファイル等を順に尋ねてきます。デフォルトのpackage.json
を素早く作りたい場合はnpm init -y
を使ってください。
プロジェクト依存パッケージのインストール
プロジェクトのルートディレクトリ(package.json
があるフォルダ)で、すべての必要な依存パッケージをnpm install
でインストールできます。
cd /Applications/ServBay/www/my-project.servbay.demo
npm install
2
このコマンドはpackage.json
のdependencies
とdevDependencies
を読み、必要なモジュールをnode_modules
フォルダにインストールします。
新しい依存パッケージの追加
プロジェクトに新しいライブラリやフレームワークを追加するには、npm install <package-name>
コマンドを使います。
# 実行時依存(例:Expressフレームワーク)をインストール
npm install express
# 開発時依存(例:テスト用のMocha)をインストール
npm install mocha --save-dev
2
3
4
5
デフォルトでは、npm install <package-name>
はパッケージをnode_modules
にインストールし、package.json
のdependencies
へ自動で追記します。--save-dev
フラグを使うと、devDependencies
に追加され、開発やテスト・ビルド用の依存管理に便利です。
依存パッケージの削除
不要な依存パッケージは、npm uninstall <package-name>
で削除できます。
npm uninstall express
これにより、該当パッケージがnode_modules
から削除され、package.json
も更新されます。
依存パッケージのアップデート
プロジェクトの依存パッケージを(package.json
で指定された範囲内で)最新バージョンに保つには、npm update
を使います。
npm update
このコマンドは、node_modules
にインストール済みのパッケージをスキャンし、package.json
の範囲内で最新の互換バージョンに更新します。
npmスクリプト(Scripts)の利用
package.json
のscripts
フィールドを利用すると、独自のコマンドラインスクリプトを定義できます。開発サーバーの起動、テスト実行、ビルドなどの繰り返し作業を自動化するのにとても便利です。
例えば、package.json
に以下のようなscripts
を記述できます:
{
"name": "my-project",
"version": "1.0.0",
"scripts": {
"start": "node index.js",
"test": "mocha test/**/*.js",
"build": "webpack --config webpack.config.js"
},
"dependencies": {
"express": "^4.18.2"
},
"devDependencies": {
"mocha": "^10.2.0",
"webpack": "^5.89.0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
その後、ターミナルでnpm run <script-name>
としてこれらのスクリプトを実行できます。
# アプリの起動
npm start
# テストの実行
npm test
# ビルド処理
npm run build
2
3
4
5
6
7
8
なお、start
、test
、install
、restart
、stop
等の一部スクリプト名はrun
を省略して、直接npm start
やnpm test
のように実行可能です。
よく使うnpmコマンド一覧
上記以外にも知っておくと便利なnpmコマンドがいくつかあります:
グローバルパッケージのインストール:システムのどこからでも利用できるCLIツールをインストールします。
bashnpm install -g <package-name> # 例:一時的なコマンド実行用のnpx(通常Node.jsと一緒にインストールされます) npm install -g npx # 例:開発中のアプリ自動再起動ツールnodemonのインストール npm install -g nodemon
1
2
3
4
5一時的なコマンドの実行(npx):
npx
はnpm 5.2以上に付属しているツールで、node_modules/.bin
内の実行ファイルや、必要なパッケージのコマンドを一時的にダウンロード&実行できます。グローバルインストール不要です。bash# create-react-appをグローバルインストールせずに新規Reactアプリ作成 npx create-react-app my-react-app
1
2グローバルインストール済みパッケージ一覧表示:インストール済みCLIツールやライブラリをバージョン付きで表示します。
bashnpm list -g --depth=0
1npmキャッシュのクリーンアップ:インストールエラー等はキャッシュ問題のケースがあり、クリーンアップで解決することがあります。
bashnpm cache clean --force
1パッケージ情報の表示:特定パッケージの詳細(バージョン、依存、リポジトリなど)を確認できます。
bashnpm view <package-name>
1パッケージの検索:npmリポジトリ内でキーワード検索できます。
bashnpm search <keyword>
1
トラブルシューティング
npm command not found
: ServBayでNode.jsパッケージをインストールしているか、ターミナルのパスがNode.jsとnpmのインストール先を認識できているか確認してください。パス解決にはターミナルやPCの再起動が有効です。- 依存インストールの失敗: ネットワーク接続を確認してください。会社のプロキシ設定が影響する場合はnpmのプロキシ設定が必要なこともあります。npmキャッシュをクリーン(
npm cache clean --force
)して再試行すると解決する場合もあります。 - 権限エラー: macOSではグローバルインストール(
npm install -g
)時に権限エラーが起きることがあります。Node Version Manager (nvm)の利用や、ServBayが適切なインストールパスを設定していることを確認しましょう。sudo
の利用はトラブルの元なので避けてください。なお、ServBayのNode.jsは権限問題を解消済みなので、ServBayのディレクトリ内ではユーザー権限で操作可能です。
まとめ
ServBayを使えば、ローカル環境でフル機能のNode.js開発環境を簡単に構築し、すぐにパッケージ管理やプロジェクト開発のために強力なnpm
ツールを使い始めることができます。npm
の基本操作や便利なコマンドの習得は、日々の開発効率を格段にアップさせるはずです。Node.jsエコシステムを深く活用する上で、npm
はあなたの頼れるパートナーとなるでしょう。