Add github_code/affaan-m__ECC from GitHub - direct commit (part 5)
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- github_code/affaan-m__ECC/docs/ja-JP/rules/java/patterns.md +147 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/java/security.md +101 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/java/testing.md +133 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/coding-style.md +86 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/hooks.md +17 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/patterns.md +146 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/security.md +82 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/testing.md +128 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/perl/coding-style.md +46 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/perl/hooks.md +22 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/perl/patterns.md +76 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/perl/security.md +69 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/perl/testing.md +54 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/php/coding-style.md +40 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/php/hooks.md +24 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/php/patterns.md +33 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/php/security.md +37 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/php/testing.md +39 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/coding-style.md +42 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/fastapi.md +58 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/hooks.md +19 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/patterns.md +39 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/security.md +30 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/python/testing.md +38 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/coding-style.md +46 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/hooks.md +37 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/patterns.md +44 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/security.md +51 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/testing.md +51 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/rust/coding-style.md +151 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/rust/hooks.md +16 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/rust/patterns.md +168 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/rust/security.md +141 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/rust/testing.md +154 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/swift/coding-style.md +47 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/swift/hooks.md +20 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/swift/patterns.md +66 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/swift/security.md +33 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/swift/testing.md +45 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/coding-style.md +199 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/hooks.md +22 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/patterns.md +52 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/security.md +28 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/testing.md +18 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/coding-style.md +96 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/design-quality.md +63 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/hooks.md +129 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/patterns.md +79 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/performance.md +64 -0
- github_code/affaan-m__ECC/docs/ja-JP/rules/web/security.md +57 -0
github_code/affaan-m__ECC/docs/ja-JP/rules/java/patterns.md
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.java"
|
| 4 |
+
---
|
| 5 |
+
# Java パターン
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Java 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## リポジトリパターン
|
| 10 |
+
|
| 11 |
+
データアクセスをインターフェースの背後にカプセル化する:
|
| 12 |
+
|
| 13 |
+
```java
|
| 14 |
+
public interface OrderRepository {
|
| 15 |
+
Optional<Order> findById(Long id);
|
| 16 |
+
List<Order> findAll();
|
| 17 |
+
Order save(Order order);
|
| 18 |
+
void deleteById(Long id);
|
| 19 |
+
}
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
具象実装がストレージの詳細を処理する(JPA、JDBC、テスト用インメモリ)。
|
| 23 |
+
|
| 24 |
+
## サービス層
|
| 25 |
+
|
| 26 |
+
ビジネスロジックはサービスクラスに配置する; コントローラとリポジトリは薄く保つ:
|
| 27 |
+
|
| 28 |
+
```java
|
| 29 |
+
public class OrderService {
|
| 30 |
+
private final OrderRepository orderRepository;
|
| 31 |
+
private final PaymentGateway paymentGateway;
|
| 32 |
+
|
| 33 |
+
public OrderService(OrderRepository orderRepository, PaymentGateway paymentGateway) {
|
| 34 |
+
this.orderRepository = orderRepository;
|
| 35 |
+
this.paymentGateway = paymentGateway;
|
| 36 |
+
}
|
| 37 |
+
|
| 38 |
+
public OrderSummary placeOrder(CreateOrderRequest request) {
|
| 39 |
+
var order = Order.from(request);
|
| 40 |
+
paymentGateway.charge(order.total());
|
| 41 |
+
var saved = orderRepository.save(order);
|
| 42 |
+
return OrderSummary.from(saved);
|
| 43 |
+
}
|
| 44 |
+
}
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
## コンストラクタインジェクション
|
| 48 |
+
|
| 49 |
+
常にコンストラクタインジェクションを使用する — フィールドインジェクションは使用しない:
|
| 50 |
+
|
| 51 |
+
```java
|
| 52 |
+
// GOOD — コンストラクタインジェクション(テスト可能、不変)
|
| 53 |
+
public class NotificationService {
|
| 54 |
+
private final EmailSender emailSender;
|
| 55 |
+
|
| 56 |
+
public NotificationService(EmailSender emailSender) {
|
| 57 |
+
this.emailSender = emailSender;
|
| 58 |
+
}
|
| 59 |
+
}
|
| 60 |
+
|
| 61 |
+
// BAD — フィールドインジェクション(リフレクションなしではテスト不可、フレームワークの魔法が必要)
|
| 62 |
+
public class NotificationService {
|
| 63 |
+
@Inject // or @Autowired
|
| 64 |
+
private EmailSender emailSender;
|
| 65 |
+
}
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
## DTO マッピング
|
| 69 |
+
|
| 70 |
+
DTO にはレコードを使用する。サービス/コントローラの境界でマッピングする:
|
| 71 |
+
|
| 72 |
+
```java
|
| 73 |
+
public record OrderResponse(Long id, String customer, BigDecimal total) {
|
| 74 |
+
public static OrderResponse from(Order order) {
|
| 75 |
+
return new OrderResponse(order.getId(), order.getCustomerName(), order.getTotal());
|
| 76 |
+
}
|
| 77 |
+
}
|
| 78 |
+
```
|
| 79 |
+
|
| 80 |
+
## Builder パターン
|
| 81 |
+
|
| 82 |
+
オプションパラメータが多いオブジェクトに使用する:
|
| 83 |
+
|
| 84 |
+
```java
|
| 85 |
+
public class SearchCriteria {
|
| 86 |
+
private final String query;
|
| 87 |
+
private final int page;
|
| 88 |
+
private final int size;
|
| 89 |
+
private final String sortBy;
|
| 90 |
+
|
| 91 |
+
private SearchCriteria(Builder builder) {
|
| 92 |
+
this.query = builder.query;
|
| 93 |
+
this.page = builder.page;
|
| 94 |
+
this.size = builder.size;
|
| 95 |
+
this.sortBy = builder.sortBy;
|
| 96 |
+
}
|
| 97 |
+
|
| 98 |
+
public static class Builder {
|
| 99 |
+
private String query = "";
|
| 100 |
+
private int page = 0;
|
| 101 |
+
private int size = 20;
|
| 102 |
+
private String sortBy = "id";
|
| 103 |
+
|
| 104 |
+
public Builder query(String query) { this.query = query; return this; }
|
| 105 |
+
public Builder page(int page) { this.page = page; return this; }
|
| 106 |
+
public Builder size(int size) { this.size = size; return this; }
|
| 107 |
+
public Builder sortBy(String sortBy) { this.sortBy = sortBy; return this; }
|
| 108 |
+
public SearchCriteria build() { return new SearchCriteria(this); }
|
| 109 |
+
}
|
| 110 |
+
}
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
## ドメインモデルのシールド型
|
| 114 |
+
|
| 115 |
+
```java
|
| 116 |
+
public sealed interface PaymentResult permits PaymentSuccess, PaymentFailure {
|
| 117 |
+
record PaymentSuccess(String transactionId, BigDecimal amount) implements PaymentResult {}
|
| 118 |
+
record PaymentFailure(String errorCode, String message) implements PaymentResult {}
|
| 119 |
+
}
|
| 120 |
+
|
| 121 |
+
// 網羅的な処理(Java 21+)
|
| 122 |
+
String message = switch (result) {
|
| 123 |
+
case PaymentSuccess s -> "Paid: " + s.transactionId();
|
| 124 |
+
case PaymentFailure f -> "Failed: " + f.errorCode();
|
| 125 |
+
};
|
| 126 |
+
```
|
| 127 |
+
|
| 128 |
+
## API レスポンスエンベロープ
|
| 129 |
+
|
| 130 |
+
一貫した API レスポンス:
|
| 131 |
+
|
| 132 |
+
```java
|
| 133 |
+
public record ApiResponse<T>(boolean success, T data, String error) {
|
| 134 |
+
public static <T> ApiResponse<T> ok(T data) {
|
| 135 |
+
return new ApiResponse<>(true, data, null);
|
| 136 |
+
}
|
| 137 |
+
public static <T> ApiResponse<T> error(String message) {
|
| 138 |
+
return new ApiResponse<>(false, null, message);
|
| 139 |
+
}
|
| 140 |
+
}
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
## リファレンス
|
| 144 |
+
|
| 145 |
+
スキル: `springboot-patterns` で Spring Boot アーキテクチャパターンを参照してください。
|
| 146 |
+
スキル: `quarkus-patterns` で REST、Panache、メッセージングを含む Quarkus アーキテクチャパターンを参照してください。
|
| 147 |
+
スキル: `jpa-patterns` でエンティティ設計とクエリ最適化を参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/java/security.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.java"
|
| 4 |
+
---
|
| 5 |
+
# Java セキュリティ
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/security.md](../common/security.md) を Java 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## シークレット管理
|
| 10 |
+
|
| 11 |
+
- API キー、トークン、認証情報をソースコードにハードコードしない
|
| 12 |
+
- 環境変数を使用する: `System.getenv("API_KEY")`
|
| 13 |
+
- 本番環境のシークレットにはシークレットマネージャ(Vault、AWS Secrets Manager)を使用する
|
| 14 |
+
- シークレットを含むローカル設定ファイルは `.gitignore` に追加する
|
| 15 |
+
|
| 16 |
+
```java
|
| 17 |
+
// BAD
|
| 18 |
+
private static final String API_KEY = "sk-abc123...";
|
| 19 |
+
|
| 20 |
+
// GOOD — 環境変数
|
| 21 |
+
String apiKey = System.getenv("PAYMENT_API_KEY");
|
| 22 |
+
Objects.requireNonNull(apiKey, "PAYMENT_API_KEY must be set");
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
## SQL インジェクション防止
|
| 26 |
+
|
| 27 |
+
- 常にパラメータ化クエリを使用する — ユーザー入力を SQL に連結しない
|
| 28 |
+
- `PreparedStatement` またはフレームワークのパラメータ化クエリ API を使用する
|
| 29 |
+
- ネイティブクエリで使用される入力はすべて検証・サニタイズする
|
| 30 |
+
|
| 31 |
+
```java
|
| 32 |
+
// BAD — 文字列連結による SQL インジェクション
|
| 33 |
+
Statement stmt = conn.createStatement();
|
| 34 |
+
String sql = "SELECT * FROM orders WHERE name = '" + name + "'";
|
| 35 |
+
stmt.executeQuery(sql);
|
| 36 |
+
|
| 37 |
+
// GOOD — パラメータ化クエリの PreparedStatement
|
| 38 |
+
PreparedStatement ps = conn.prepareStatement("SELECT * FROM orders WHERE name = ?");
|
| 39 |
+
ps.setString(1, name);
|
| 40 |
+
|
| 41 |
+
// GOOD — JDBC テンプレート
|
| 42 |
+
jdbcTemplate.query("SELECT * FROM orders WHERE name = ?", mapper, name);
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
## 入力検証
|
| 46 |
+
|
| 47 |
+
- 処理前にシステム境界ですべてのユーザー入力を検証する
|
| 48 |
+
- バリデーションフレームワーク使用時は DTO に Bean Validation(`@NotNull`、`@NotBlank`、`@Size`)を使用する
|
| 49 |
+
- ファイルパスとユーザー提供文字列は使用前にサニタイズする
|
| 50 |
+
- 検証に失敗した入力は明確なエラーメッセージで拒否する
|
| 51 |
+
|
| 52 |
+
```java
|
| 53 |
+
// プレーン Java での手動検証
|
| 54 |
+
public Order createOrder(String customerName, BigDecimal amount) {
|
| 55 |
+
if (customerName == null || customerName.isBlank()) {
|
| 56 |
+
throw new IllegalArgumentException("Customer name is required");
|
| 57 |
+
}
|
| 58 |
+
if (amount == null || amount.compareTo(BigDecimal.ZERO) <= 0) {
|
| 59 |
+
throw new IllegalArgumentException("Amount must be positive");
|
| 60 |
+
}
|
| 61 |
+
return new Order(customerName, amount);
|
| 62 |
+
}
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
## 認証と認可
|
| 66 |
+
|
| 67 |
+
- 独自の暗号化を実装しない — 確立されたライブラリを使用する
|
| 68 |
+
- パスワードは bcrypt または Argon2 で保存する、MD5/SHA1 は使用しない
|
| 69 |
+
- サービス境界で認可チェックを強制する
|
| 70 |
+
- ログから機密データを消去する — パスワード、トークン、PII をログに記録しない
|
| 71 |
+
|
| 72 |
+
## 依存関係のセキュリティ
|
| 73 |
+
|
| 74 |
+
- `mvn dependency:tree` または `./gradlew dependencies` で推移的依存関係を監査する
|
| 75 |
+
- OWASP Dependency-Check または Snyk を使用して既知の CVE をスキャンする
|
| 76 |
+
- 依存関係を最新に保つ — Dependabot または Renovate を設定する
|
| 77 |
+
|
| 78 |
+
## エラーメッセージ
|
| 79 |
+
|
| 80 |
+
- API レスポンスにスタックトレース、内部パス、SQL エラーを公開しない
|
| 81 |
+
- ハンドラ境界で例外を安全な汎用クライアントメッセージにマッピングする
|
| 82 |
+
- 詳細なエラーはサーバー側でログに記録する; クライアントには汎用メッセージを返す
|
| 83 |
+
|
| 84 |
+
```java
|
| 85 |
+
// 詳細をログに記録し、汎用メッセージを返す
|
| 86 |
+
try {
|
| 87 |
+
return orderService.findById(id);
|
| 88 |
+
} catch (OrderNotFoundException ex) {
|
| 89 |
+
log.warn("Order not found: id={}", id);
|
| 90 |
+
return ApiResponse.error("Resource not found"); // 汎用、内部情報なし
|
| 91 |
+
} catch (Exception ex) {
|
| 92 |
+
log.error("Unexpected error processing order id={}", id, ex);
|
| 93 |
+
return ApiResponse.error("Internal server error"); // ex.getMessage() を公開しない
|
| 94 |
+
}
|
| 95 |
+
```
|
| 96 |
+
|
| 97 |
+
## リファレンス
|
| 98 |
+
|
| 99 |
+
スキル: `springboot-security` で Spring Security の認証・認可パターンを参照してください。
|
| 100 |
+
スキル: `quarkus-security` で JWT/OIDC、RBAC、CDI を含む Quarkus セキュリティを参照してください。
|
| 101 |
+
スキル: `security-review` で一般的なセキュリティチェックリストを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/java/testing.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.java"
|
| 4 |
+
---
|
| 5 |
+
# Java テスト
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/testing.md](../common/testing.md) を Java 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## テストフレームワーク
|
| 10 |
+
|
| 11 |
+
- **JUnit 5**(`@Test`、`@ParameterizedTest`、`@Nested`、`@DisplayName`)
|
| 12 |
+
- **AssertJ** — 流暢なアサーション(`assertThat(result).isEqualTo(expected)`)
|
| 13 |
+
- **Mockito** — 依存関係のモック
|
| 14 |
+
- **Testcontainers** — データベースやサービスを必要とする統合テスト
|
| 15 |
+
|
| 16 |
+
## テストの構成
|
| 17 |
+
|
| 18 |
+
```
|
| 19 |
+
src/test/java/com/example/app/
|
| 20 |
+
service/ # サービス層のユニットテスト
|
| 21 |
+
controller/ # Web 層 / API テスト
|
| 22 |
+
repository/ # データアクセステスト
|
| 23 |
+
integration/ # クロスレイヤー統合テスト
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
`src/main/java` のパッケージ構造を `src/test/java` にミラーリングする。
|
| 27 |
+
|
| 28 |
+
## ユニットテストパターン
|
| 29 |
+
|
| 30 |
+
```java
|
| 31 |
+
@ExtendWith(MockitoExtension.class)
|
| 32 |
+
class OrderServiceTest {
|
| 33 |
+
|
| 34 |
+
@Mock
|
| 35 |
+
private OrderRepository orderRepository;
|
| 36 |
+
|
| 37 |
+
private OrderService orderService;
|
| 38 |
+
|
| 39 |
+
@BeforeEach
|
| 40 |
+
void setUp() {
|
| 41 |
+
orderService = new OrderService(orderRepository);
|
| 42 |
+
}
|
| 43 |
+
|
| 44 |
+
@Test
|
| 45 |
+
@DisplayName("findById returns order when exists")
|
| 46 |
+
void findById_existingOrder_returnsOrder() {
|
| 47 |
+
var order = new Order(1L, "Alice", BigDecimal.TEN);
|
| 48 |
+
when(orderRepository.findById(1L)).thenReturn(Optional.of(order));
|
| 49 |
+
|
| 50 |
+
var result = orderService.findById(1L);
|
| 51 |
+
|
| 52 |
+
assertThat(result.customerName()).isEqualTo("Alice");
|
| 53 |
+
verify(orderRepository).findById(1L);
|
| 54 |
+
}
|
| 55 |
+
|
| 56 |
+
@Test
|
| 57 |
+
@DisplayName("findById throws when order not found")
|
| 58 |
+
void findById_missingOrder_throws() {
|
| 59 |
+
when(orderRepository.findById(99L)).thenReturn(Optional.empty());
|
| 60 |
+
|
| 61 |
+
assertThatThrownBy(() -> orderService.findById(99L))
|
| 62 |
+
.isInstanceOf(OrderNotFoundException.class)
|
| 63 |
+
.hasMessageContaining("99");
|
| 64 |
+
}
|
| 65 |
+
}
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
## パラメータ化テスト
|
| 69 |
+
|
| 70 |
+
```java
|
| 71 |
+
@ParameterizedTest
|
| 72 |
+
@CsvSource({
|
| 73 |
+
"100.00, 10, 90.00",
|
| 74 |
+
"50.00, 0, 50.00",
|
| 75 |
+
"200.00, 25, 150.00"
|
| 76 |
+
})
|
| 77 |
+
@DisplayName("discount applied correctly")
|
| 78 |
+
void applyDiscount(BigDecimal price, int pct, BigDecimal expected) {
|
| 79 |
+
assertThat(PricingUtils.discount(price, pct)).isEqualByComparingTo(expected);
|
| 80 |
+
}
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
## 統合テスト
|
| 84 |
+
|
| 85 |
+
Testcontainers を使用した実データベース統合:
|
| 86 |
+
|
| 87 |
+
```java
|
| 88 |
+
@Testcontainers
|
| 89 |
+
class OrderRepositoryIT {
|
| 90 |
+
|
| 91 |
+
@Container
|
| 92 |
+
static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16");
|
| 93 |
+
|
| 94 |
+
private OrderRepository repository;
|
| 95 |
+
|
| 96 |
+
@BeforeEach
|
| 97 |
+
void setUp() {
|
| 98 |
+
var dataSource = new PGSimpleDataSource();
|
| 99 |
+
dataSource.setUrl(postgres.getJdbcUrl());
|
| 100 |
+
dataSource.setUser(postgres.getUsername());
|
| 101 |
+
dataSource.setPassword(postgres.getPassword());
|
| 102 |
+
repository = new JdbcOrderRepository(dataSource);
|
| 103 |
+
}
|
| 104 |
+
|
| 105 |
+
@Test
|
| 106 |
+
void save_and_findById() {
|
| 107 |
+
var saved = repository.save(new Order(null, "Bob", BigDecimal.ONE));
|
| 108 |
+
var found = repository.findById(saved.getId());
|
| 109 |
+
assertThat(found).isPresent();
|
| 110 |
+
}
|
| 111 |
+
}
|
| 112 |
+
```
|
| 113 |
+
|
| 114 |
+
Spring Boot 統合テストについては、スキル: `springboot-tdd` を参照してください。
|
| 115 |
+
Quarkus 統合テストについては、スキル: `quarkus-tdd` を参照してください。
|
| 116 |
+
|
| 117 |
+
## テスト命名
|
| 118 |
+
|
| 119 |
+
`@DisplayName` を使った説明的な名前:
|
| 120 |
+
- メソッド名には `methodName_scenario_expectedBehavior()`
|
| 121 |
+
- レポート用に `@DisplayName("人間が読める説明")`
|
| 122 |
+
|
| 123 |
+
## カバレッジ
|
| 124 |
+
|
| 125 |
+
- 行カバレッジ 80% 以上を目標
|
| 126 |
+
- カバレッジレポートには JaCoCo を使用
|
| 127 |
+
- サービスとドメインロジックに集中する — 自明な getter/設定クラスはスキップ
|
| 128 |
+
|
| 129 |
+
## リファレンス
|
| 130 |
+
|
| 131 |
+
スキル: `springboot-tdd` で MockMvc と Testcontainers を使った Spring Boot TDD パターンを参照してください。
|
| 132 |
+
スキル: `quarkus-tdd` で REST Assured と Dev Services を使った Quarkus TDD パターンを参照してください。
|
| 133 |
+
スキル: `java-coding-standards` でテスト要件を参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/coding-style.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.kt"
|
| 4 |
+
- "**/*.kts"
|
| 5 |
+
---
|
| 6 |
+
# Kotlin コーディングスタイル
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Kotlin 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## フォーマット
|
| 11 |
+
|
| 12 |
+
- **ktlint** または **Detekt** でスタイルを強制
|
| 13 |
+
- 公式 Kotlin コードスタイル(`gradle.properties` に `kotlin.code.style=official`)
|
| 14 |
+
|
| 15 |
+
## 不変性
|
| 16 |
+
|
| 17 |
+
- `var` よりも `val` を優先 — デフォルトは `val`、ミューテーションが必要な場合のみ `var` を使用
|
| 18 |
+
- 値型には `data class` を使用する; public API では不変コレクション(`List`、`Map`、`Set`)を使用
|
| 19 |
+
- 状態更新にはコピーオンライト: `state.copy(field = newValue)`
|
| 20 |
+
|
| 21 |
+
## 命名
|
| 22 |
+
|
| 23 |
+
Kotlin の慣例に従う:
|
| 24 |
+
- `camelCase` — 関数とプロパティ
|
| 25 |
+
- `PascalCase` — クラス、インターフェース、オブジェクト、型エイリアス
|
| 26 |
+
- `SCREAMING_SNAKE_CASE` — 定数(`const val` または `@JvmStatic`)
|
| 27 |
+
- インターフェースの接頭辞は振る舞いで付ける、`I` ではない: `Clickable` であって `IClickable` ではない
|
| 28 |
+
|
| 29 |
+
## Null 安全性
|
| 30 |
+
|
| 31 |
+
- `!!` は使用しない — `?.`、`?:`、`requireNotNull()`、または `checkNotNull()` を優先
|
| 32 |
+
- スコープ付き null 安全操作には `?.let {}` を使用
|
| 33 |
+
- 正当に結果がない可能性がある関数からは nullable 型を返す
|
| 34 |
+
|
| 35 |
+
```kotlin
|
| 36 |
+
// BAD
|
| 37 |
+
val name = user!!.name
|
| 38 |
+
|
| 39 |
+
// GOOD
|
| 40 |
+
val name = user?.name ?: "Unknown"
|
| 41 |
+
val name = requireNotNull(user) { "User must be set before accessing name" }.name
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
## シールド型
|
| 45 |
+
|
| 46 |
+
閉じた状態階層のモデリングにはシールドクラス/インターフェースを使用する:
|
| 47 |
+
|
| 48 |
+
```kotlin
|
| 49 |
+
sealed interface UiState<out T> {
|
| 50 |
+
data object Loading : UiState<Nothing>
|
| 51 |
+
data class Success<T>(val data: T) : UiState<T>
|
| 52 |
+
data class Error(val message: String) : UiState<Nothing>
|
| 53 |
+
}
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
シールド型に対しては常に網羅的な `when` を使用する — `else` ブランチは使わない。
|
| 57 |
+
|
| 58 |
+
## 拡張関数
|
| 59 |
+
|
| 60 |
+
ユーティリティ操作には拡張関数を使用するが、発見しやすくする:
|
| 61 |
+
- レシーバー型にちなんだファイル名にする(`StringExt.kt`、`FlowExt.kt`)
|
| 62 |
+
- スコープを限定する — `Any` や過度に汎用的な型に拡張を追加しない
|
| 63 |
+
|
| 64 |
+
## スコープ関数
|
| 65 |
+
|
| 66 |
+
適切なスコープ関数を使用する:
|
| 67 |
+
- `let` — null チェック + 変換: `user?.let { greet(it) }`
|
| 68 |
+
- `run` — レシーバーを使って結果を計算: `service.run { fetch(config) }`
|
| 69 |
+
- `apply` — オブジェクトの設定: `builder.apply { timeout = 30 }`
|
| 70 |
+
- `also` — 副作用: `result.also { log(it) }`
|
| 71 |
+
- スコープ関数の深いネストは避ける(最大2レベル)
|
| 72 |
+
|
| 73 |
+
## エラーハンドリング
|
| 74 |
+
|
| 75 |
+
- `Result<T>` またはカスタムシールド型を使用
|
| 76 |
+
- throwable コードのラッピングには `runCatching {}` を使用
|
| 77 |
+
- `CancellationException` は絶対にキャッチしない — 常に再スローする
|
| 78 |
+
- 制御フローに `try-catch` を使用しない
|
| 79 |
+
|
| 80 |
+
```kotlin
|
| 81 |
+
// BAD — 制御フローに例外を使用
|
| 82 |
+
val user = try { repository.getUser(id) } catch (e: NotFoundException) { null }
|
| 83 |
+
|
| 84 |
+
// GOOD — nullable 戻り値
|
| 85 |
+
val user: User? = repository.findUser(id)
|
| 86 |
+
```
|
github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/hooks.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.kt"
|
| 4 |
+
- "**/*.kts"
|
| 5 |
+
- "**/build.gradle.kts"
|
| 6 |
+
---
|
| 7 |
+
# Kotlin フック
|
| 8 |
+
|
| 9 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Kotlin 固有のコンテンツで拡張します。
|
| 10 |
+
|
| 11 |
+
## PostToolUse フック
|
| 12 |
+
|
| 13 |
+
`~/.claude/settings.json` で設定:
|
| 14 |
+
|
| 15 |
+
- **ktfmt/ktlint**: 編集後に `.kt` と `.kts` ファイルを自動フォーマット
|
| 16 |
+
- **detekt**: Kotlin ファイル編集後に静的解析を実行
|
| 17 |
+
- **./gradlew build**: 変更後にコンパイルを検証
|
github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/patterns.md
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.kt"
|
| 4 |
+
- "**/*.kts"
|
| 5 |
+
---
|
| 6 |
+
# Kotlin パターン
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Kotlin および Android/KMP 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## 依存性注入
|
| 11 |
+
|
| 12 |
+
コンストラクタインジェクションを優先する。Koin(KMP)または Hilt(Android のみ)を使用:
|
| 13 |
+
|
| 14 |
+
```kotlin
|
| 15 |
+
// Koin — モジュール宣言
|
| 16 |
+
val dataModule = module {
|
| 17 |
+
single<ItemRepository> { ItemRepositoryImpl(get(), get()) }
|
| 18 |
+
factory { GetItemsUseCase(get()) }
|
| 19 |
+
viewModelOf(::ItemListViewModel)
|
| 20 |
+
}
|
| 21 |
+
|
| 22 |
+
// Hilt — アノテーション
|
| 23 |
+
@HiltViewModel
|
| 24 |
+
class ItemListViewModel @Inject constructor(
|
| 25 |
+
private val getItems: GetItemsUseCase
|
| 26 |
+
) : ViewModel()
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
## ViewModel パターン
|
| 30 |
+
|
| 31 |
+
単一の状態オブジェクト、イベントシンク、単方向データフロー:
|
| 32 |
+
|
| 33 |
+
```kotlin
|
| 34 |
+
data class ScreenState(
|
| 35 |
+
val items: List<Item> = emptyList(),
|
| 36 |
+
val isLoading: Boolean = false
|
| 37 |
+
)
|
| 38 |
+
|
| 39 |
+
class ScreenViewModel(private val useCase: GetItemsUseCase) : ViewModel() {
|
| 40 |
+
private val _state = MutableStateFlow(ScreenState())
|
| 41 |
+
val state = _state.asStateFlow()
|
| 42 |
+
|
| 43 |
+
fun onEvent(event: ScreenEvent) {
|
| 44 |
+
when (event) {
|
| 45 |
+
is ScreenEvent.Load -> load()
|
| 46 |
+
is ScreenEvent.Delete -> delete(event.id)
|
| 47 |
+
}
|
| 48 |
+
}
|
| 49 |
+
}
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
## リポジトリパターン
|
| 53 |
+
|
| 54 |
+
- `suspend` 関数は `Result<T>` またはカスタムエラー型を返す
|
| 55 |
+
- リアクティブストリームには `Flow`
|
| 56 |
+
- ローカルとリモートのデータソースを調整する
|
| 57 |
+
|
| 58 |
+
```kotlin
|
| 59 |
+
interface ItemRepository {
|
| 60 |
+
suspend fun getById(id: String): Result<Item>
|
| 61 |
+
suspend fun getAll(): Result<List<Item>>
|
| 62 |
+
fun observeAll(): Flow<List<Item>>
|
| 63 |
+
}
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
## UseCase パターン
|
| 67 |
+
|
| 68 |
+
単一責任、`operator fun invoke`:
|
| 69 |
+
|
| 70 |
+
```kotlin
|
| 71 |
+
class GetItemUseCase(private val repository: ItemRepository) {
|
| 72 |
+
suspend operator fun invoke(id: String): Result<Item> {
|
| 73 |
+
return repository.getById(id)
|
| 74 |
+
}
|
| 75 |
+
}
|
| 76 |
+
|
| 77 |
+
class GetItemsUseCase(private val repository: ItemRepository) {
|
| 78 |
+
suspend operator fun invoke(): Result<List<Item>> {
|
| 79 |
+
return repository.getAll()
|
| 80 |
+
}
|
| 81 |
+
}
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
## expect/actual(KMP)
|
| 85 |
+
|
| 86 |
+
プラットフォーム固有の実装に使用:
|
| 87 |
+
|
| 88 |
+
```kotlin
|
| 89 |
+
// commonMain
|
| 90 |
+
expect fun platformName(): String
|
| 91 |
+
expect class SecureStorage {
|
| 92 |
+
fun save(key: String, value: String)
|
| 93 |
+
fun get(key: String): String?
|
| 94 |
+
}
|
| 95 |
+
|
| 96 |
+
// androidMain
|
| 97 |
+
actual fun platformName(): String = "Android"
|
| 98 |
+
actual class SecureStorage {
|
| 99 |
+
actual fun save(key: String, value: String) { /* EncryptedSharedPreferences */ }
|
| 100 |
+
actual fun get(key: String): String? = null /* ... */
|
| 101 |
+
}
|
| 102 |
+
|
| 103 |
+
// iosMain
|
| 104 |
+
actual fun platformName(): String = "iOS"
|
| 105 |
+
actual class SecureStorage {
|
| 106 |
+
actual fun save(key: String, value: String) { /* Keychain */ }
|
| 107 |
+
actual fun get(key: String): String? = null /* ... */
|
| 108 |
+
}
|
| 109 |
+
```
|
| 110 |
+
|
| 111 |
+
## コルーチンパターン
|
| 112 |
+
|
| 113 |
+
- ViewModel では `viewModelScope`、構造化された子作業には `coroutineScope` を使用
|
| 114 |
+
- コールド Flow から StateFlow への変換には `stateIn(viewModelScope, SharingStarted.WhileSubscribed(5_000), initialValue)` を使用
|
| 115 |
+
- 子の失敗を独立させる場合は `supervisorScope` を使用
|
| 116 |
+
|
| 117 |
+
## DSL を使った Builder パターン
|
| 118 |
+
|
| 119 |
+
```kotlin
|
| 120 |
+
class HttpClientConfig {
|
| 121 |
+
var baseUrl: String = ""
|
| 122 |
+
var timeout: Long = 30_000
|
| 123 |
+
private val interceptors = mutableListOf<Interceptor>()
|
| 124 |
+
|
| 125 |
+
fun interceptor(block: () -> Interceptor) {
|
| 126 |
+
interceptors.add(block())
|
| 127 |
+
}
|
| 128 |
+
}
|
| 129 |
+
|
| 130 |
+
fun httpClient(block: HttpClientConfig.() -> Unit): HttpClient {
|
| 131 |
+
val config = HttpClientConfig().apply(block)
|
| 132 |
+
return HttpClient(config)
|
| 133 |
+
}
|
| 134 |
+
|
| 135 |
+
// 使用例
|
| 136 |
+
val client = httpClient {
|
| 137 |
+
baseUrl = "https://api.example.com"
|
| 138 |
+
timeout = 15_000
|
| 139 |
+
interceptor { AuthInterceptor(tokenProvider) }
|
| 140 |
+
}
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
## リファレンス
|
| 144 |
+
|
| 145 |
+
スキル: `kotlin-coroutines-flows` で詳細なコルーチンパターンを参照してください。
|
| 146 |
+
スキル: `android-clean-architecture` でモジュールとレイヤーパターンを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/security.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.kt"
|
| 4 |
+
- "**/*.kts"
|
| 5 |
+
---
|
| 6 |
+
# Kotlin セキュリティ
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/security.md](../common/security.md) を Kotlin および Android/KMP 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## シークレット管理
|
| 11 |
+
|
| 12 |
+
- API キー、トークン、認証情報をソースコードにハードコードしない
|
| 13 |
+
- ローカル開発のシークレットには `local.properties`(git で無視)を使用する
|
| 14 |
+
- リリースビルドには CI シークレットから生成される `BuildConfig` フィールドを使用する
|
| 15 |
+
- ランタイムのシークレット保存には `EncryptedSharedPreferences`(Android)または Keychain(iOS)を使用する
|
| 16 |
+
|
| 17 |
+
```kotlin
|
| 18 |
+
// BAD
|
| 19 |
+
val apiKey = "sk-abc123..."
|
| 20 |
+
|
| 21 |
+
// GOOD — BuildConfig から(ビルド時に生成)
|
| 22 |
+
val apiKey = BuildConfig.API_KEY
|
| 23 |
+
|
| 24 |
+
// GOOD — ランタイム時にセキュアストレージから
|
| 25 |
+
val token = secureStorage.get("auth_token")
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
## ネットワークセキュリティ
|
| 29 |
+
|
| 30 |
+
- HTTPS のみを使用する — クリアテキストをブロックするため `network_security_config.xml` を設定する
|
| 31 |
+
- 機密性の高いエンドポイントには OkHttp の `CertificatePinner` または Ktor 相当で証明書ピンニングを行う
|
| 32 |
+
- すべての HTTP クライアントにタイムアウトを設定する — デフォルト(無限の場合がある)のまま放置しない
|
| 33 |
+
- すべてのサーバーレスポンスを使用前に検証・サニタイズする
|
| 34 |
+
|
| 35 |
+
```xml
|
| 36 |
+
<!-- res/xml/network_security_config.xml -->
|
| 37 |
+
<network-security-config>
|
| 38 |
+
<base-config cleartextTrafficPermitted="false" />
|
| 39 |
+
</network-security-config>
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
## 入力検証
|
| 43 |
+
|
| 44 |
+
- 処理や API 送信前にすべてのユーザー入力を検証する
|
| 45 |
+
- Room/SQLDelight にはパラメータ化クエリを使用する — ユーザー入力を SQL に連結しない
|
| 46 |
+
- パストラバーサルを防ぐためユーザー入力のファイルパスをサニタイズする
|
| 47 |
+
|
| 48 |
+
```kotlin
|
| 49 |
+
// BAD — SQL インジェクション
|
| 50 |
+
@Query("SELECT * FROM items WHERE name = '$input'")
|
| 51 |
+
|
| 52 |
+
// GOOD — パラメータ化
|
| 53 |
+
@Query("SELECT * FROM items WHERE name = :input")
|
| 54 |
+
fun findByName(input: String): List<ItemEntity>
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
## データ保護
|
| 58 |
+
|
| 59 |
+
- Android では機密性の高いキーバリューデータに `EncryptedSharedPreferences` を使用する
|
| 60 |
+
- 明示的なフィールド名で `@Serializable` を使用する — 内部プロパティ名を漏洩させない
|
| 61 |
+
- 不要になった機密データはメモリからクリアする
|
| 62 |
+
- シリアライズされたクラスの名前マングリングを防ぐため `@Keep` または ProGuard ルールを使用する
|
| 63 |
+
|
| 64 |
+
## 認証
|
| 65 |
+
|
| 66 |
+
- トークンはプレーンな SharedPreferences ではなくセキュアストレージに保存する
|
| 67 |
+
- 適切な 401/403 ハンドリングでトークンリフレッシュを実装する
|
| 68 |
+
- ログアウト時にすべての認証状態をクリアする(トークン、キャッシュされたユーザーデータ、Cookie)
|
| 69 |
+
- 機密性の高い操作にはバイオメトリクス認証(`BiometricPrompt`)を使用する
|
| 70 |
+
|
| 71 |
+
## ProGuard / R8
|
| 72 |
+
|
| 73 |
+
- すべてのシリアライズされたモデル(`@Serializable`、Gson、Moshi)の Keep ルール
|
| 74 |
+
- リフレクションベースのライブラリ(Koin、Retrofit)の Keep ルール
|
| 75 |
+
- リリースビルドをテストする — 難読化はシリアライズを無言で壊す可能性がある
|
| 76 |
+
|
| 77 |
+
## WebView セキュリティ
|
| 78 |
+
|
| 79 |
+
- 明示的に必要でない限り JavaScript を無効にする: `settings.javaScriptEnabled = false`
|
| 80 |
+
- WebView にロードする前に URL を検証する
|
| 81 |
+
- 機密データにアクセスする `@JavascriptInterface` メソッドを公開しない
|
| 82 |
+
- `WebViewClient.shouldOverrideUrlLoading()` を使用してナビゲーションを制御する
|
github_code/affaan-m__ECC/docs/ja-JP/rules/kotlin/testing.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.kt"
|
| 4 |
+
- "**/*.kts"
|
| 5 |
+
---
|
| 6 |
+
# Kotlin テスト
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/testing.md](../common/testing.md) を Kotlin および Android/KMP 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## テストフレームワーク
|
| 11 |
+
|
| 12 |
+
- **kotlin.test** — マルチプラットフォーム(KMP)用(`@Test`、`assertEquals`、`assertTrue`)
|
| 13 |
+
- **JUnit 4/5** — Android 固有のテスト用
|
| 14 |
+
- **Turbine** — Flow と StateFlow のテスト用
|
| 15 |
+
- **kotlinx-coroutines-test** — コルーチンテスト用(`runTest`、`TestDispatcher`)
|
| 16 |
+
|
| 17 |
+
## Turbine を使った ViewModel テスト
|
| 18 |
+
|
| 19 |
+
```kotlin
|
| 20 |
+
@Test
|
| 21 |
+
fun `loading state emitted then data`() = runTest {
|
| 22 |
+
val repo = FakeItemRepository()
|
| 23 |
+
repo.addItem(testItem)
|
| 24 |
+
val viewModel = ItemListViewModel(GetItemsUseCase(repo))
|
| 25 |
+
|
| 26 |
+
viewModel.state.test {
|
| 27 |
+
assertEquals(ItemListState(), awaitItem()) // 初期状態
|
| 28 |
+
viewModel.onEvent(ItemListEvent.Load)
|
| 29 |
+
assertTrue(awaitItem().isLoading) // ローディング中
|
| 30 |
+
assertEquals(listOf(testItem), awaitItem().items) // ロード完了
|
| 31 |
+
}
|
| 32 |
+
}
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
## モックよりもフェイクを優先
|
| 36 |
+
|
| 37 |
+
モッキングフレームワークよりも手書きのフェイクを優先する:
|
| 38 |
+
|
| 39 |
+
```kotlin
|
| 40 |
+
class FakeItemRepository : ItemRepository {
|
| 41 |
+
private val items = mutableListOf<Item>()
|
| 42 |
+
var fetchError: Throwable? = null
|
| 43 |
+
|
| 44 |
+
override suspend fun getAll(): Result<List<Item>> {
|
| 45 |
+
fetchError?.let { return Result.failure(it) }
|
| 46 |
+
return Result.success(items.toList())
|
| 47 |
+
}
|
| 48 |
+
|
| 49 |
+
override fun observeAll(): Flow<List<Item>> = flowOf(items.toList())
|
| 50 |
+
|
| 51 |
+
fun addItem(item: Item) { items.add(item) }
|
| 52 |
+
}
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
## コルーチンテスト
|
| 56 |
+
|
| 57 |
+
```kotlin
|
| 58 |
+
@Test
|
| 59 |
+
fun `parallel operations complete`() = runTest {
|
| 60 |
+
val repo = FakeRepository()
|
| 61 |
+
val result = loadDashboard(repo)
|
| 62 |
+
advanceUntilIdle()
|
| 63 |
+
assertNotNull(result.items)
|
| 64 |
+
assertNotNull(result.stats)
|
| 65 |
+
}
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
`runTest` を使用する — 仮想時間を自動的に進め、`TestScope` を提供する。
|
| 69 |
+
|
| 70 |
+
## Ktor MockEngine
|
| 71 |
+
|
| 72 |
+
```kotlin
|
| 73 |
+
val mockEngine = MockEngine { request ->
|
| 74 |
+
when (request.url.encodedPath) {
|
| 75 |
+
"/api/items" -> respond(
|
| 76 |
+
content = Json.encodeToString(testItems),
|
| 77 |
+
headers = headersOf(HttpHeaders.ContentType, ContentType.Application.Json.toString())
|
| 78 |
+
)
|
| 79 |
+
else -> respondError(HttpStatusCode.NotFound)
|
| 80 |
+
}
|
| 81 |
+
}
|
| 82 |
+
|
| 83 |
+
val client = HttpClient(mockEngine) {
|
| 84 |
+
install(ContentNegotiation) { json() }
|
| 85 |
+
}
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
## Room/SQLDelight テスト
|
| 89 |
+
|
| 90 |
+
- Room: インメモリテストには `Room.inMemoryDatabaseBuilder()` を使用
|
| 91 |
+
- SQLDelight: JVM テストには `JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)` を使用
|
| 92 |
+
|
| 93 |
+
```kotlin
|
| 94 |
+
@Test
|
| 95 |
+
fun `insert and query items`() = runTest {
|
| 96 |
+
val driver = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
|
| 97 |
+
Database.Schema.create(driver)
|
| 98 |
+
val db = Database(driver)
|
| 99 |
+
|
| 100 |
+
db.itemQueries.insert("1", "Sample Item", "description")
|
| 101 |
+
val items = db.itemQueries.getAll().executeAsList()
|
| 102 |
+
assertEquals(1, items.size)
|
| 103 |
+
}
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
## テスト命名
|
| 107 |
+
|
| 108 |
+
バッククォートで囲んだ説明的な名前を使用する:
|
| 109 |
+
|
| 110 |
+
```kotlin
|
| 111 |
+
@Test
|
| 112 |
+
fun `search with empty query returns all items`() = runTest { }
|
| 113 |
+
|
| 114 |
+
@Test
|
| 115 |
+
fun `delete item emits updated list without deleted item`() = runTest { }
|
| 116 |
+
```
|
| 117 |
+
|
| 118 |
+
## テストの構成
|
| 119 |
+
|
| 120 |
+
```
|
| 121 |
+
src/
|
| 122 |
+
├── commonTest/kotlin/ # 共有テスト(ViewModel、UseCase、Repository)
|
| 123 |
+
├── androidUnitTest/kotlin/ # Android ユニットテスト(JUnit)
|
| 124 |
+
├── androidInstrumentedTest/kotlin/ # インストルメンテッドテスト(Room、UI)
|
| 125 |
+
└── iosTest/kotlin/ # iOS 固有のテスト
|
| 126 |
+
```
|
| 127 |
+
|
| 128 |
+
最低限のテストカバレッジ: すべての機能に対して ViewModel + UseCase。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/perl/coding-style.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.pl"
|
| 4 |
+
- "**/*.pm"
|
| 5 |
+
- "**/*.t"
|
| 6 |
+
- "**/*.psgi"
|
| 7 |
+
- "**/*.cgi"
|
| 8 |
+
---
|
| 9 |
+
# Perl コーディングスタイル
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Perl 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## 標準
|
| 14 |
+
|
| 15 |
+
- 常に `use v5.36`(`strict`、`warnings`、`say`、サブルーチンシグネチャを有効化)
|
| 16 |
+
- サブルーチンシグネチャを使用する — `@_` を手動で展開しない
|
| 17 |
+
- 明示的な改行付きの `print` よりも `say` を優先
|
| 18 |
+
|
| 19 |
+
## 不変性
|
| 20 |
+
|
| 21 |
+
- **Moo** で `is => 'ro'` と **Types::Standard** をすべての属性に使用
|
| 22 |
+
- blessed ハッシュリファレンスを直接使用しない — 常に Moo/Moose アクセサを使用
|
| 23 |
+
- **OO オーバーライドノート**: `builder` または `default` を持つ Moo の `has` 属性は、計算された読み取り専用値として許容される
|
| 24 |
+
|
| 25 |
+
## フォーマット
|
| 26 |
+
|
| 27 |
+
以下の設定で **perltidy** を使用:
|
| 28 |
+
|
| 29 |
+
```
|
| 30 |
+
-i=4 # 4スペースインデント
|
| 31 |
+
-l=100 # 100文字の行長
|
| 32 |
+
-ce # cuddled else
|
| 33 |
+
-bar # 開き波括弧は常に右
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
## リンティング
|
| 37 |
+
|
| 38 |
+
**perlcritic** をテーマ `core`、`pbp`、`security` で重大度 3 で使用する。
|
| 39 |
+
|
| 40 |
+
```bash
|
| 41 |
+
perlcritic --severity 3 --theme 'core || pbp || security' lib/
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
## リファレンス
|
| 45 |
+
|
| 46 |
+
スキル: `perl-patterns` で包括的なモダン Perl のイディオムとベストプラクティスを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/perl/hooks.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.pl"
|
| 4 |
+
- "**/*.pm"
|
| 5 |
+
- "**/*.t"
|
| 6 |
+
- "**/*.psgi"
|
| 7 |
+
- "**/*.cgi"
|
| 8 |
+
---
|
| 9 |
+
# Perl フック
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Perl 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## PostToolUse フック
|
| 14 |
+
|
| 15 |
+
`~/.claude/settings.json` で設定:
|
| 16 |
+
|
| 17 |
+
- **perltidy**: 編集後に `.pl` と `.pm` ファイルを自動フォーマット
|
| 18 |
+
- **perlcritic**: `.pm` ファイル編集後にリントチェックを実行
|
| 19 |
+
|
| 20 |
+
## 警告
|
| 21 |
+
|
| 22 |
+
- スクリプト以外の `.pm` ファイルでの `print` について警告する — `say` またはロギングモジュール(例: `Log::Any`)を使用すること
|
github_code/affaan-m__ECC/docs/ja-JP/rules/perl/patterns.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.pl"
|
| 4 |
+
- "**/*.pm"
|
| 5 |
+
- "**/*.t"
|
| 6 |
+
- "**/*.psgi"
|
| 7 |
+
- "**/*.cgi"
|
| 8 |
+
---
|
| 9 |
+
# Perl パターン
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Perl 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## リポジトリパターン
|
| 14 |
+
|
| 15 |
+
**DBI** または **DBIx::Class** をインターフェースの背後に使用する:
|
| 16 |
+
|
| 17 |
+
```perl
|
| 18 |
+
package MyApp::Repo::User;
|
| 19 |
+
use Moo;
|
| 20 |
+
|
| 21 |
+
has dbh => (is => 'ro', required => 1);
|
| 22 |
+
|
| 23 |
+
sub find_by_id ($self, $id) {
|
| 24 |
+
my $sth = $self->dbh->prepare('SELECT * FROM users WHERE id = ?');
|
| 25 |
+
$sth->execute($id);
|
| 26 |
+
return $sth->fetchrow_hashref;
|
| 27 |
+
}
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
## DTO / 値オブジェクト
|
| 31 |
+
|
| 32 |
+
**Moo** クラスと **Types::Standard** を使用する(Python の dataclass に相当):
|
| 33 |
+
|
| 34 |
+
```perl
|
| 35 |
+
package MyApp::DTO::User;
|
| 36 |
+
use Moo;
|
| 37 |
+
use Types::Standard qw(Str Int);
|
| 38 |
+
|
| 39 |
+
has name => (is => 'ro', isa => Str, required => 1);
|
| 40 |
+
has email => (is => 'ro', isa => Str, required => 1);
|
| 41 |
+
has age => (is => 'ro', isa => Int);
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
## リソース管理
|
| 45 |
+
|
| 46 |
+
- 常に `autodie` 付きの **3引数 open** を使用する
|
| 47 |
+
- ファイル操作には **Path::Tiny** を使用する
|
| 48 |
+
|
| 49 |
+
```perl
|
| 50 |
+
use autodie;
|
| 51 |
+
use Path::Tiny;
|
| 52 |
+
|
| 53 |
+
my $content = path('config.json')->slurp_utf8;
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
## モジュールインターフェース
|
| 57 |
+
|
| 58 |
+
`Exporter 'import'` と `@EXPORT_OK` を使用する — `@EXPORT` は使用しない:
|
| 59 |
+
|
| 60 |
+
```perl
|
| 61 |
+
use Exporter 'import';
|
| 62 |
+
our @EXPORT_OK = qw(parse_config validate_input);
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
## 依存関係管理
|
| 66 |
+
|
| 67 |
+
再現可能なインストールのために **cpanfile** + **carton** を使用する:
|
| 68 |
+
|
| 69 |
+
```bash
|
| 70 |
+
carton install
|
| 71 |
+
carton exec prove -lr t/
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## リファレンス
|
| 75 |
+
|
| 76 |
+
スキル: `perl-patterns` で包括的なモダン Perl のパターンとイディオムを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/perl/security.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.pl"
|
| 4 |
+
- "**/*.pm"
|
| 5 |
+
- "**/*.t"
|
| 6 |
+
- "**/*.psgi"
|
| 7 |
+
- "**/*.cgi"
|
| 8 |
+
---
|
| 9 |
+
# Perl セキュリティ
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/security.md](../common/security.md) を Perl 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## 汚染モード
|
| 14 |
+
|
| 15 |
+
- すべての CGI/Web 向けスクリプトで `-T` フラグを使用する
|
| 16 |
+
- 外部コマンド実行前に `%ENV`(`$ENV{PATH}`、`$ENV{CDPATH}` など)をサニタイズする
|
| 17 |
+
|
| 18 |
+
## 入力検証
|
| 19 |
+
|
| 20 |
+
- アンテイントには許可リスト正規表現を使用する — `/(.*)/s` は絶対に使用しない
|
| 21 |
+
- すべてのユーザー入力を明示的なパターンで検証する:
|
| 22 |
+
|
| 23 |
+
```perl
|
| 24 |
+
if ($input =~ /\A([a-zA-Z0-9_-]+)\z/) {
|
| 25 |
+
my $clean = $1;
|
| 26 |
+
}
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
## ファイル I/O
|
| 30 |
+
|
| 31 |
+
- **3引数 open のみ** — 2引数 open は使用しない
|
| 32 |
+
- `Cwd::realpath` でパストラバーサルを防止する:
|
| 33 |
+
|
| 34 |
+
```perl
|
| 35 |
+
use Cwd 'realpath';
|
| 36 |
+
my $safe_path = realpath($user_path);
|
| 37 |
+
die "Path traversal" unless $safe_path =~ m{\A/allowed/directory/};
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
## プロセス実行
|
| 41 |
+
|
| 42 |
+
- **リスト形式の `system()`** を使用する — 単一文字列形式は使用しない
|
| 43 |
+
- 出力キャプチャには **IPC::Run3** を使用する
|
| 44 |
+
- 変数補間付きのバッククォートは使用しない
|
| 45 |
+
|
| 46 |
+
```perl
|
| 47 |
+
system('grep', '-r', $pattern, $directory); # 安全
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
## SQL インジェクション防止
|
| 51 |
+
|
| 52 |
+
常に DBI プレースホルダを使用する — SQL に補間しない:
|
| 53 |
+
|
| 54 |
+
```perl
|
| 55 |
+
my $sth = $dbh->prepare('SELECT * FROM users WHERE email = ?');
|
| 56 |
+
$sth->execute($email);
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
## セキュリティスキャン
|
| 60 |
+
|
| 61 |
+
**perlcritic** をセキュリティテーマで重大度 4 以上で実行する:
|
| 62 |
+
|
| 63 |
+
```bash
|
| 64 |
+
perlcritic --severity 4 --theme security lib/
|
| 65 |
+
```
|
| 66 |
+
|
| 67 |
+
## リファレンス
|
| 68 |
+
|
| 69 |
+
スキル: `perl-security` で包括的な Perl セキュリティパターン、汚染モード、安全な I/O を参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/perl/testing.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.pl"
|
| 4 |
+
- "**/*.pm"
|
| 5 |
+
- "**/*.t"
|
| 6 |
+
- "**/*.psgi"
|
| 7 |
+
- "**/*.cgi"
|
| 8 |
+
---
|
| 9 |
+
# Perl テスト
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/testing.md](../common/testing.md) を Perl 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## フレームワーク
|
| 14 |
+
|
| 15 |
+
新規プロジェクトには **Test2::V0** を使用する(Test::More ではない):
|
| 16 |
+
|
| 17 |
+
```perl
|
| 18 |
+
use Test2::V0;
|
| 19 |
+
|
| 20 |
+
is($result, 42, 'answer is correct');
|
| 21 |
+
|
| 22 |
+
done_testing;
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
## ランナー
|
| 26 |
+
|
| 27 |
+
```bash
|
| 28 |
+
prove -l t/ # lib/ を @INC に追加
|
| 29 |
+
prove -lr -j8 t/ # 再帰的、8並列ジョブ
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
`lib/` を `@INC` に含めるため、常に `-l` を使用する。
|
| 33 |
+
|
| 34 |
+
## カバレッジ
|
| 35 |
+
|
| 36 |
+
**Devel::Cover** を使用する — 80% 以上を目標:
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
cover -test
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
## モック
|
| 43 |
+
|
| 44 |
+
- **Test::MockModule** — 既存モジュールのメソッドをモック
|
| 45 |
+
- **Test::MockObject** — ゼロからテストダブルを作成
|
| 46 |
+
|
| 47 |
+
## 注意点
|
| 48 |
+
|
| 49 |
+
- テストファイルは常に `done_testing` で終了する
|
| 50 |
+
- `prove` で `-l` フラグを忘れない
|
| 51 |
+
|
| 52 |
+
## リファレンス
|
| 53 |
+
|
| 54 |
+
スキル: `perl-testing` で Test2::V0、prove、Devel::Cover を使った詳細な Perl TDD パターンを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/php/coding-style.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.php"
|
| 4 |
+
- "**/composer.json"
|
| 5 |
+
---
|
| 6 |
+
# PHP コーディングスタイル
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を PHP 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## 標準
|
| 11 |
+
|
| 12 |
+
- **PSR-12** のフォーマットと命名規則に従う。
|
| 13 |
+
- アプリケーションコードでは `declare(strict_types=1);` を優先する。
|
| 14 |
+
- 新しいコードが許す限り、スカラー型ヒント、戻り値の型、型付きプロパティをあらゆる箇所で使用する。
|
| 15 |
+
|
| 16 |
+
## 不変性
|
| 17 |
+
|
| 18 |
+
- サービス境界を越えるデータには不変の DTO と値オブジェクトを優先する。
|
| 19 |
+
- 可能な場合はリクエスト/レスポンスペイロードに `readonly` プロパティまたは不変コンストラクタを使用する。
|
| 20 |
+
- 単純なマップには配列を使用する; ビジネスクリティカルな構造は明示的なクラスに昇格させる。
|
| 21 |
+
|
| 22 |
+
## フォーマット
|
| 23 |
+
|
| 24 |
+
- フォーマットには **PHP-CS-Fixer** または **Laravel Pint** を使用する。
|
| 25 |
+
- 静的解析には **PHPStan** または **Psalm** を使用する。
|
| 26 |
+
- Composer スクリプトをチェックインし、ローカルと CI で同じコマンドが実行されるようにする。
|
| 27 |
+
|
| 28 |
+
## インポート
|
| 29 |
+
|
| 30 |
+
- 参照されるすべてのクラス、インターフェース、トレイトに `use` 文を追加する。
|
| 31 |
+
- プロジェクトが明示的に完全修飾名を好む場合を除き、グローバル名前空間への依存を避ける。
|
| 32 |
+
|
| 33 |
+
## エラーハンドリング
|
| 34 |
+
|
| 35 |
+
- 例外的な状態には例外をスローする; 新しいコードでは隠れたエラーチャネルとして `false`/`null` を返すことを避ける。
|
| 36 |
+
- フレームワーク/リクエスト入力をドメインロジックに到達する前に検証済み DTO に変換する。
|
| 37 |
+
|
| 38 |
+
## リファレンス
|
| 39 |
+
|
| 40 |
+
スキル: `backend-patterns` でより広範なサービス/リポジトリの階層化ガイダンスを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/php/hooks.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.php"
|
| 4 |
+
- "**/composer.json"
|
| 5 |
+
- "**/phpstan.neon"
|
| 6 |
+
- "**/phpstan.neon.dist"
|
| 7 |
+
- "**/psalm.xml"
|
| 8 |
+
---
|
| 9 |
+
# PHP フック
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を PHP 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## PostToolUse フック
|
| 14 |
+
|
| 15 |
+
`~/.claude/settings.json` で設定:
|
| 16 |
+
|
| 17 |
+
- **Pint / PHP-CS-Fixer**: 編集された `.php` ファイルを自動フォーマット。
|
| 18 |
+
- **PHPStan / Psalm**: 型付きコードベースで PHP 編集後に静的解析を実行。
|
| 19 |
+
- **PHPUnit / Pest**: 編集が動作に影響する場合、対象ファイルやモジュールのテストを実行。
|
| 20 |
+
|
| 21 |
+
## 警告
|
| 22 |
+
|
| 23 |
+
- 編集されたファイルに残された `var_dump`、`dd`、`dump`、`die()` について警告する。
|
| 24 |
+
- 編集された PHP ファイルが生 SQL を追加したり CSRF/セッション保護を無効化している場合に警告する。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/php/patterns.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.php"
|
| 4 |
+
- "**/composer.json"
|
| 5 |
+
---
|
| 6 |
+
# PHP パターン
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を PHP 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## 薄いコントローラ、明示的なサービス
|
| 11 |
+
|
| 12 |
+
- コントローラはトランスポートに集中する: 認証、バリデーション、シリアライゼーション、ステータスコード。
|
| 13 |
+
- ビジネスルールは HTTP ブートストラップなしでテストしやすいアプリケーション/ドメインサービスに移動する。
|
| 14 |
+
|
| 15 |
+
## DTO と値オブジェクト
|
| 16 |
+
|
| 17 |
+
- 形状の重い連想配列をリクエスト、コマンド、外部 API ペイロード用の DTO に置き換える。
|
| 18 |
+
- 金額、識別子、日付範囲、その他の制約のある概念には値オブジェクトを使用する。
|
| 19 |
+
|
| 20 |
+
## 依存性注入
|
| 21 |
+
|
| 22 |
+
- フレームワークのグローバルではなく、インターフェースまたは狭いサービス契約に依存する。
|
| 23 |
+
- サービスロケータ検索なしでテスト可能になるよう、コンストラクタ経由で協力オブジェクトを渡す。
|
| 24 |
+
|
| 25 |
+
## 境界
|
| 26 |
+
|
| 27 |
+
- モデル層が永続化以上のことをしている場合、ORM モデルをドメイン判断から分離する。
|
| 28 |
+
- サードパーティ SDK を小さなアダプタでラップし、コードベースの残りが彼らの契約ではなく自身の契約に依存するようにする。
|
| 29 |
+
|
| 30 |
+
## リファレンス
|
| 31 |
+
|
| 32 |
+
スキル: `api-design` でエンドポイントの規約とレスポンス形状のガイダンスを参照してください。
|
| 33 |
+
スキル: `laravel-patterns` で Laravel 固有のアーキテクチャガイダンスを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/php/security.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.php"
|
| 4 |
+
- "**/composer.lock"
|
| 5 |
+
- "**/composer.json"
|
| 6 |
+
---
|
| 7 |
+
# PHP セキュリティ
|
| 8 |
+
|
| 9 |
+
> このファイルは [common/security.md](../common/security.md) を PHP 固有のコンテンツで拡張します。
|
| 10 |
+
|
| 11 |
+
## 入力と出力
|
| 12 |
+
|
| 13 |
+
- フレームワーク境界でリクエスト入力を検証する(`FormRequest`、Symfony Validator、または明示的な DTO バリデーション)。
|
| 14 |
+
- テンプレートではデフォルトで出力をエスケープする; 生の HTML レンダリングは正当化が必要な例外として扱う。
|
| 15 |
+
- バリデーションなしにクエリパラメータ、Cookie、ヘッダー、アップロードされたファイルのメタデータを信頼しない。
|
| 16 |
+
|
| 17 |
+
## データベースの安全性
|
| 18 |
+
|
| 19 |
+
- すべての動的クエリにプリペアドステートメント(`PDO`、Doctrine、Eloquent クエリビルダ)を使用する。
|
| 20 |
+
- コントローラ/ビューでの文字列構築 SQL を避ける。
|
| 21 |
+
- ORM のマスアサインメントを慎重にスコープし、書き込み可能なフィールドをホワイトリストにする。
|
| 22 |
+
|
| 23 |
+
## シークレットと依存関係
|
| 24 |
+
|
| 25 |
+
- 環境変数またはシークレットマネージャからシークレットをロードする、コミットされた設定ファイルからは読み込まない。
|
| 26 |
+
- CI で `composer audit` を実行し、依存関係追加前に新しいパッケージメンテナーの信頼性を確認する。
|
| 27 |
+
- メジャーバージョンは意図的に固定し、放棄されたパッケージは速やかに削除する。
|
| 28 |
+
|
| 29 |
+
## 認証とセッションの安全性
|
| 30 |
+
|
| 31 |
+
- パスワード保存には `password_hash()` / `password_verify()` を使用する。
|
| 32 |
+
- 認証と権限変更後にセッション識別子を再生成する。
|
| 33 |
+
- 状態変更を伴う Web リクエストに CSRF 保護を強制する。
|
| 34 |
+
|
| 35 |
+
## リファレンス
|
| 36 |
+
|
| 37 |
+
スキル: `laravel-security` で Laravel 固有のセキュリティガイダンスを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/php/testing.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.php"
|
| 4 |
+
- "**/phpunit.xml"
|
| 5 |
+
- "**/phpunit.xml.dist"
|
| 6 |
+
- "**/composer.json"
|
| 7 |
+
---
|
| 8 |
+
# PHP テスト
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/testing.md](../common/testing.md) を PHP 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## フレームワーク
|
| 13 |
+
|
| 14 |
+
デフォルトのテストフレームワークとして **PHPUnit** を使用する。プロジェクトに **Pest** が設定されている場合、新しいテストには Pest を優先し、フレームワークの混在を避ける。
|
| 15 |
+
|
| 16 |
+
## カバレッジ
|
| 17 |
+
|
| 18 |
+
```bash
|
| 19 |
+
vendor/bin/phpunit --coverage-text
|
| 20 |
+
# または
|
| 21 |
+
vendor/bin/pest --coverage
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
CI では **pcov** または **Xdebug** を優先し、カバレッジ閾値は暗黙知ではなく CI で管理する。
|
| 25 |
+
|
| 26 |
+
## テストの構成
|
| 27 |
+
|
| 28 |
+
- 高速なユニットテストとフレームワーク/データベース統合テストを分離する。
|
| 29 |
+
- フィクスチャには大きな手書き配列ではなくファクトリ/ビルダーを使用する。
|
| 30 |
+
- HTTP/コントローラテストはトランスポートとバリデーションに集中する; ビジネスルールはサービスレベルのテストに移動する。
|
| 31 |
+
|
| 32 |
+
## Inertia
|
| 33 |
+
|
| 34 |
+
プロジェクトが Inertia.js を使用している場合、生の JSON アサーションではなく `AssertableInertia` 付きの `assertInertia` でコンポーネント名とプロップスを検証することを優先する。
|
| 35 |
+
|
| 36 |
+
## リファレンス
|
| 37 |
+
|
| 38 |
+
スキル: `tdd-workflow` でリポジトリ全体の RED -> GREEN -> REFACTOR ループを参照してください。
|
| 39 |
+
スキル: `laravel-tdd` で Laravel 固有のテストパターン(PHPUnit と Pest)を参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/coding-style.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.py"
|
| 4 |
+
- "**/*.pyi"
|
| 5 |
+
---
|
| 6 |
+
# Python コーディングスタイル
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Python 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## 標準
|
| 11 |
+
|
| 12 |
+
- **PEP 8** 規約に従う
|
| 13 |
+
- すべての関数シグネチャに**型アノテーション**を使用する
|
| 14 |
+
|
| 15 |
+
## 不変性
|
| 16 |
+
|
| 17 |
+
不変データ構造を優先する:
|
| 18 |
+
|
| 19 |
+
```python
|
| 20 |
+
from dataclasses import dataclass
|
| 21 |
+
|
| 22 |
+
@dataclass(frozen=True)
|
| 23 |
+
class User:
|
| 24 |
+
name: str
|
| 25 |
+
email: str
|
| 26 |
+
|
| 27 |
+
from typing import NamedTuple
|
| 28 |
+
|
| 29 |
+
class Point(NamedTuple):
|
| 30 |
+
x: float
|
| 31 |
+
y: float
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
## フォーマット
|
| 35 |
+
|
| 36 |
+
- **black** — コードフォーマット
|
| 37 |
+
- **isort** — インポートの並べ替え
|
| 38 |
+
- **ruff** — リンティング
|
| 39 |
+
|
| 40 |
+
## リファレンス
|
| 41 |
+
|
| 42 |
+
スキル: `python-patterns` で包括的な Python のイディオムとパターンを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/fastapi.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/app/**/*.py"
|
| 4 |
+
- "**/fastapi/**/*.py"
|
| 5 |
+
- "**/*_api.py"
|
| 6 |
+
---
|
| 7 |
+
# FastAPI ルール
|
| 8 |
+
|
| 9 |
+
FastAPI プロジェクトでは、一般的な Python ルールと併せてこれらのルールを使用してください。
|
| 10 |
+
|
| 11 |
+
## 構造
|
| 12 |
+
|
| 13 |
+
- アプリの構築は `create_app()` に配置する。
|
| 14 |
+
- ルーターは薄く保つ; 永続化とビジネスロジックはサービスまたは CRUD ヘルパーに移動する。
|
| 15 |
+
- リクエストスキーマ、更新スキーマ、レスポンススキーマは分離する。
|
| 16 |
+
- データベースセッションと認証は依存関係に配置する。
|
| 17 |
+
|
| 18 |
+
## 非同期
|
| 19 |
+
|
| 20 |
+
- I/O を実行するエンドポイントには `async def` を使用する。
|
| 21 |
+
- 非同期エンドポイントからは非同期データベースクライアントと HTTP クライアントを使用する。
|
| 22 |
+
- 非同期ルートから `requests`、同期 SQLAlchemy セッション、またはブロッキングファイル/ネットワーク操作を呼び出さない。
|
| 23 |
+
|
| 24 |
+
## 依存性注入
|
| 25 |
+
|
| 26 |
+
```python
|
| 27 |
+
@router.get("/users/{user_id}")
|
| 28 |
+
async def get_user(
|
| 29 |
+
user_id: str,
|
| 30 |
+
db: AsyncSession = Depends(get_db),
|
| 31 |
+
current_user: User = Depends(get_current_user),
|
| 32 |
+
):
|
| 33 |
+
...
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
ルートハンドラ内で `SessionLocal()` や長寿命クライアントを作成しない。
|
| 37 |
+
|
| 38 |
+
## スキーマ
|
| 39 |
+
|
| 40 |
+
- レスポンスモデルにパスワード、パスワードハッシュ、アクセストークン、リフレッシュトークン、内部認証状態を含めない。
|
| 41 |
+
- アプリケーションデータを返すエンドポイントには `response_model` を使用する。
|
| 42 |
+
- 手書きのバリデーションの代わりに、Pydantic でルールを表現できる場合はフィールド制約を使用する。
|
| 43 |
+
|
| 44 |
+
## セキュリティ
|
| 45 |
+
|
| 46 |
+
- CORS オリジンは環境固有にする。
|
| 47 |
+
- ワイルドカードオリジンと認証情報付き CORS を組み合わせない。
|
| 48 |
+
- JWT の有効期限、発行者、オーディエンス、アルゴリズムを検証する。
|
| 49 |
+
- 認証および書き込み負荷の高いエンドポイントにレート制限を適用する。
|
| 50 |
+
- ログから認証情報、Cookie、Authorization ヘッダー、トークンを除去する。
|
| 51 |
+
|
| 52 |
+
## テスト
|
| 53 |
+
|
| 54 |
+
- `Depends` で使用される正確な依存関係をオーバーライドする。
|
| 55 |
+
- テスト後に `app.dependency_overrides` をクリアする。
|
| 56 |
+
- 非同期アプリケーションには非同期テストクライアントを優先する。
|
| 57 |
+
|
| 58 |
+
スキル: `fastapi-patterns` を参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/hooks.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.py"
|
| 4 |
+
- "**/*.pyi"
|
| 5 |
+
---
|
| 6 |
+
# Python フック
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Python 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## PostToolUse フック
|
| 11 |
+
|
| 12 |
+
`~/.claude/settings.json` で設定:
|
| 13 |
+
|
| 14 |
+
- **black/ruff**: 編集後に `.py` ファイルを自動フォーマット
|
| 15 |
+
- **mypy/pyright**: `.py` ファイル編集後に型チェックを実行
|
| 16 |
+
|
| 17 |
+
## 警告
|
| 18 |
+
|
| 19 |
+
- 編集されたファイル内の `print()` 文について警告する(代わりに `logging` モジュールを使用)
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/patterns.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.py"
|
| 4 |
+
- "**/*.pyi"
|
| 5 |
+
---
|
| 6 |
+
# Python パターン
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Python 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## Protocol(ダックタイピング)
|
| 11 |
+
|
| 12 |
+
```python
|
| 13 |
+
from typing import Protocol
|
| 14 |
+
|
| 15 |
+
class Repository(Protocol):
|
| 16 |
+
def find_by_id(self, id: str) -> dict | None: ...
|
| 17 |
+
def save(self, entity: dict) -> dict: ...
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
## DTO としての Dataclass
|
| 21 |
+
|
| 22 |
+
```python
|
| 23 |
+
from dataclasses import dataclass
|
| 24 |
+
|
| 25 |
+
@dataclass
|
| 26 |
+
class CreateUserRequest:
|
| 27 |
+
name: str
|
| 28 |
+
email: str
|
| 29 |
+
age: int | None = None
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
## コンテキストマネージャとジェネレータ
|
| 33 |
+
|
| 34 |
+
- リソース管理にはコンテキストマネージャ(`with` 文)を使用する
|
| 35 |
+
- 遅延評価とメモリ効率の良いイテレーションにはジェネレータを使用する
|
| 36 |
+
|
| 37 |
+
## リファレンス
|
| 38 |
+
|
| 39 |
+
スキル: `python-patterns` でデコレータ、並行処理、パッケージ構成を含む包括的なパターンを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/security.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.py"
|
| 4 |
+
- "**/*.pyi"
|
| 5 |
+
---
|
| 6 |
+
# Python セキュリティ
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/security.md](../common/security.md) を Python 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## シークレット管理
|
| 11 |
+
|
| 12 |
+
```python
|
| 13 |
+
import os
|
| 14 |
+
from dotenv import load_dotenv
|
| 15 |
+
|
| 16 |
+
load_dotenv()
|
| 17 |
+
|
| 18 |
+
api_key = os.environ["OPENAI_API_KEY"] # 未設定の場合 KeyError を発生
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
## セキュリティスキャン
|
| 22 |
+
|
| 23 |
+
- **bandit** を使用して静的セキュリティ解析を実行:
|
| 24 |
+
```bash
|
| 25 |
+
bandit -r src/
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
## リファレンス
|
| 29 |
+
|
| 30 |
+
スキル: `django-security` で Django 固有のセキュリティガイドラインを参照してください(該当する場合)。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/python/testing.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.py"
|
| 4 |
+
- "**/*.pyi"
|
| 5 |
+
---
|
| 6 |
+
# Python テスト
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/testing.md](../common/testing.md) を Python 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## フレームワーク
|
| 11 |
+
|
| 12 |
+
テストフレームワークとして **pytest** を使用する。
|
| 13 |
+
|
| 14 |
+
## カバレッジ
|
| 15 |
+
|
| 16 |
+
```bash
|
| 17 |
+
pytest --cov=src --cov-report=term-missing
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
## テストの構成
|
| 21 |
+
|
| 22 |
+
テスト分類には `pytest.mark` を使用する:
|
| 23 |
+
|
| 24 |
+
```python
|
| 25 |
+
import pytest
|
| 26 |
+
|
| 27 |
+
@pytest.mark.unit
|
| 28 |
+
def test_calculate_total():
|
| 29 |
+
...
|
| 30 |
+
|
| 31 |
+
@pytest.mark.integration
|
| 32 |
+
def test_database_connection():
|
| 33 |
+
...
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
## リファレンス
|
| 37 |
+
|
| 38 |
+
スキル: `python-testing` で詳細な pytest パターンとフィクスチャを参照してください。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/coding-style.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rb"
|
| 4 |
+
- "**/*.rake"
|
| 5 |
+
- "**/Gemfile"
|
| 6 |
+
- "**/*.gemspec"
|
| 7 |
+
- "**/config.ru"
|
| 8 |
+
---
|
| 9 |
+
# Ruby コーディングスタイル
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Ruby および Rails 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## 標準
|
| 14 |
+
|
| 15 |
+
- プロジェクトが既に古いサポート対象ランタイムを固定していない限り、新しい Rails 開発では **Ruby 3.3+** をターゲットにする。
|
| 16 |
+
- 本番環境では起動時間、メモリ、リクエスト/ジョブのスループットを測定した後にのみ **YJIT** を有効にする。
|
| 17 |
+
- プロジェクトがその規約を使用している場合、新しい Ruby ファイルに `# frozen_string_literal: true` を追加する。
|
| 18 |
+
- 巧妙なメタプログラミングよりも明快な Ruby を優先する。DSL を多用するコードは狭く、テストされた境界の背後に隔離する。
|
| 19 |
+
|
| 20 |
+
## フォーマットとリンティング
|
| 21 |
+
|
| 22 |
+
- プロジェクトのチェックイン済み RuboCop 設定を使用する。Rails 8+ アプリでは `rubocop-rails-omakase` から始め、コードベースに実際の規約がある場合にのみカスタマイズする。
|
| 23 |
+
- フォーマッタ/リンターのコマンドは binstub またはスクリプトの背後に配置し、CI とローカルの実行を一致させる:
|
| 24 |
+
|
| 25 |
+
```bash
|
| 26 |
+
bundle exec rubocop
|
| 27 |
+
bundle exec rubocop -A
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
- 例外が狭く、文書化されており、コードで明確に表現するのが困難でない限り、インラインで cop を無効にしない。
|
| 31 |
+
|
| 32 |
+
## Rails スタイル
|
| 33 |
+
|
| 34 |
+
- カスタム構造を追加する前に、Rails の命名規則とディレクトリ規約に従う。
|
| 35 |
+
- コントローラはトランスポートに焦点を当てる: 認証、認可、パラメータ処理、レスポンスの形状。
|
| 36 |
+
- 再利用可能なドメインロジックは、デフォルトの儀式としてではなく、実際の複雑さに基づいてモデル、concerns、サービスオブジェクト、クエリオブジェクト、またはフォームオブジェクトに配置する。
|
| 37 |
+
- グローバルにインストールされたコマンドよりも `bin/rails`、`bin/rake`、およびチェックイン済み binstub を優先する。
|
| 38 |
+
|
| 39 |
+
## エラーハンドリング
|
| 40 |
+
|
| 41 |
+
- 特定の例外を rescue する。広範な `rescue StandardError` ブロックは、再スローするか、運用者に十分なコンテキストを保持する場合を除いて避ける。
|
| 42 |
+
- 運用イベントには `ActiveSupport::Notifications` またはアプリのロガーを使用する。コミット済みのアプリケーションコードに `puts`、`pp`、`debugger` を残さない。
|
| 43 |
+
|
| 44 |
+
## 参考
|
| 45 |
+
|
| 46 |
+
サービス/リポジトリの階層化ガイダンスについてはスキル: `backend-patterns` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/hooks.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rb"
|
| 4 |
+
- "**/*.rake"
|
| 5 |
+
- "**/Gemfile"
|
| 6 |
+
- "**/Gemfile.lock"
|
| 7 |
+
- "**/config/routes.rb"
|
| 8 |
+
---
|
| 9 |
+
# Ruby フック
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Ruby および Rails 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## PostToolUse フック
|
| 14 |
+
|
| 15 |
+
binstub とチェックイン済みツールを優先するようにプロジェクトローカルのフックを設定する:
|
| 16 |
+
|
| 17 |
+
- **RuboCop**: Ruby 編集後に `bundle exec rubocop -A <file>` またはプロジェクトのより安全なフォーマッタコマンドを実行する。
|
| 18 |
+
- **Brakeman**: セキュリティに関わる Rails の変更後に `bundle exec brakeman --no-pager` を実行する。
|
| 19 |
+
- **テスト**: 変更されたファイルに対して最も狭い範囲の `bin/rails test ...` または `bundle exec rspec ...` コマンドを実行する。
|
| 20 |
+
- **Bundler audit**: `Gemfile` または `Gemfile.lock` が変更され、プロジェクトに bundler-audit がインストールされている場合、`bundle exec bundle-audit check --update` を実行する。
|
| 21 |
+
|
| 22 |
+
## 警告
|
| 23 |
+
|
| 24 |
+
- アプリケーションコードにコミットされた `debugger`、`binding.irb`、`binding.pry`、`puts`、`pp`、`p` の呼び出しに対して警告する。
|
| 25 |
+
- 編集が CSRF 保護を無効にしたり、マスアサインメントを拡大したり、パラメータ化なしで生の SQL を追加した場合に警告する。
|
| 26 |
+
- マイグレーションが可逆的なパスや文書化されたロールアウト計画なしにデータを破壊的に変更する場合に警告する。
|
| 27 |
+
|
| 28 |
+
## CI ゲートの提案
|
| 29 |
+
|
| 30 |
+
```bash
|
| 31 |
+
bundle exec rubocop
|
| 32 |
+
bundle exec brakeman --no-pager
|
| 33 |
+
bin/rails test
|
| 34 |
+
bundle exec rspec
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
プロジェクトに存在するコマンドのみを使用する。メンテナーの承認なしに新しいフック依存関係をインストールしない。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/patterns.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rb"
|
| 4 |
+
- "**/*.rake"
|
| 5 |
+
- "**/Gemfile"
|
| 6 |
+
- "**/app/**/*.erb"
|
| 7 |
+
- "**/config/routes.rb"
|
| 8 |
+
---
|
| 9 |
+
# Ruby パターン
|
| 10 |
+
|
| 11 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Ruby および Rails 固有のコンテンツで拡張します。
|
| 12 |
+
|
| 13 |
+
## まず Rails Way
|
| 14 |
+
|
| 15 |
+
- 小規模および中規模の機能には、プレーンな Rails MVC と Active Record の規約から始める。
|
| 16 |
+
- モデル/コントローラの境界が複数の責務を担っている場合に、サービスオブジェクト、クエリオブジェクト、フォームオブジェクト、デコレータ、またはプレゼンターを導入する。
|
| 17 |
+
- 抽出したオブジェクトには `Manager` や `Processor` のような汎用的なレイヤー名ではなく、実行するビジネス操作にちなんだ名前を付ける。
|
| 18 |
+
|
| 19 |
+
## 永続化
|
| 20 |
+
|
| 21 |
+
- マルチホスト本番 Rails アプリでは、既存プラットフォームが MySQL や SQLite を使用する明確な理由がない限り PostgreSQL を優先する。
|
| 22 |
+
- Rails 8 の SQLite ベースのデフォルトは、シングルホストまたは小規模なデプロイメントに適しているが、共有マルチサービスシステムに自動的に適合するわけではない。
|
| 23 |
+
- 生の SQL はクエリオブジェクトまたはモデルスコープの背後に配置し、すべての動的値をパラメータ化する。
|
| 24 |
+
|
| 25 |
+
## バックグラウンドジョブとランタイムサービス
|
| 26 |
+
|
| 27 |
+
- グリーンフィールドの Rails 8 アプリで、適度なスループットとシンプルなデプロイメントが必要な場合は **Solid Queue** を使用する。
|
| 28 |
+
- 成熟したオブザーバビリティ、高スループット、既存の Redis インフラストラクチャ、または Pro/Enterprise 機能が必要な場合は **Sidekiq** を使用する。
|
| 29 |
+
- **Solid Cache** と **Solid Cable** はそのデプロイメントモデルがアプリに適合する場合に使用する。共有クロスサービス動作、高ファンアウト、または高度なデータ構造が重要な場合は Redis を使用する。
|
| 30 |
+
|
| 31 |
+
## フロントエンド
|
| 32 |
+
|
| 33 |
+
- サーバーレンダリングの Rails アプリには Turbo、Stimulus、Importmap、Propshaft を使用した **Hotwire** を優先する。
|
| 34 |
+
- インタラクションの複雑さ、既存のプロダクトアーキテクチャ、またはチームのオーナーシップが追加のクライアントサーフェスを正当化する場合は、React、Vue、Inertia.js、または個別の SPA を使用する。
|
| 35 |
+
- ビューコンポーネント、パーシャル、プレゼンターはレンダリングの判断に集中させる。永続化と認可をテンプレートに含めない。
|
| 36 |
+
|
| 37 |
+
## 認証
|
| 38 |
+
|
| 39 |
+
- シンプルなセッション認証とパスワードリセットのニーズには Rails 8 認証ジェネレータを使用する。
|
| 40 |
+
- OAuth、MFA、confirmable/lockable フロー、マルチモデル認証、または大規模な既存 Devise フットプリントが要件に含まれる場合は Devise または他の確立された認証システムを使用する。
|
| 41 |
+
|
| 42 |
+
## 参考
|
| 43 |
+
|
| 44 |
+
サービス境界とアダプターパターンについてはスキル: `backend-patterns` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/security.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rb"
|
| 4 |
+
- "**/*.rake"
|
| 5 |
+
- "**/Gemfile"
|
| 6 |
+
- "**/Gemfile.lock"
|
| 7 |
+
- "**/config/routes.rb"
|
| 8 |
+
- "**/config/credentials*.yml.enc"
|
| 9 |
+
---
|
| 10 |
+
# Ruby セキュリティ
|
| 11 |
+
|
| 12 |
+
> このファイルは [common/security.md](../common/security.md) を Ruby および Rails 固有のコンテンツで拡張します。
|
| 13 |
+
|
| 14 |
+
## Rails デフォルト
|
| 15 |
+
|
| 16 |
+
- 状態を変更するブラウザリクエストでは CSRF 保護を有効にしておく。
|
| 17 |
+
- マスアサインメントの前に strong parameters または型付き境界オブジェクトを使用する。
|
| 18 |
+
- シークレットは Rails credentials、環境変数、またはシークレットマネージャーに保存する。平文のキー、トークン、プライベート資格情報、またはコピーした `.env` 値をコミットしない。
|
| 19 |
+
|
| 20 |
+
## SQL と Active Record
|
| 21 |
+
|
| 22 |
+
- Active Record クエリ API とパラメータ化された SQL を優先する。
|
| 23 |
+
- リクエスト、Cookie、ヘッダー、ジョブ、または Webhook の値を SQL 文字列に補間しない。
|
| 24 |
+
- モデルコールバックのスコープを慎重に設定する。セキュリティに関わる副作用は明示的にし、テストでカバーする。
|
| 25 |
+
|
| 26 |
+
## 認証とセッション
|
| 27 |
+
|
| 28 |
+
- シンプルなセッション認証には Rails 8 認証ジェネレータを使用する。OAuth、MFA、confirmable、lockable、マルチモデル認証、または既存の Devise 規約が必要な場合は Devise を使用する。
|
| 29 |
+
- サインインと権限変更後にセッションをローテーションする。
|
| 30 |
+
- アカウント回復フローは有効期限、ワンタイムトークン、レート制限、および監査ログで保護する。
|
| 31 |
+
|
| 32 |
+
## 依存関係
|
| 33 |
+
|
| 34 |
+
- ロックファイルが変更された時に依存関係チェックを実行する:
|
| 35 |
+
|
| 36 |
+
```bash
|
| 37 |
+
bundle audit check --update
|
| 38 |
+
bundle exec brakeman --no-pager
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
- 新しい gem については、メンテナーの活動状況、ネイティブ拡張のリスク、推移的依存関係、および Rails コアで同じ動作を実装できるかどうかを確認する。
|
| 42 |
+
|
| 43 |
+
## Web セーフティ
|
| 44 |
+
|
| 45 |
+
- デフォルトでテンプレート出力をエスケープする。`html_safe`、`raw`、およびカスタムサニタイザーはセキュリティに関わるコードとして扱う。
|
| 46 |
+
- ファイルアップロードはコンテンツタイプ、拡張子、サイズ、および保存先で検証する。
|
| 47 |
+
- バックグラウンドジョブ、Webhook、Action Cable メッセージ、および Turbo Stream 入力は信頼されない境界として扱う。
|
| 48 |
+
|
| 49 |
+
## 参考
|
| 50 |
+
|
| 51 |
+
セキュア・バイ・デフォルトのレビューパターンについてはスキル: `security-review` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/ruby/testing.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rb"
|
| 4 |
+
- "**/*.rake"
|
| 5 |
+
- "**/Gemfile"
|
| 6 |
+
- "**/test/**/*.rb"
|
| 7 |
+
- "**/spec/**/*.rb"
|
| 8 |
+
- "**/config/routes.rb"
|
| 9 |
+
---
|
| 10 |
+
# Ruby テスト
|
| 11 |
+
|
| 12 |
+
> このファイルは [common/testing.md](../common/testing.md) を Ruby および Rails 固有のコンテンツで拡張します。
|
| 13 |
+
|
| 14 |
+
## フレームワーク
|
| 15 |
+
|
| 16 |
+
- Rails アプリがデフォルトの Rails テストスタックに従っている場合は **Minitest** を使用する。
|
| 17 |
+
- プロジェクトで既に確立されている場合、またはチームがそれに関する明確な本番規約を持っている場合は **RSpec** を使用する。
|
| 18 |
+
- マイグレーションの理由なしに、同じ機能領域内で Minitest と RSpec を混在させない。
|
| 19 |
+
|
| 20 |
+
## テストピラミッド
|
| 21 |
+
|
| 22 |
+
- 高速なドメインロジックはモデル、サービス、クエリ、ポリシー、ジョブのテストに配置する。
|
| 23 |
+
- HTTP コントラクト、認証動作、リダイレクト、ステータスコード、レスポンスの形状にはリクエスト/コントローラテストを使用する。
|
| 24 |
+
- ブラウザ依存の重要なフローにのみ Capybara を使用したシステムテストを使用する。焦点を絞り、安定させる。
|
| 25 |
+
- バックグラウンドジョブは動作のユニットテストとキュー/エンキューコントラクトの統合テストでカバーする。
|
| 26 |
+
|
| 27 |
+
## フィクスチャとファクトリ
|
| 28 |
+
|
| 29 |
+
- Rails フィクスチャがプロジェクトのデフォルトで、データグラフが小さい場合はそれを使用する。
|
| 30 |
+
- シナリオが明示的なオブジェクト構築や複雑なトレイトを必要とする場合は `factory_bot` を使用する。
|
| 31 |
+
- テストデータはアサートされる動作の近くに配置する。セットアップコストを隠すグローバルフィクスチャを避ける。
|
| 32 |
+
|
| 33 |
+
## コマンド
|
| 34 |
+
|
| 35 |
+
プロジェクトローカルのコマンドを優先する:
|
| 36 |
+
|
| 37 |
+
```bash
|
| 38 |
+
bin/rails test
|
| 39 |
+
bin/rails test test/models/user_test.rb
|
| 40 |
+
bundle exec rspec
|
| 41 |
+
bundle exec rspec spec/models/user_spec.rb
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
## カバレッジ
|
| 45 |
+
|
| 46 |
+
- カバレッジが強制される場合は SimpleCov を使用する。しきい値は CI に設定し、低価値なテストでブランチカバレッジを水増ししない。
|
| 47 |
+
- バグ修正では、本番コードを変更する前にリグレッションテストを追加する。
|
| 48 |
+
|
| 49 |
+
## 参考
|
| 50 |
+
|
| 51 |
+
リポジトリ全体の RED -> GREEN -> REFACTOR ループについてはスキル: `tdd-workflow` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/rust/coding-style.md
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rs"
|
| 4 |
+
---
|
| 5 |
+
# Rust コーディングスタイル
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Rust 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## フォーマット
|
| 10 |
+
|
| 11 |
+
- 強制には **rustfmt** を使用 — コミット前に必ず `cargo fmt` を実行する
|
| 12 |
+
- リントには **clippy** を使用 — `cargo clippy -- -D warnings`(警告をエラーとして扱う)
|
| 13 |
+
- 4スペースインデント(rustfmt デフォルト)
|
| 14 |
+
- 最大行幅: 100文字(rustfmt デフォルト)
|
| 15 |
+
|
| 16 |
+
## 不変性
|
| 17 |
+
|
| 18 |
+
Rust の変数はデフォルトで不変 — これを活用する:
|
| 19 |
+
|
| 20 |
+
- デフォルトで `let` を使用する。ミューテーションが必要な場合にのみ `let mut` を使用する
|
| 21 |
+
- その場でのミューテーションよりも新しい値を返すことを優先する
|
| 22 |
+
- 関数が割り当てる必要があるかどうかわからない場合は `Cow<'_, T>` を使用する
|
| 23 |
+
|
| 24 |
+
```rust
|
| 25 |
+
use std::borrow::Cow;
|
| 26 |
+
|
| 27 |
+
// 良い例 — デフォルトで不変、新しい値を返す
|
| 28 |
+
fn normalize(input: &str) -> Cow<'_, str> {
|
| 29 |
+
if input.contains(' ') {
|
| 30 |
+
Cow::Owned(input.replace(' ', "_"))
|
| 31 |
+
} else {
|
| 32 |
+
Cow::Borrowed(input)
|
| 33 |
+
}
|
| 34 |
+
}
|
| 35 |
+
|
| 36 |
+
// 悪い例 — 不要なミューテーション
|
| 37 |
+
fn normalize_bad(input: &mut String) {
|
| 38 |
+
*input = input.replace(' ', "_");
|
| 39 |
+
}
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
## 命名
|
| 43 |
+
|
| 44 |
+
標準的な Rust の規約に従う:
|
| 45 |
+
- 関数、メソッド、変数、モジュール、クレートには `snake_case`
|
| 46 |
+
- 型、トレイト、列挙型、型パラメータには `PascalCase`(UpperCamelCase)
|
| 47 |
+
- 定数とスタティックには `SCREAMING_SNAKE_CASE`
|
| 48 |
+
- ライフタイム: 短い小文字(`'a`、`'de`)— 複雑な場合は説明的な名前(`'input`)
|
| 49 |
+
|
| 50 |
+
## 所有権と借用
|
| 51 |
+
|
| 52 |
+
- デフォルトで借用(`&T`)する。格納または消費する必要がある場合にのみ所有権を取得する
|
| 53 |
+
- 根本原因を理解せずにボローチェッカーを満たすためにクローンしない
|
| 54 |
+
- 関数パラメータでは `String` よりも `&str`、`Vec<T>` よりも `&[T]` を受け入れる
|
| 55 |
+
- `String` を所有する必要があるコンストラクタには `impl Into<String>` を使用する
|
| 56 |
+
|
| 57 |
+
```rust
|
| 58 |
+
// 良い例 — 所有権が不要な場合は借用する
|
| 59 |
+
fn word_count(text: &str) -> usize {
|
| 60 |
+
text.split_whitespace().count()
|
| 61 |
+
}
|
| 62 |
+
|
| 63 |
+
// 良い例 — Into を使用してコンストラクタで所有権を取得する
|
| 64 |
+
fn new(name: impl Into<String>) -> Self {
|
| 65 |
+
Self { name: name.into() }
|
| 66 |
+
}
|
| 67 |
+
|
| 68 |
+
// 悪い例 — &str で十分なのに String を取得する
|
| 69 |
+
fn word_count_bad(text: String) -> usize {
|
| 70 |
+
text.split_whitespace().count()
|
| 71 |
+
}
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## エラーハンドリング
|
| 75 |
+
|
| 76 |
+
- 伝搬には `Result<T, E>` と `?` を使用する — 本番コードでは `unwrap()` を使わない
|
| 77 |
+
- **ライブラリ**: `thiserror` で型付きエラーを定義する
|
| 78 |
+
- **アプリケーション**: 柔軟なエラーコンテキストには `anyhow` を使用する
|
| 79 |
+
- `.with_context(|| format!("failed to ..."))?` でコンテキストを追加する
|
| 80 |
+
- `unwrap()` / `expect()` はテストと本当に到達不可能な状態にのみ使用する
|
| 81 |
+
|
| 82 |
+
```rust
|
| 83 |
+
// 良い例 — thiserror によるライブラリエラー
|
| 84 |
+
#[derive(Debug, thiserror::Error)]
|
| 85 |
+
pub enum ConfigError {
|
| 86 |
+
#[error("failed to read config: {0}")]
|
| 87 |
+
Io(#[from] std::io::Error),
|
| 88 |
+
#[error("invalid config format: {0}")]
|
| 89 |
+
Parse(String),
|
| 90 |
+
}
|
| 91 |
+
|
| 92 |
+
// 良い例 — anyhow によるアプリケーションエラー
|
| 93 |
+
use anyhow::Context;
|
| 94 |
+
|
| 95 |
+
fn load_config(path: &str) -> anyhow::Result<Config> {
|
| 96 |
+
let content = std::fs::read_to_string(path)
|
| 97 |
+
.with_context(|| format!("failed to read {path}"))?;
|
| 98 |
+
toml::from_str(&content)
|
| 99 |
+
.with_context(|| format!("failed to parse {path}"))
|
| 100 |
+
}
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
## ループよりもイテレータ
|
| 104 |
+
|
| 105 |
+
変換にはイテレータチェーンを優先する。複雑な制御フローにはループを使用する:
|
| 106 |
+
|
| 107 |
+
```rust
|
| 108 |
+
// 良い例 — 宣言的で合成可能
|
| 109 |
+
let active_emails: Vec<&str> = users.iter()
|
| 110 |
+
.filter(|u| u.is_active)
|
| 111 |
+
.map(|u| u.email.as_str())
|
| 112 |
+
.collect();
|
| 113 |
+
|
| 114 |
+
// 良い例 — 早期リターンを伴う複雑なロジックにはループ
|
| 115 |
+
for user in &users {
|
| 116 |
+
if let Some(verified) = verify_email(&user.email)? {
|
| 117 |
+
send_welcome(&verified)?;
|
| 118 |
+
}
|
| 119 |
+
}
|
| 120 |
+
```
|
| 121 |
+
|
| 122 |
+
## モジュール構成
|
| 123 |
+
|
| 124 |
+
型ごとではなく、ドメインごとに整理する:
|
| 125 |
+
|
| 126 |
+
```text
|
| 127 |
+
src/
|
| 128 |
+
├── main.rs
|
| 129 |
+
├── lib.rs
|
| 130 |
+
├── auth/ # ドメインモジュール
|
| 131 |
+
│ ├── mod.rs
|
| 132 |
+
│ ├── token.rs
|
| 133 |
+
│ └── middleware.rs
|
| 134 |
+
├── orders/ # ドメインモジュール
|
| 135 |
+
│ ├── mod.rs
|
| 136 |
+
│ ├── model.rs
|
| 137 |
+
│ └── service.rs
|
| 138 |
+
└── db/ # インフラストラクチャ
|
| 139 |
+
├── mod.rs
|
| 140 |
+
└── pool.rs
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
## 可視性
|
| 144 |
+
|
| 145 |
+
- デフォルトはプライベート。内部共有には `pub(crate)` を使用する
|
| 146 |
+
- クレートのパブリック API の一��であるものだけに `pub` を付ける
|
| 147 |
+
- `lib.rs` からパブリック API を再エクスポートする
|
| 148 |
+
|
| 149 |
+
## 参考
|
| 150 |
+
|
| 151 |
+
包括的な Rust のイディオムとパターンについてはスキル: `rust-patterns` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/rust/hooks.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rs"
|
| 4 |
+
- "**/Cargo.toml"
|
| 5 |
+
---
|
| 6 |
+
# Rust フック
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Rust 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## PostToolUse フック
|
| 11 |
+
|
| 12 |
+
`~/.claude/settings.json` で設定する:
|
| 13 |
+
|
| 14 |
+
- **cargo fmt**: `.rs` ファイルを編集後に自動フォーマットする
|
| 15 |
+
- **cargo clippy**: Rust ファイルの編集後にリントチェックを実行する
|
| 16 |
+
- **cargo check**: 変更後にコンパイルを検証する(`cargo build` よりも高速)
|
github_code/affaan-m__ECC/docs/ja-JP/rules/rust/patterns.md
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rs"
|
| 4 |
+
---
|
| 5 |
+
# Rust パターン
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Rust 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## トレイトを使ったリポジトリパターン
|
| 10 |
+
|
| 11 |
+
データアクセスをトレイトの背後にカプセル化する:
|
| 12 |
+
|
| 13 |
+
```rust
|
| 14 |
+
pub trait OrderRepository: Send + Sync {
|
| 15 |
+
fn find_by_id(&self, id: u64) -> Result<Option<Order>, StorageError>;
|
| 16 |
+
fn find_all(&self) -> Result<Vec<Order>, StorageError>;
|
| 17 |
+
fn save(&self, order: &Order) -> Result<Order, StorageError>;
|
| 18 |
+
fn delete(&self, id: u64) -> Result<(), StorageError>;
|
| 19 |
+
}
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
具象実装がストレージの詳細を処理する(Postgres、SQLite、テスト用インメモリ)。
|
| 23 |
+
|
| 24 |
+
## サービスレイヤー
|
| 25 |
+
|
| 26 |
+
サービス構造体にビジネスロジックを配置する。コンストラクタ経由で依存関係を注入する:
|
| 27 |
+
|
| 28 |
+
```rust
|
| 29 |
+
pub struct OrderService {
|
| 30 |
+
repo: Box<dyn OrderRepository>,
|
| 31 |
+
payment: Box<dyn PaymentGateway>,
|
| 32 |
+
}
|
| 33 |
+
|
| 34 |
+
impl OrderService {
|
| 35 |
+
pub fn new(repo: Box<dyn OrderRepository>, payment: Box<dyn PaymentGateway>) -> Self {
|
| 36 |
+
Self { repo, payment }
|
| 37 |
+
}
|
| 38 |
+
|
| 39 |
+
pub fn place_order(&self, request: CreateOrderRequest) -> anyhow::Result<OrderSummary> {
|
| 40 |
+
let order = Order::from(request);
|
| 41 |
+
self.payment.charge(order.total())?;
|
| 42 |
+
let saved = self.repo.save(&order)?;
|
| 43 |
+
Ok(OrderSummary::from(saved))
|
| 44 |
+
}
|
| 45 |
+
}
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## 型安全のための Newtype パターン
|
| 49 |
+
|
| 50 |
+
引数の取り違えを防ぐために個別のラッパー型を使用する:
|
| 51 |
+
|
| 52 |
+
```rust
|
| 53 |
+
struct UserId(u64);
|
| 54 |
+
struct OrderId(u64);
|
| 55 |
+
|
| 56 |
+
fn get_order(user: UserId, order: OrderId) -> anyhow::Result<Order> {
|
| 57 |
+
// 呼び出し側で user と order の ID を誤って入れ替えることができない
|
| 58 |
+
todo!()
|
| 59 |
+
}
|
| 60 |
+
```
|
| 61 |
+
|
| 62 |
+
## 列挙型ステートマシン
|
| 63 |
+
|
| 64 |
+
状態を列挙型としてモデリングする — 不正な状態を表現不可能にする:
|
| 65 |
+
|
| 66 |
+
```rust
|
| 67 |
+
enum ConnectionState {
|
| 68 |
+
Disconnected,
|
| 69 |
+
Connecting { attempt: u32 },
|
| 70 |
+
Connected { session_id: String },
|
| 71 |
+
Failed { reason: String, retries: u32 },
|
| 72 |
+
}
|
| 73 |
+
|
| 74 |
+
fn handle(state: &ConnectionState) {
|
| 75 |
+
match state {
|
| 76 |
+
ConnectionState::Disconnected => connect(),
|
| 77 |
+
ConnectionState::Connecting { attempt } if *attempt > 3 => abort(),
|
| 78 |
+
ConnectionState::Connecting { .. } => wait(),
|
| 79 |
+
ConnectionState::Connected { session_id } => use_session(session_id),
|
| 80 |
+
ConnectionState::Failed { retries, .. } if *retries < 5 => retry(),
|
| 81 |
+
ConnectionState::Failed { reason, .. } => log_failure(reason),
|
| 82 |
+
}
|
| 83 |
+
}
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
ビジネス上重要な列挙型では常に網羅的にマッチする — ワイルドカード `_` は使わない。
|
| 87 |
+
|
| 88 |
+
## ビルダーパターン
|
| 89 |
+
|
| 90 |
+
多数のオプションパラメータを持つ構造体に使用する:
|
| 91 |
+
|
| 92 |
+
```rust
|
| 93 |
+
pub struct ServerConfig {
|
| 94 |
+
host: String,
|
| 95 |
+
port: u16,
|
| 96 |
+
max_connections: usize,
|
| 97 |
+
}
|
| 98 |
+
|
| 99 |
+
impl ServerConfig {
|
| 100 |
+
pub fn builder(host: impl Into<String>, port: u16) -> ServerConfigBuilder {
|
| 101 |
+
ServerConfigBuilder {
|
| 102 |
+
host: host.into(),
|
| 103 |
+
port,
|
| 104 |
+
max_connections: 100,
|
| 105 |
+
}
|
| 106 |
+
}
|
| 107 |
+
}
|
| 108 |
+
|
| 109 |
+
pub struct ServerConfigBuilder {
|
| 110 |
+
host: String,
|
| 111 |
+
port: u16,
|
| 112 |
+
max_connections: usize,
|
| 113 |
+
}
|
| 114 |
+
|
| 115 |
+
impl ServerConfigBuilder {
|
| 116 |
+
pub fn max_connections(mut self, n: usize) -> Self {
|
| 117 |
+
self.max_connections = n;
|
| 118 |
+
self
|
| 119 |
+
}
|
| 120 |
+
|
| 121 |
+
pub fn build(self) -> ServerConfig {
|
| 122 |
+
ServerConfig {
|
| 123 |
+
host: self.host,
|
| 124 |
+
port: self.port,
|
| 125 |
+
max_connections: self.max_connections,
|
| 126 |
+
}
|
| 127 |
+
}
|
| 128 |
+
}
|
| 129 |
+
```
|
| 130 |
+
|
| 131 |
+
## 拡張性制御のための Sealed トレイト
|
| 132 |
+
|
| 133 |
+
プライベートモジュールを使用してトレイトをシールし、外部からの実装を防止する:
|
| 134 |
+
|
| 135 |
+
```rust
|
| 136 |
+
mod private {
|
| 137 |
+
pub trait Sealed {}
|
| 138 |
+
}
|
| 139 |
+
|
| 140 |
+
pub trait Format: private::Sealed {
|
| 141 |
+
fn encode(&self, data: &[u8]) -> Vec<u8>;
|
| 142 |
+
}
|
| 143 |
+
|
| 144 |
+
pub struct Json;
|
| 145 |
+
impl private::Sealed for Json {}
|
| 146 |
+
impl Format for Json {
|
| 147 |
+
fn encode(&self, data: &[u8]) -> Vec<u8> { todo!() }
|
| 148 |
+
}
|
| 149 |
+
```
|
| 150 |
+
|
| 151 |
+
## API レスポンスエンベロープ
|
| 152 |
+
|
| 153 |
+
ジェネリック列挙型を使用した一貫した API レスポンス:
|
| 154 |
+
|
| 155 |
+
```rust
|
| 156 |
+
#[derive(Debug, serde::Serialize)]
|
| 157 |
+
#[serde(tag = "status")]
|
| 158 |
+
pub enum ApiResponse<T: serde::Serialize> {
|
| 159 |
+
#[serde(rename = "ok")]
|
| 160 |
+
Ok { data: T },
|
| 161 |
+
#[serde(rename = "error")]
|
| 162 |
+
Error { message: String },
|
| 163 |
+
}
|
| 164 |
+
```
|
| 165 |
+
|
| 166 |
+
## 参考
|
| 167 |
+
|
| 168 |
+
所有権、トレイト、ジェネリクス、並行性、非同期を含む包括的なパターンについてはスキル: `rust-patterns` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/rust/security.md
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rs"
|
| 4 |
+
---
|
| 5 |
+
# Rust セキュリティ
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/security.md](../common/security.md) を Rust 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## シークレット管理
|
| 10 |
+
|
| 11 |
+
- API キー、トークン、資格情報をソースコードにハードコードしない
|
| 12 |
+
- 環境変数を使用する: `std::env::var("API_KEY")`
|
| 13 |
+
- 必要なシークレットが起動時に欠落している場合は即座に失敗する
|
| 14 |
+
- `.env` ファイルは `.gitignore` に含める
|
| 15 |
+
|
| 16 |
+
```rust
|
| 17 |
+
// 悪い例
|
| 18 |
+
const API_KEY: &str = "sk-abc123...";
|
| 19 |
+
|
| 20 |
+
// 良い例 — 早期バリデーション付きの環境変数
|
| 21 |
+
fn load_api_key() -> anyhow::Result<String> {
|
| 22 |
+
std::env::var("PAYMENT_API_KEY")
|
| 23 |
+
.context("PAYMENT_API_KEY must be set")
|
| 24 |
+
}
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## SQL インジェクション防止
|
| 28 |
+
|
| 29 |
+
- 常にパラメータ化クエリを使用する — ユーザー入力を SQL 文字列にフォーマットしない
|
| 30 |
+
- バインドパラメータ付きのクエリビルダーまたは ORM(sqlx、diesel、sea-orm)を使用する
|
| 31 |
+
|
| 32 |
+
```rust
|
| 33 |
+
// 悪い例 — フォーマット文字列による SQL インジェクション
|
| 34 |
+
let query = format!("SELECT * FROM users WHERE name = '{name}'");
|
| 35 |
+
sqlx::query(&query).fetch_one(&pool).await?;
|
| 36 |
+
|
| 37 |
+
// 良い例 — sqlx によるパラメータ化クエリ
|
| 38 |
+
// プレースホルダ構文はバックエンドにより異なる: Postgres: $1 | MySQL: ? | SQLite: $1
|
| 39 |
+
sqlx::query("SELECT * FROM users WHERE name = $1")
|
| 40 |
+
.bind(&name)
|
| 41 |
+
.fetch_one(&pool)
|
| 42 |
+
.await?;
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
## 入力バリデーション
|
| 46 |
+
|
| 47 |
+
- 処理前にシステム境界ですべてのユーザー入力を検証する
|
| 48 |
+
- 型システムを使用して不変条件を強制する(newtype パターン)
|
| 49 |
+
- バリデーションではなくパースする — 境界で非構造化データを型付き構造体に変換する
|
| 50 |
+
- 無効な入力は明確なエラーメッセージで拒否する
|
| 51 |
+
|
| 52 |
+
```rust
|
| 53 |
+
// バリデーションではなくパースする — 無効な状態は表現不可能
|
| 54 |
+
pub struct Email(String);
|
| 55 |
+
|
| 56 |
+
impl Email {
|
| 57 |
+
pub fn parse(input: &str) -> Result<Self, ValidationError> {
|
| 58 |
+
let trimmed = input.trim();
|
| 59 |
+
let at_pos = trimmed.find('@')
|
| 60 |
+
.filter(|&p| p > 0 && p < trimmed.len() - 1)
|
| 61 |
+
.ok_or_else(|| ValidationError::InvalidEmail(input.to_string()))?;
|
| 62 |
+
let domain = &trimmed[at_pos + 1..];
|
| 63 |
+
if trimmed.len() > 254 || !domain.contains('.') {
|
| 64 |
+
return Err(ValidationError::InvalidEmail(input.to_string()));
|
| 65 |
+
}
|
| 66 |
+
// 本番環境では、バリデーション済みメールクレート(例: `email_address`)の使用を推奨
|
| 67 |
+
Ok(Self(trimmed.to_string()))
|
| 68 |
+
}
|
| 69 |
+
|
| 70 |
+
pub fn as_str(&self) -> &str {
|
| 71 |
+
&self.0
|
| 72 |
+
}
|
| 73 |
+
}
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
## アンセーフコード
|
| 77 |
+
|
| 78 |
+
- `unsafe` ブロックを最小限にする — 安全な抽象化を優先する
|
| 79 |
+
- すべての `unsafe` ブロックには不変条件を説明する `// SAFETY:` コメントが必要
|
| 80 |
+
- 利便性のためにボローチェッカーを迂回するために `unsafe` を使用しない
|
| 81 |
+
- レビュー時にすべての `unsafe` コードを監査する — 正当な理由なしに使用するのは危険信号である
|
| 82 |
+
- C ライブラリには `safe` な FFI ラッパーを優先する
|
| 83 |
+
|
| 84 |
+
```rust
|
| 85 |
+
// 良い例 — safety コメントが必要なすべての不変条件を文書化
|
| 86 |
+
let widget: &Widget = {
|
| 87 |
+
// SAFETY: `ptr` は non-null、アライン済み、初期化された Widget を指し、
|
| 88 |
+
// そのライフタイム中にミュータブル参照やミューテーションは存在しない。
|
| 89 |
+
unsafe { &*ptr }
|
| 90 |
+
};
|
| 91 |
+
|
| 92 |
+
// 悪い例 — safety の正当化がない
|
| 93 |
+
unsafe { &*ptr }
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
## 依存関係のセキュリティ
|
| 97 |
+
|
| 98 |
+
- `cargo audit` を実行して依存関係の既知の CVE をスキャンする
|
| 99 |
+
- `cargo deny check` でライセンスとアドバイザリのコンプライアンスを確認する
|
| 100 |
+
- `cargo tree` で推移的依存関係を監査する
|
| 101 |
+
- 依存関係を最新に保つ — Dependabot または Renovate を設定する
|
| 102 |
+
- 依存関係数を最小限にする — 新しいクレートを追加する前に評価する
|
| 103 |
+
|
| 104 |
+
```bash
|
| 105 |
+
# セキュリティ監査
|
| 106 |
+
cargo audit
|
| 107 |
+
|
| 108 |
+
# アドバイザリ、重複バージョン、制限付きライセンスの拒否
|
| 109 |
+
cargo deny check
|
| 110 |
+
|
| 111 |
+
# 依存関係ツリーの検査
|
| 112 |
+
cargo tree
|
| 113 |
+
cargo tree -d # 重複のみ表示
|
| 114 |
+
```
|
| 115 |
+
|
| 116 |
+
## エラーメッセージ
|
| 117 |
+
|
| 118 |
+
- API レスポンスに内部パス、スタックトレース、データベースエラーを公開しない
|
| 119 |
+
- 詳細なエラーはサーバー側でログに記録する。クライアントには汎用メッセージを返す
|
| 120 |
+
- 構造化されたサーバー側ロギングには `tracing` または `log` を使用する
|
| 121 |
+
|
| 122 |
+
```rust
|
| 123 |
+
// エラーを適切なステータスコードと汎用メッセージにマッピングする
|
| 124 |
+
// (例では axum を使用。レスポンス型はフレームワークに合わせて調整する)
|
| 125 |
+
match order_service.find_by_id(id) {
|
| 126 |
+
Ok(order) => Ok((StatusCode::OK, Json(order))),
|
| 127 |
+
Err(ServiceError::NotFound(_)) => {
|
| 128 |
+
tracing::info!(order_id = id, "order not found");
|
| 129 |
+
Err((StatusCode::NOT_FOUND, "Resource not found"))
|
| 130 |
+
}
|
| 131 |
+
Err(e) => {
|
| 132 |
+
tracing::error!(order_id = id, error = %e, "unexpected error");
|
| 133 |
+
Err((StatusCode::INTERNAL_SERVER_ERROR, "Internal server error"))
|
| 134 |
+
}
|
| 135 |
+
}
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
## 参考
|
| 139 |
+
|
| 140 |
+
アンセーフコードのガイドラインと所有権パターンについてはスキル: `rust-patterns` を参照。
|
| 141 |
+
一般的なセキュリティチェックリストについてはスキル: `security-review` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/rust/testing.md
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.rs"
|
| 4 |
+
---
|
| 5 |
+
# Rust テスト
|
| 6 |
+
|
| 7 |
+
> このファイルは [common/testing.md](../common/testing.md) を Rust 固有のコンテンツで拡張します。
|
| 8 |
+
|
| 9 |
+
## テストフレームワーク
|
| 10 |
+
|
| 11 |
+
- ユニットテストには `#[cfg(test)]` モジュール内の **`#[test]`** を使用する
|
| 12 |
+
- パラメータ化テストとフィクスチャには **rstest** を使用する
|
| 13 |
+
- プロパティベーステストには **proptest** を使用する
|
| 14 |
+
- トレイトベースのモッキングには **mockall** を使用する
|
| 15 |
+
- 非同期テストには **`#[tokio::test]`** を使用する
|
| 16 |
+
|
| 17 |
+
## テストの構成
|
| 18 |
+
|
| 19 |
+
```text
|
| 20 |
+
my_crate/
|
| 21 |
+
├── src/
|
| 22 |
+
│ ├── lib.rs # #[cfg(test)] モジュール内のユニットテスト
|
| 23 |
+
│ ├── auth/
|
| 24 |
+
│ │ └── mod.rs # #[cfg(test)] mod tests { ... }
|
| 25 |
+
│ └── orders/
|
| 26 |
+
│ └── service.rs # #[cfg(test)] mod tests { ... }
|
| 27 |
+
├── tests/ # 統合テスト(各ファイル = 個別のバイナリ)
|
| 28 |
+
│ ├── api_test.rs
|
| 29 |
+
│ ├── db_test.rs
|
| 30 |
+
│ └── common/ # 共有テストユーティリティ
|
| 31 |
+
│ └── mod.rs
|
| 32 |
+
└── benches/ # Criterion ベンチマーク
|
| 33 |
+
└── benchmark.rs
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
ユニットテストは同じファイル内の `#[cfg(test)]` モジュールに配置する。統合テストは `tests/` に配置する。
|
| 37 |
+
|
| 38 |
+
## ユニットテストのパターン
|
| 39 |
+
|
| 40 |
+
```rust
|
| 41 |
+
#[cfg(test)]
|
| 42 |
+
mod tests {
|
| 43 |
+
use super::*;
|
| 44 |
+
|
| 45 |
+
#[test]
|
| 46 |
+
fn creates_user_with_valid_email() {
|
| 47 |
+
let user = User::new("Alice", "alice@example.com").unwrap();
|
| 48 |
+
assert_eq!(user.name, "Alice");
|
| 49 |
+
}
|
| 50 |
+
|
| 51 |
+
#[test]
|
| 52 |
+
fn rejects_invalid_email() {
|
| 53 |
+
let result = User::new("Bob", "not-an-email");
|
| 54 |
+
assert!(result.is_err());
|
| 55 |
+
assert!(result.unwrap_err().to_string().contains("invalid email"));
|
| 56 |
+
}
|
| 57 |
+
}
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
## パラメータ化テスト
|
| 61 |
+
|
| 62 |
+
```rust
|
| 63 |
+
use rstest::rstest;
|
| 64 |
+
|
| 65 |
+
#[rstest]
|
| 66 |
+
#[case("hello", 5)]
|
| 67 |
+
#[case("", 0)]
|
| 68 |
+
#[case("rust", 4)]
|
| 69 |
+
fn test_string_length(#[case] input: &str, #[case] expected: usize) {
|
| 70 |
+
assert_eq!(input.len(), expected);
|
| 71 |
+
}
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## 非同期テスト
|
| 75 |
+
|
| 76 |
+
```rust
|
| 77 |
+
#[tokio::test]
|
| 78 |
+
async fn fetches_data_successfully() {
|
| 79 |
+
let client = TestClient::new().await;
|
| 80 |
+
let result = client.get("/data").await;
|
| 81 |
+
assert!(result.is_ok());
|
| 82 |
+
}
|
| 83 |
+
```
|
| 84 |
+
|
| 85 |
+
## mockall によるモッキング
|
| 86 |
+
|
| 87 |
+
本番コードでトレイトを定義し、テストモジュールでモックを生成する:
|
| 88 |
+
|
| 89 |
+
```rust
|
| 90 |
+
// 本番トレイト — 統合テストがインポートできるように pub にする
|
| 91 |
+
pub trait UserRepository {
|
| 92 |
+
fn find_by_id(&self, id: u64) -> Option<User>;
|
| 93 |
+
}
|
| 94 |
+
|
| 95 |
+
#[cfg(test)]
|
| 96 |
+
mod tests {
|
| 97 |
+
use super::*;
|
| 98 |
+
use mockall::predicate::eq;
|
| 99 |
+
|
| 100 |
+
mockall::mock! {
|
| 101 |
+
pub Repo {}
|
| 102 |
+
impl UserRepository for Repo {
|
| 103 |
+
fn find_by_id(&self, id: u64) -> Option<User>;
|
| 104 |
+
}
|
| 105 |
+
}
|
| 106 |
+
|
| 107 |
+
#[test]
|
| 108 |
+
fn service_returns_user_when_found() {
|
| 109 |
+
let mut mock = MockRepo::new();
|
| 110 |
+
mock.expect_find_by_id()
|
| 111 |
+
.with(eq(42))
|
| 112 |
+
.times(1)
|
| 113 |
+
.returning(|_| Some(User { id: 42, name: "Alice".into() }));
|
| 114 |
+
|
| 115 |
+
let service = UserService::new(Box::new(mock));
|
| 116 |
+
let user = service.get_user(42).unwrap();
|
| 117 |
+
assert_eq!(user.name, "Alice");
|
| 118 |
+
}
|
| 119 |
+
}
|
| 120 |
+
```
|
| 121 |
+
|
| 122 |
+
## テストの命名
|
| 123 |
+
|
| 124 |
+
シナリオを説明する記述的な名前を使用する:
|
| 125 |
+
- `creates_user_with_valid_email()`
|
| 126 |
+
- `rejects_order_when_insufficient_stock()`
|
| 127 |
+
- `returns_none_when_not_found()`
|
| 128 |
+
|
| 129 |
+
## カバレッジ
|
| 130 |
+
|
| 131 |
+
- 80%以上の行カバレッジを目標にする
|
| 132 |
+
- カバレッジレポートには **cargo-llvm-cov** を使用する
|
| 133 |
+
- ビジネスロジックに集中する — 生成コードと FFI バインディングは除外する
|
| 134 |
+
|
| 135 |
+
```bash
|
| 136 |
+
cargo llvm-cov # サマリー
|
| 137 |
+
cargo llvm-cov --html # HTML レポート
|
| 138 |
+
cargo llvm-cov --fail-under-lines 80 # しきい値以下で失敗
|
| 139 |
+
```
|
| 140 |
+
|
| 141 |
+
## テストコマンド
|
| 142 |
+
|
| 143 |
+
```bash
|
| 144 |
+
cargo test # すべてのテストを実行
|
| 145 |
+
cargo test -- --nocapture # println 出力を表示
|
| 146 |
+
cargo test test_name # パターンに一致するテストを実行
|
| 147 |
+
cargo test --lib # ユニットテストのみ
|
| 148 |
+
cargo test --test api_test # 特定の統合テスト(tests/api_test.rs)
|
| 149 |
+
cargo test --doc # ドキュメントテストのみ
|
| 150 |
+
```
|
| 151 |
+
|
| 152 |
+
## 参考
|
| 153 |
+
|
| 154 |
+
プロパティベーステスト、フィクスチャ、Criterion によるベンチマークを含む包括的なテストパターンについてはスキル: `rust-testing` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/swift/coding-style.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.swift"
|
| 4 |
+
- "**/Package.swift"
|
| 5 |
+
---
|
| 6 |
+
# Swift コーディングスタイル
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Swift 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## フォーマット
|
| 11 |
+
|
| 12 |
+
- 自動フォーマットには **SwiftFormat**、スタイル強制には **SwiftLint** を使用する
|
| 13 |
+
- Xcode 16+ には代替として `swift-format` がバンドルされている
|
| 14 |
+
|
| 15 |
+
## 不変性
|
| 16 |
+
|
| 17 |
+
- `var` よりも `let` を優先する — すべてを `let` で定義し、コンパイラが要求する場合にのみ `var` に変更する
|
| 18 |
+
- デフォルトで値セマンティクスの `struct` を使用する。同一性や参照セマンティクスが必要な場合にのみ `class` を使用する
|
| 19 |
+
|
| 20 |
+
## 命名
|
| 21 |
+
|
| 22 |
+
[Apple API デザインガイドライン](https://www.swift.org/documentation/api-design-guidelines/) に従う:
|
| 23 |
+
|
| 24 |
+
- 使用箇所での明確さ — 不要な単語を省く
|
| 25 |
+
- メソッドとプロパティは型ではなく役割にちなんだ名前を付ける
|
| 26 |
+
- グローバル定数よりも `static let` を定数に使用する
|
| 27 |
+
|
| 28 |
+
## エラーハンドリング
|
| 29 |
+
|
| 30 |
+
型付き throws(Swift 6+)とパターンマッチングを使用する:
|
| 31 |
+
|
| 32 |
+
```swift
|
| 33 |
+
func load(id: String) throws(LoadError) -> Item {
|
| 34 |
+
guard let data = try? read(from: path) else {
|
| 35 |
+
throw .fileNotFound(id)
|
| 36 |
+
}
|
| 37 |
+
return try decode(data)
|
| 38 |
+
}
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
## 並行性
|
| 42 |
+
|
| 43 |
+
Swift 6 の厳格な並行性チェックを有効にする。以下を優先する:
|
| 44 |
+
|
| 45 |
+
- 隔離境界をまたぐデータには `Sendable` 値型
|
| 46 |
+
- 共有ミュータブル状態にはアクター
|
| 47 |
+
- 非構造化 `Task {}` よりも構造化された並行性(`async let`、`TaskGroup`)
|
github_code/affaan-m__ECC/docs/ja-JP/rules/swift/hooks.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.swift"
|
| 4 |
+
- "**/Package.swift"
|
| 5 |
+
---
|
| 6 |
+
# Swift フック
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Swift 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## PostToolUse フック
|
| 11 |
+
|
| 12 |
+
`~/.claude/settings.json` で設定する:
|
| 13 |
+
|
| 14 |
+
- **SwiftFormat**: `.swift` ファイルを編集後に自動フォーマットする
|
| 15 |
+
- **SwiftLint**: `.swift` ファイルの編集後にリントチェックを実行する
|
| 16 |
+
- **swift build**: 編集後に変更されたパッケージを型チェックする
|
| 17 |
+
|
| 18 |
+
## 警告
|
| 19 |
+
|
| 20 |
+
`print()` 文にフラグを立てる — 本番コードでは代わりに `os.Logger` または構造化ロギングを使用する。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/swift/patterns.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.swift"
|
| 4 |
+
- "**/Package.swift"
|
| 5 |
+
---
|
| 6 |
+
# Swift パターン
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Swift 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## プロトコル指向設計
|
| 11 |
+
|
| 12 |
+
小さく焦点を絞ったプロトコルを定義する。共有デフォルトにはプロトコル拡張を使用する:
|
| 13 |
+
|
| 14 |
+
```swift
|
| 15 |
+
protocol Repository: Sendable {
|
| 16 |
+
associatedtype Item: Identifiable & Sendable
|
| 17 |
+
func find(by id: Item.ID) async throws -> Item?
|
| 18 |
+
func save(_ item: Item) async throws
|
| 19 |
+
}
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
## 値型
|
| 23 |
+
|
| 24 |
+
- データ転送オブジェクトとモデルには構造体を使用する
|
| 25 |
+
- 異なる状態をモデリングするには関連値付きの列挙型を使用する:
|
| 26 |
+
|
| 27 |
+
```swift
|
| 28 |
+
enum LoadState<T: Sendable>: Sendable {
|
| 29 |
+
case idle
|
| 30 |
+
case loading
|
| 31 |
+
case loaded(T)
|
| 32 |
+
case failed(Error)
|
| 33 |
+
}
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
## アクターパターン
|
| 37 |
+
|
| 38 |
+
ロックやディスパッチキューの代わりに、共有ミュータブル状態にはアクターを使用する:
|
| 39 |
+
|
| 40 |
+
```swift
|
| 41 |
+
actor Cache<Key: Hashable & Sendable, Value: Sendable> {
|
| 42 |
+
private var storage: [Key: Value] = [:]
|
| 43 |
+
|
| 44 |
+
func get(_ key: Key) -> Value? { storage[key] }
|
| 45 |
+
func set(_ key: Key, value: Value) { storage[key] = value }
|
| 46 |
+
}
|
| 47 |
+
```
|
| 48 |
+
|
| 49 |
+
## 依存性注入
|
| 50 |
+
|
| 51 |
+
デフォルトパラメータ付きでプロトコルを注入する — 本番ではデフォルトを使用し、テストではモックを注入する:
|
| 52 |
+
|
| 53 |
+
```swift
|
| 54 |
+
struct UserService {
|
| 55 |
+
private let repository: any UserRepository
|
| 56 |
+
|
| 57 |
+
init(repository: any UserRepository = DefaultUserRepository()) {
|
| 58 |
+
self.repository = repository
|
| 59 |
+
}
|
| 60 |
+
}
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## 参考
|
| 64 |
+
|
| 65 |
+
アクターベースの永続化パターンについてはスキル: `swift-actor-persistence` を参照。
|
| 66 |
+
プロトコルベースの DI とテストについてはスキル: `swift-protocol-di-testing` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/swift/security.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.swift"
|
| 4 |
+
- "**/Package.swift"
|
| 5 |
+
---
|
| 6 |
+
# Swift セキュリティ
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/security.md](../common/security.md) を Swift 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## シークレット管理
|
| 11 |
+
|
| 12 |
+
- 機密データ(トークン、パスワード、キー)には **Keychain Services** を使用する — `UserDefaults` は使わない
|
| 13 |
+
- ビルド時のシークレットには環境変数または `.xcconfig` ファイルを使用する
|
| 14 |
+
- ソースにシークレットをハードコードしない — 逆コンパイルツールで容易に抽出される
|
| 15 |
+
|
| 16 |
+
```swift
|
| 17 |
+
let apiKey = ProcessInfo.processInfo.environment["API_KEY"]
|
| 18 |
+
guard let apiKey, !apiKey.isEmpty else {
|
| 19 |
+
fatalError("API_KEY not configured")
|
| 20 |
+
}
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
## トランスポートセキュリティ
|
| 24 |
+
|
| 25 |
+
- App Transport Security(ATS)はデフォルトで強制される — 無効にしない
|
| 26 |
+
- 重要なエンドポイントには証明書ピンニングを使用する
|
| 27 |
+
- すべてのサーバー証明書を検証する
|
| 28 |
+
|
| 29 |
+
## 入力バリデーション
|
| 30 |
+
|
| 31 |
+
- 表示前にすべてのユーザー入力をサニタイズしてインジェクションを防止する
|
| 32 |
+
- 強制アンラップではなく、バリデーション付きの `URL(string:)` を使用する
|
| 33 |
+
- 外部ソース(API、ディープリンク、ペーストボード)からのデータは処理前に検証する
|
github_code/affaan-m__ECC/docs/ja-JP/rules/swift/testing.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.swift"
|
| 4 |
+
- "**/Package.swift"
|
| 5 |
+
---
|
| 6 |
+
# Swift テスト
|
| 7 |
+
|
| 8 |
+
> このファイルは [common/testing.md](../common/testing.md) を Swift 固有のコンテンツで拡張します。
|
| 9 |
+
|
| 10 |
+
## フレームワーク
|
| 11 |
+
|
| 12 |
+
新しいテストには **Swift Testing**(`import Testing`)を使用する。`@Test` と `#expect` を使用する:
|
| 13 |
+
|
| 14 |
+
```swift
|
| 15 |
+
@Test("User creation validates email")
|
| 16 |
+
func userCreationValidatesEmail() throws {
|
| 17 |
+
#expect(throws: ValidationError.invalidEmail) {
|
| 18 |
+
try User(email: "not-an-email")
|
| 19 |
+
}
|
| 20 |
+
}
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
## テストの分離
|
| 24 |
+
|
| 25 |
+
各テストは新しいインスタンスを取得する — `init` でセットアップし、`deinit` でティアダウンする。テスト間で共有ミュータブル状態を持たない。
|
| 26 |
+
|
| 27 |
+
## パラメータ化テスト
|
| 28 |
+
|
| 29 |
+
```swift
|
| 30 |
+
@Test("Validates formats", arguments: ["json", "xml", "csv"])
|
| 31 |
+
func validatesFormat(format: String) throws {
|
| 32 |
+
let parser = try Parser(format: format)
|
| 33 |
+
#expect(parser.isValid)
|
| 34 |
+
}
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
## カバレッジ
|
| 38 |
+
|
| 39 |
+
```bash
|
| 40 |
+
swift test --enable-code-coverage
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
## 参考
|
| 44 |
+
|
| 45 |
+
プロトコルベースの依存性注入と Swift Testing によるモックパターンについてはスキル: `swift-protocol-di-testing` を参照。
|
github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/coding-style.md
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.ts"
|
| 4 |
+
- "**/*.tsx"
|
| 5 |
+
- "**/*.js"
|
| 6 |
+
- "**/*.jsx"
|
| 7 |
+
---
|
| 8 |
+
# TypeScript/JavaScript コーディングスタイル
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を TypeScript/JavaScript 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## 型とインターフェース
|
| 13 |
+
|
| 14 |
+
パブリック API、共有モデル、コンポーネント props を明示的、可読的、再利用可能にするために型を使用する。
|
| 15 |
+
|
| 16 |
+
### パブリック API
|
| 17 |
+
|
| 18 |
+
- エクスポートされる関数、共有ユーティリティ、パブリッククラスメソッドにパラメータ型と戻り値型を追加する
|
| 19 |
+
- 明白なローカル変数の型は TypeScript に推論させる
|
| 20 |
+
- 繰り返されるインラインオブジェクトシェイプは名前付き型またはインターフェースに抽出する
|
| 21 |
+
|
| 22 |
+
```typescript
|
| 23 |
+
// 間違い: 明示的な型のないエクスポート関数
|
| 24 |
+
export function formatUser(user) {
|
| 25 |
+
return `${user.firstName} ${user.lastName}`
|
| 26 |
+
}
|
| 27 |
+
|
| 28 |
+
// 正しい: パブリック API での明示的な型
|
| 29 |
+
interface User {
|
| 30 |
+
firstName: string
|
| 31 |
+
lastName: string
|
| 32 |
+
}
|
| 33 |
+
|
| 34 |
+
export function formatUser(user: User): string {
|
| 35 |
+
return `${user.firstName} ${user.lastName}`
|
| 36 |
+
}
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
### インターフェース vs 型エイリアス
|
| 40 |
+
|
| 41 |
+
- 拡張または実装される可能性のあるオブジェクトシェイプには `interface` を使用する
|
| 42 |
+
- ユニオン、インターセクション、タプル、マップ型、ユーティリティ型には `type` を使用する
|
| 43 |
+
- 相互運用性のために `enum` が必要でない限り、`enum` よりも文字列リテラルユニオンを優先する
|
| 44 |
+
|
| 45 |
+
```typescript
|
| 46 |
+
interface User {
|
| 47 |
+
id: string
|
| 48 |
+
email: string
|
| 49 |
+
}
|
| 50 |
+
|
| 51 |
+
type UserRole = 'admin' | 'member'
|
| 52 |
+
type UserWithRole = User & {
|
| 53 |
+
role: UserRole
|
| 54 |
+
}
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
### `any` の回避
|
| 58 |
+
|
| 59 |
+
- アプリケーションコードで `any` を避ける
|
| 60 |
+
- 外部または信頼されない入力には `unknown` を使用し、安全にナローイングする
|
| 61 |
+
- 値の型が呼び出し側に依存する場合はジェネリクスを使用する
|
| 62 |
+
|
| 63 |
+
```typescript
|
| 64 |
+
// 間違い: any は型安全性を除去する
|
| 65 |
+
function getErrorMessage(error: any) {
|
| 66 |
+
return error.message
|
| 67 |
+
}
|
| 68 |
+
|
| 69 |
+
// 正しい: unknown は安全なナローイングを強制する
|
| 70 |
+
function getErrorMessage(error: unknown): string {
|
| 71 |
+
if (error instanceof Error) {
|
| 72 |
+
return error.message
|
| 73 |
+
}
|
| 74 |
+
|
| 75 |
+
return 'Unexpected error'
|
| 76 |
+
}
|
| 77 |
+
```
|
| 78 |
+
|
| 79 |
+
### React Props
|
| 80 |
+
|
| 81 |
+
- コンポーネント props は名前付き `interface` または `type` で定義する
|
| 82 |
+
- コールバック props は明示的に型付けする
|
| 83 |
+
- 特定の理由がない限り `React.FC` を使用しない
|
| 84 |
+
|
| 85 |
+
```typescript
|
| 86 |
+
interface User {
|
| 87 |
+
id: string
|
| 88 |
+
email: string
|
| 89 |
+
}
|
| 90 |
+
|
| 91 |
+
interface UserCardProps {
|
| 92 |
+
user: User
|
| 93 |
+
onSelect: (id: string) => void
|
| 94 |
+
}
|
| 95 |
+
|
| 96 |
+
function UserCard({ user, onSelect }: UserCardProps) {
|
| 97 |
+
return <button onClick={() => onSelect(user.id)}>{user.email}</button>
|
| 98 |
+
}
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
### JavaScript ファイル
|
| 102 |
+
|
| 103 |
+
- `.js` および `.jsx` ファイルでは、型が明確さを向上させ TypeScript への移行が実用的でない場合に JSDoc を使用する
|
| 104 |
+
- JSDoc をランタイム動作と整合させる
|
| 105 |
+
|
| 106 |
+
```javascript
|
| 107 |
+
/**
|
| 108 |
+
* @param {{ firstName: string, lastName: string }} user
|
| 109 |
+
* @returns {string}
|
| 110 |
+
*/
|
| 111 |
+
export function formatUser(user) {
|
| 112 |
+
return `${user.firstName} ${user.lastName}`
|
| 113 |
+
}
|
| 114 |
+
```
|
| 115 |
+
|
| 116 |
+
## 不変性
|
| 117 |
+
|
| 118 |
+
不変な更新にはスプレッド演算子を使用する:
|
| 119 |
+
|
| 120 |
+
```typescript
|
| 121 |
+
interface User {
|
| 122 |
+
id: string
|
| 123 |
+
name: string
|
| 124 |
+
}
|
| 125 |
+
|
| 126 |
+
// 間違い: ミューテーション
|
| 127 |
+
function updateUser(user: User, name: string): User {
|
| 128 |
+
user.name = name // ミューテーション!
|
| 129 |
+
return user
|
| 130 |
+
}
|
| 131 |
+
|
| 132 |
+
// 正しい: 不変性
|
| 133 |
+
function updateUser(user: Readonly<User>, name: string): User {
|
| 134 |
+
return {
|
| 135 |
+
...user,
|
| 136 |
+
name
|
| 137 |
+
}
|
| 138 |
+
}
|
| 139 |
+
```
|
| 140 |
+
|
| 141 |
+
## エラーハンドリング
|
| 142 |
+
|
| 143 |
+
async/await と try-catch を使用し、unknown エラーを安全にナローイングする:
|
| 144 |
+
|
| 145 |
+
```typescript
|
| 146 |
+
interface User {
|
| 147 |
+
id: string
|
| 148 |
+
email: string
|
| 149 |
+
}
|
| 150 |
+
|
| 151 |
+
declare function riskyOperation(userId: string): Promise<User>
|
| 152 |
+
|
| 153 |
+
function getErrorMessage(error: unknown): string {
|
| 154 |
+
if (error instanceof Error) {
|
| 155 |
+
return error.message
|
| 156 |
+
}
|
| 157 |
+
|
| 158 |
+
return 'Unexpected error'
|
| 159 |
+
}
|
| 160 |
+
|
| 161 |
+
const logger = {
|
| 162 |
+
error: (message: string, error: unknown) => {
|
| 163 |
+
// 本番用ロガー(例: pino や winston)に置き換えてください。
|
| 164 |
+
}
|
| 165 |
+
}
|
| 166 |
+
|
| 167 |
+
async function loadUser(userId: string): Promise<User> {
|
| 168 |
+
try {
|
| 169 |
+
const result = await riskyOperation(userId)
|
| 170 |
+
return result
|
| 171 |
+
} catch (error: unknown) {
|
| 172 |
+
logger.error('Operation failed', error)
|
| 173 |
+
throw new Error(getErrorMessage(error))
|
| 174 |
+
}
|
| 175 |
+
}
|
| 176 |
+
```
|
| 177 |
+
|
| 178 |
+
## 入力バリデーション
|
| 179 |
+
|
| 180 |
+
スキーマベースのバリデーションには Zod を使用し、スキーマから型を推論する:
|
| 181 |
+
|
| 182 |
+
```typescript
|
| 183 |
+
import { z } from 'zod'
|
| 184 |
+
|
| 185 |
+
const userSchema = z.object({
|
| 186 |
+
email: z.string().email(),
|
| 187 |
+
age: z.number().int().min(0).max(150)
|
| 188 |
+
})
|
| 189 |
+
|
| 190 |
+
type UserInput = z.infer<typeof userSchema>
|
| 191 |
+
|
| 192 |
+
const validated: UserInput = userSchema.parse(input)
|
| 193 |
+
```
|
| 194 |
+
|
| 195 |
+
## Console.log
|
| 196 |
+
|
| 197 |
+
- 本番コードに `console.log` 文を残さない
|
| 198 |
+
- 代わりに適切なロギングライブラリを使用する
|
| 199 |
+
- 自動検出についてはフックを参照
|
github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/hooks.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.ts"
|
| 4 |
+
- "**/*.tsx"
|
| 5 |
+
- "**/*.js"
|
| 6 |
+
- "**/*.jsx"
|
| 7 |
+
---
|
| 8 |
+
# TypeScript/JavaScript フック
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を TypeScript/JavaScript 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## PostToolUse フック
|
| 13 |
+
|
| 14 |
+
`~/.claude/settings.json` で設定する:
|
| 15 |
+
|
| 16 |
+
- **Prettier**: JS/TS ファイルを編集後に自動フォーマットする
|
| 17 |
+
- **TypeScript チェック**: `.ts`/`.tsx` ファイルの編集後に `tsc` を実行する
|
| 18 |
+
- **console.log 警告**: 編集されたファイルの `console.log` について警告する
|
| 19 |
+
|
| 20 |
+
## Stop フック
|
| 21 |
+
|
| 22 |
+
- **console.log 監査**: セッション終了前にすべての変更されたファイルで `console.log` をチェックする
|
github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/patterns.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.ts"
|
| 4 |
+
- "**/*.tsx"
|
| 5 |
+
- "**/*.js"
|
| 6 |
+
- "**/*.jsx"
|
| 7 |
+
---
|
| 8 |
+
# TypeScript/JavaScript パターン
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を TypeScript/JavaScript 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## API レスポンスフォーマット
|
| 13 |
+
|
| 14 |
+
```typescript
|
| 15 |
+
interface ApiResponse<T> {
|
| 16 |
+
success: boolean
|
| 17 |
+
data?: T
|
| 18 |
+
error?: string
|
| 19 |
+
meta?: {
|
| 20 |
+
total: number
|
| 21 |
+
page: number
|
| 22 |
+
limit: number
|
| 23 |
+
}
|
| 24 |
+
}
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## カスタムフックパターン
|
| 28 |
+
|
| 29 |
+
```typescript
|
| 30 |
+
export function useDebounce<T>(value: T, delay: number): T {
|
| 31 |
+
const [debouncedValue, setDebouncedValue] = useState<T>(value)
|
| 32 |
+
|
| 33 |
+
useEffect(() => {
|
| 34 |
+
const handler = setTimeout(() => setDebouncedValue(value), delay)
|
| 35 |
+
return () => clearTimeout(handler)
|
| 36 |
+
}, [value, delay])
|
| 37 |
+
|
| 38 |
+
return debouncedValue
|
| 39 |
+
}
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
## リポジトリパターン
|
| 43 |
+
|
| 44 |
+
```typescript
|
| 45 |
+
interface Repository<T> {
|
| 46 |
+
findAll(filters?: Filters): Promise<T[]>
|
| 47 |
+
findById(id: string): Promise<T | null>
|
| 48 |
+
create(data: CreateDto): Promise<T>
|
| 49 |
+
update(id: string, data: UpdateDto): Promise<T>
|
| 50 |
+
delete(id: string): Promise<void>
|
| 51 |
+
}
|
| 52 |
+
```
|
github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/security.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.ts"
|
| 4 |
+
- "**/*.tsx"
|
| 5 |
+
- "**/*.js"
|
| 6 |
+
- "**/*.jsx"
|
| 7 |
+
---
|
| 8 |
+
# TypeScript/JavaScript セキュリティ
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/security.md](../common/security.md) を TypeScript/JavaScript 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## シークレット管理
|
| 13 |
+
|
| 14 |
+
```typescript
|
| 15 |
+
// 絶対にダメ: ハードコードされたシークレット
|
| 16 |
+
const apiKey = "sk-proj-xxxxx"
|
| 17 |
+
|
| 18 |
+
// 常に: 環境変数
|
| 19 |
+
const apiKey = process.env.API_KEY
|
| 20 |
+
|
| 21 |
+
if (!apiKey) {
|
| 22 |
+
throw new Error('API_KEY not configured')
|
| 23 |
+
}
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
## エージェントサポート
|
| 27 |
+
|
| 28 |
+
- 包括的なセキュリティ監査には **security-reviewer** スキルを使用する
|
github_code/affaan-m__ECC/docs/ja-JP/rules/typescript/testing.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
paths:
|
| 3 |
+
- "**/*.ts"
|
| 4 |
+
- "**/*.tsx"
|
| 5 |
+
- "**/*.js"
|
| 6 |
+
- "**/*.jsx"
|
| 7 |
+
---
|
| 8 |
+
# TypeScript/JavaScript テスト
|
| 9 |
+
|
| 10 |
+
> このファイルは [common/testing.md](../common/testing.md) を TypeScript/JavaScript 固有のコンテンツで拡張します。
|
| 11 |
+
|
| 12 |
+
## E2E テスト
|
| 13 |
+
|
| 14 |
+
重要なユーザーフローの E2E テストフレームワークとして **Playwright** を使用する。
|
| 15 |
+
|
| 16 |
+
## エージェントサポート
|
| 17 |
+
|
| 18 |
+
- **e2e-runner** - Playwright E2E テストスペシャリスト
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/coding-style.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/coding-style.md](../common/coding-style.md) を Web 固有のフロントエンドコンテンツで拡張します。
|
| 2 |
+
|
| 3 |
+
# Web コーディングスタイル
|
| 4 |
+
|
| 5 |
+
## ファイル構成
|
| 6 |
+
|
| 7 |
+
ファイルタイプではなく、機能またはサーフェスエリアごとに整理する:
|
| 8 |
+
|
| 9 |
+
```text
|
| 10 |
+
src/
|
| 11 |
+
├── components/
|
| 12 |
+
│ ├── hero/
|
| 13 |
+
│ │ ├── Hero.tsx
|
| 14 |
+
│ │ ├── HeroVisual.tsx
|
| 15 |
+
│ │ └── hero.css
|
| 16 |
+
│ ├── scrolly-section/
|
| 17 |
+
│ │ ├── ScrollySection.tsx
|
| 18 |
+
│ │ ├── StickyVisual.tsx
|
| 19 |
+
│ │ └── scrolly.css
|
| 20 |
+
│ └── ui/
|
| 21 |
+
│ ├── Button.tsx
|
| 22 |
+
│ ├── SurfaceCard.tsx
|
| 23 |
+
│ └── AnimatedText.tsx
|
| 24 |
+
├── hooks/
|
| 25 |
+
│ ├── useReducedMotion.ts
|
| 26 |
+
│ └── useScrollProgress.ts
|
| 27 |
+
├── lib/
|
| 28 |
+
│ ├── animation.ts
|
| 29 |
+
│ └── color.ts
|
| 30 |
+
└── styles/
|
| 31 |
+
├── tokens.css
|
| 32 |
+
├── typography.css
|
| 33 |
+
└── global.css
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
## CSS カスタムプロパティ
|
| 37 |
+
|
| 38 |
+
デザイントークンを変数として定義する。パレット、タイポグラフィ、スペーシングを繰り返しハードコードしない:
|
| 39 |
+
|
| 40 |
+
```css
|
| 41 |
+
:root {
|
| 42 |
+
--color-surface: oklch(98% 0 0);
|
| 43 |
+
--color-text: oklch(18% 0 0);
|
| 44 |
+
--color-accent: oklch(68% 0.21 250);
|
| 45 |
+
|
| 46 |
+
--text-base: clamp(1rem, 0.92rem + 0.4vw, 1.125rem);
|
| 47 |
+
--text-hero: clamp(3rem, 1rem + 7vw, 8rem);
|
| 48 |
+
|
| 49 |
+
--space-section: clamp(4rem, 3rem + 5vw, 10rem);
|
| 50 |
+
|
| 51 |
+
--duration-fast: 150ms;
|
| 52 |
+
--duration-normal: 300ms;
|
| 53 |
+
--ease-out-expo: cubic-bezier(0.16, 1, 0.3, 1);
|
| 54 |
+
}
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
## アニメーション専用プロパティ
|
| 58 |
+
|
| 59 |
+
コンポジタフレンドリーなモーションを優先する:
|
| 60 |
+
- `transform`
|
| 61 |
+
- `opacity`
|
| 62 |
+
- `clip-path`
|
| 63 |
+
- `filter`(控えめに)
|
| 64 |
+
|
| 65 |
+
レイアウトに紐づくプロパティのアニメーションを避ける:
|
| 66 |
+
- `width`
|
| 67 |
+
- `height`
|
| 68 |
+
- `top`
|
| 69 |
+
- `left`
|
| 70 |
+
- `margin`
|
| 71 |
+
- `padding`
|
| 72 |
+
- `border`
|
| 73 |
+
- `font-size`
|
| 74 |
+
|
| 75 |
+
## セマンティック HTML ファースト
|
| 76 |
+
|
| 77 |
+
```html
|
| 78 |
+
<header>
|
| 79 |
+
<nav aria-label="Main navigation">...</nav>
|
| 80 |
+
</header>
|
| 81 |
+
<main>
|
| 82 |
+
<section aria-labelledby="hero-heading">
|
| 83 |
+
<h1 id="hero-heading">...</h1>
|
| 84 |
+
</section>
|
| 85 |
+
</main>
|
| 86 |
+
<footer>...</footer>
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
セマンティック要素が存在するときに、汎用的な `div` ラッパースタックに頼らない。
|
| 90 |
+
|
| 91 |
+
## 命名
|
| 92 |
+
|
| 93 |
+
- コンポーネント: PascalCase(`ScrollySection`、`SurfaceCard`)
|
| 94 |
+
- フック: `use` プレフィックス(`useReducedMotion`)
|
| 95 |
+
- CSS クラス: kebab-case またはユーティリティクラス
|
| 96 |
+
- アニメーションタイムライン: 意図を含む camelCase(`heroRevealTl`)
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/design-quality.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Web 固有のデザイン品質ガイダンスで拡張します。
|
| 2 |
+
|
| 3 |
+
# Web デザイン品質基準
|
| 4 |
+
|
| 5 |
+
## アンチテンプレートポリシー
|
| 6 |
+
|
| 7 |
+
汎用的なテンプレートに見える UI をリリースしない。フロントエンドの出力は意図的で、主張があり、プロダクトに固有であるべきである。
|
| 8 |
+
|
| 9 |
+
### 禁止パターン
|
| 10 |
+
|
| 11 |
+
- 均一なスペーシングで階層のないデフォルトのカードグリッド
|
| 12 |
+
- 中央揃えの見出し、グラデーションブロブ、汎用 CTA の定番ヒーローセクション
|
| 13 |
+
- 完成したデザインとして出す未変更のライブラリデフォルト
|
| 14 |
+
- レイヤリング、深度、モーションのないフラットレイアウト
|
| 15 |
+
- すべてのコンポーネントで均一な角丸、スペーシング、シャドウ
|
| 16 |
+
- 1つのアクセントカラーだけの安全なグレー・オン・ホワイトのスタイリング
|
| 17 |
+
- サイドバー + カード + チャートで視点のないダッシュボード量産レイアウト
|
| 18 |
+
- 意図的な理由なしに使用されるデフォルトフォントスタック
|
| 19 |
+
|
| 20 |
+
### 必要な品質
|
| 21 |
+
|
| 22 |
+
すべての意味のあるフロントエンドサーフェスは、以下のうち少なくとも4つを示すべきである:
|
| 23 |
+
|
| 24 |
+
1. スケールコントラストによる明確な階層
|
| 25 |
+
2. 均一なパディングではなく、スペーシングの意図的なリズム
|
| 26 |
+
3. オーバーラップ、シャドウ、サーフェス、またはモーションによる深度やレイヤリング
|
| 27 |
+
4. 個性と実際のペアリング戦略を持つタイポグラフィ
|
| 28 |
+
5. 装飾的ではなく、セマンティックに使用される色
|
| 29 |
+
6. デザインされたと感じるホバー、フォーカス、アクティブ状態
|
| 30 |
+
7. 必要に応じたグリッドを打ち破るエディトリアルまたはベントーレイアウト
|
| 31 |
+
8. ビジュアルの方向性に合ったテクスチャ、グレイン、または雰囲気
|
| 32 |
+
9. 注意をそらすのではなく、フローを明確にするモーション
|
| 33 |
+
10. 後付けではなく、デザインシステムの一部として扱われるデータビジュアライゼーション
|
| 34 |
+
|
| 35 |
+
## フロントエンドコードを書く前に
|
| 36 |
+
|
| 37 |
+
1. 具体的なスタイルの方向性を選ぶ。「クリーンミニマル」のような曖昧なデフォルトを避ける。
|
| 38 |
+
2. パレットを意図的に定義する。
|
| 39 |
+
3. タイポグラフィを意図的に選択する。
|
| 40 |
+
4. 少なくとも少数の実際のリファレンスを集める。
|
| 41 |
+
5. 関連する ECC のデザイン/フロントエンドスキルを使用する。
|
| 42 |
+
|
| 43 |
+
## 価値あるスタイルの方向性
|
| 44 |
+
|
| 45 |
+
- エディトリアル / マガジン
|
| 46 |
+
- ネオブルータリズム
|
| 47 |
+
- 実際の深度を持つグラスモーフィズム
|
| 48 |
+
- 規律あるコントラストのダークラグジュアリーまたはライトラグジュアリー
|
| 49 |
+
- ベントーレイアウト
|
| 50 |
+
- スクローリーテリング
|
| 51 |
+
- 3D 統合
|
| 52 |
+
- スイス / インターナショナル
|
| 53 |
+
- レトロフューチャリズム
|
| 54 |
+
|
| 55 |
+
自動的にダークモードをデフォルトにしない。プロダクトが実際に求めるビジュアルの方向性を選択する。
|
| 56 |
+
|
| 57 |
+
## コンポーネントチェックリスト
|
| 58 |
+
|
| 59 |
+
- [ ] デフォルトの Tailwind や shadcn テンプレートに見えないか?
|
| 60 |
+
- [ ] 意図的なホバー/フォーカス/アクティブ状態があるか?
|
| 61 |
+
- [ ] 均一な強調ではなく階層を使用しているか?
|
| 62 |
+
- [ ] 実際のプロダクトのスクリーンショットで信憑性があるか?
|
| 63 |
+
- [ ] 両テーマをサポートする場合、ライトとダークの両方が意図的に感じられるか?
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/hooks.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/hooks.md](../common/hooks.md) を Web 固有のフック推奨事項で拡張します。
|
| 2 |
+
|
| 3 |
+
# Web フック
|
| 4 |
+
|
| 5 |
+
## 推奨 PostToolUse フック
|
| 6 |
+
|
| 7 |
+
プロジェクトローカルのツールを優先する。リモートの使い捨てパッケージ実行にフックを接続しない。
|
| 8 |
+
|
| 9 |
+
### 保存時フォーマット
|
| 10 |
+
|
| 11 |
+
編集後にプロジェクトの既存フォーマッタエントリポイントを使用する:
|
| 12 |
+
|
| 13 |
+
```json
|
| 14 |
+
{
|
| 15 |
+
"hooks": {
|
| 16 |
+
"PostToolUse": [
|
| 17 |
+
{
|
| 18 |
+
"matcher": "Write|Edit",
|
| 19 |
+
"command": "pnpm prettier --write \"$FILE_PATH\"",
|
| 20 |
+
"description": "Format edited frontend files"
|
| 21 |
+
}
|
| 22 |
+
]
|
| 23 |
+
}
|
| 24 |
+
}
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
`yarn prettier` や `npm exec prettier --` による同等のローカルコマンドも、リポジトリが所有する依存関係を使用する場合は問題ない。
|
| 28 |
+
|
| 29 |
+
### リントチェック
|
| 30 |
+
|
| 31 |
+
```json
|
| 32 |
+
{
|
| 33 |
+
"hooks": {
|
| 34 |
+
"PostToolUse": [
|
| 35 |
+
{
|
| 36 |
+
"matcher": "Write|Edit",
|
| 37 |
+
"command": "pnpm eslint --fix \"$FILE_PATH\"",
|
| 38 |
+
"description": "Run ESLint on edited frontend files"
|
| 39 |
+
}
|
| 40 |
+
]
|
| 41 |
+
}
|
| 42 |
+
}
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
### 型チェック
|
| 46 |
+
|
| 47 |
+
`--incremental` を使用して再実行時に前回の `.tsbuildinfo` を再利用する(変更のないコードでは30-60秒ではなく1-3秒)。`timeout` でラップして、停止した tsc が OS によって回収されるようにする — これにより、編集が tsc の完了よりも速く発生した場合のマルチプロセス蓄積を防止する。
|
| 48 |
+
|
| 49 |
+
```json
|
| 50 |
+
{
|
| 51 |
+
"hooks": {
|
| 52 |
+
"PostToolUse": [
|
| 53 |
+
{
|
| 54 |
+
"matcher": "Write|Edit",
|
| 55 |
+
"command": "timeout 60 pnpm tsc --noEmit --pretty false --incremental --tsBuildInfoFile node_modules/.cache/tsc-hook.tsbuildinfo",
|
| 56 |
+
"description": "Type-check after frontend edits (incremental + timeout-capped)"
|
| 57 |
+
}
|
| 58 |
+
]
|
| 59 |
+
}
|
| 60 |
+
}
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
**両方のフラグが重要な理由:**
|
| 64 |
+
- `--incremental` なしでは、すべての編集でプログラム全体をゼロから再チェックする。実際の Next.js プロジェクトでは、これが急速に積み重なる: 5-10秒間隔の編集 + 30-60秒の tsc 実行 = N個の並行 tsc プロセス。
|
| 65 |
+
- `timeout` なしでは、ハングした tsc(推移的依存関係の変更、再帰型で停止した型チェッカー)は終了せず、親シェルが終了したときに孤児になる。
|
| 66 |
+
- `--tsBuildInfoFile` が必要なのは、`--noEmit` が通常 buildinfo の書き込みを抑制するため。パスを明示的に指定することでインクリメンタルが機能し続ける。
|
| 67 |
+
|
| 68 |
+
Windows で GNU coreutils がない場合は、`timeout 60` を PowerShell ラッパーに置き換えるか、Stop/SessionEnd フックに頼って停滞した tsc プロセスを掃除する。
|
| 69 |
+
|
| 70 |
+
### CSS リント
|
| 71 |
+
|
| 72 |
+
```json
|
| 73 |
+
{
|
| 74 |
+
"hooks": {
|
| 75 |
+
"PostToolUse": [
|
| 76 |
+
{
|
| 77 |
+
"matcher": "Write|Edit",
|
| 78 |
+
"command": "pnpm stylelint --fix \"$FILE_PATH\"",
|
| 79 |
+
"description": "Lint edited stylesheets"
|
| 80 |
+
}
|
| 81 |
+
]
|
| 82 |
+
}
|
| 83 |
+
}
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
## PreToolUse フック
|
| 87 |
+
|
| 88 |
+
### ファイルサイズガード
|
| 89 |
+
|
| 90 |
+
まだ存在しない可能性のあるファイルからではなく、ツール入力コンテンツからの巨大な書き込みをブロックする:
|
| 91 |
+
|
| 92 |
+
```json
|
| 93 |
+
{
|
| 94 |
+
"hooks": {
|
| 95 |
+
"PreToolUse": [
|
| 96 |
+
{
|
| 97 |
+
"matcher": "Write",
|
| 98 |
+
"command": "node -e \"let d='';process.stdin.on('data',c=>d+=c);process.stdin.on('end',()=>{const i=JSON.parse(d);const c=i.tool_input?.content||'';const lines=c.split('\\n').length;if(lines>800){console.error('[Hook] BLOCKED: File exceeds 800 lines ('+lines+' lines)');console.error('[Hook] Split into smaller modules');process.exit(2)}console.log(d)})\"",
|
| 99 |
+
"description": "Block writes that exceed 800 lines"
|
| 100 |
+
}
|
| 101 |
+
]
|
| 102 |
+
}
|
| 103 |
+
}
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
## Stop フック
|
| 107 |
+
|
| 108 |
+
### 最終ビルド検証
|
| 109 |
+
|
| 110 |
+
```json
|
| 111 |
+
{
|
| 112 |
+
"hooks": {
|
| 113 |
+
"Stop": [
|
| 114 |
+
{
|
| 115 |
+
"command": "pnpm build",
|
| 116 |
+
"description": "Verify the production build at session end"
|
| 117 |
+
}
|
| 118 |
+
]
|
| 119 |
+
}
|
| 120 |
+
}
|
| 121 |
+
```
|
| 122 |
+
|
| 123 |
+
## 順序
|
| 124 |
+
|
| 125 |
+
推奨順序:
|
| 126 |
+
1. フォーマット
|
| 127 |
+
2. リント
|
| 128 |
+
3. 型チェック
|
| 129 |
+
4. ビルド検証
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/patterns.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/patterns.md](../common/patterns.md) を Web 固有のパターンで拡張します。
|
| 2 |
+
|
| 3 |
+
# Web パターン
|
| 4 |
+
|
| 5 |
+
## コンポーネントコンポジション
|
| 6 |
+
|
| 7 |
+
### コンパウンドコンポーネント
|
| 8 |
+
|
| 9 |
+
関連する UI が状態とインタラクションのセマンティクスを共有する場合、コンパウンドコンポーネントを使用する:
|
| 10 |
+
|
| 11 |
+
```tsx
|
| 12 |
+
<Tabs defaultValue="overview">
|
| 13 |
+
<Tabs.List>
|
| 14 |
+
<Tabs.Trigger value="overview">Overview</Tabs.Trigger>
|
| 15 |
+
<Tabs.Trigger value="settings">Settings</Tabs.Trigger>
|
| 16 |
+
</Tabs.List>
|
| 17 |
+
<Tabs.Content value="overview">...</Tabs.Content>
|
| 18 |
+
<Tabs.Content value="settings">...</Tabs.Content>
|
| 19 |
+
</Tabs>
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
- 親が状態を所有する
|
| 23 |
+
- 子はコンテキスト経由で消費する
|
| 24 |
+
- 複雑なウィジェットでは props のバケツリレーよりもこれを優先する
|
| 25 |
+
|
| 26 |
+
### レンダープロップ / スロット
|
| 27 |
+
|
| 28 |
+
- 動作は共有されるがマークアップを変える必要がある場合、レンダープロップまたはスロットパターンを使用する
|
| 29 |
+
- キーボードハンドリング、ARIA、フォーカスロジックはヘッドレスレイヤーに保持する
|
| 30 |
+
|
| 31 |
+
### コンテナ / プレゼンテーション分離
|
| 32 |
+
|
| 33 |
+
- コンテナコンポーネントがデータ読み込みと副作用を所有する
|
| 34 |
+
- プレゼンテーションコンポーネントは props を受け取り UI をレンダリングする
|
| 35 |
+
- プレゼンテーションコンポーネントは純粋に保つべきである
|
| 36 |
+
|
| 37 |
+
## 状態管理
|
| 38 |
+
|
| 39 |
+
これらを個別に扱う:
|
| 40 |
+
|
| 41 |
+
| 関心事 | ツール |
|
| 42 |
+
|--------|--------|
|
| 43 |
+
| サーバー状態 | TanStack Query、SWR、tRPC |
|
| 44 |
+
| クライアント状態 | Zustand、Jotai、signals |
|
| 45 |
+
| URL 状態 | search params、route segments |
|
| 46 |
+
| フォーム状態 | React Hook Form または同等のもの |
|
| 47 |
+
|
| 48 |
+
- サーバー状態をクライアントストアに複製しない
|
| 49 |
+
- 冗長な計算済み状態を保存する代わりに値を導出する
|
| 50 |
+
|
| 51 |
+
## 状態としての URL
|
| 52 |
+
|
| 53 |
+
共有可能な状態を URL に永続化する:
|
| 54 |
+
- フィルタ
|
| 55 |
+
- ソート順
|
| 56 |
+
- ページネーション
|
| 57 |
+
- アクティブタブ
|
| 58 |
+
- 検索クエリ
|
| 59 |
+
|
| 60 |
+
## データフェッチ
|
| 61 |
+
|
| 62 |
+
### Stale-While-Revalidate
|
| 63 |
+
|
| 64 |
+
- キャッシュされたデータを即座に返す
|
| 65 |
+
- バックグラウンドで再バリデーションする
|
| 66 |
+
- 手作りする代わりに既存のライブラリを優先する
|
| 67 |
+
|
| 68 |
+
### 楽観的更新
|
| 69 |
+
|
| 70 |
+
- 現在の状態のスナップショットを取る
|
| 71 |
+
- 楽観的な更新を適用する
|
| 72 |
+
- 失敗時にロールバックする
|
| 73 |
+
- ロールバック時に可視的なエラーフィードバックを出す
|
| 74 |
+
|
| 75 |
+
### 並列ローディング
|
| 76 |
+
|
| 77 |
+
- 独立したデータを並列にフェッチする
|
| 78 |
+
- 親子のリクエストウォーターフォールを避ける
|
| 79 |
+
- 正当な理由がある場合、次のルートや状態をプリフェッチする
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/performance.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/performance.md](../common/performance.md) を Web 固有のパフォーマンスコンテンツで拡張します。
|
| 2 |
+
|
| 3 |
+
# Web パフォーマンスルール
|
| 4 |
+
|
| 5 |
+
## Core Web Vitals 目標
|
| 6 |
+
|
| 7 |
+
| メトリクス | 目標 |
|
| 8 |
+
|-----------|------|
|
| 9 |
+
| LCP | < 2.5秒 |
|
| 10 |
+
| INP | < 200ms |
|
| 11 |
+
| CLS | < 0.1 |
|
| 12 |
+
| FCP | < 1.5秒 |
|
| 13 |
+
| TBT | < 200ms |
|
| 14 |
+
|
| 15 |
+
## バンドルバジェット
|
| 16 |
+
|
| 17 |
+
| ページタイプ | JS バジェット(gzip 圧縮後) | CSS バジェット |
|
| 18 |
+
|-------------|---------------------------|--------------|
|
| 19 |
+
| ランディングページ | < 150kb | < 30kb |
|
| 20 |
+
| アプリページ | < 300kb | < 50kb |
|
| 21 |
+
| マイクロサイト | < 80kb | < 15kb |
|
| 22 |
+
|
| 23 |
+
## ローディング戦略
|
| 24 |
+
|
| 25 |
+
1. 正当な場合、クリティカルなアバブ・ザ・フォールド CSS をインライン化する
|
| 26 |
+
2. ヒーロー画像とプライマリフォントのみをプリロードする
|
| 27 |
+
3. 非クリティカルな CSS や JS を遅延読み込みする
|
| 28 |
+
4. 重いライブラリを動的インポートする
|
| 29 |
+
|
| 30 |
+
```js
|
| 31 |
+
const gsapModule = await import('gsap');
|
| 32 |
+
const { ScrollTrigger } = await import('gsap/ScrollTrigger');
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
## 画像最適化
|
| 36 |
+
|
| 37 |
+
- 明示的な `width` と `height`
|
| 38 |
+
- ヒーローメディアのみに `loading="eager"` と `fetchpriority="high"`
|
| 39 |
+
- ビロウ・ザ・フォールドのアセットには `loading="lazy"`
|
| 40 |
+
- フォールバック付きで AVIF または WebP を優先する
|
| 41 |
+
- レンダリングサイズを大幅に超えるソース画像を配信しない
|
| 42 |
+
|
| 43 |
+
## フォント読み込み
|
| 44 |
+
|
| 45 |
+
- 明確な例外がない限り、フォントファミリーは最大2つ
|
| 46 |
+
- `font-display: swap`
|
| 47 |
+
- 可能な場合はサブセット化する
|
| 48 |
+
- 本当にクリティカルなウェイト/スタイルのみをプリロードする
|
| 49 |
+
|
| 50 |
+
## アニメーションパフォーマンス
|
| 51 |
+
|
| 52 |
+
- コンポジタフレンドリーなプロパティのみをアニメーションする
|
| 53 |
+
- `will-change` は狭い範囲で使用し、完了時に削除する
|
| 54 |
+
- シンプルなトランジションには CSS を優先する
|
| 55 |
+
- JS モーションには `requestAnimationFrame` または確立されたアニメーションライブラリを使用する
|
| 56 |
+
- スクロールハンドラの乱発を避ける。IntersectionObserver または行儀の良いライブラリを使用する
|
| 57 |
+
|
| 58 |
+
## パフォーマンスチェックリスト
|
| 59 |
+
|
| 60 |
+
- [ ] すべての画像に明示的なサイズがある
|
| 61 |
+
- [ ] 意図しないレンダーブロッキングリソースがない
|
| 62 |
+
- [ ] 動的コンテンツによるレイアウトシフトがない
|
| 63 |
+
- [ ] モーションがコンポジタフレンドリーなプロパティにとどまっている
|
| 64 |
+
- [ ] サードパーティスクリプトが async/defer で読み込まれ、必要な場合のみ使用されている
|
github_code/affaan-m__ECC/docs/ja-JP/rules/web/security.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
> このファイルは [common/security.md](../common/security.md) を Web 固有のセキュリティコンテンツで拡張します。
|
| 2 |
+
|
| 3 |
+
# Web セキュリティルール
|
| 4 |
+
|
| 5 |
+
## コンテンツセキュリティポリシー
|
| 6 |
+
|
| 7 |
+
本番環境では常に CSP を設定する。
|
| 8 |
+
|
| 9 |
+
### ノンスベースの CSP
|
| 10 |
+
|
| 11 |
+
`'unsafe-inline'` の代わりに、スクリプトにはリクエストごとのノンスを使用する。
|
| 12 |
+
|
| 13 |
+
```text
|
| 14 |
+
Content-Security-Policy:
|
| 15 |
+
default-src 'self';
|
| 16 |
+
script-src 'self' 'nonce-{RANDOM}' https://cdn.jsdelivr.net;
|
| 17 |
+
style-src 'self' 'unsafe-inline' https://fonts.googleapis.com;
|
| 18 |
+
img-src 'self' data: https:;
|
| 19 |
+
font-src 'self' https://fonts.gstatic.com;
|
| 20 |
+
connect-src 'self' https://*.example.com;
|
| 21 |
+
frame-src 'none';
|
| 22 |
+
object-src 'none';
|
| 23 |
+
base-uri 'self';
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
オリジンはプロジェクトに合わせて調整する。このブロックをそのままコピーして使わない。
|
| 27 |
+
|
| 28 |
+
## XSS 防止
|
| 29 |
+
|
| 30 |
+
- サニタイズされていない HTML を注入しない
|
| 31 |
+
- サニタイズなしで `innerHTML` / `dangerouslySetInnerHTML` を使用しない
|
| 32 |
+
- 動的テンプレート値をエスケープする
|
| 33 |
+
- どうしても必要な場合は、検証済みのローカルサニタイザーでユーザー HTML をサニタイズする
|
| 34 |
+
|
| 35 |
+
## サードパーティスクリプト
|
| 36 |
+
|
| 37 |
+
- 非同期で読み込む
|
| 38 |
+
- CDN から配信する場合は SRI を使用する
|
| 39 |
+
- 四半期ごとに監査する
|
| 40 |
+
- 実用的な場合、重要な依存関係にはセルフホスティングを優先する
|
| 41 |
+
|
| 42 |
+
## HTTPS とヘッダー
|
| 43 |
+
|
| 44 |
+
```text
|
| 45 |
+
Strict-Transport-Security: max-age=31536000; includeSubDomains; preload
|
| 46 |
+
X-Content-Type-Options: nosniff
|
| 47 |
+
X-Frame-Options: DENY
|
| 48 |
+
Referrer-Policy: strict-origin-when-cross-origin
|
| 49 |
+
Permissions-Policy: camera=(), microphone=(), geolocation=()
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
## フォーム
|
| 53 |
+
|
| 54 |
+
- 状態を変更するフォームには CSRF 保護
|
| 55 |
+
- 送信エンドポイントにはレート制限
|
| 56 |
+
- クライアント側とサーバー側の両方でバリデーション
|
| 57 |
+
- 重い CAPTCHA デフォルトよりもハニーポットや軽量なアンチアビューズ制御を優先する
|