mcpField
N
nestjs-best-practices

nestjs-best-practices

github.com/rolling-scopes開発10.4k47 回インストール1 週間前に更新
リポジトリ

nestjs-best-practices について

nestjs-best-practices は、NestJS アプリケーションの構築、レビュー、リファクタリングに使うルールガイドです。10 カテゴリーにまたがる 40 のルールを影響度順に並べ、個別のルールファイルに例を記載しています。

主な機能

  1. 0110 カテゴリーにわたる 40 ルール
  2. 02優先度順のガイダンス
  3. 03アーキテクチャと依存性注入
  4. 04セキュリティ、性能、テストの実践
  5. 05コード例付きのルールファイル

活用シーン

  1. 01NestJS のモジュールとサービスの構成
  2. 02認証とセキュリティのレビュー
  3. 03既存 NestJS コードベースのリファクタリング
  4. 04クエリ、テスト、性能の改善

インストール

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

$npx skills add https://github.com/rolling-scopes/rsschool-app --skill nestjs-best-practices

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

同梱ファイル

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

.gitignore
AGENTS.md
README.md
.github/workflows/
branch-protection.yml
deploy.yml
rules/
api-use-dto-serialization.md
api-use-interceptors.md
api-use-pipes.md
api-versioning.md
arch-avoid-circular-deps.md
arch-feature-modules.md
arch-module-sharing.md
arch-single-responsibility.md
arch-use-events.md
arch-use-repository-pattern.md
db-avoid-n-plus-one.md
db-use-migrations.md
db-use-transactions.md
devops-graceful-shutdown.md
devops-use-config-module.md
devops-use-logging.md
di-avoid-service-locator.md
di-interface-segregation.md
di-liskov-substitution.md
di-prefer-constructor-injection.md
di-scope-awareness.md
di-use-interfaces-tokens.md
error-handle-async-errors.md
error-throw-http-exceptions.md
error-use-exception-filters.md

詳細

NestJS のベストプラクティス

NestJS アプリケーション向けの包括的なベストプラクティスガイドです。影響度に基づいて自動リファクタリングとコード生成を導く、10 カテゴリにわたる 40 のルールが含まれています。

適用する場面

以下の場合に、これらのガイドラインを参照してください。

  • NestJS のモジュール、コントローラー、サービスを新規作成するとき
  • 認証と認可を実装するとき
  • アーキテクチャやセキュリティの問題についてコードレビューするとき
  • 既存の NestJS コードベースをリファクタリングするとき
  • パフォーマンスやデータベースクエリを最適化するとき
  • マイクロサービスアーキテクチャを構築するとき

優先度別のルールカテゴリ

優先度カテゴリ影響度プレフィックス
1アーキテクチャCRITICALarch-
2依存性注入CRITICALdi-
3エラー処理HIGHerror-
4セキュリティHIGHsecurity-
5パフォーマンスHIGHperf-
6テストMEDIUM-HIGHtest-
7データベースと ORMMEDIUM-HIGHdb-
8API 設計MEDIUMapi-
9マイクロサービスMEDIUMmicro-
10DevOps とデプロイLOW-MEDIUMdevops-

クイックリファレンス

1. アーキテクチャ（CRITICAL）
  • arch-avoid-circular-deps - モジュール間の循環依存を避ける
  • arch-feature-modules - 技術レイヤーではなく機能ごとに整理する
  • arch-module-sharing - モジュールのエクスポート／インポートを適切に行い、プロバイダーの重複を避ける
  • arch-single-responsibility - 「何でもこなすサービス」ではなく、責務を絞ったサービスにする
  • arch-use-repository-pattern - テスト容易性のためにデータベースロジックを抽象化する
  • arch-use-events - 疎結合を実現するイベント駆動型アーキテクチャを採用する
2. 依存性注入（CRITICAL）
  • di-avoid-service-locator - サービスロケーターのアンチパターンを避ける
  • di-interface-segregation - インターフェース分離の原則（ISP）
  • di-liskov-substitution - リスコフの置換原則（LSP）
  • di-prefer-constructor-injection - プロパティ注入よりコンストラクター注入を優先する
  • di-scope-awareness - シングルトン／リクエスト／トランジェントのスコープを理解する
  • di-use-interfaces-tokens - インターフェースにはインジェクショントークンを使用する
3. エラー処理（HIGH）
  • error-use-exception-filters - 例外処理を一元化する
  • error-throw-http-exceptions - NestJS の HTTP 例外を使用する
  • error-handle-async-errors - 非同期エラーを適切に処理する
4. セキュリティ（HIGH）
  • security-auth-jwt - JWT 認証を安全に実装する
  • security-validate-all-input - class-validator でバリデーションする
  • security-use-guards - 認証・認可ガードを使用する
  • security-sanitize-output - XSS 攻撃を防ぐ
  • security-rate-limiting - レート制限を実装する
5. パフォーマンス（HIGH）
  • perf-async-hooks - 非同期ライフサイクルフックを適切に使用する
  • perf-use-caching - キャッシュ戦略を実装する
  • perf-optimize-database - データベースクエリを最適化する
  • perf-lazy-loading - 起動を高速化するためにモジュールを遅延読み込みする
6. テスト（MEDIUM-HIGH）
  • test-use-testing-module - NestJS のテストユーティリティを使用する
  • test-e2e-supertest - Supertest で E2E テストを行う
  • test-mock-external-services - 外部依存関係をモックする
7. データベースと ORM（MEDIUM-HIGH）
  • db-use-transactions - トランザクションを管理する
  • db-avoid-n-plus-one - N+1 クエリ問題を避ける
  • db-use-migrations - スキーマ変更にはマイグレーションを使用する
8. API 設計（MEDIUM）
  • api-use-dto-serialization - DTO とレスポンスのシリアライズ
  • api-use-interceptors - 横断的関心事に対応する
  • api-versioning - API のバージョニング戦略
  • api-use-pipes - パイプによる入力変換
9. マイクロサービス（MEDIUM）
  • micro-use-patterns - メッセージとイベントのパターン
  • micro-use-health-checks - オーケストレーション向けのヘルスチェック
  • micro-use-queues - バックグラウンドジョブを処理する
10. DevOps とデプロイ（低〜中）
  • devops-use-config-module - 環境設定
  • devops-use-logging - 構造化ロギング
  • devops-graceful-shutdown - ダウンタイムなしのデプロイ

使用方法

詳しい説明とコード例については、各ルールファイルをお読みください。

rules/arch-avoid-circular-deps.md
rules/security-validate-all-input.md
rules/_sections.md

各ルールファイルには、次の内容が含まれています。

  • 重要である理由の簡単な説明
  • 説明付きの誤ったコード例
  • 説明付きの正しいコード例
  • 追加のコンテキストと参考情報

完全版ドキュメント

すべてのルールを展開した完全なガイドについては、AGENTS.md をご覧ください。

コメント

Markdown 対応