PNPM パッケージマネージャ
これは何ですか?
このプロジェクトは、パッケージ管理のために PNPM を使用しています。PNPMはNPMと同じですが、最適化されています。
このプロジェクトを使用するためにPNPMが必要というわけではありません。npm
を使用することもできます。しかし、PNPMを初めて紹介される方には、とてもシンプルで非常に効率的なツールであり、使い始めるには最適なプロジェクトです。
PNPMはすべてのパッケージを共通の場所に保存し、各プロジェクトの「node_modules」フォルダーに直接保存するのではありません。
パッケージをインストールする際には、そのパッケージとバージョンが共通の場所に存在するかを確認します。存在しない場合は、共通の場所に読み込まれ、存在する場合は「node_modules」から共通の場所へのリンクが設定されます。正確に同じバージョンのソフトウェアが複数のプロジェクトにコピーされることはありません。
一般情報
PNPMのインストール
npm install -g pnpm
- その後、すべての操作や必要な場所では
npm
の代わりにpnpm
を使用します。
設定ノート
PNPMのマイナーな設定が必要です。pnpm setup
を実行して、そのプロセスが自動的にパラメータと必要なフォルダーへのPATHを設定することを許可できます。もしくは、これらのノートを参考にしてセットアップをカスタマイズできます。環境の変更を行う前にIDEを閉じてください。
pnpm
コマンドは npm
、npx
、およびその他の関連コマンドと同じフォルダーにインストールされます。これの設定には「global-bin-dir」と「store-dir」というパラメータが含まれています。
global-bin-dir は、pnpm が独自のコマンドを保存する場所です。これは、NPMがコマンドを保存するフォルダーに似ています。実際、このフォルダーはそのフォルダーの下にあることもあります。例えば:
- C:\Users\you\AppData\Roaming\npm
- C:\Users\you\AppData\Roaming\npm\global-bin-dir
このフォルダーを手動で設定できます。フォルダーを作成し、次のコマンドを実行します:
pnpm config set global-bin-dir "C:\Users\you\AppData\Roaming\npm\global-bin-dir"
また、このフォルダーをユーザーPATHに追加してください。
store-dir は、すべての共通node_modulesパッケージが保存される場所です。
このフォルダーも手動で設定できます。フォルダーを作成し、次のコマンドを実行します:
pnpm config set store-dir "D:\path\.pnpm-store"
(このフォルダーの下に ‘v3’ フォルダーのツリーが作成されます。)
また、このフォルダーをユーザーPATHに追加してください。
既存のプロジェクト
既存のプロジェクトでは、「node_modules」フォルダーを削除し、pnpm install
を実行するだけで大丈夫です。これにより、既存の package.json とロックファイルを使用して新しい場所にパッケージがインストールされ、ローカルの「node_modules」フォルダーからリンクが設定されます。
一度pnpmがインストールされたら、pnpm install
を実行して、すべての依存関係を持つ「node_modules」を読み込みます。
このプロジェクト特有の情報
- 上記の通りPNPMをインストールするか、パッケージ管理のためにNPMを使用します。
- このプロジェクトのルートフォルダーでターミナルを開き、
pnpm install
を実行します。 /docs
に移動し、pnpm install
を実行します。
これで、ドキュメントを表示し、このプロジェクトを使用する準備が整いました。