npmのworkspacesの使い方ついてまとめる

npm-workspaces-tips.md

前提

• workspaces は、ローカルファイルシステムでリンクされたパッケージを効率的に処理するためのオプション
  • パッケージで使うモジュールで重複されたものは1つに絞れる
• npm のバージョンが7以上
• 以下のプロジェクト構成だとする
  • . ├── A │   └── package.json └── package.json

手動で既存のプロジェクトで workkspaces の指定方法

プロジェクトのルートディレクトリの package.json で指定すること

• workspaces の指定
  • 階層Aのワークスペースを使うことを記載する

  • ︙
    "workspaces": ["A"]
    "private": true //ルートディレクトリをパッケージとして公開しない場合
    ︙
    

A 内の package.json で指定すること

• name の指定
  • ルートディレクトリにある package.json から参照できるようにする

  • ︙
    "name": "A"
    "private": true //Aディレクトリをパッケージとして公開しない場合
    ︙
    

workspaces 関連のコマンド

ワークスペースを初期化する

• npm init -w ワークスペースで指定するディレクトリ
  • ワークスペースで指定するディレクトリに package.json が生成される
  • ルートディレクトリにある package.json の workspaces にワークスペースで指定するディレクトリが追加される

ワークスペースに向けてパッケージをインストールする

• npm install インストールするパッケージ名 -w ワークスペース名
  • uninstall 、 ci などのコマンドも使える

コマンドを実行する

• npm run コマンド -w ワークスペース名
  • 指定されたワークスペースでコマンドを実行する
• npm run コマンド --workspaces
  • ルートディレクトリで指定したワークスペース全体にコマンドを実行する

参考

• リリース一覧 | Node.js
• workspaces | npm Docs
• npm workspace와 esbuild로 monorepo 구축해보기 – yceffort
• Nuhends 의 Tech Life :: [node] yarn workspaces 빠르게 알아보기
• Yarn のワークスペースの初歩 - 30歳からのプログラミング