nestjs

このスキルを使うタイミング

次のような要望がある場合は、いつでもこのスキルを使ってください。

• NestJS アプリケーションの構築またはリファクタリング
• コントローラー、プロバイダー、モジュールの実装
• ミドルウェア、パイプ、ガード、インターセプターの適用
• DI スコープ、動的モジュール、ライフサイクルフックの設定
• バリデーション、シリアライゼーション、キャッシュ、ロギング、キューの追加
• GraphQL、WebSockets、マイクロサービスとの連携
• OpenAPI/Swagger による API ドキュメントの作成
• 認証／認可またはセキュリティ強化の実装
• NestJS のユニットテストまたは e2e テストの作成

このスキルの使い方

1. ユーザーのリクエストからトピックを特定し、以下のマッピングで対応するサンプルファイルを探します

2. examples/ ディレクトリから適切なサンプルファイルを読み込みます

3. 構文、構成、ベストプラクティスについて、そのサンプルファイルに記載された具体的な指示に従います

   重要な注意事項：

   • すべてのサンプルは NestJS 公式ドキュメントの構成に準拠しています
   • 該当する場合、サンプルには JavaScript と TypeScript の両方のバージョンが含まれています
   • 各サンプルファイルには、主要な概念、コード例、公式ドキュメントへのリンクが含まれています
   • ベストプラクティスや一般的なパターンについては、必ずサンプルファイルを確認してください

4. 一般的なひな形の作成を効率化するため、templates/ ディレクトリのテンプレートを使います

ドキュメントの対応関係（https://docs.nestjs.com/ と一対一対応）

概要

• examples/overview/introduction.md → https://docs.nestjs.com/
• examples/fundamentals/first-steps.md → https://docs.nestjs.com/first-steps
• examples/fundamentals/controllers.md → https://docs.nestjs.com/controllers
• examples/fundamentals/providers.md → https://docs.nestjs.com/providers
• examples/fundamentals/modules.md → https://docs.nestjs.com/modules
• examples/fundamentals/middleware.md → https://docs.nestjs.com/middleware
• examples/fundamentals/exception-filters.md → https://docs.nestjs.com/exception-filters
• examples/fundamentals/pipes.md → https://docs.nestjs.com/pipes
• examples/fundamentals/guards.md → https://docs.nestjs.com/guards
• examples/fundamentals/interceptors.md → https://docs.nestjs.com/interceptors
• examples/overview/custom-decorators.md → https://docs.nestjs.com/custom-decorators

基礎

• examples/fundamentals/custom-providers.md → https://docs.nestjs.com/fundamentals/custom-providers
• examples/fundamentals/async-providers.md → https://docs.nestjs.com/fundamentals/async-providers
• examples/fundamentals/dynamic-modules.md → https://docs.nestjs.com/fundamentals/dynamic-modules
• examples/fundamentals/module-ref.md → https://docs.nestjs.com/fundamentals/module-ref
• examples/fundamentals/execution-context.md → https://docs.nestjs.com/fundamentals/execution-context
• examples/fundamentals/lifecycle-events.md → https://docs.nestjs.com/fundamentals/lifecycle-events
• examples/fundamentals/injection-scopes.md → https://docs.nestjs.com/fundamentals/injection-scopes
• examples/fundamentals/request-scoped.md → https://docs.nestjs.com/fundamentals/request-scoped
• examples/fundamentals/circular-dependency.md → https://docs.nestjs.com/fundamentals/circular-dependency Techniques (技巧)
• examples/techniques/configuration.md → https://docs.nestjs.com/techniques/configuration
• examples/techniques/validation.md → https://docs.nestjs.com/techniques/validation
• examples/techniques/serialization.md → https://docs.nestjs.com/techniques/serialization
• examples/techniques/caching.md → https://docs.nestjs.com/techniques/caching
• examples/techniques/logger.md → https://docs.nestjs.com/techniques/logger
• examples/techniques/events.md → https://docs.nestjs.com/techniques/events
• examples/techniques/task-scheduling.md → https://docs.nestjs.com/techniques/task-scheduling
• examples/techniques/queues.md → https://docs.nestjs.com/techniques/queues
• examples/techniques/file-upload.md → https://docs.nestjs.com/techniques/file-upload
• examples/techniques/streaming-files.md → https://docs.nestjs.com/techniques/streaming-files
• examples/techniques/database.md → https://docs.nestjs.com/techniques/database
• examples/techniques/mongodb.md → https://docs.nestjs.com/techniques/mongodb
• examples/techniques/mongoose.md → https://docs.nestjs.com/techniques/mongoose
• examples/techniques/sequelize.md → https://docs.nestjs.com/techniques/sequelize
• examples/techniques/prisma.md → https://docs.nestjs.com/recipes/prisma

Security (安全)

• examples/security/authentication.md → https://docs.nestjs.com/security/authentication
• examples/security/authorization.md → https://docs.nestjs.com/security/authorization
• examples/security/helmet.md → https://docs.nestjs.com/security/helmet
• examples/security/cors.md → https://docs.nestjs.com/security/cors
• examples/security/rate-limiting.md → https://docs.nestjs.com/security/rate-limiting

GraphQL

