typescript-style-guide

TypeScript スタイルガイド

現在のタスクに関連する規約だけを適用してください。自動的に適用できるルールは、TypeScript、リンター、フォーマッターに任せてください。

ワークフロー

1. 利用側のリポジトリの規約と設定を確認します。
2. 明示されているリポジトリの規約を、この見解に基づくガイドより優先します。
3. 該当するガイドのトピックを特定します。
4. タスクの主なガイドトピックに関するリファレンスだけを読みます。タスクが実質的に複数のトピックにまたがる場合に限り、複数のリファレンスを読みます。
5. 現在のタスクに即して、規約を適用、確認、または説明します。
6. 規約の適用が状況や判断に左右される場合は、重要なトレードオフを明示します。

リファレンスの案内

• 型のモデリング、推論、読み取り専用データ、定数、テンプレートリテラル型、any、unknown、型アサーション、型エラー、型定義、配列、型のみのインポート、生成されたサービス型については、references/types.md を読みます。このリファレンスは、unknown の型の絞り込みと型アサーション（実行時の null チェックを含む）に関して、他のリファレンスより優先されます。
• 判別可能なユニオンの一般的なモデリング、型の絞り込み、無効な状態、網羅性チェック、必須および省略可能なオブジェクトプロパティ、バリアント固有のデータを持つアプリケーション状態、関数の引数、React の props については、references/discriminated-unions.md を読みます。判別可能なユニオンがアプリケーション状態、関数の引数、または React の props に関係する場合は、このリファレンスを優先します。
• 関数の責務、ステートレス性、純粋性、副作用、関数の引数、関数 API の設計、戻り値の型については、references/functions.md を読みます。
• 変数宣言、単純なリテラルユニオンによる状態のモデリング、列挙型の代替、アプリケーション状態で不在を null または undefined のどちらで表すかに関するタスクでは、references/variables.md を読みます。型の絞り込みにのみ使う付随的な変数や実行時チェックについては読みません。
• 名前付きエクスポート、命名規則、ジェネリック型パラメーター、React の命名、コメント、TSDoc については、references/naming.md を読みます。
• コードの配置、機能単位の構成、相対および絶対インポートパス、フロントエンドまたはバックエンドのプロジェクト構造については、references/source-organization.md を読みます。型のみのインポートの意味については読みません。これは Types の範囲です。
• React コンポーネントおよびフックの API、props から state への同期、コンポーネントの型付けと役割、データフロー、state の配置、複合コンポーネントについては、references/react.md を読みます。
• テストの設計、Arrange-Act-Assert パターン、分離、実装詳細、モック、テストの説明、スナップショットについては、references/tests.md を読みます。

適用範囲

• 決定論的な TypeScript、ESLint、フォーマットのチェックを再実装しないでください。
• このガイドが有効だからという理由だけで、無関係な規約を導入しないでください。
• 利用側のリポジトリに規約がない場合は、このガイドの規約をデフォルトとして扱ってください。