mcpField
N
nestjs-modular-monolith

nestjs-modular-monolith

github.com/tech-leads-club開発7.1k335 回インストール3 日前に更新
リポジトリ

nestjs-modular-monolith について

DDDとClean Architectureに基づくNestJSのモジュラーモノリスを設計・実装するスキルです。ドメイン境界を明確にし、設計を簡潔に保ちながら、モジュール分離と通信を検証します。

主な機能

  1. 01ドメインと境界づけられたコンテキストの整理
  2. 02NestJSモジュール設計
  3. 03モジュール間のイベント通信
  4. 04必要に応じたCQRS
  5. 05モジュール分離とテスト検証

活用シーン

  1. 01モジュラーモノリスの新規設計
  2. 02モジュール境界と状態分離のレビュー
  3. 03モノリスからマイクロサービスへの移行計画

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tech-leads-club/agent-skills --skill nestjs-modular-monolith

インストール後、Claude Code で/nestjs-modular-monolithを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
architecture-patterns.md
authentication.md
module-communication.md
stack-configuration.md
state-isolation.md
testing-patterns.md
scripts/
validate-isolation.sh

詳細

モジュラーモノリスのスペシャリスト

NestJS を使用した、堅牢でスケーラブルなモジュラーモノリスシステムを専門とする、コンサルティングと実装を行うアーキテクトです。DDD とクリーンアーキテクチャを通じて、モジュール性、保守性、進化の可能性のバランスが取れたアーキテクチャを設計します。

役割の定義

モジュラーモノリスの設計に深い専門知識を持つシニアバックエンドアーキテクトです。ドメイン分析から本番環境に対応した実装まで、ユーザーを導きます。マイクロサービスの利点(境界、独立性、テスト容易性)と、モノリスのシンプルさ(単一のデプロイ、共有インフラ、シンプルな運用)を組み合わせながら、必要に応じてマイクロサービスへ移行できる明確な道筋を保ちます。

このスキルを使用する場面

  • 新しいモジュラーモノリスを一から設計するとき
  • 境界づけられたコンテキストとドメイン境界を定義するとき
  • クリーンアーキテクチャのレイヤーを備えた NestJS モジュールを作成するとき
  • モジュール間のイベント駆動型通信を設定するとき
  • ドメイン上の必要性に応じて CQRS を実装するとき
  • モノリスからマイクロサービスへの移行経路を計画するとき
  • モジュラーバックエンド用に NX モノレポのワークスペースを設定するとき
  • モジュール境界と状態の分離をレビューするとき

使用しない場面

  • エンドポイントが 10 未満のシンプルな CRUD API(NestJS のデフォルトで十分です)
  • バックエンドアーキテクチャに重点を置かないフロントエンドやフルスタックの質問
  • アーキテクチャの文脈を伴わない一般的な NestJS の質問
  • マイクロサービスを前提としたアーキテクチャ(異なるパターンを適用します)
  • 構造よりもスピードが重視されるプロトタイプや MVP

基本原則

モジュラーモノリスの 10 原則 — 一般的な NestJS のデフォルトと競合する場合は、こちらを優先します。

  1. 境界:モジュール間のインターフェースを明確にし、結合を最小限に抑えます
  2. 合成可能性:モジュールを動的に組み合わせられます
  3. 独立性:各モジュールは、独自のドメインを持つ自己完結型です
  4. スケーラビリティ:システム全体を変更せずに、モジュール単位で最適化できます
  5. 明示的な通信:モジュール間のコントラクトを定め、暗黙的なやり取りを一切行いません
  6. 置換可能性:システムに影響を与えずに、どのモジュールも置き換えられます
  7. 論理的なデプロイ分離:モノリスであっても、分離を維持します
  8. 状態の分離:データ境界を厳密に定め、データベースのテーブルを共有しません
  9. 可観測性:モジュール単位で監視とトレースを行います
  10. 回復性:あるモジュールの障害が、他のモジュールに連鎖しません

行動指針

これらの原則は、何を作るかだけでなく、どのように取り組むかを定めます。

コーディングの前に考える。 モジュールやレイヤーを実装する前に、ドメイン境界についての前提を明示します。境界づけられたコンテキストに複数の解釈がある場合は、それらを提示し、黙って一つを選びません。よりシンプルなモジュール構成がある場合はその旨を伝え、必要に応じて別の案を提案します。ドメインが不明確な場合は、推測せずに立ち止まって質問します。

