npx、Yarn、ワークスペースを活用したnpmパッケージのインストール場所設定
Node.jsとnpmにおけるローカルインストールパッケージの場所設定方法
Node.jsパッケージを管理するツールであるnpmは、デフォルトでプロジェクトディレクトリのnode_modulesフォルダにパッケージをインストールします。しかし、状況によっては、このデフォルトの場所を変更したい場合があります。
このチュートリアルでは、npmパッケージのローカルインストール場所をカスタム設定する方法を、以下の2つの方法に分けて詳しく説明します。
- npm config コマンドを使用する
- 環境変数を使用する
npm configコマンドを使用すると、npmの設定を変更できます。ローカルインストール場所を設定するには、以下のコマンドを実行します。
npm config set prefix <your-custom-directory>
上記の例では、your-custom-directoryを、パッケージをインストールするカスタムディレクトリのパスに置き換えます。
例
以下のコマンドは、/home/user/my-npm-packagesディレクトリをローカルインストール場所として設定します。
npm config set prefix /home/user/my-npm-packages
このコマンドを実行すると、~/.npmrcファイルに設定が保存されます。
環境変数を使用しても、npmパッケージのローカルインストール場所を設定できます。以下の手順を実行します。
- NODE_PATH環境変数を設定する
NODE_PATH環境変数に、カスタムインストールディレクトリへのパスを追加します。以下のコマンドを実行します。
export NODE_PATH="<your-custom-directory>:$NODE_PATH"
export NODE_PATH=/home/user/my-npm-packages:$NODE_PATH
- シェル設定ファイルに設定を永続化する
上記の設定を永続化するには、シェル設定ファイル（例：.bashrc、.zshrc）に以下の行を追加します。
export NODE_PATH="<your-custom-directory>:$NODE_PATH"
注意事項
- 上記の方法で設定を変更する前に、必ず現在の設定をバックアップしておいてください。
- カスタムインストールディレクトリが存在しない場合は、事前に作成する必要があります。
- 環境変数を使用する場合、すべてのターミナルセッションで設定が有効になるように、シェル設定ファイルに設定を追加する必要があります。
上記以外にも、npmパッケージのインストール場所を制御する方法はいくつかあります。詳細は、npm公式ドキュメントを参照してください。
以下のサンプルコードは、方法1：npm config コマンドを使用する で説明した内容を実行するbashスクリプトです。
#!/bin/bash
# カスタムインストールディレクトリを設定
CUSTOM_DIR="/home/user/my-npm-packages"
# 現在の設定をバックアップ
echo "現在の設定をバックアップしています..."
npm config get prefix > ~/.npmrc.bak
# カスタムインストールディレクトリを設定
echo "カスタムインストールディレクトリを設定しています..."
npm config set prefix "$CUSTOM_DIR"
# 設定を検証
echo "設定を検証しています..."
npm config get prefix
echo "完了しました！"
このスクリプトを実行するには、以下の手順を実行します。
- 上記のコードをテキストエディタで保存します。
- ファイルを
set-npm-prefix.shなどの名前に変更します。 - 以下のコマンドを実行してスクリプトを実行可能にします。
chmod +x set-npm-prefix.sh
./set-npm-prefix.sh
このサンプルコードはあくまでも一例です。ご自身のニーズに合わせて、自由にカスタマイズしてください。
Node.jsとnpmにおけるローカルインストールパッケージの場所設定方法：その他の方法
上記で説明した2つの方法に加え、npmパッケージのローカルインストール場所を設定する方法は他にもいくつかあります。
npx コマンドを使用する
npxコマンドは、Node.jsパッケージを一時的にインストールして実行できるツールです。ローカルインストール場所を変更する必要がある場合、npxを使用してパッケージをインストールすることで、デフォルトの場所を使用せずに済みます。
以下の例は、npxを使用してmy-packageパッケージを/home/user/my-projects/project1/node_modulesディレクトリにインストールする方法を示しています。
npx install my-package --prefix /home/user/my-projects/project1
Yarnを使用する
Yarnは、npmに代わるパッケージマネージャーです。Yarnは、グローバルインストールとローカルインストールの場所を個別に設定できる機能を提供しています。
yarn install my-package --prefix /home/user/my-projects/project1
ワークスペースを使用する
npm workspaces機能を使用すると、プロジェクト内の複数のディレクトリにパッケージをインストールできます。ワークスペースを使用すると、各ディレクトリに個別のローカルインストール場所を設定できます。
詳細は、npmドキュメントを参照してください: https://docs.npmjs.com/cli/v7/using-npm/workspaces/
パッケージのインストールオプションを使用する
一部のパッケージは、インストール時に--prefixオプションを受け付けて、インストール場所を指定できます。
npm install my-package --prefix /home/user/my-projects/project1
上記の方法を使用する場合は、各方法に固有のドキュメントを参照して、詳細を確認することをお勧めします。
npmパッケージのローカルインストール場所を設定するには、さまざまな方法があります。上記で紹介した方法はほんの一例です。
ご自身のニーズに合った方法を選択してください。
node.js npm
