| name | typescript-coding-conventions |
| description | General TypeScript coding conventions for type safety, exported API design, and module structure. Auto-triggers when writing or refactoring TypeScript code in files matching `*.ts`, `*.tsx`, `*.mts`, or `*.cts` outside framework-specific rules. |
TypeScript Coding Conventions
TypeScript 全般のコーディング規約集。型安全性、公開インターフェースの明示性、モジュール構造、命名規則を中心に定義する。
When to Apply
以下のいずれかに該当する作業時に自動で参照する:
- 次のパターンに一致するファイルの作成・修正
- TypeScript ファイルの新規作成
- JavaScript から TypeScript への移行
- 型エラー修正や型定義の改善
- exported function / utility / service の設計
- import / export 構造の整理
Compatibility
TypeScript 5.0+ / ES2022+
Rule Categories
| Category | Prefix |
|---|
| 型安全性 | types- |
| インターフェース設計 | interface- |
| モジュール構成 | module- |
| 命名規則 | naming- |
Quick Reference
型安全性
インターフェース設計
モジュール構成
命名規則
How to Use
個別ルールの詳細は rules/ ディレクトリ内のファイルを参照。上記 Quick Reference のリンクから各ルールにアクセスできる。
各ルールファイルには以下を含める:
- ルールの説明と根拠
- Bad / Good のコード例
- 迷いやすいケースの判断基準