NestJS Drizzle CRUD ジェネレータ

概要

NestJS アプリケーション向けに Drizzle ORM を使用した完全な CRUD モジュールを自動生成します。zaccheroni-monorepo パターンに従うすべての必要なファイルを生成します：フィーチャーモジュール、コントローラー、サービス、Zod 検証済み DTO、Drizzle スキーマ、Jest ユニットテストです。

使用する場合

• 完全な CRUD エンドポイント付きで新しいエンティティモジュールを作成する場合
• NestJS でデータベース連動フィーチャーを構築する場合
• Zod 検証を使用したタイプセーフな DTO を生成する場合
• Drizzle ORM クエリを備えたサービスを追加する場合
• モック化されたデータベースを使用したユニットテストを作成する場合

手順

ステップ 1：エンティティフィールドを定義する

エンティティ定義を収集します：

• エンティティ名（例：user、product、order）
• 型付きフィールドリスト（サポートされている型については references/field-types.md を参照）
• 必須フィールド vs デフォルト値を持つオプショナルフィールド

ステップ 2：ジェネレータを実行する

python scripts/generate_crud.py --feature <name> --fields '<json-array>' --output <path>

ステップ 3：生成されたファイルを確認する

すべての予想されたファイルが作成されたことを確認します：

ls -la libs/server/<feature-name>/src/lib/

予想される構造：

controllers/
services/
dto/
schema/
<feature>-feature.module.ts

ステップ 4：TypeScript コンパイルを実行する

cd libs/server && npx tsc --noEmit

ステップ 5：ユニットテストを実行する

cd libs/server && npm test -- --testPathPattern=<feature-name>

例

User モジュールを生成する

python scripts/generate_crud.py \
  --feature user \
  --fields '[{"name": "name", "type": "string", "required": true}, {"name": "email", "type": "email", "required": true}, {"name": "password", "type": "string", "required": true}]' \
  --output ./libs/server

Product モジュールを生成する

python scripts/generate_crud.py \
  --feature product \
  --fields '[{"name": "title", "type": "string", "required": true}, {"name": "price", "type": "number", "required": true}, {"name": "description", "type": "text", "required": false}, {"name": "inStock", "type": "boolean", "required": false, "default": true}]' \
  --output ./libs/server

生成される構造

libs/server/{feature-name}/
├── src/
│   ├── index.ts
│   └── lib/
│       ├── {feature}-feature.module.ts
│       ├── controllers/
│       │   ├── index.ts
│       │   └── {feature}.controller.ts
│       ├── services/
│       │   ├── index.ts
│       │   ├── {feature}.service.ts
│       │   └── {feature}.service.spec.ts
│       ├── dto/
│       │   ├── index.ts
│       │   └── {feature}.dto.ts
│       └── schema/
│           └── {feature}.table.ts

機能

モジュール

• forRootAsync パターンを使用した遅延設定
• 他のモジュール用に生成されたサービスをエクスポート
• フィーチャーテーブルのための DatabaseModule をインポート

コントローラー

• 完全な CRUD エンドポイント：POST、GET、PATCH、DELETE
• ページネーション用のクエリパラメータ検証
• Zod 検証パイプ統合

サービス

• Drizzle ORM クエリメソッド
• ソフト削除サポート（deletedAt カラム経由）
• リミット/オフセットによるページネーション
• フィルタリングサポート
• タイプセーフな戻り値型

DTO

• Create および Update 用の Zod スキーマ
• フィルタリング用のクエリパラメータスキーマ
• NestJS DTO 統合

テスト

• Jest テストスイート
• モック化された Drizzle データベース
• すべての CRUD 操作のテストケース

手動統合

生成後、アプリモジュールに統合します：

// app.module.ts
import { {{FeatureName}}FeatureModule } from '@your-org/server-{{feature}}';

@Module({
  imports: [
    {{FeatureName}}FeatureModule.forRootAsync({
      useFactory: () => ({
        defaultPageSize: 10,
        maxPageSize: 100,
      }),
    }),
  ],
})
export class AppModule {}

依存関係

必要なパッケージ：

• @nestjs/common
• @nestjs/core
• drizzle-orm
• drizzle-zod
• zod
• nestjs-zod

ベストプラクティス

1. コミット前に検証する：生成されたコードをコミットする前に必ず tsc --noEmit とテストを実行してください
2. サービスをカスタマイズする：生成後、検証したサービスにビジネスロジックを追加してください
3. データベースマイグレーション：生成された Drizzle スキーマのためのマイグレーションを別途作成してください
4. 生成された型を使用する：アプリケーションコード内で生成された型を参照してください
5. DTO を確認する：API 要件に基づいて Zod 検証ルールを調整してください

制約と警告

• ソフト削除のみ：削除操作はソフト削除（deletedAt タイムスタンプ）を使用します。ハード削除には手動による変更が必要です
• 認証なし：生成されたコードに認証ガードは含まれません。セキュリティ要件に基づいて追加してください
• 基本的な CRUD のみ：複雑なクエリ、トランザクション、またはビジネスロジックは手動で実装する必要があります
• JSON エスケープ：コマンドライン上で JSON 配列を渡すときは、フィールドの周囲にシングルクォートを使用してください