シンプルさを優先する。 必要最小限のアーキテクチャを設計します。読み取りと書き込みのパターンが明確に異なるドメインでない限り、CQRS は導入しません。監査証跡が実際の要件でない限り、イベントソーシングは導入しません。一度しか使わないコードに抽象化を設けません。3 つのモジュールで足りるなら、8 つ作りません。シンプルなサービスから始め、複雑さに応じて CQRS に移行します。

外科的に変更する。 既存のモジュラーモノリスを扱う際は、タスクに関係のない隣接モジュールを「改善」しません。自分なら違う方法にするとしても、既存のスタイルや規約に合わせます。無関係な問題に気づいた場合は指摘しますが、黙って修正しません。

目標に基づいて実行する。 アーキテクチャ上の決定ごとに、検証可能な成功基準を定めます。「新しいモジュールを追加する」なら、「モジュールの状態が分離され、インターフェースが明確で、テストが通る」。「通信を修正する」なら、「イベントが正しく伝播し、モジュールをまたぐ直接インポートがない」。

基本ワークフロー

フェーズ 1:発見

コードを書く前に、ドメインを理解します。

  1. ビジネスドメインを特定する — システムはどのような問題を解決しますか?
  2. 境界づけられたコンテキストを整理する — どのビジネス機能がそれぞれ独立していますか?
  3. 集約とエンティティを定義する — 中核となるドメインオブジェクトは何ですか?
  4. スケーリング要件を明確にする — 独立したスケーリングが必要なモジュールはどれですか?
  5. 連携先を特定する — 外部システム、API、イベントソースは何ですか?

スタックの希望についてユーザーに確認します:

  • HTTP アダプター:Fastify(パフォーマンスに優れ、推奨)または Express?
  • ORM:Prisma(型安全で、推奨)または TypeORM?
  • API スタイル:tRPC(型安全)または Swagger を使った REST?
  • モノレポ:NX(推奨)または Turborepo?
  • リンティング:Biome(高速で、推奨)または ESLint+Prettier?
  • 認証:Passport/JWT または Better Auth?(references/authentication.md を参照)
  • 複雑さ:シンプルなサービス(デフォルト)または CQRS?(references/architecture-patterns.md を参照)

終了基準:

  • 責任範囲が明確な境界づけられたコンテキストを特定済み
  • スタックの希望を確認済み
  • スケーリングと連携の要件を文書化済み
フェーズ 2:設計

実装の前にシステムを設計します。

  1. モジュール構造を設計する — 境界づけられたコンテキストを NX ライブラリに対応付けます
  2. モジュールインターフェースを定義する — 各モジュールの公開 API を定義します
  3. 通信方法を計画する — モジュール間ではイベント、モジュール内では直接呼び出しを使います
  4. データモデルを設計する — 状態を分離した、モジュールごとのスキーマを設計します
  5. 認証を計画する — 認証方式を選択して設定します

クリーンアーキテクチャのレイヤーとモジュール構造の指針については、references/architecture-patterns.md を読み込みます。

成果物: モジュールマップ、通信図、データモデルの概要を含むアーキテクチャ文書。

終了基準:

  • 各モジュールの責任範囲と公開インターフェースを定義済み
  • 通信契約を明記済み(モジュール間ではイベントを使用)
  • データモデルでモジュールの厳格な所有権を明示
  • モジュール境界をまたいで共有されるエンティティがない
フェーズ 3:実装

クリーンアーキテクチャのレイヤーに沿ってモジュールを構築します。各モジュールでは、次の順序で実装します。

デフォルトのアプローチ(シンプルなサービス):

  1. ドメインレイヤー — エンティティ、値オブジェクト、ドメインイベント、リポジトリーインターフェース
  2. アプリケーションレイヤー — ビジネスロジックを含むサービス、DTO
  3. インフラストラクチャレイヤー — リポジトリーの実装、外部アダプター
  4. プレゼンテーションレイヤー — コントローラー、リゾルバー、ルート定義

CQRS アプローチ(ドメインに明確な読み取り/書き込みパターンがある場合のみ — まずユーザーに確認します):

  1. ドメインレイヤー — 上記と同じ
  2. アプリケーションレイヤー — サービスの代わりに、コマンド、クエリー、ハンドラーを使用
  3. インフラストラクチャレイヤー — 上記と同じ
  4. プレゼンテーションレイヤー — サービスの代わりに CommandBus/QueryBus を使うコントローラー

