plan-flow-skill 1.0.0

package/rules/patterns/review-code-templates.mdc

@@ -0,0 +1,315 @@
+---
+description: "Output templates for code review documents"
+alwaysApply: false
+---
+
+# Review Code Templates
+
+This document contains output templates for the code review skill. For the core workflow, see `.cursor/rules/skills/review-code-skill.mdc`.
+
+---
+
+## Output Format
+
+The generated review document should follow this structure:
+
+```markdown
+# Local Code Review: {Description}
+
+## Review Information
+
+| Field          | Value                 |
+| -------------- | --------------------- |
+| Date           | {date}                |
+| Files Reviewed | {number_of_files}     |
+| Scope          | {all/staged/unstaged} |
+| Language(s)    | {detected_languages}  |
+
+---
+
+## Changed Files
+
+| File          | Status     | Lines Changed |
+| ------------- | ---------- | ------------- |
+| `{file_path}` | {modified} | +{add}/-{del} |
+| ...           | ...        | ...           |
+
+---
+
+## Reference Implementations Found
+
+For each changed file, similar implementations in the codebase:
+
+### {changed_file_path}
+
+**Similar implementations found:**
+
+| Reference File        | Pattern Observed      | Consistency    |
+| --------------------- | --------------------- | -------------- |
+| `{similar_file_path}` | {pattern_description} | Match/Conflict |
+| ...                   | ...                   | ...            |
+
+**Pattern Notes:**
+
+- {observation about how similar code handles the same concern}
+
+---
+
+## Review Summary
+
+| Metric                | Value              |
+| --------------------- | ------------------ |
+| **Total Findings**    | {count}            |
+| Critical              | {critical_count}   |
+| Major                 | {major_count}      |
+| Minor                 | {minor_count}      |
+| Suggestion            | {suggestion_count} |
+| **Pattern Conflicts** | {conflict_count}   |
+| **Total Fix Effort**  | {sum_of_scores}/X  |
+
+---
+
+## Findings
+
+### Finding 1: {Finding Name}
+
+| Field          | Value                                            |
+| -------------- | ------------------------------------------------ |
+| File           | `{file_path}`                                    |
+| Line           | {line_number}                                    |
+| Severity       | {Critical/Major/Minor/Suggestion}                |
+| Fix Complexity | {X/10} - {Level}                                 |
+| Pattern        | {Reference to pattern from rules, if applicable} |
+
+**Description**:
+{Detailed explanation of the issue found}
+
+**Reference Implementation**:
+See `{reference_file_path}` for how this is handled elsewhere in the codebase.
+
+**Suggested Fix**:
+\`\`\`{language}
+// Suggested code improvement
+\`\`\`
+
+---
+
+## Pattern Conflicts
+
+This section documents conflicts between the new code and existing codebase patterns.
+
+### Conflict 1: {Conflict Name}
+
+| Field          | Value                                  |
+| -------------- | -------------------------------------- |
+| New Code File  | `{changed_file_path}`                  |
+| Reference File | `{existing_file_path}`                 |
+| Pattern Type   | {naming/structure/error-handling/etc}  |
+| Resolution     | {Update new code/Update rules/Discuss} |
+
+**New Code Pattern**:
+\`\`\`{language}
+// Pattern used in new code
+\`\`\`
+
+**Existing Pattern**:
+\`\`\`{language}
+// Pattern used in existing codebase
+\`\`\`
+
+**Recommendation**:
+{Which pattern to use and why}
+
+---
+
+## Rule Update Recommendations
+
+When pattern conflicts are found, recommend updates to prevent future inconsistencies.
+
+### Recommended Addition to `allowed-patterns.mdc`
+
+If a good pattern is discovered that isn't documented:
+
+\`\`\`markdown
+
+### {Pattern Name}
+
+{Description of the pattern}
+
+\`\`\`typescript
+// Example of the pattern
+\`\`\`
+
+**Why**: {Explanation of benefit}
+\`\`\`
+
+### Recommended Addition to `forbidden-patterns.mdc`
+
+If an anti-pattern is found that should be avoided:
+
+\`\`\`markdown
+
+### DON'T: {Pattern Name}
+
+**Problem**: {Description of why this is problematic}
+
+\`\`\`typescript
+// BAD - Example of the anti-pattern
+\`\`\`
+
+**Why This is Wrong**:
+
+- {Reason 1}
+- {Reason 2}
+
+**Fix**: {Description of the correct approach}
+\`\`\`
+
+---
+
+## Positive Highlights
+
+List any particularly well-written code or good practices observed:
+
+- {Highlight 1}
+- {Highlight 2}
+
+---
+
+## Commit Readiness
+
+| Status | {Ready to Commit/Needs Changes/Needs Discussion} |
+| ------ | ------------------------------------------------ |
+| Reason | {Brief explanation}                              |
+
+### Before Committing
+
+- [ ] Address all Critical findings
+- [ ] Address all Major findings
+- [ ] Review Pattern Conflicts and decide on resolution
+- [ ] Update rules files if new patterns should be documented
+```
+
+---
+
+## Example Output
+
+### Pattern Conflict Example
+
+```markdown
+### Conflict 1: Error Handling Pattern
+
+| Field          | Value                          |
+| -------------- | ------------------------------ |
+| New Code File  | `src/services/userService.ts`  |
+| Reference File | `src/services/orderService.ts` |
+| Pattern Type   | error-handling                 |
+| Resolution     | Update new code                |
+
+**New Code Pattern**:
+\`\`\`typescript
+try {
+await saveUser(data);
+} catch (e) {
+console.log(e); // Silent console log
+return null;
+}
+\`\`\`
+
+**Existing Pattern**:
+\`\`\`typescript
+try {
+await saveOrder(data);
+} catch (error) {
+logger.error('Failed to save order', { error, orderId: data.id });
+throw new ServiceError('Unable to save order');
+}
+\`\`\`
+
+**Recommendation**:
+Update new code to follow the established error handling pattern from `orderService.ts`. The existing pattern properly logs errors with context and throws a meaningful error for the caller to handle.
+```
+
+### Rule Update Recommendation Example
+
+```markdown
+## Rule Update Recommendations
+
+### Recommended Addition to `allowed-patterns.mdc`
+
+\`\`\`markdown
+
+### Service Layer Error Handling
+
+All service layer functions should handle errors with proper logging and re-throw with meaningful error types.
+
+\`\`\`typescript
+// GOOD - Service layer error handling
+try {
+await performOperation(data);
+} catch (error) {
+logger.error('Operation failed', { error, context: data.id });
+throw new ServiceError('Operation failed', { cause: error });
+}
+\`\`\`
+
+**Why**: Ensures errors are traceable in logs while providing meaningful errors to callers.
+\`\`\`
+
+### Recommended Addition to `forbidden-patterns.mdc`
+
+\`\`\`markdown
+
+### DON'T: Silent Console Logging in Services
+
+**Problem**: Using console.log for errors in service layer loses context and makes debugging difficult.
+
+\`\`\`typescript
+// BAD - Silent console log
+catch (e) {
+console.log(e);
+return null;
+}
+\`\`\`
+
+**Why This is Wrong**:
+
+- console.log doesn't persist in production logging systems
+- Returning null hides the error from callers
+- No context about what operation failed
+
+**Fix**: Use structured logger and throw meaningful errors.
+\`\`\`
+```
+
+---
+
+## Finding Example
+
+```markdown
+### Finding 1: Silent Error Swallowing
+
+| Field          | Value                         |
+| -------------- | ----------------------------- |
+| File           | `src/services/userService.ts` |
+| Line           | 45                            |
+| Severity       | Major                         |
+| Fix Complexity | 3/10 - Low                    |
+| Pattern        | forbidden-patterns.mdc        |
+
+**Description**:
+The catch block catches an error but only logs it to console and returns null. This hides errors from callers and makes debugging difficult.
+
+**Reference Implementation**:
+See `src/services/orderService.ts` for proper error handling pattern.
+
+**Suggested Fix**:
+\`\`\`typescript
+try {
+  await saveUser(data);
+} catch (error) {
+  logger.error('Failed to save user', { error, userId: data.id });
+  throw new ServiceError('Unable to save user', { cause: error });
+}
+\`\`\`
+```

