【Node.js】lernaでMonorepoな環境を構築する

Node.jsでlernaを使ってMonorepoな環境を構築したい！

概要

今回の記事では、Node.jsでlernaを使ってMonorepoな環境を構築する手順を掲載する。

Monorepoとは、複数のプロジェクトを単一のリポジトリで管理する方法。共通の処理があったり、複数のアプリを合わせて、1つのサービスとするような感じのプロジェクト郡の管理に

npmでもyarnでもパッケージ管理できる。yarnを使いたい場合はインストールしておく。

npm install -g yarn

lernaのプロジェクトを作るディレクトリーの中でlernaをインストールする。

npm install -d lerna

lernaでプロジェクトを初期化する。

npx lerna init

workspaceがプロジェクトだとして下記のような感じでディレクトリーとファイルが作られる。

workspace
    node_module
    .gitgnore
    lerna.json
    package-lock.json
    package.json

lerna.jsonの中身を確認する。

{
  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
  "version": "0.0.0",
  "packages": [
    "packages/*"
  ]
}

パッケージの管理をyarnで行いたい場合は"npmClient": "yarn"を追加する。

{
  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
  "version": "0.0.0",
  "packages": [
    "packages/*"
  ],
  "npmClient": "yarn"
}

packagesのpackages/*がlernaで管理するプロジェクトの保管場所になるのでディレクトリーpackagesを作って、この中にプロジェクトを作ったり、移動したりする。

管理してるプロジェクト同士の依存関係の簡単な設定の例。

workspace
    packages
        main_app
        admin_app
    ...

main_appとadmin_appがあって、admin_appがmain_appに依存してるとする場合、はadmin_appのpackage.jsonのdependenciesの中に"main_app": "^1.0.0"を追加する。

{
  "name": "admin_app",
  "version": "1.0.0",
  "private": true,
  ...
  "dependencies": {
    ...
    "main_app": "^1.0.0"
  },
  ...
}

tsconfig.jsonのbaseUrlをいじってる場合は、pathsも編集した方が良さげ。

{
  "compilerOptions": {
    ...
    "baseUrl": "./src",
    "paths": {
      "main_app/*": ["../../main_app/src/*"]
    }
  },
}

編集が終わったら、ディレクトリーworkspaceに移動してyarn installまたはnpm installを実行するとプロジェクト間の依存関係に従って処理される。

yarn install

共通のパッケージのインストールもディレクトリーworkspaceでyarnやnpmを実行する。

メインのアプリがあって、管理アプリなどを別のプロジェクトで作る場合や共通のコードがある場合に使えるかもね！