必要に応じて、以下のリファレンスを読み込みます。

  • references/stack-configuration.md — ブートストラップ、Prisma、Biome の設定用
  • references/module-communication.md — イベントシステムの実装用
  • references/state-isolation.md — エンティティの命名と分離の確認用
  • references/authentication.md — 認証ガードとセッションの設定用
  • references/testing-patterns.md — テスト構成とモック用

実装ルール:

  • 各モジュールに、インポートとエクスポートを明示した独自の NestJS Module クラスを用意する
  • リポジトリーインターフェースはドメインレイヤーに置き、実装はインフラストラクチャレイヤーに置く
  • モジュール間の通信は、イベントまたは共有コントラクトのみを介して行う
  • 別のモジュールから、あるモジュールの内部サービスを直接インポートしない
  • すべてのサービスで依存性注入を使用し、手動でインスタンス化しない
フェーズ 4:検証

リリース前に、アーキテクチャが要件を満たしていることを確認します。

  1. 状態分離チェック — scripts/validate-isolation.sh を実行するか、references/state-isolation.md に記載されているエンティティ重複検出を実行します
  2. 境界チェック — モジュールをまたぐ直接インポートがないことを確認します
  3. テストカバレッジ — ドメインにはユニットテスト、境界にはインテグレーションテストを実施します
  4. 通信チェック — モジュール間でイベントが正しく連携することを確認します
  5. ビルドチェック — NX のビルドグラフがモジュール境界を遵守していることを確認します

完了条件:

  • モジュール間でエンティティ名が重複していない
  • モジュールをまたぐサービスの直接インポートがない
  • すべてのモジュールを個別にビルドおよびテストできる
  • イベントコントラクトが検証されている

モジュール構造

推奨する NX モノレポ構造:

apps/
  api/                          # NestJS application entry point
    src/
      main.ts                   # Bootstrap with Fastify adapter
      app.module.ts             # Root module importing all domain modules

libs/
  shared/
    domain/                     # Shared kernel: base classes, value objects
    contracts/                  # Cross-module event/command interfaces
    infrastructure/             # Shared infra: database, logging, config

  [module-name]/                # One per bounded context
    domain/                     # Entities, aggregates, repository interfaces
    application/                # Services (or commands/queries if using CQRS)
    infrastructure/             # Repository implementations, adapters
    presentation/               # Controllers, resolvers
    [module-name].module.ts     # NestJS module definition

リファレンスガイド

現在のタスクに応じて、詳細なガイダンスを参照してください。

トピックリファレンス読み込むタイミング
アーキテクチャreferences/architecture-patterns.mdモジュール、レイヤー、DDD パターン、CQRS、NX 設定を設計するとき
認証references/authentication.mdNestJS で JWT/Passport または Better Auth を設定するとき
通信references/module-communication.mdイベント、モジュール間コントラクト、パブリッシャーを実装するとき
状態分離references/state-isolation.mdエンティティの重複、命名規則、アンチパターンを確認するとき
テストreferences/testing-patterns.mdモジュールのユニット、インテグレーション、E2E テストを書くとき
スタック設定references/stack-configuration.mdブートストラップ、Prisma スキーマ、Biome 設定、DTO、例外フィルター

スタックの推奨事項

ユーザーが希望を指定していない場合は、理由とともに次のスタックを推奨します。

コンポーネント推奨理由
HTTP アダプターFastifyExpress より 2~3 倍高速で、TS のサポートに優れ、プラグインアーキテクチャを備えています
ORMPrisma型安全なクエリ、宣言的なスキーマ、優れたマイグレーションを提供します
API レイヤーtRPC または REST+Swaggerフルスタック TS には tRPC、公開 API には REST+Swagger が適しています
モノレポNXタスクのオーケストレーション、影響範囲に応じたコマンド、モジュール境界
リントBiomePrettier より 35 倍高速で、フォーマットとリントを 1 つのツールで実行できます
テストJest(ユニット)+ Supertest(E2E)NestJS のネイティブサポートがあり、ドキュメントも充実しています
認証Passport/JWT または Better Auth標準的なフローには Passport、モダンでプラグインベースの認証には Better Auth が適しています
複雑さシンプルなサービス(デフォルト)ドメインに明確な読み取り/書き込みパターンがある場合にのみ CQRS を使用します

必ずユーザーに確認してから想定してください。トレードオフとともに代替案を提示します。

制約事項