package/rules/patterns/review-pr-patterns.mdc

@@ -0,0 +1,370 @@
+---
+description: "PR review checklist and patterns for code reviews"
+alwaysApply: false
+---
+
+# PR Review Patterns
+
+This file defines **patterns and guidelines for reviewing Pull Requests**. It integrates with language-specific patterns and references both allowed and forbidden patterns to ensure comprehensive code reviews.
+
+---
+
+## How to Use This File
+
+1. **Analyze the existing codebase** to understand the patterns, conventions, and architectural decisions already established in the project. Look at:
+   - Naming conventions used throughout the codebase
+   - Code organization and folder structure
+   - Error handling approaches
+   - Testing patterns and frameworks in use
+   - Existing abstractions and utilities
+   - Configuration and dependency management style
+2. **Identify the language(s)** in the PR being reviewed
+3. **Apply general review patterns** from this file
+4. **Reference language-specific patterns** based on the codebase:
+   - For TypeScript/JavaScript: See `.cursor/rules/languages/typescript-patterns.mdc`
+   - For Python: See `.cursor/rules/languages/python-patterns.mdc`
+5. **Cross-check against forbidden patterns** in `.cursor/rules/core/forbidden-patterns.mdc`
+6. **Validate alignment with allowed patterns** in `.cursor/rules/core/allowed-patterns.mdc`
+
+> **Important:** The patterns already present in the project take precedence. New code should be consistent with the existing codebase style, even if it differs slightly from generic best practices.
+
+---
+
+## General PR Review Checklist
+
+### 1. Code Quality
+
+Before approving any PR, verify the following:
+
+- [ ] Code follows the patterns defined in `.cursor/rules/core/allowed-patterns.mdc`
+- [ ] Code avoids anti-patterns defined in `.cursor/rules/core/forbidden-patterns.mdc`
+- [ ] Code adheres to language-specific patterns (see Language-Specific Reviews section)
+- [ ] No magic numbers or hardcoded values without context
+- [ ] Error handling is explicit and meaningful
+- [ ] Functions and components follow single responsibility principle
+
+### 2. Naming and Readability
+
+- [ ] Variables, functions, and classes have descriptive names
+- [ ] Code is self-documenting where possible
+- [ ] Complex logic has appropriate comments explaining the "why"
+- [ ] Consistent naming conventions throughout the PR
+
+### 3. Testing
+
+- [ ] New functionality has corresponding tests
+- [ ] Edge cases are covered
+- [ ] Tests are readable and follow AAA pattern (Arrange, Act, Assert)
+- [ ] No flaky or timing-dependent tests
+
+### 4. Security
+
+- [ ] No hardcoded secrets, API keys, or credentials
+- [ ] User inputs are validated and sanitized
+- [ ] Authentication and authorization are properly checked
+- [ ] Sensitive data is handled appropriately
+
+### 5. Performance
+
+- [ ] No unnecessary loops or repeated computations
+- [ ] Appropriate use of caching where applicable
+- [ ] No N+1 query problems
+- [ ] Large data sets are handled efficiently
+
+---
+
+## Language-Specific Reviews
+
+### TypeScript/JavaScript PRs
+
+When reviewing TypeScript or JavaScript code, apply these additional checks from `.cursor/rules/languages/typescript-patterns.mdc`:
+
+**Type Safety:**
+
+- [ ] Strict type-checking is enabled and followed
+- [ ] No use of `any` type (use `unknown` with type guards instead)
+- [ ] Interfaces are used for object shapes
+- [ ] Discriminated unions for state management
+- [ ] Proper use of generics for reusable components
+
+**Patterns to Look For:**
+
+```typescript
+// GOOD - Discriminated unions for state
+type RequestState =
+  | { status: "idle" }
+  | { status: "loading" }
+  | { status: "success"; data: User }
+  | { status: "error"; error: Error };
+
+// BAD - Loose typing with any
+let value: any;
+```
+
+**Null Safety:**
+
+- [ ] Optional chaining is used appropriately (`?.`)
+- [ ] Nullish coalescing is used (`??`)
+- [ ] Type guards are implemented for runtime type checking
+
+**Immutability:**
+
+- [ ] `readonly` is used where mutation should be prevented
+- [ ] Arrays are not mutated directly; spread operators or `.map()` are used
+
+**Reference:** See `.cursor/rules/languages/typescript-patterns.mdc` for the complete TypeScript best practices.
+
+---
+
+### Python PRs
+
+When reviewing Python code, apply these additional checks from `.cursor/rules/languages/python-patterns.mdc`:
+
+**Type Hints:**
+
+- [ ] Function signatures have type hints
+- [ ] Return types are specified
+- [ ] Complex types use `typing` module (e.g., `List`, `Dict`, `Optional`)
+
+**Patterns to Look For:**
+
+```python
+# GOOD - Type hints with docstrings
+def fetch_user(user_id: str) -> Optional[User]:
+    """Fetch a user by their ID.
+
+    Args:
+        user_id: The unique identifier of the user.
+
+    Returns:
+        The user if found, None otherwise.
+    """
+    pass
+
+# BAD - No type hints, unclear function signature
+def fetch_user(user_id):
+    pass
+```
+
+**Error Handling:**
+
+- [ ] Specific exceptions are caught (not bare `except:`)
+- [ ] Context managers are used for resources (`with` statement)
+- [ ] Errors are logged with appropriate context
+
+**Code Style:**
+
+- [ ] PEP 8 compliance
+- [ ] Meaningful variable and function names (snake_case)
+- [ ] Docstrings for public functions and classes
+- [ ] No circular imports
+
+**Reference:** See `.cursor/rules/languages/python-patterns.mdc` for the complete Python best practices.
+
+---
+
+## Forbidden Patterns to Catch in Reviews
+
+Always flag these anti-patterns from `.cursor/rules/core/forbidden-patterns.mdc`:
+
+### 1. Magic Numbers
+
+```typescript
+// FLAG THIS
+setTimeout(cleanup, 86400000)
+if (retryCount > 5) { ... }
+
+// SUGGEST THIS
+const ONE_DAY_MS = 24 * 60 * 60 * 1000
+setTimeout(cleanup, ONE_DAY_MS)
+```
+
+### 2. Silent Error Swallowing
+
+```typescript
+// FLAG THIS
+try {
+  await saveData(data);
+} catch (error) {
+  // Silent failure
+}
+
+// SUGGEST THIS
+try {
+  await saveData(data);
+} catch (error) {
+  logger.error("Failed to save data", { error, data });
+  throw new UserFacingError("Unable to save. Please try again.");
+}
+```
+
+### 3. Nested Ternaries
+
+```typescript
+// FLAG THIS
+const status = isLoading
+  ? "loading"
+  : hasError
+  ? "error"
+  : isComplete
+  ? "complete"
+  : "idle";
+
+// SUGGEST THIS
+function getStatus(isLoading: boolean, hasError: boolean, isComplete: boolean) {
+  if (isLoading) return "loading";
+  if (hasError) return "error";
+  if (isComplete) return "complete";
+  return "idle";
+}
+```
+
+### 4. Parameter Mutation
+
+```typescript
+// FLAG THIS
+function addItem(items: string[], newItem: string) {
+  items.push(newItem); // Mutates original!
+  return items;
+}
+
+// SUGGEST THIS
+function addItem(items: string[], newItem: string) {
+  return [...items, newItem];
+}
+```
+
+### 5. Mixed Async Patterns
+
+```typescript
+// FLAG THIS
+async function processData() {
+  const result = await fetchData();
+  return result.then((data) => transform(data));
+}
+
+// SUGGEST THIS
+async function processData() {
+  const data = await fetchData();
+  return transform(data);
+}
+```
+
+---
+
+## Allowed Patterns to Encourage
+
+Reference `.cursor/rules/core/allowed-patterns.mdc` and encourage these practices:
+
+### 1. Descriptive Naming
+
+```typescript
+// ENCOURAGE
+function calculateOrderTotal(items: OrderItem[]): number;
+function fetchUserProfile(userId: string): Promise<User>;
+const isAuthenticated = checkAuthStatus();
+```
+
+### 2. Single Responsibility
+
+```typescript
+// ENCOURAGE - Focused, testable functions
+function formatCurrency(amount: number): string {
+  return new Intl.NumberFormat("en-US", {
+    style: "currency",
+    currency: "USD",
+  }).format(amount);
+}
+```
+
+### 3. Explicit Error Handling
+
+```typescript
+// ENCOURAGE
+async function fetchData(url: string) {
+  try {
+    const response = await fetch(url);
+    if (!response.ok) {
+      throw new ApiError(`Request failed: ${response.status}`);
+    }
+    return response.json();
+  } catch (error) {
+    logger.error("Failed to fetch data", { url, error });
+    throw error;
+  }
+}
+```
+
+### 4. Consistent Code Organization
+
+```
+// ENCOURAGE this structure
+src/
+├── components/       # UI components
+├── hooks/            # Custom React hooks
+├── utils/            # Utility functions
+├── types/            # TypeScript type definitions
+├── services/         # API and external service integrations
+└── stores/           # State management
+```
+
+---
+
+## Review Comment Templates
+
+Use these templates for consistent review feedback:
+
+### Suggesting a Pattern Change
+
+```markdown
+**Pattern Suggestion**: This code uses [anti-pattern name].
+
+Consider refactoring to:
+\`\`\`typescript
+// Suggested improvement
+\`\`\`
+
+Reference: See `.cursor/rules/core/forbidden-patterns.mdc` for details on why this pattern is problematic.
+```
+
+### Requesting Type Safety Improvements
+
+```markdown
+**Type Safety**: The use of `any` here bypasses TypeScript's type checking.
+
+Consider using `unknown` with a type guard, or define a specific interface.
+
+Reference: See `.cursor/rules/languages/typescript-patterns.mdc` section on "Avoid the `any` Type".
+```
+
+### Flagging Missing Error Handling
+
+```markdown
+**Error Handling**: This error is being swallowed silently.
+
+Please add appropriate logging and user feedback. See `.cursor/rules/core/allowed-patterns.mdc` for error handling guidelines.
+```
+
+---
+
+## PR Approval Criteria
+
+A PR should only be approved when:
+
+1. **No forbidden patterns** are present (or have been addressed)
+2. **Allowed patterns** are followed where applicable
+3. **Language-specific patterns** are adhered to
+4. **Tests** are present and passing
+5. **No security concerns** have been identified
+6. **Code is readable** and maintainable
+
+---
+
+## Quick Reference: Pattern Files
+
+| File                      | Purpose                        | When to Reference              |
+| ------------------------- | ------------------------------ | ------------------------------ |
+| `.cursor/rules/core/forbidden-patterns.mdc`  | Anti-patterns to avoid         | When flagging problematic code |
+| `.cursor/rules/core/allowed-patterns.mdc`    | Best practices to follow       | When suggesting improvements   |
+| `.cursor/rules/languages/typescript-patterns.mdc` | TypeScript-specific guidelines | When reviewing TS/JS code      |
+| `.cursor/rules/languages/python-patterns.mdc`     | Python-specific guidelines     | When reviewing Python code     |