Web開発のためのモノレポ戦略

モノレポ：単一リポジトリで複数プロジェクトを管理する

モノレポとは、複数のプロジェクトを含む単一のGitリポジトリです。フロントエンド、バックエンド、共有ライブラリ、ドキュメント用に別々のリポジトリを持つ代わりに、それらすべてを1か所にまとめます。このアプローチはGoogle、Meta、Microsoftによって先駆けられ、現在ではあらゆる規模のチームで人気があります。

モノレポを使用する理由

主な利点はコードの共有です。フロントエンドとバックエンドがTypeScriptの型を共有する場合、それらを一度定義してどこでも使用できます。共有ユーティリティ関数、バリデーションスキーマ、設定ファイルは1か所にあります。複数のプロジェクトに影響する変更は、複数のリポジトリ間で調整するのではなく、1つのコミットで行うことができます。

アトミックコミットも別の利点です。APIエンドポイントを変更し、それに合わせてフロントエンドを更新する必要がある場合、1つのコミットで行います。タイミングの問題もバージョンの不一致もありません。コードレビューでは変更の全体像が示されます。そして、プロジェクトの境界を越えたリファクタリングも簡単です。

ツール

いくつかのツールがモノレポを実用的にします。Nxは、インテリジェントなキャッシュ、依存関係グラフの認識、多くのフレームワークのサポートを備えた強力なビルドシステムです。Turborepoはよりシンプルで、キャッシュとタスクオーケストレーションに焦点を当てています。pnpmワークスペースとYarnワークスペースは、パッケージリンクによる基本的なモノレポサポートを提供します。

これらのツールは、どのプロジェクトがどのプロジェクトに依存しているかを理解し、変更の影響を受けるテストとビルドのみを実行できます。これにより、モノレポは大規模になっても高速に動作します。

モノレポの整理

典型的なモノレポ構造では、共有コードをpackagesディレクトリに、アプリケーションをappsディレクトリに、ツール設定をルートに配置します。各パッケージには独自のpackage.json、TypeScript設定、テストがあります。ルート設定は、リンティング、フォーマット、テストの共有標準を設定します。

明確な所有権が重要です。コードは1つのリポジトリにありますが、異なるチームが異なるパッケージを所有できます。CODEOWNERSファイルは、誰が何に責任を持つかを定義します。CIパイプラインは、変更されたファイルに基づいて異なるチェックを実行するように設定できます。

潜在的な課題

モノレポには課題がないわけではありません。リポジトリのサイズが大きくなる可能性がありますが、最新のGitはこれをうまく処理します。CIは、変更されたプロジェクトのみをビルドするようにスマートである必要があります。アクセス制御はより微妙です。リポジトリの一部のみへのアクセスを許可することはできません。また、ツールのセットアップは、単純な単一プロジェクトのリポジトリよりも複雑です。

ほとんどのチームにとって、コード共有とアトミックコミットの利点は課題を上回ります。鍵となるのは、適切なツールを使用し、リポジトリの整理方法に関する明確な規則を確立することです。