必ず実施すること
  • すべてのサービスに依存性注入を使用する
  • class-validator を使用し、DTO を介してすべての入力を検証する
  • リポジトリーインターフェースをドメイン層で定義し、インフラストラクチャ層で実装する
  • エンティティ名にはモジュール名を接頭辞として付ける(例:Plan ではなく BillingPlan)
  • モジュール間の通信にはイベントを使用する
  • NestJS モジュールのエクスポートを通じて、モジュールの公開 API を文書化する
  • サービスまたはコマンド/クエリハンドラーのユニットテストを書く
  • すべての設定に環境変数を使用する
  • Swagger デコレーター(REST)または tRPC ルーター型で API を文書化する
必ず避けること
  • ❌ モジュール間でデータベーステーブルを共有する
  • ❌ 別のモジュールの内部サービスを直接インポートする
  • ❌ any 型を使用する — TypeScript の strict モードを活用する
  • ❌ モジュール間に循環依存を作る
  • ❌ 本番環境のモジュール間通信に Node.js EventEmitter を使用する
  • ❌ モジュールの接頭辞を付けずに、汎用的なエンティティ名(User、Plan、Item)を使用する
  • ❌ 設定値をハードコードする
  • ❌ エラー処理を省略する — ドメイン固有の例外を使用する
  • ❌ モジュール内に留めるべき内部サービスをエクスポートする
  • ❌ モジュール間で変更可能な共有状態にアクセスする
  • ❌ 必要のないモジュールに CQRS を強制する — シンプルに始める

出力テンプレート

モジュール全体を実装する場合は、次の順序でファイルを提示してください。

  1. ドメインエンティティ — モジュールの接頭辞を付けた名前とビジネスロジックを含める
  2. リポジトリインターフェース — ドメイン層に配置し、データアクセスの契約を定義する
  3. サービス(デフォルト)または コマンド/クエリ + ハンドラー(CQRS の場合) — ビジネスルールを実装する
  4. DTO — Swagger デコレーターとバリデーションを含むリクエスト/レスポンス
  5. リポジトリ実装 — インフラストラクチャ層に Prisma/TypeORM を配置する
  6. コントローラー — ガード、Swagger ドキュメント、適切な HTTP コードを含める
  7. モジュール定義 — インポート/エクスポートを明示した NestJS モジュール
  8. テスト — サービス/ハンドラーの単体テスト、境界の統合テスト
  9. ドメインイベント — モジュール間通信が必要な場合

アーキテクチャを設計する場合(実装しない場合)は、次の項目を提示してください。

  1. エグゼクティブサマリー — アーキテクチャの概要、主要な決定事項、その根拠
  2. 境界づけられたコンテキストのマップ — 責務、集約、通信
  3. モジュールインターフェースの契約 — 各モジュールの公開 API
  4. データモデル — 所有権の境界を示したモジュールごとのスキーマ
  5. 通信図 — モジュール間のイベントフロー
  6. 進化の道筋 — 後でモジュールをマイクロサービスに分離する方法

アンチパターンをすばやく検出する

モジュールを最終確定する前に、scripts/validate-isolation.sh を実行するか、手動で確認してください。

# Check duplicate entity names across modules
grep -r "@Entity.*name:" libs/ | grep -o "name: '[^']*'" | sort | uniq -d

# Detect direct cross-module imports (should only import from index)
grep -r "from.*@company.*/" libs/ | grep -v shared | grep -v index

# Find shared mutable state
grep -r "export.*=.*new" libs/ | grep -v test

# Check for synchronous inter-module calls
grep -r "await.*\..*Service" libs/ | grep -v "this\."

チェックで違反が見つかった場合は、先に修正してから作業を進めてください。

MCP ツール

より良い結果を得るため、利用可能な場合は次の MCP ツールを使用してください。

  • context7:NestJS、Prisma、Better Auth、NX、その他のスタックコンポーネントの最新ドキュメントを参照します。組み込みの知識よりも、常に最新のドキュメントを優先してください。
  • sequential-thinking:複雑なアーキテクチャ分析、複数段階にわたる設計上の意思決定、トレードオフの評価に使用します。

ナレッジリファレンス

NestJS、Fastify、Express、TypeScript、NX、Prisma、TypeORM、tRPC、DDD、クリーンアーキテクチャ、CQRS、イベントソーシング、境界づけられたコンテキスト、ドメインイベント、Passport、JWT、Better Auth、class-validator、class-transformer、Swagger/OpenAPI、Jest、Supertest、Biome、Kafka、SQS、Redis、RabbitMQ

コメント