• examples/graphql/quick-start.md → https://docs.nestjs.com/graphql/quick-start
• examples/graphql/resolvers.md → https://docs.nestjs.com/graphql/resolvers
• examples/graphql/scalars.md → https://docs.nestjs.com/graphql/scalars
• examples/graphql/interfaces.md → https://docs.nestjs.com/graphql/interfaces
• examples/graphql/unions.md → https://docs.nestjs.com/graphql/unions
• examples/graphql/directives.md → https://docs.nestjs.com/graphql/directives
• examples/graphql/plugins.md → https://docs.nestjs.com/graphql/plugins
• examples/graphql/subscriptions.md → https://docs.nestjs.com/graphql/subscriptions
• examples/graphql/federation.md → https://docs.nestjs.com/graphql/federation
• examples/graphql/migration.md → https://docs.nestjs.com/graphql/migration

WebSockets

• examples/websockets/gateways.md → https://docs.nestjs.com/websockets/gateways
• examples/websockets/exception-filters.md → https://docs.nestjs.com/websockets/exception-filters
• examples/websockets/guards.md → https://docs.nestjs.com/websockets/guards
• examples/websockets/interceptors.md → https://docs.nestjs.com/websockets/interceptors
• examples/websockets/adapters.md → https://docs.nestjs.com/websockets/adapters

Microservices

• examples/microservices/basics.md → https://docs.nestjs.com/microservices/basics
• examples/microservices/redis.md → https://docs.nestjs.com/microservices/redis
• examples/microservices/mqtt.md → https://docs.nestjs.com/microservices/mqtt
• examples/microservices/nats.md → https://docs.nestjs.com/microservices/nats
• examples/microservices/kafka.md → https://docs.nestjs.com/microservices/kafka
• examples/microservices/grpc.md → https://docs.nestjs.com/microservices/grpc
• examples/microservices/rabbitmq.md → https://docs.nestjs.com/microservices/rabbitmq
• examples/microservices/custom-transport.md → https://docs.nestjs.com/microservices/custom-transport
• examples/microservices/hybrid-application.md → https://docs.nestjs.com/microservices/hybrid-application

OpenAPI（Swagger）

• examples/openapi/introduction.md → https://docs.nestjs.com/openapi/introduction
• examples/openapi/operations.md → https://docs.nestjs.com/openapi/operations
• examples/openapi/types-and-parameters.md → https://docs.nestjs.com/openapi/types-and-parameters
• examples/openapi/security.md → https://docs.nestjs.com/openapi/security
• examples/openapi/mapped-types.md → https://docs.nestjs.com/openapi/mapped-types

CLI・テスト・レシピ

• examples/cli/overview.md → https://docs.nestjs.com/cli/overview
• examples/testing/unit-testing.md → https://docs.nestjs.com/fundamentals/testing
• examples/testing/e2e-testing.md → https://docs.nestjs.com/fundamentals/testing
• examples/recipes/cqrs.md → https://docs.nestjs.com/recipes/cqrs
• examples/recipes/mikroorm.md → https://docs.nestjs.com/recipes/mikroorm
• examples/recipes/terminus.md → https://docs.nestjs.com/recipes/terminus
• examples/faq.md → https://docs.nestjs.com/faq

例とテンプレート

このスキルには、NestJS の公式ドキュメントの構成（https://docs.nestjs.com/）に合わせて整理された詳細な例が含まれています。すべての例は examples/ ディレクトリにあり、トピックごとに整理されています（上記の対応表を参照）。

例の使用方法：

• ユーザーのリクエストからトピックを特定します
• 上記の対応表から適切な例のファイルを読み込みます
• そのファイルの手順、構文、ベストプラクティスに従います
• コード例を具体的なユースケースに合わせて調整します

テンプレートの使用方法：

• 一般的なスキャフォールディングには、templates/ ディレクトリ内のテンプレートを参照します
• テンプレートには、コントローラー、プロバイダー、モジュール、ミドルウェア、ガード、パイプ、インターセプター、例外フィルター、DTO、プロジェクト構成が含まれます
• テンプレートを具体的なニーズやコーディングスタイルに合わせて調整します

ベストプラクティス

1. 依存性注入を使用する：NestJS の DI コンテナーを活用し、テスト容易性と保守性を高めます
2. モジュールごとに整理する：関連する機能をフィーチャーモジュールにまとめます
3. デコレーターを一貫して使用する：コントローラー、プロバイダー、ルートには NestJS のデコレーターパターンに従います
4. 入力データを検証する：リクエストの検証には ValidationPipe と DTO を使用します
5. エラーを適切に処理する：一貫したエラー処理のために、グローバル例外フィルターを実装します
6. 認可にはガードを使用する：インラインチェックではなく、ガードでルートを保護します
7. インターセプターを活用する：ロギングや変換など、横断的な関心事にはインターセプターを使用します
8. 型安全性：型安全性と開発者エクスペリエンスを高めるために TypeScript を使用します
9. 十分にテストする：サービスには単体テストを、API エンドポイントには E2E テストを作成します
10. 公式のパターンに従う：推奨されるパターンやプラクティスについては、公式ドキュメントを参照します

リソース

• 公式ドキュメント：https://docs.nestjs.com/
• GitHub リポジトリ：https://github.com/nestjs/nest

キーワード

NestJS、Node.js、フレームワーク、コントローラー、プロバイダー、モジュール、ミドルウェア、例外フィルター、パイプ、ガード、インターセプター、依存性注入、GraphQL、WebSocket、マイクロサービス、OpenAPI、Swagger、テスト、検証、キャッシュ、ロギング、TypeScript、デコレーター、DI、IoC、コントローラー、プロバイダー、モジュール、ミドルウェア、ガード、パイプ、インターセプター、依存性注入