@uoyo/mvtt 2.0.0-beta.0 → 2.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +131 -147
- package/dist/build/assembler.d.ts.map +1 -1
- package/dist/build/assembler.js +2 -0
- package/dist/build/assembler.js.map +1 -1
- package/dist/build/plan-validator.d.ts +26 -0
- package/dist/build/plan-validator.d.ts.map +1 -0
- package/dist/build/plan-validator.js +225 -0
- package/dist/build/plan-validator.js.map +1 -0
- package/dist/build/section-loader.d.ts.map +1 -1
- package/dist/build/section-loader.js +45 -9
- package/dist/build/section-loader.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +2 -11
- package/dist/cli.js.map +1 -1
- package/dist/commands/doctor.d.ts.map +1 -1
- package/dist/commands/doctor.js +0 -1
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/install.d.ts +1 -4
- package/dist/commands/install.d.ts.map +1 -1
- package/dist/commands/install.js +18 -14
- package/dist/commands/install.js.map +1 -1
- package/dist/commands/migrate.d.ts +18 -0
- package/dist/commands/migrate.d.ts.map +1 -0
- package/dist/commands/migrate.js +163 -0
- package/dist/commands/migrate.js.map +1 -0
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +35 -2
- package/dist/commands/update.js.map +1 -1
- package/dist/fs/core-manifest.d.ts +17 -0
- package/dist/fs/core-manifest.d.ts.map +1 -0
- package/dist/fs/core-manifest.js +76 -0
- package/dist/fs/core-manifest.js.map +1 -0
- package/dist/fs/install-manifest.d.ts +1 -2
- package/dist/fs/install-manifest.d.ts.map +1 -1
- package/dist/fs/install-manifest.js +1 -2
- package/dist/fs/install-manifest.js.map +1 -1
- package/dist/fs/materialize.d.ts.map +1 -1
- package/dist/fs/materialize.js +23 -3
- package/dist/fs/materialize.js.map +1 -1
- package/dist/types/core-manifest.d.ts +12 -0
- package/dist/types/core-manifest.d.ts.map +1 -0
- package/dist/types/core-manifest.js +2 -0
- package/dist/types/core-manifest.js.map +1 -0
- package/dist/types/registry.d.ts +13 -5
- package/dist/types/registry.d.ts.map +1 -1
- package/install-manifest.yaml +31 -27
- package/package.json +57 -57
- package/registry.yaml +192 -209
- package/sources/defaults/config.yaml +27 -30
- package/sources/defaults/project-context.yaml +15 -26
- package/sources/defaults/session.yaml +31 -23
- package/sources/knowledge/core/manifest.yaml +4 -45
- package/sources/sections/activation-load-config.md +11 -5
- package/sources/sections/activation-load-context.md +26 -11
- package/sources/sections/activation-preflight.md +14 -4
- package/sources/sections/footer-next-steps.md +35 -9
- package/sources/sections/output-language-constraint.md +11 -0
- package/sources/sections/role-header.md +13 -13
- package/sources/sections/session-update.md +47 -0
- package/sources/skills/mvt-analyze/business.md +69 -33
- package/sources/skills/mvt-analyze/manifest.yaml +90 -89
- package/sources/skills/mvt-analyze-code/business.md +82 -35
- package/sources/skills/mvt-analyze-code/manifest.yaml +34 -26
- package/sources/skills/mvt-check-context/business.md +89 -42
- package/sources/skills/mvt-check-context/manifest.yaml +10 -21
- package/sources/skills/mvt-cleanup/business.md +80 -31
- package/sources/skills/mvt-cleanup/manifest.yaml +85 -93
- package/sources/skills/mvt-config/business.md +94 -26
- package/sources/skills/mvt-config/manifest.yaml +15 -27
- package/sources/skills/mvt-create-skill/business.md +224 -111
- package/sources/skills/mvt-create-skill/manifest.yaml +31 -15
- package/sources/skills/mvt-design/business.md +116 -34
- package/sources/skills/mvt-design/manifest.yaml +22 -31
- package/sources/skills/mvt-fix/business.md +103 -28
- package/sources/skills/mvt-fix/manifest.yaml +8 -22
- package/sources/skills/mvt-help/business.md +74 -70
- package/sources/skills/mvt-help/manifest.yaml +16 -10
- package/sources/skills/mvt-implement/business.md +91 -32
- package/sources/skills/mvt-implement/manifest.yaml +17 -33
- package/sources/skills/mvt-init/business.md +164 -49
- package/sources/skills/mvt-init/manifest.yaml +36 -28
- package/sources/skills/mvt-manage-context/business.md +175 -0
- package/sources/skills/mvt-manage-context/manifest.yaml +123 -0
- package/sources/skills/mvt-plan-dev/business.md +75 -0
- package/sources/skills/mvt-plan-dev/manifest.yaml +91 -0
- package/sources/skills/mvt-quick-dev/business.md +99 -0
- package/sources/skills/mvt-quick-dev/manifest.yaml +69 -0
- package/sources/skills/mvt-refactor/business.md +104 -33
- package/sources/skills/mvt-refactor/manifest.yaml +17 -32
- package/sources/skills/mvt-resume/business.md +137 -0
- package/sources/skills/mvt-resume/manifest.yaml +71 -0
- package/sources/skills/mvt-review/business.md +112 -49
- package/sources/skills/mvt-review/manifest.yaml +15 -34
- package/sources/skills/mvt-status/business.md +71 -24
- package/sources/skills/mvt-status/manifest.yaml +18 -26
- package/sources/skills/mvt-sync-context/business.md +148 -23
- package/sources/skills/mvt-sync-context/manifest.yaml +51 -39
- package/sources/skills/mvt-template/business.md +96 -49
- package/sources/skills/mvt-template/manifest.yaml +13 -21
- package/sources/skills/mvt-test/business.md +104 -36
- package/sources/skills/mvt-test/manifest.yaml +14 -23
- package/sources/skills/mvt-update-plan/business.md +72 -0
- package/sources/skills/mvt-update-plan/manifest.yaml +132 -0
- package/sources/templates/analyze-output/body.md +8 -31
- package/sources/templates/analyze-output/manifest.yaml +11 -11
- package/sources/templates/design-output/body.md +17 -50
- package/sources/templates/design-output/manifest.yaml +11 -11
- package/sources/templates/implement-output/body.md +6 -27
- package/sources/templates/implement-output/manifest.yaml +11 -11
- package/sources/templates/project-context/body.md +13 -0
- package/sources/templates/project-context/manifest.yaml +12 -0
- package/sources/templates/review-output/body.md +6 -40
- package/sources/templates/review-output/manifest.yaml +11 -11
- package/sources/templates/test-output/body.md +4 -28
- package/sources/templates/test-output/manifest.yaml +11 -11
- package/sources/knowledge/core/review-principles.md +0 -51
- package/sources/knowledge/patterns/clean-architecture/manifest.yaml +0 -66
- package/sources/knowledge/patterns/clean-architecture/review-checklist.md +0 -230
- package/sources/knowledge/patterns/ddd/manifest.yaml +0 -83
- package/sources/knowledge/patterns/ddd/review-checklist.md +0 -226
- package/sources/knowledge/patterns/ddd/tactical-patterns.md +0 -12
- package/sources/knowledge/patterns/frontend-react/manifest.yaml +0 -44
- package/sources/knowledge/patterns/frontend-react/review-checklist.md +0 -78
- package/sources/knowledge/patterns/manifest.yaml +0 -113
- package/sources/skills/mvt-add-context/business.md +0 -47
- package/sources/skills/mvt-add-context/manifest.yaml +0 -83
- package/sources/templates/analyze-code-output/body.md +0 -44
- package/sources/templates/analyze-code-output/manifest.yaml +0 -11
- package/sources/templates/cleanup-output/body.md +0 -9
- package/sources/templates/cleanup-output/manifest.yaml +0 -11
- package/sources/templates/config-output/body.md +0 -11
- package/sources/templates/config-output/manifest.yaml +0 -11
- package/sources/templates/context-check-output/body.md +0 -32
- package/sources/templates/context-check-output/manifest.yaml +0 -11
- package/sources/templates/fix-output/body.md +0 -30
- package/sources/templates/fix-output/manifest.yaml +0 -11
- package/sources/templates/init-output/body.md +0 -34
- package/sources/templates/init-output/manifest.yaml +0 -11
- package/sources/templates/refactor-output/body.md +0 -32
- package/sources/templates/refactor-output/manifest.yaml +0 -11
- package/sources/templates/status-output/body.md +0 -36
- package/sources/templates/status-output/manifest.yaml +0 -11
- package/sources/templates/sync-context-output/body.md +0 -16
- package/sources/templates/sync-context-output/manifest.yaml +0 -11
|
@@ -1,38 +1,15 @@
|
|
|
1
|
-
|
|
1
|
+
# Requirements Analysis: {Feature Name}
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
{1-2 paragraph summary of the feature}
|
|
3
|
+
## Feature Overview
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
| Actor | Type | Description |
|
|
8
|
-
|-------|------|-------------|
|
|
9
|
-
| {actor} | {primary/secondary/system} | {description} |
|
|
5
|
+
## Actors
|
|
10
6
|
|
|
11
|
-
|
|
12
|
-
| ID | Requirement | Priority | Category |
|
|
13
|
-
|----|-------------|----------|----------|
|
|
14
|
-
| REQ-001 | {requirement} | {P0/P1/P2} | {functional/non-functional} |
|
|
7
|
+
## Requirements
|
|
15
8
|
|
|
16
|
-
|
|
17
|
-
| Concept | Type | Description |
|
|
18
|
-
|---------|------|-------------|
|
|
19
|
-
| {concept} | {Entity/Value Object/Service} | {description} |
|
|
9
|
+
## Domain Concepts
|
|
20
10
|
|
|
21
|
-
|
|
22
|
-
| ID | Rule | Condition | Action |
|
|
23
|
-
|----|------|-----------|--------|
|
|
24
|
-
| BR-001 | {rule_name} | {when} | {then} |
|
|
11
|
+
## Business Rules
|
|
25
12
|
|
|
26
|
-
|
|
27
|
-
| # | Question | Impact | Blocking? |
|
|
28
|
-
|---|----------|--------|-----------|
|
|
29
|
-
| Q1 | {question} | {what_it_affects} | {Yes/No} |
|
|
13
|
+
## Ambiguities & Questions
|
|
30
14
|
|
|
31
|
-
|
|
32
|
-
- **Change ID**: {YYYYMMDD-slug}
|
|
33
|
-
- **Artifact**: `.ai-agents/workspace/artifacts/{change-id}/analysis.md`
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
**Suggested Next Steps**:
|
|
37
|
-
- `/mvt-design` to create architecture based on this analysis
|
|
38
|
-
- Address blocking questions before proceeding
|
|
15
|
+
## Change Tracking
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
name: analyze-output
|
|
2
|
-
output: .ai-agents/skills/_templates/analyze-output.md
|
|
3
|
-
|
|
4
|
-
frontmatter:
|
|
5
|
-
id: analyze-output
|
|
6
|
-
version: "1.0"
|
|
7
|
-
skill: mvt-analyze
|
|
8
|
-
|
|
9
|
-
sections:
|
|
10
|
-
- type: file
|
|
11
|
-
source: ./body.md
|
|
1
|
+
name: analyze-output
|
|
2
|
+
output: .ai-agents/skills/_templates/analyze-output.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: analyze-output
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-analyze
|
|
8
|
+
|
|
9
|
+
sections:
|
|
10
|
+
- type: file
|
|
11
|
+
source: ./body.md
|
|
@@ -1,50 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
// {InterfaceName}
|
|
19
|
-
{interface_definition}
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### Data Flow
|
|
23
|
-
```mermaid
|
|
24
|
-
sequenceDiagram
|
|
25
|
-
participant C as Client
|
|
26
|
-
participant S as Service
|
|
27
|
-
participant R as Repository
|
|
28
|
-
C->>S: request
|
|
29
|
-
S->>R: query
|
|
30
|
-
R-->>S: result
|
|
31
|
-
S-->>C: response
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### File Structure
|
|
35
|
-
| File | Action | Description |
|
|
36
|
-
|------|--------|-------------|
|
|
37
|
-
| `{path}` | {Create/Modify} | {description} |
|
|
38
|
-
|
|
39
|
-
### Implementation Guidelines
|
|
40
|
-
- {guideline_1}
|
|
41
|
-
- {guideline_2}
|
|
42
|
-
|
|
43
|
-
### Change Tracking
|
|
44
|
-
- **Change ID**: {change-id}
|
|
45
|
-
- **Artifact**: `.ai-agents/workspace/artifacts/{change-id}/design.md`
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
**Suggested Next Steps**:
|
|
49
|
-
- `/mvt-implement` to start implementing this design
|
|
50
|
-
- Refine specific modules if needed
|
|
1
|
+
# Architecture Design: {Feature Name}
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
## Architecture Decision Records
|
|
6
|
+
|
|
7
|
+
## Module Design
|
|
8
|
+
|
|
9
|
+
## Key Interfaces
|
|
10
|
+
|
|
11
|
+
## Data Flow
|
|
12
|
+
|
|
13
|
+
## File Structure
|
|
14
|
+
|
|
15
|
+
## Implementation Guidelines
|
|
16
|
+
|
|
17
|
+
## Change Tracking
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
name: design-output
|
|
2
|
-
output: .ai-agents/skills/_templates/design-output.md
|
|
3
|
-
|
|
4
|
-
frontmatter:
|
|
5
|
-
id: design-output
|
|
6
|
-
version: "1.0"
|
|
7
|
-
skill: mvt-design
|
|
8
|
-
|
|
9
|
-
sections:
|
|
10
|
-
- type: file
|
|
11
|
-
source: ./body.md
|
|
1
|
+
name: design-output
|
|
2
|
+
output: .ai-agents/skills/_templates/design-output.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: design-output
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-design
|
|
8
|
+
|
|
9
|
+
sections:
|
|
10
|
+
- type: file
|
|
11
|
+
source: ./body.md
|
|
@@ -1,32 +1,11 @@
|
|
|
1
|
-
|
|
1
|
+
# Implementation: {Feature Name}
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
| # | Step | Files | Status |
|
|
5
|
-
|---|------|-------|--------|
|
|
6
|
-
| 1 | {step} | `{files}` | {pending/done} |
|
|
3
|
+
## Implementation Plan
|
|
7
4
|
|
|
8
|
-
|
|
9
|
-
| File | Action | Description |
|
|
10
|
-
|------|--------|-------------|
|
|
11
|
-
| `{path}` | {Create/Modify/Delete} | {description} |
|
|
5
|
+
## Changes
|
|
12
6
|
|
|
13
|
-
|
|
7
|
+
## Implementation Details
|
|
14
8
|
|
|
15
|
-
|
|
16
|
-
```{language}
|
|
17
|
-
{code}
|
|
18
|
-
```
|
|
9
|
+
## Design Compliance
|
|
19
10
|
|
|
20
|
-
|
|
21
|
-
| Design Requirement | Status | Notes |
|
|
22
|
-
|-------------------|--------|-------|
|
|
23
|
-
| {requirement} | {Compliant/Deviation} | {notes} |
|
|
24
|
-
|
|
25
|
-
### Change Tracking
|
|
26
|
-
- **Change ID**: {change-id}
|
|
27
|
-
- **Artifact**: `.ai-agents/workspace/artifacts/{change-id}/implementation.md`
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
**Suggested Next Steps**:
|
|
31
|
-
- `/mvt-review` to review the implementation
|
|
32
|
-
- `/mvt-test` to write tests
|
|
11
|
+
## Change Tracking
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
name: implement-output
|
|
2
|
-
output: .ai-agents/skills/_templates/implement-output.md
|
|
3
|
-
|
|
4
|
-
frontmatter:
|
|
5
|
-
id: implement-output
|
|
6
|
-
version: "1.0"
|
|
7
|
-
skill: mvt-implement
|
|
8
|
-
|
|
9
|
-
sections:
|
|
10
|
-
- type: file
|
|
11
|
-
source: ./body.md
|
|
1
|
+
name: implement-output
|
|
2
|
+
output: .ai-agents/skills/_templates/implement-output.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: implement-output
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-implement
|
|
8
|
+
|
|
9
|
+
sections:
|
|
10
|
+
- type: file
|
|
11
|
+
source: ./body.md
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
name: project-context
|
|
2
|
+
output: .ai-agents/skills/_templates/project-context.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: project-context
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-analyze-code
|
|
8
|
+
description: "Project semantic document template -- defines section structure for project-context.md"
|
|
9
|
+
|
|
10
|
+
sections:
|
|
11
|
+
- type: file
|
|
12
|
+
source: ./body.md
|
|
@@ -1,45 +1,11 @@
|
|
|
1
|
-
|
|
1
|
+
# Code Review Report
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
- **Overall Assessment**: {Good / Needs Work / Critical Issues}
|
|
5
|
-
- **Files Reviewed**: {count}
|
|
6
|
-
- **Critical Issues**: {count}
|
|
7
|
-
- **Warnings**: {count}
|
|
8
|
-
- **Suggestions**: {count}
|
|
3
|
+
## Summary
|
|
9
4
|
|
|
10
|
-
|
|
5
|
+
## Critical Issues
|
|
11
6
|
|
|
12
|
-
|
|
13
|
-
**File**: `{file}:{line}`
|
|
14
|
-
**Issue**: {description}
|
|
15
|
-
**Suggestion**: {fix_suggestion}
|
|
7
|
+
## Warnings
|
|
16
8
|
|
|
17
|
-
|
|
18
|
-
// Current code
|
|
19
|
-
{problematic_code}
|
|
9
|
+
## Suggestions
|
|
20
10
|
|
|
21
|
-
|
|
22
|
-
{suggested_code}
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### Warnings
|
|
26
|
-
|
|
27
|
-
#### W{N}: {Issue Title}
|
|
28
|
-
**File**: `{file}:{line}`
|
|
29
|
-
**Issue**: {description}
|
|
30
|
-
**Suggestion**: {fix_suggestion}
|
|
31
|
-
|
|
32
|
-
### Suggestions
|
|
33
|
-
|
|
34
|
-
#### S{N}: {Suggestion Title}
|
|
35
|
-
**File**: `{file}`
|
|
36
|
-
**Suggestion**: {improvement}
|
|
37
|
-
|
|
38
|
-
### Highlights
|
|
39
|
-
- {positive_finding_1}
|
|
40
|
-
- {positive_finding_2}
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
**Suggested Next Steps**:
|
|
44
|
-
- `/mvt-fix` to address critical issues
|
|
45
|
-
- `/mvt-test` to add missing tests
|
|
11
|
+
## Highlights
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
name: review-output
|
|
2
|
-
output: .ai-agents/skills/_templates/review-output.md
|
|
3
|
-
|
|
4
|
-
frontmatter:
|
|
5
|
-
id: review-output
|
|
6
|
-
version: "1.0"
|
|
7
|
-
skill: mvt-review
|
|
8
|
-
|
|
9
|
-
sections:
|
|
10
|
-
- type: file
|
|
11
|
-
source: ./body.md
|
|
1
|
+
name: review-output
|
|
2
|
+
output: .ai-agents/skills/_templates/review-output.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: review-output
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-review
|
|
8
|
+
|
|
9
|
+
sections:
|
|
10
|
+
- type: file
|
|
11
|
+
source: ./body.md
|
|
@@ -1,31 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
# Test Design: {Feature Name}
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
| ID | Scenario | Input | Expected Output | Type |
|
|
5
|
-
|----|----------|-------|-----------------|------|
|
|
6
|
-
| T1 | {scenario} | {input} | {expected} | {Happy Path / Edge Case / Negative / Security} |
|
|
3
|
+
## Test Cases
|
|
7
4
|
|
|
8
|
-
|
|
5
|
+
## Test Code
|
|
9
6
|
|
|
10
|
-
|
|
11
|
-
```{language}
|
|
12
|
-
{test_code}
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### Coverage Analysis
|
|
16
|
-
| Requirement | Test Coverage | Status |
|
|
17
|
-
|-------------|---------------|--------|
|
|
18
|
-
| REQ-001 | T1, T2 | {Covered / Missing} |
|
|
19
|
-
|
|
20
|
-
### Coverage by Type
|
|
21
|
-
| Type | Count | Coverage |
|
|
22
|
-
|------|-------|----------|
|
|
23
|
-
| Happy Path | {n} | {pct}% |
|
|
24
|
-
| Edge Case | {n} | {pct}% |
|
|
25
|
-
| Negative | {n} | {pct}% |
|
|
26
|
-
| Security | {n} | {pct}% |
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
**Suggested Next Steps**:
|
|
30
|
-
- Run tests
|
|
31
|
-
- `/mvt-fix` if tests fail
|
|
7
|
+
## Coverage Analysis
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
name: test-output
|
|
2
|
-
output: .ai-agents/skills/_templates/test-output.md
|
|
3
|
-
|
|
4
|
-
frontmatter:
|
|
5
|
-
id: test-output
|
|
6
|
-
version: "1.0"
|
|
7
|
-
skill: mvt-test
|
|
8
|
-
|
|
9
|
-
sections:
|
|
10
|
-
- type: file
|
|
11
|
-
source: ./body.md
|
|
1
|
+
name: test-output
|
|
2
|
+
output: .ai-agents/skills/_templates/test-output.md
|
|
3
|
+
|
|
4
|
+
frontmatter:
|
|
5
|
+
id: test-output
|
|
6
|
+
version: "1.0"
|
|
7
|
+
skill: mvt-test
|
|
8
|
+
|
|
9
|
+
sections:
|
|
10
|
+
- type: file
|
|
11
|
+
source: ./body.md
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
# Code Review Principles
|
|
2
|
-
|
|
3
|
-
Actionable checklist for reviewing code quality. Use during `#review` and as reference during `#implement`.
|
|
4
|
-
|
|
5
|
-
## Naming & Readability
|
|
6
|
-
|
|
7
|
-
- [ ] Classes/functions named by **what they do**, not how they do it
|
|
8
|
-
- [ ] No abbreviations unless universally understood (e.g., `id`, `url`, `http`)
|
|
9
|
-
- [ ] Boolean variables/methods start with `is`, `has`, `can`, `should`
|
|
10
|
-
- [ ] Collections named as plural nouns; single items as singular
|
|
11
|
-
- [ ] No "Manager", "Helper", "Utils" god-classes — split by responsibility
|
|
12
|
-
|
|
13
|
-
## Single Responsibility
|
|
14
|
-
|
|
15
|
-
- [ ] Each class/module has **one reason to change**
|
|
16
|
-
- [ ] Functions do **one thing** and are ≤ 30 lines (guideline, not hard rule)
|
|
17
|
-
- [ ] If you need "and" to describe what a function does → split it
|
|
18
|
-
|
|
19
|
-
## Dependency Direction
|
|
20
|
-
|
|
21
|
-
- [ ] Business logic does NOT import framework/infrastructure code
|
|
22
|
-
- [ ] Dependencies point **inward** (infrastructure → application → domain)
|
|
23
|
-
- [ ] External services accessed through **interfaces/abstractions**
|
|
24
|
-
- [ ] No circular dependencies between modules
|
|
25
|
-
|
|
26
|
-
## Error Handling
|
|
27
|
-
|
|
28
|
-
- [ ] Errors are handled at the **appropriate level** (not swallowed silently)
|
|
29
|
-
- [ ] Fail fast: validate inputs at entry points
|
|
30
|
-
- [ ] No empty catch blocks
|
|
31
|
-
- [ ] Error messages include **context** (what failed, why, what to do)
|
|
32
|
-
|
|
33
|
-
## Duplication & Abstraction
|
|
34
|
-
|
|
35
|
-
- [ ] No copy-paste blocks — extract shared logic into functions
|
|
36
|
-
- [ ] But: don't merge similar-looking code that changes for **different reasons**
|
|
37
|
-
- [ ] Abstractions are justified by **current** requirements, not hypothetical ones
|
|
38
|
-
- [ ] No dead code or commented-out blocks
|
|
39
|
-
|
|
40
|
-
## State & Side Effects
|
|
41
|
-
|
|
42
|
-
- [ ] Mutable state is **minimized** and localized
|
|
43
|
-
- [ ] Functions clearly indicate whether they have side effects
|
|
44
|
-
- [ ] No hidden global state mutations
|
|
45
|
-
- [ ] Concurrent access to shared state is protected
|
|
46
|
-
|
|
47
|
-
## Testing Indicators
|
|
48
|
-
|
|
49
|
-
- [ ] Public API has clear contracts that are testable
|
|
50
|
-
- [ ] Dependencies are injectable (not hard-coded `new`)
|
|
51
|
-
- [ ] No logic in constructors that makes testing difficult
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
id: "clean-architecture"
|
|
2
|
-
type: "pattern"
|
|
3
|
-
name: "Clean Architecture"
|
|
4
|
-
version: "1.0"
|
|
5
|
-
description: "Robert C. Martin's Clean Architecture for testable, maintainable systems"
|
|
6
|
-
|
|
7
|
-
token_estimate:
|
|
8
|
-
total: 800
|
|
9
|
-
breakdown:
|
|
10
|
-
- file: review-checklist.md
|
|
11
|
-
tokens: 800
|
|
12
|
-
load_priority: 1
|
|
13
|
-
summary: "Clean Architecture compliance checklist"
|
|
14
|
-
|
|
15
|
-
loading_strategy:
|
|
16
|
-
level_1_manifest_only:
|
|
17
|
-
tokens: 150
|
|
18
|
-
use_case: "Check available Clean Architecture patterns"
|
|
19
|
-
|
|
20
|
-
level_2_full:
|
|
21
|
-
tokens: 800
|
|
22
|
-
use_case: "Complete Clean Architecture review guidance"
|
|
23
|
-
|
|
24
|
-
loading:
|
|
25
|
-
priority: 10
|
|
26
|
-
auto_load: false
|
|
27
|
-
|
|
28
|
-
files:
|
|
29
|
-
- path: "review-checklist.md"
|
|
30
|
-
description: "Checklist for reviewing code against Clean Architecture"
|
|
31
|
-
required: true
|
|
32
|
-
tokens: 800
|
|
33
|
-
|
|
34
|
-
attributes:
|
|
35
|
-
terminology:
|
|
36
|
-
entity: "Entity"
|
|
37
|
-
use_case: "Use Case"
|
|
38
|
-
interface_adapter: "Interface Adapter"
|
|
39
|
-
framework: "Framework"
|
|
40
|
-
boundary: "Boundary"
|
|
41
|
-
presenter: "Presenter"
|
|
42
|
-
controller: "Controller"
|
|
43
|
-
gateway: "Gateway"
|
|
44
|
-
request_model: "Request Model"
|
|
45
|
-
response_model: "Response Model"
|
|
46
|
-
view_model: "View Model"
|
|
47
|
-
|
|
48
|
-
checklist:
|
|
49
|
-
- "Dependencies point inward"
|
|
50
|
-
- "Entities are pure business objects"
|
|
51
|
-
- "Use Cases contain application logic"
|
|
52
|
-
- "Interfaces defined by inner layer"
|
|
53
|
-
- "Frameworks are details"
|
|
54
|
-
- "Database is a detail"
|
|
55
|
-
- "UI is a detail"
|
|
56
|
-
- "Testable without external dependencies"
|
|
57
|
-
|
|
58
|
-
scenarios:
|
|
59
|
-
- name: "Design application architecture"
|
|
60
|
-
files: ["overview.md"]
|
|
61
|
-
|
|
62
|
-
- name: "Code review"
|
|
63
|
-
files: ["review-checklist.md"]
|
|
64
|
-
|
|
65
|
-
- name: "Understand layer separation"
|
|
66
|
-
files: ["overview.md"]
|