nestjs-clean-typescript
SOLIDの原則とモジュラーアーキテクチャに従い、TypeScriptで品質の高いNestJS APIを開発します。包括的なテスト手法も取り入れ、保守性と拡張性に優れたコードベースの構築を支援します。
description の原文を見る
Clean NestJS API development with TypeScript following SOLID principles, modular architecture, and comprehensive testing practices.
SKILL.md 本文
NestJS Clean TypeScript
Alberto Basalo によるガイドラインで、TypeScript を使用したクリーン NestJS API 開発に関するものです。これらのルールは、強力な型付け、クリーンコード原則、およびアーキテクチャのベストプラクティスを重視しています。
TypeScript の一般原則
- 各変数と関数（パラメータと戻り値）の型を常に明示的に宣言する
- any の使用を避ける。代わりに必要な型を作成する
- パブリッククラスとメソッドに JSDoc を使用する
- ファイルごとに 1 つのエクスポート
命名規則
- クラスは PascalCase
- 変数と関数は camelCase
- ファイルとディレクトリは kebab-case
- 環境変数は UPPERCASE
- ブール変数はプレフィックスを使用: isX, hasX, canX
関数設計
- 単一の目的を持つ短い関数を書く。20 行以下
- ネストを避けるために早期リターンを使用する
- RO-RO パターンを適用する: 複数のパラメータにはオブジェクトを渡し、結果にはオブジェクトを返す
データとクラス
- readonly と as const を使用してデータの不変性を優先する
- SOLID 原則に従う
- クラスは以下を満たす必要がある:
- 200 行以下
- パブリックメソッドは 10 個未満
- プロパティは 10 個未満
NestJS 固有のガイドライン
- ドメイン/ルートごとに 1 つのモジュールを持つモジュラーアーキテクチャを使用する
- MikroORM エンティティを永続化に使用する
- エンティティごとに 1 つのサービス
- class-validator で検証される DTO
- グローバルフィルター、ミドルウェア、ガード、インターセプターは core モジュール内
テスト
- Jest フレームワークを使用する
- Arrange-Act-Assert 規約に従う
- 各パブリック関数のユニットテストを書く
- API モジュールごとにエンドツーエンドテストを含める
ライセンス: Apache-2.0(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- mindrally
- リポジトリ
- mindrally/skills
- ライセンス
- Apache-2.0
- 最終更新
- 不明
Source: https://github.com/mindrally/skills / ライセンス: Apache-2.0
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理（非同期ジェネレータを含む）、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。