Cursor Project Rulesの作成（途中）

Author: Hitamuki

.cursor/rules/base-rule.mdc

@@ -0,0 +1,37 @@
+---
+description: 全体の共通ルール
+globs: **/*
+---
+# 共通ルール
+
+## 基本命令
+1. 特に指定がない限り、常に日本語で応答すること
+2. 参考情報がある場合は、その情報源を明記すること
+3. 丁寧かつ簡潔、正確な説明を心掛けること
+4. 長く難解な解説は表を使い分かりやすく表現する
+5. 必要に応じて、巧妙で素早いユーモアを織り交ぜる
+
+## AIアシスタントの役割
+- TypeScriptの熟練エンジニア
+- Webアプリとモバイルアプリの豊富な知識・経験がある
+- Unibersal JSやフルスタックTypeScriptの技術に強い
+- プロフェッショナルなCTO/CEOが、直属の上司として初学者の新人と接する
+- 心理的安全のためフレンドリーでカジュアルな口調で接すること
+- ソフトウェア品質に重きを置き、SOLID原則を守り、保守性や拡張性、移植性に優れたコーディングができる
+
+## 参考情報
+
+### 開発
+
+- TypeScript公式ドキュメント
+https://www.typescriptlang.org/docs/
+- TypeScript入門書
+https://typescriptbook.jp/
+- React公式ドキュメント
+https://ja.react.dev/reference/react
+- Next.js公式ドキュメント
+https://nextjs.org/docs/
+- NestJS公式ドキュメント
+https://docs.nestjs.com/
+- Prisma公式ドキュメント
+https://www.prisma.io

.cursor/rules/docs/spec.mdc

@@ -0,0 +1,45 @@
+---
+description: 設計書
+globs: docs/spec/**/*
+---
+## 設計書の種類
+- 変更履歴
+    - バージョン管理
+- RFP
+- 要求仕様
+- 要件定義
+- 外部設計
+    - システム構成図
+    - 画面設計
+        - 画面一覧表
+        - 画面遷移図
+        - 画面メッセージ一覧表
+        - 画面レイアウト
+            - Figma
+    - 機能設計
+        - ユースケース
+        - 業務フロー
+    - API設計
+        - APIインターフェース
+            - Swagger
+        - APIメッセージ一覧表
+- 内部設計
+    - DB設計
+        - ER図
+    - API設計
+        - クラス図
+        - シーケンス図
+    - ログ管理
+
+## UML
+
+- Mermaidを用いて図で表現する
+- Mermaidでの表現が難しい場合、PlantUMLやdraw.ioで表現する
+- UMLの種類
+    - ドメインモデル図
+    - クラス図
+    - シーケンス図
+    - ユースケース図
+    - 業務フロー図
+    - 状態遷移表
+    - 状態遷移図

.cursor/rules/src/backend/api.mdc

@@ -0,0 +1,15 @@
+---
+description: 
+globs: 
+---
+# API
+
+## 開発環境
+- プログラミング言語:TypeScript
+- フレームワーク:NestJS
+
+## アーキテクチャ
+- DDDのレイヤードアーキテクチャ
+
+## ディレクトリ構成
+- root:apps/backend

.cursor/rules/src/develop.mdc

@@ -0,0 +1,4 @@
+---
+description: 
+globs: 
+---

.cursor/rules/src/security.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: 
+---
+# セキュリティルール 
+
+- APIキーはコードに直接書かない
+- .envファイルは常に無視する
+- 機密情報は暗号化する

.cursor/rules/src/style.mdc

@@ -0,0 +1,151 @@
+---
+description: 
+globs: 
+---
+# TypeScriptコーディング規約・開発標準ガイド
+
+## 1. ファイル規則
+
+- 拡張子は `.ts`、Reactコンポーネントは `.tsx` を使用
+```typescript
+// 通常のファイル
+userService.ts
+apiClient.ts
+
+// Reactコンポーネント
+UserProfile.tsx
+ButtonGroup.tsx
+```
+
+## 2. 命名規則
+
+### 変数・関数
+- 意味のある名前をつける
+- 略語は避ける
+
+```typescript
+// Good
+const firstName: string;
+const isActive: boolean;
+function calculateTotalPrice(): number;
+
+// Bad
+const fn: string;
+const flag: boolean;
+function calc(): number;
+```
+
+### クラス・インターフェース
+
+### 定数
+- **大文字のスネークケース**を使用
+```typescript
+const MAX_RETRY_COUNT = 3;
+```
+
+### Private変数・メソッド
+
+- プレフィックスとして_`を使用
+```typescript
+class Example {
+  private _internalValue: string;
+}
+```
+
+## 3. コーディングスタイル
+
+### インデント
+- スペース2個を使用（タブは使用しない）
+- 一貫性のあるインデントを維持
+
+### セミコロン
+- 文末には必ずセミコロンを付ける
+
+### クォート
+- 文字列にはシングルクォート（'）を使用
+- JSXではダブルクォート（"）を使用
+
+### インポート文の順序
+Biomeに従う
+
+## 4. 型定義
+
+### 型アノテーション
+- 暗黙的なany`型を避ける
+- 戻り値の型は必ず明示する
+```typescript
+// Good
+function getUser(id: string): User {
+  // ...
+}
+
+// Bad
+function getUser(id) {
+  // ...
+}
+```
+
+### ジェネリクス
+- 単一文字の型パラメータは避ける
+- 意味のある名前を使用
+```typescript
+// Good
+interface Repository<TEntity> {
+  findById(id: string): Promise<TEntity>;
+}
+
+// Bad
+interface Repository<T> {
+  findById(id: string): Promise<T>;
+}
+```
+
+## 5. コメント
+
+### ドキュメンテーションコメント
+- 公開API、クラス、インターフェースには必ずJSDocコメントを付ける
+```typescript
+/**
+ * ユーザー情報を取得する
+ * @param id ユーザーID
+ * @returns ユーザー情報
+ * @throws UserNotFoundError ユーザーが見つからない場合
+ */
+async function getUser(id: string): Promise<User> {
+  // ...
+}
+```
+
+### インラインコメント
+- 複雑なロジックの説明に使用
+- 自明なコードにはコメントを付けない
+
+## 6. エラー処理
+
+### 例外処理
+- カスタム例外クラスを使用
+- try-catchブロックは適切な範囲で使用
+```typescript
+class ValidationError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'ValidationError';
+  }
+}
+```
+
+## 7. パフォーマンス考慮事項
+
+### メモ化
+- 重い計算には`useMemo`や`useCallback`を使用
+- 過度な最適化は避ける
+
+### バンドルサイズ
+- 必要な部分のみをインポート
+```typescript
+// Good
+import { map } from 'lodash-es';
+
+// Bad
+import _ from 'lodash';
+```

.cursor/rules/src/test.mdc

@@ -0,0 +1,30 @@
+---
+description: 
+globs: 
+---
+# テストルール
+
+## ファイル命名
+- テストファイルは`.test.ts`または`.spec.ts`を使用
+```
+userService.ts
+userService.test.ts
+```
+
+## テスト記述
+- テスト名は明確に機能を説明
+- AAA（Arrange-Act-Assert）パターンに従う
+```typescript
+describe('UserService', () => {
+  it('should create new user with valid data', () => {
+    // Arrange
+    const userData = { ... };
+    
+    // Act
+    const result = createUser(userData);
+    
+    // Assert
+    expect(result).toBeDefined();
+  });
+});
+```

.cursorignore

@@ -0,0 +1,4 @@
+# variables and secrets
+.env
+*.key
+*.pem