@su-record/vibe 2.7.16 → 2.7.18
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/.env.example +37 -37
- package/CLAUDE.md +153 -134
- package/LICENSE +21 -21
- package/README.md +449 -449
- package/agents/architect-low.md +41 -41
- package/agents/architect-medium.md +59 -59
- package/agents/architect.md +80 -80
- package/agents/build-error-resolver.md +115 -115
- package/agents/compounder.md +261 -261
- package/agents/diagrammer.md +178 -178
- package/agents/docs/api-documenter.md +99 -99
- package/agents/docs/changelog-writer.md +93 -93
- package/agents/e2e-tester.md +294 -294
- package/agents/explorer-low.md +42 -42
- package/agents/explorer-medium.md +59 -59
- package/agents/explorer.md +48 -48
- package/agents/implementer-low.md +43 -43
- package/agents/implementer-medium.md +52 -52
- package/agents/implementer.md +54 -54
- package/agents/junior-mentor.md +141 -141
- package/agents/planning/requirements-analyst.md +84 -84
- package/agents/planning/ux-advisor.md +83 -83
- package/agents/qa/acceptance-tester.md +86 -86
- package/agents/qa/edge-case-finder.md +93 -93
- package/agents/refactor-cleaner.md +143 -143
- package/agents/research/best-practices-agent.md +199 -199
- package/agents/research/codebase-patterns-agent.md +157 -157
- package/agents/research/framework-docs-agent.md +188 -188
- package/agents/research/security-advisory-agent.md +213 -213
- package/agents/review/architecture-reviewer.md +107 -107
- package/agents/review/complexity-reviewer.md +116 -116
- package/agents/review/data-integrity-reviewer.md +88 -88
- package/agents/review/git-history-reviewer.md +103 -103
- package/agents/review/performance-reviewer.md +86 -86
- package/agents/review/python-reviewer.md +150 -150
- package/agents/review/rails-reviewer.md +139 -139
- package/agents/review/react-reviewer.md +144 -144
- package/agents/review/security-reviewer.md +80 -80
- package/agents/review/simplicity-reviewer.md +140 -140
- package/agents/review/test-coverage-reviewer.md +116 -116
- package/agents/review/typescript-reviewer.md +127 -127
- package/agents/searcher.md +54 -54
- package/agents/simplifier.md +120 -120
- package/agents/tester.md +49 -49
- package/agents/ui/ui-a11y-auditor.md +93 -93
- package/agents/ui/ui-antipattern-detector.md +94 -94
- package/agents/ui/ui-dataviz-advisor.md +69 -69
- package/agents/ui/ui-design-system-gen.md +57 -57
- package/agents/ui/ui-industry-analyzer.md +49 -49
- package/agents/ui/ui-layout-architect.md +65 -65
- package/agents/ui/ui-stack-implementer.md +68 -68
- package/agents/ui/ux-compliance-reviewer.md +81 -81
- package/agents/ui-previewer.md +258 -258
- package/commands/vibe.analyze.md +379 -379
- package/commands/vibe.review.md +607 -607
- package/commands/vibe.run.md +2124 -2124
- package/commands/vibe.spec.md +1195 -1195
- package/commands/vibe.spec.review.md +569 -569
- package/commands/vibe.utils.md +413 -413
- package/commands/vibe.verify.md +484 -484
- package/dist/cli/collaborator.js +52 -52
- package/dist/cli/commands/evolution.js +12 -12
- package/dist/cli/commands/info.js +51 -51
- package/dist/cli/commands/init.js +5 -5
- package/dist/cli/commands/remove.js +14 -14
- package/dist/cli/commands/sentinel.js +27 -27
- package/dist/cli/commands/skills.js +5 -5
- package/dist/cli/commands/slack.js +10 -10
- package/dist/cli/commands/telegram.js +12 -12
- package/dist/cli/commands/upgrade.d.ts +3 -3
- package/dist/cli/commands/upgrade.d.ts.map +1 -1
- package/dist/cli/commands/upgrade.js +24 -3
- package/dist/cli/commands/upgrade.js.map +1 -1
- package/dist/cli/detect.js +32 -32
- package/dist/cli/index.js +51 -51
- package/dist/cli/llm/claude-commands.js +16 -16
- package/dist/cli/llm/config.js +18 -18
- package/dist/cli/llm/gemini-commands.js +16 -16
- package/dist/cli/llm/gpt-commands.js +19 -19
- package/dist/cli/llm/help.js +21 -21
- package/dist/cli/postinstall/cursor-agents.js +32 -32
- package/dist/cli/postinstall/cursor-rules.js +83 -83
- package/dist/cli/postinstall/cursor-skills.js +743 -743
- package/dist/cli/setup/Provisioner.js +42 -42
- package/dist/infra/lib/DeepInit.js +24 -24
- package/dist/infra/lib/IterationTracker.js +11 -11
- package/dist/infra/lib/PythonParser.js +108 -108
- package/dist/infra/lib/ReviewRace.js +96 -96
- package/dist/infra/lib/SkillFrontmatter.js +28 -28
- package/dist/infra/lib/SkillQualityGate.js +9 -9
- package/dist/infra/lib/SkillRepository.js +159 -159
- package/dist/infra/lib/UltraQA.js +99 -99
- package/dist/infra/lib/autonomy/AuditStore.js +41 -41
- package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
- package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
- package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
- package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
- package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
- package/dist/infra/lib/embedding/VectorStore.js +22 -22
- package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
- package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
- package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
- package/dist/infra/lib/evolution/InsightStore.js +90 -90
- package/dist/infra/lib/evolution/RollbackManager.js +5 -5
- package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
- package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
- package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
- package/dist/infra/lib/evolution/UsageTracker.js +28 -28
- package/dist/infra/lib/gemini/orchestration.js +5 -5
- package/dist/infra/lib/gpt/orchestration.js +4 -4
- package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
- package/dist/infra/lib/memory/MemorySearch.js +57 -57
- package/dist/infra/lib/memory/MemoryStorage.js +181 -181
- package/dist/infra/lib/memory/ObservationStore.js +28 -28
- package/dist/infra/lib/memory/ReflectionStore.js +30 -30
- package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
- package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
- package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
- package/dist/infra/lib/telemetry/SkillTelemetry.d.ts +52 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.d.ts.map +1 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.js +117 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.js.map +1 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.test.d.ts +2 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.test.d.ts.map +1 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.test.js +91 -0
- package/dist/infra/lib/telemetry/SkillTelemetry.test.js.map +1 -0
- package/dist/infra/orchestrator/AgentManager.js +12 -12
- package/dist/infra/orchestrator/AgentRegistry.js +65 -65
- package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
- package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
- package/dist/infra/orchestrator/parallelResearch.js +24 -24
- package/dist/test-helpers/index.d.ts +36 -0
- package/dist/test-helpers/index.d.ts.map +1 -0
- package/dist/test-helpers/index.js +85 -0
- package/dist/test-helpers/index.js.map +1 -0
- package/dist/test-helpers/index.test.d.ts +2 -0
- package/dist/test-helpers/index.test.d.ts.map +1 -0
- package/dist/test-helpers/index.test.js +92 -0
- package/dist/test-helpers/index.test.js.map +1 -0
- package/dist/tools/convention/analyzeComplexity.test.js +115 -115
- package/dist/tools/convention/validateCodeQuality.test.js +104 -104
- package/dist/tools/memory/createMemoryTimeline.js +10 -10
- package/dist/tools/memory/getMemoryGraph.js +12 -12
- package/dist/tools/memory/getSessionContext.js +9 -9
- package/dist/tools/memory/linkMemories.js +14 -14
- package/dist/tools/memory/listMemories.js +4 -4
- package/dist/tools/memory/recallMemory.js +4 -4
- package/dist/tools/memory/saveMemory.js +4 -4
- package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
- package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
- package/dist/tools/semantic/astGrep.test.js +6 -6
- package/dist/tools/spec/prdParser.test.js +171 -171
- package/dist/tools/spec/specGenerator.js +169 -169
- package/dist/tools/spec/traceabilityMatrix.js +64 -64
- package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
- package/hooks/gemini-hooks.json +73 -73
- package/hooks/hooks.json +137 -137
- package/hooks/scripts/code-check.js +77 -77
- package/hooks/scripts/context-save.js +212 -212
- package/hooks/scripts/hud-status.js +291 -291
- package/hooks/scripts/keyword-detector.js +214 -214
- package/hooks/scripts/llm-orchestrate.js +475 -475
- package/hooks/scripts/post-edit.js +32 -32
- package/hooks/scripts/pre-tool-guard.js +125 -125
- package/hooks/scripts/prompt-dispatcher.js +185 -185
- package/hooks/scripts/sentinel-guard.js +104 -104
- package/hooks/scripts/session-start.js +106 -106
- package/hooks/scripts/stop-notify.js +209 -209
- package/hooks/scripts/utils.js +100 -100
- package/languages/csharp-unity.md +515 -515
- package/languages/gdscript-godot.md +470 -470
- package/languages/ruby-rails.md +489 -489
- package/languages/typescript-angular.md +433 -433
- package/languages/typescript-astro.md +416 -416
- package/languages/typescript-electron.md +406 -406
- package/languages/typescript-nestjs.md +524 -524
- package/languages/typescript-svelte.md +407 -407
- package/languages/typescript-tauri.md +365 -365
- package/package.json +123 -121
- package/skills/agents-md/SKILL.md +120 -120
- package/skills/arch-guard/SKILL.md +180 -180
- package/skills/brand-assets/SKILL.md +146 -146
- package/skills/capability-loop/SKILL.md +167 -167
- package/skills/characterization-test/SKILL.md +206 -206
- package/skills/commerce-patterns/SKILL.md +63 -63
- package/skills/commit-push-pr/SKILL.md +75 -75
- package/skills/context7-usage/SKILL.md +105 -105
- package/skills/core-capabilities/SKILL.md +13 -13
- package/skills/e2e-commerce/SKILL.md +61 -61
- package/skills/exec-plan/SKILL.md +147 -147
- package/skills/frontend-design/SKILL.md +12 -12
- package/skills/git-worktree/SKILL.md +72 -72
- package/skills/handoff/SKILL.md +109 -109
- package/skills/parallel-research/SKILL.md +87 -87
- package/skills/priority-todos/SKILL.md +63 -63
- package/skills/seo-checklist/SKILL.md +57 -57
- package/skills/techdebt/SKILL.md +122 -122
- package/skills/tool-fallback/SKILL.md +103 -103
- package/skills/typescript-advanced-types/SKILL.md +66 -66
- package/skills/ui-ux-pro-max/SKILL.md +221 -221
- package/skills/vercel-react-best-practices/SKILL.md +59 -59
- package/skills/video-production/SKILL.md +51 -51
- package/vibe/config.json +29 -29
- package/vibe/constitution.md +227 -227
- package/vibe/rules/principles/communication-guide.md +98 -98
- package/vibe/rules/principles/development-philosophy.md +52 -52
- package/vibe/rules/principles/quick-start.md +102 -102
- package/vibe/rules/quality/bdd-contract-testing.md +393 -393
- package/vibe/rules/quality/checklist.md +276 -276
- package/vibe/rules/quality/performance.md +236 -236
- package/vibe/rules/quality/testing-strategy.md +440 -440
- package/vibe/rules/standards/anti-patterns.md +541 -541
- package/vibe/rules/standards/code-structure.md +291 -291
- package/vibe/rules/standards/complexity-metrics.md +313 -313
- package/vibe/rules/standards/git-workflow.md +237 -237
- package/vibe/rules/standards/naming-conventions.md +198 -198
- package/vibe/rules/standards/security.md +305 -305
- package/vibe/rules/writing/document-style.md +74 -74
- package/vibe/setup.sh +31 -31
- package/vibe/templates/constitution-template.md +252 -252
- package/vibe/templates/contract-backend-template.md +526 -526
- package/vibe/templates/contract-frontend-template.md +599 -599
- package/vibe/templates/feature-template.md +96 -96
- package/vibe/templates/spec-template.md +221 -221
- package/vibe/ui-ux-data/charts.csv +26 -26
- package/vibe/ui-ux-data/colors.csv +97 -97
- package/vibe/ui-ux-data/icons.csv +101 -101
- package/vibe/ui-ux-data/landing.csv +31 -31
- package/vibe/ui-ux-data/products.csv +96 -96
- package/vibe/ui-ux-data/react-performance.csv +45 -45
- package/vibe/ui-ux-data/stacks/astro.csv +54 -54
- package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
- package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
- package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
- package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
- package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
- package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
- package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
- package/vibe/ui-ux-data/stacks/react.csv +54 -54
- package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
- package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
- package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
- package/vibe/ui-ux-data/stacks/vue.csv +50 -50
- package/vibe/ui-ux-data/styles.csv +68 -68
- package/vibe/ui-ux-data/typography.csv +57 -57
- package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
- package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
- package/vibe/ui-ux-data/version.json +31 -31
- package/vibe/ui-ux-data/web-interface.csv +31 -31
|
@@ -1,206 +1,206 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: characterization-test
|
|
3
|
-
description: "Lock existing behavior with characterization tests before modifying code."
|
|
4
|
-
triggers: [legacy, characterization test, lock behavior, regression prevention, before refactor, large file]
|
|
5
|
-
priority: 65
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Characterization Test Skill
|
|
9
|
-
|
|
10
|
-
> **Philosophy: "Never change what you cannot verify"**
|
|
11
|
-
|
|
12
|
-
Lock existing behavior with snapshot/characterization tests before modifying code. This prevents regressions in legacy, complex, or unfamiliar codebases.
|
|
13
|
-
|
|
14
|
-
## Pre-check (K1)
|
|
15
|
-
|
|
16
|
-
> Are you modifying existing code with uncertain behavior? If the code is new (you just wrote it), well-tested, or trivially simple, skip characterization tests and write regular unit tests instead.
|
|
17
|
-
|
|
18
|
-
## When to Use
|
|
19
|
-
|
|
20
|
-
| Scenario | Signal |
|
|
21
|
-
|----------|--------|
|
|
22
|
-
| Legacy file (>500 lines) | Large files with accumulated behavior |
|
|
23
|
-
| Complex branching | Multiple if/else, switch, ternary chains |
|
|
24
|
-
| API endpoint modification | Request/response contract must be preserved |
|
|
25
|
-
| Database schema change | Migration must preserve existing data semantics |
|
|
26
|
-
| Refactoring request | "refactor", "clean up", "simplify" keywords |
|
|
27
|
-
| Unfamiliar code | No prior context about the module |
|
|
28
|
-
|
|
29
|
-
## Core Workflow
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
ANALYZE → GENERATE → VERIFY → CHANGE → REGRESS → RECONCILE
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Step 1: ANALYZE
|
|
36
|
-
|
|
37
|
-
Explore the target code to understand its current behavior.
|
|
38
|
-
|
|
39
|
-
**Parallel exploration** (use sub-agents when available):
|
|
40
|
-
- Read the target file(s)
|
|
41
|
-
- Identify all public exports / API surface
|
|
42
|
-
- Map branching paths (if/else, switch, try/catch)
|
|
43
|
-
- List external dependencies and side effects
|
|
44
|
-
- Check for existing tests
|
|
45
|
-
|
|
46
|
-
**Analysis checklist:**
|
|
47
|
-
- [ ] All public functions identified
|
|
48
|
-
- [ ] Input parameter ranges documented
|
|
49
|
-
- [ ] Edge cases listed (null, empty, boundary values)
|
|
50
|
-
- [ ] Side effects cataloged (DB writes, file I/O, network calls)
|
|
51
|
-
- [ ] Error paths mapped
|
|
52
|
-
|
|
53
|
-
### Step 2: GENERATE
|
|
54
|
-
|
|
55
|
-
Create characterization tests that capture current behavior as-is.
|
|
56
|
-
|
|
57
|
-
**TypeScript template:**
|
|
58
|
-
```typescript
|
|
59
|
-
import { describe, it, expect } from 'vitest';
|
|
60
|
-
|
|
61
|
-
describe('[ModuleName] characterization tests', () => {
|
|
62
|
-
// Happy path - capture normal behavior
|
|
63
|
-
it('should [describe current behavior]', () => {
|
|
64
|
-
const result = targetFunction(normalInput);
|
|
65
|
-
// Snapshot the ACTUAL output, not what you THINK it should be
|
|
66
|
-
expect(result).toMatchSnapshot();
|
|
67
|
-
});
|
|
68
|
-
|
|
69
|
-
// Edge cases - capture boundary behavior
|
|
70
|
-
it('should handle empty input', () => {
|
|
71
|
-
const result = targetFunction('');
|
|
72
|
-
expect(result).toMatchSnapshot();
|
|
73
|
-
});
|
|
74
|
-
|
|
75
|
-
// Error paths - capture failure modes
|
|
76
|
-
it('should handle invalid input', () => {
|
|
77
|
-
expect(() => targetFunction(null)).toThrowErrorMatchingSnapshot();
|
|
78
|
-
});
|
|
79
|
-
});
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
**Python template:**
|
|
83
|
-
```python
|
|
84
|
-
import pytest
|
|
85
|
-
|
|
86
|
-
class TestModuleNameCharacterization:
|
|
87
|
-
"""Lock existing behavior before modification."""
|
|
88
|
-
|
|
89
|
-
def test_normal_behavior(self, snapshot):
|
|
90
|
-
result = target_function(normal_input)
|
|
91
|
-
assert result == snapshot
|
|
92
|
-
|
|
93
|
-
def test_empty_input(self, snapshot):
|
|
94
|
-
result = target_function("")
|
|
95
|
-
assert result == snapshot
|
|
96
|
-
|
|
97
|
-
def test_invalid_input(self):
|
|
98
|
-
with pytest.raises(Exception) as exc_info:
|
|
99
|
-
target_function(None)
|
|
100
|
-
assert str(exc_info.value) # Capture error message
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
**Key principles:**
|
|
104
|
-
- Test ACTUAL behavior, not expected behavior
|
|
105
|
-
- Use `toMatchSnapshot()` / snapshot assertions
|
|
106
|
-
- Cover every public function
|
|
107
|
-
- Include edge cases and error paths
|
|
108
|
-
- Do NOT fix bugs in characterization tests
|
|
109
|
-
|
|
110
|
-
### Step 3: VERIFY
|
|
111
|
-
|
|
112
|
-
Run the characterization tests to confirm they pass with current code.
|
|
113
|
-
|
|
114
|
-
```bash
|
|
115
|
-
# TypeScript
|
|
116
|
-
npx vitest run --reporter=verbose [test-file]
|
|
117
|
-
|
|
118
|
-
# Python
|
|
119
|
-
pytest -v [test-file]
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
- All tests MUST pass before proceeding
|
|
123
|
-
- If any test fails, the characterization is wrong — fix the test, not the code
|
|
124
|
-
- Update snapshots if needed: `npx vitest run -u [test-file]`
|
|
125
|
-
|
|
126
|
-
### Step 4: CHANGE
|
|
127
|
-
|
|
128
|
-
Now implement the requested modification.
|
|
129
|
-
|
|
130
|
-
- Make changes incrementally
|
|
131
|
-
- Run characterization tests after each change
|
|
132
|
-
- Any unexpected test failure = potential regression
|
|
133
|
-
|
|
134
|
-
### Step 5: REGRESS
|
|
135
|
-
|
|
136
|
-
Run full characterization test suite after all changes.
|
|
137
|
-
|
|
138
|
-
```bash
|
|
139
|
-
npx vitest run [characterization-test-file]
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
- **All passing**: Changes preserve existing behavior
|
|
143
|
-
- **Expected failures**: Tests for intentionally changed behavior
|
|
144
|
-
- **Unexpected failures**: STOP — investigate regression
|
|
145
|
-
|
|
146
|
-
### Step 6: RECONCILE
|
|
147
|
-
|
|
148
|
-
Update characterization tests to match new intended behavior.
|
|
149
|
-
|
|
150
|
-
- Review each failing test individually
|
|
151
|
-
- Confirm the failure is due to intentional change
|
|
152
|
-
- Update snapshot: `npx vitest run -u`
|
|
153
|
-
- Add NEW tests for new behavior
|
|
154
|
-
- Document why each test changed
|
|
155
|
-
|
|
156
|
-
## Scenario-Specific Workflows
|
|
157
|
-
|
|
158
|
-
### Legacy File (>500 lines)
|
|
159
|
-
|
|
160
|
-
1. Generate function-level characterization tests
|
|
161
|
-
2. Focus on public API surface first
|
|
162
|
-
3. Add integration tests for cross-function flows
|
|
163
|
-
4. Refactor in small increments
|
|
164
|
-
|
|
165
|
-
### Complex Branching
|
|
166
|
-
|
|
167
|
-
1. Map all branches with a decision tree
|
|
168
|
-
2. Write one test per branch path
|
|
169
|
-
3. Include boundary values for each condition
|
|
170
|
-
4. Test combinations of related conditions
|
|
171
|
-
|
|
172
|
-
### API Endpoint
|
|
173
|
-
|
|
174
|
-
1. Capture request/response pairs for all routes
|
|
175
|
-
2. Test all HTTP methods, status codes, headers
|
|
176
|
-
3. Include authentication/authorization paths
|
|
177
|
-
4. Test error responses and validation messages
|
|
178
|
-
|
|
179
|
-
### Database Schema
|
|
180
|
-
|
|
181
|
-
1. Create fixtures with representative data
|
|
182
|
-
2. Test queries before and after migration
|
|
183
|
-
3. Verify data integrity post-migration
|
|
184
|
-
4. Test rollback scenarios
|
|
185
|
-
|
|
186
|
-
## Integration with VIBE Workflow
|
|
187
|
-
|
|
188
|
-
### With `/vibe.spec`
|
|
189
|
-
Add characterization test phase to SPEC before implementation:
|
|
190
|
-
```
|
|
191
|
-
## Pre-Implementation
|
|
192
|
-
- [ ] Characterization tests written for affected modules
|
|
193
|
-
- [ ] All characterization tests passing
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
### With `/vibe.run`
|
|
197
|
-
The implementation agent should:
|
|
198
|
-
1. Check for characterization tests before modifying files
|
|
199
|
-
2. Run them before and after changes
|
|
200
|
-
3. Flag any unexpected failures
|
|
201
|
-
|
|
202
|
-
### With `/vibe.review`
|
|
203
|
-
Review agents verify:
|
|
204
|
-
- Characterization tests exist for modified legacy code
|
|
205
|
-
- No regressions in existing behavior
|
|
206
|
-
- New behavior has corresponding new tests
|
|
1
|
+
---
|
|
2
|
+
name: characterization-test
|
|
3
|
+
description: "Lock existing behavior with characterization tests before modifying code."
|
|
4
|
+
triggers: [legacy, characterization test, lock behavior, regression prevention, before refactor, large file]
|
|
5
|
+
priority: 65
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Characterization Test Skill
|
|
9
|
+
|
|
10
|
+
> **Philosophy: "Never change what you cannot verify"**
|
|
11
|
+
|
|
12
|
+
Lock existing behavior with snapshot/characterization tests before modifying code. This prevents regressions in legacy, complex, or unfamiliar codebases.
|
|
13
|
+
|
|
14
|
+
## Pre-check (K1)
|
|
15
|
+
|
|
16
|
+
> Are you modifying existing code with uncertain behavior? If the code is new (you just wrote it), well-tested, or trivially simple, skip characterization tests and write regular unit tests instead.
|
|
17
|
+
|
|
18
|
+
## When to Use
|
|
19
|
+
|
|
20
|
+
| Scenario | Signal |
|
|
21
|
+
|----------|--------|
|
|
22
|
+
| Legacy file (>500 lines) | Large files with accumulated behavior |
|
|
23
|
+
| Complex branching | Multiple if/else, switch, ternary chains |
|
|
24
|
+
| API endpoint modification | Request/response contract must be preserved |
|
|
25
|
+
| Database schema change | Migration must preserve existing data semantics |
|
|
26
|
+
| Refactoring request | "refactor", "clean up", "simplify" keywords |
|
|
27
|
+
| Unfamiliar code | No prior context about the module |
|
|
28
|
+
|
|
29
|
+
## Core Workflow
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
ANALYZE → GENERATE → VERIFY → CHANGE → REGRESS → RECONCILE
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Step 1: ANALYZE
|
|
36
|
+
|
|
37
|
+
Explore the target code to understand its current behavior.
|
|
38
|
+
|
|
39
|
+
**Parallel exploration** (use sub-agents when available):
|
|
40
|
+
- Read the target file(s)
|
|
41
|
+
- Identify all public exports / API surface
|
|
42
|
+
- Map branching paths (if/else, switch, try/catch)
|
|
43
|
+
- List external dependencies and side effects
|
|
44
|
+
- Check for existing tests
|
|
45
|
+
|
|
46
|
+
**Analysis checklist:**
|
|
47
|
+
- [ ] All public functions identified
|
|
48
|
+
- [ ] Input parameter ranges documented
|
|
49
|
+
- [ ] Edge cases listed (null, empty, boundary values)
|
|
50
|
+
- [ ] Side effects cataloged (DB writes, file I/O, network calls)
|
|
51
|
+
- [ ] Error paths mapped
|
|
52
|
+
|
|
53
|
+
### Step 2: GENERATE
|
|
54
|
+
|
|
55
|
+
Create characterization tests that capture current behavior as-is.
|
|
56
|
+
|
|
57
|
+
**TypeScript template:**
|
|
58
|
+
```typescript
|
|
59
|
+
import { describe, it, expect } from 'vitest';
|
|
60
|
+
|
|
61
|
+
describe('[ModuleName] characterization tests', () => {
|
|
62
|
+
// Happy path - capture normal behavior
|
|
63
|
+
it('should [describe current behavior]', () => {
|
|
64
|
+
const result = targetFunction(normalInput);
|
|
65
|
+
// Snapshot the ACTUAL output, not what you THINK it should be
|
|
66
|
+
expect(result).toMatchSnapshot();
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
// Edge cases - capture boundary behavior
|
|
70
|
+
it('should handle empty input', () => {
|
|
71
|
+
const result = targetFunction('');
|
|
72
|
+
expect(result).toMatchSnapshot();
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
// Error paths - capture failure modes
|
|
76
|
+
it('should handle invalid input', () => {
|
|
77
|
+
expect(() => targetFunction(null)).toThrowErrorMatchingSnapshot();
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Python template:**
|
|
83
|
+
```python
|
|
84
|
+
import pytest
|
|
85
|
+
|
|
86
|
+
class TestModuleNameCharacterization:
|
|
87
|
+
"""Lock existing behavior before modification."""
|
|
88
|
+
|
|
89
|
+
def test_normal_behavior(self, snapshot):
|
|
90
|
+
result = target_function(normal_input)
|
|
91
|
+
assert result == snapshot
|
|
92
|
+
|
|
93
|
+
def test_empty_input(self, snapshot):
|
|
94
|
+
result = target_function("")
|
|
95
|
+
assert result == snapshot
|
|
96
|
+
|
|
97
|
+
def test_invalid_input(self):
|
|
98
|
+
with pytest.raises(Exception) as exc_info:
|
|
99
|
+
target_function(None)
|
|
100
|
+
assert str(exc_info.value) # Capture error message
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**Key principles:**
|
|
104
|
+
- Test ACTUAL behavior, not expected behavior
|
|
105
|
+
- Use `toMatchSnapshot()` / snapshot assertions
|
|
106
|
+
- Cover every public function
|
|
107
|
+
- Include edge cases and error paths
|
|
108
|
+
- Do NOT fix bugs in characterization tests
|
|
109
|
+
|
|
110
|
+
### Step 3: VERIFY
|
|
111
|
+
|
|
112
|
+
Run the characterization tests to confirm they pass with current code.
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
# TypeScript
|
|
116
|
+
npx vitest run --reporter=verbose [test-file]
|
|
117
|
+
|
|
118
|
+
# Python
|
|
119
|
+
pytest -v [test-file]
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
- All tests MUST pass before proceeding
|
|
123
|
+
- If any test fails, the characterization is wrong — fix the test, not the code
|
|
124
|
+
- Update snapshots if needed: `npx vitest run -u [test-file]`
|
|
125
|
+
|
|
126
|
+
### Step 4: CHANGE
|
|
127
|
+
|
|
128
|
+
Now implement the requested modification.
|
|
129
|
+
|
|
130
|
+
- Make changes incrementally
|
|
131
|
+
- Run characterization tests after each change
|
|
132
|
+
- Any unexpected test failure = potential regression
|
|
133
|
+
|
|
134
|
+
### Step 5: REGRESS
|
|
135
|
+
|
|
136
|
+
Run full characterization test suite after all changes.
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
npx vitest run [characterization-test-file]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
- **All passing**: Changes preserve existing behavior
|
|
143
|
+
- **Expected failures**: Tests for intentionally changed behavior
|
|
144
|
+
- **Unexpected failures**: STOP — investigate regression
|
|
145
|
+
|
|
146
|
+
### Step 6: RECONCILE
|
|
147
|
+
|
|
148
|
+
Update characterization tests to match new intended behavior.
|
|
149
|
+
|
|
150
|
+
- Review each failing test individually
|
|
151
|
+
- Confirm the failure is due to intentional change
|
|
152
|
+
- Update snapshot: `npx vitest run -u`
|
|
153
|
+
- Add NEW tests for new behavior
|
|
154
|
+
- Document why each test changed
|
|
155
|
+
|
|
156
|
+
## Scenario-Specific Workflows
|
|
157
|
+
|
|
158
|
+
### Legacy File (>500 lines)
|
|
159
|
+
|
|
160
|
+
1. Generate function-level characterization tests
|
|
161
|
+
2. Focus on public API surface first
|
|
162
|
+
3. Add integration tests for cross-function flows
|
|
163
|
+
4. Refactor in small increments
|
|
164
|
+
|
|
165
|
+
### Complex Branching
|
|
166
|
+
|
|
167
|
+
1. Map all branches with a decision tree
|
|
168
|
+
2. Write one test per branch path
|
|
169
|
+
3. Include boundary values for each condition
|
|
170
|
+
4. Test combinations of related conditions
|
|
171
|
+
|
|
172
|
+
### API Endpoint
|
|
173
|
+
|
|
174
|
+
1. Capture request/response pairs for all routes
|
|
175
|
+
2. Test all HTTP methods, status codes, headers
|
|
176
|
+
3. Include authentication/authorization paths
|
|
177
|
+
4. Test error responses and validation messages
|
|
178
|
+
|
|
179
|
+
### Database Schema
|
|
180
|
+
|
|
181
|
+
1. Create fixtures with representative data
|
|
182
|
+
2. Test queries before and after migration
|
|
183
|
+
3. Verify data integrity post-migration
|
|
184
|
+
4. Test rollback scenarios
|
|
185
|
+
|
|
186
|
+
## Integration with VIBE Workflow
|
|
187
|
+
|
|
188
|
+
### With `/vibe.spec`
|
|
189
|
+
Add characterization test phase to SPEC before implementation:
|
|
190
|
+
```
|
|
191
|
+
## Pre-Implementation
|
|
192
|
+
- [ ] Characterization tests written for affected modules
|
|
193
|
+
- [ ] All characterization tests passing
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### With `/vibe.run`
|
|
197
|
+
The implementation agent should:
|
|
198
|
+
1. Check for characterization tests before modifying files
|
|
199
|
+
2. Run them before and after changes
|
|
200
|
+
3. Flag any unexpected failures
|
|
201
|
+
|
|
202
|
+
### With `/vibe.review`
|
|
203
|
+
Review agents verify:
|
|
204
|
+
- Characterization tests exist for modified legacy code
|
|
205
|
+
- No regressions in existing behavior
|
|
206
|
+
- New behavior has corresponding new tests
|
|
@@ -1,63 +1,63 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: commerce-patterns
|
|
3
|
-
description: "E-commerce domain patterns - cart, payment, inventory with transaction safety"
|
|
4
|
-
triggers: [commerce, ecommerce, cart, payment, checkout, inventory, stock, order, pg, toss, stripe]
|
|
5
|
-
priority: 70
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Commerce Patterns
|
|
9
|
-
|
|
10
|
-
## Pre-check (K1)
|
|
11
|
-
|
|
12
|
-
> Is this an e-commerce transaction flow? If building simple CRUD without payment/stock management, this skill is not needed.
|
|
13
|
-
|
|
14
|
-
## Gotchas & Traps
|
|
15
|
-
|
|
16
|
-
These are the non-obvious failure modes LLMs typically miss:
|
|
17
|
-
|
|
18
|
-
### Payment
|
|
19
|
-
|
|
20
|
-
| Trap | Consequence | Prevention |
|
|
21
|
-
|------|-------------|------------|
|
|
22
|
-
| No idempotency key | User double-clicks → charged twice | `idempotencyKey: order_${orderId}_${timestamp}` on every payment request |
|
|
23
|
-
| Webhook not idempotent | Retry delivers duplicate events | Check `eventId` before processing, store processed events |
|
|
24
|
-
| Missing webhook signature verification | Attacker forges payment confirmation | Always verify HMAC signature before processing |
|
|
25
|
-
| No payment state machine | Order stuck in limbo | `PENDING → PROCESSING → AUTHORIZED → CAPTURED → COMPLETED` (+ FAILED, CANCELED, REFUNDED) |
|
|
26
|
-
|
|
27
|
-
### Inventory
|
|
28
|
-
|
|
29
|
-
| Trap | Consequence | Prevention |
|
|
30
|
-
|------|-------------|------------|
|
|
31
|
-
| Non-atomic stock decrement | Race condition → negative stock | `UPDATE SET stock = stock - $1 WHERE stock >= $1` (atomic with check) |
|
|
32
|
-
| No reservation TTL | Stock locked forever on abandoned checkout | 15-min reservation + scheduled cleanup job |
|
|
33
|
-
| Commit without reservation | Stock sold twice | Two-phase: RESERVE (checkout start) → COMMIT (payment success) / RELEASE (failure) |
|
|
34
|
-
| Optimistic lock without retry | Fails silently under contention | Use `version` column or `FOR UPDATE` for high-contention products |
|
|
35
|
-
|
|
36
|
-
### Cart & Pricing
|
|
37
|
-
|
|
38
|
-
| Trap | Consequence | Prevention |
|
|
39
|
-
|------|-------------|------------|
|
|
40
|
-
| No price snapshot | Price changes between add and checkout | Store `price` at add time, revalidate at checkout entry |
|
|
41
|
-
| No guest→user cart merge | Guest loses cart on login | Merge by `sessionId` on login, user cart takes priority for duplicates |
|
|
42
|
-
| No cart expiration | Abandoned carts accumulate forever | TTL-based cleanup (e.g., 7 days) |
|
|
43
|
-
|
|
44
|
-
## Checkout Flow (Reference)
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
Cart Validation → Order Creation (PENDING) → Stock Reservation (15min) → Payment
|
|
48
|
-
├─ Success → Order PAID, Stock COMMIT, Send Confirmation
|
|
49
|
-
└─ Failure → Order FAILED, Stock RELEASE
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## Related
|
|
53
|
-
|
|
54
|
-
See `e2e-commerce` skill for test scenarios covering these patterns (P0 duplicate payment, stock release on failure, etc.).
|
|
55
|
-
|
|
56
|
-
## Done Criteria (K4)
|
|
57
|
-
|
|
58
|
-
- [ ] Idempotency key on all payment requests
|
|
59
|
-
- [ ] Webhook handler is idempotent (dedup by eventId)
|
|
60
|
-
- [ ] Stock updates are atomic (SQL-level check)
|
|
61
|
-
- [ ] Two-phase reservation implemented with TTL
|
|
62
|
-
- [ ] Prices snapshot at cart add, revalidated at checkout
|
|
63
|
-
- [ ] Payment state machine covers all transitions
|
|
1
|
+
---
|
|
2
|
+
name: commerce-patterns
|
|
3
|
+
description: "E-commerce domain patterns - cart, payment, inventory with transaction safety"
|
|
4
|
+
triggers: [commerce, ecommerce, cart, payment, checkout, inventory, stock, order, pg, toss, stripe]
|
|
5
|
+
priority: 70
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Commerce Patterns
|
|
9
|
+
|
|
10
|
+
## Pre-check (K1)
|
|
11
|
+
|
|
12
|
+
> Is this an e-commerce transaction flow? If building simple CRUD without payment/stock management, this skill is not needed.
|
|
13
|
+
|
|
14
|
+
## Gotchas & Traps
|
|
15
|
+
|
|
16
|
+
These are the non-obvious failure modes LLMs typically miss:
|
|
17
|
+
|
|
18
|
+
### Payment
|
|
19
|
+
|
|
20
|
+
| Trap | Consequence | Prevention |
|
|
21
|
+
|------|-------------|------------|
|
|
22
|
+
| No idempotency key | User double-clicks → charged twice | `idempotencyKey: order_${orderId}_${timestamp}` on every payment request |
|
|
23
|
+
| Webhook not idempotent | Retry delivers duplicate events | Check `eventId` before processing, store processed events |
|
|
24
|
+
| Missing webhook signature verification | Attacker forges payment confirmation | Always verify HMAC signature before processing |
|
|
25
|
+
| No payment state machine | Order stuck in limbo | `PENDING → PROCESSING → AUTHORIZED → CAPTURED → COMPLETED` (+ FAILED, CANCELED, REFUNDED) |
|
|
26
|
+
|
|
27
|
+
### Inventory
|
|
28
|
+
|
|
29
|
+
| Trap | Consequence | Prevention |
|
|
30
|
+
|------|-------------|------------|
|
|
31
|
+
| Non-atomic stock decrement | Race condition → negative stock | `UPDATE SET stock = stock - $1 WHERE stock >= $1` (atomic with check) |
|
|
32
|
+
| No reservation TTL | Stock locked forever on abandoned checkout | 15-min reservation + scheduled cleanup job |
|
|
33
|
+
| Commit without reservation | Stock sold twice | Two-phase: RESERVE (checkout start) → COMMIT (payment success) / RELEASE (failure) |
|
|
34
|
+
| Optimistic lock without retry | Fails silently under contention | Use `version` column or `FOR UPDATE` for high-contention products |
|
|
35
|
+
|
|
36
|
+
### Cart & Pricing
|
|
37
|
+
|
|
38
|
+
| Trap | Consequence | Prevention |
|
|
39
|
+
|------|-------------|------------|
|
|
40
|
+
| No price snapshot | Price changes between add and checkout | Store `price` at add time, revalidate at checkout entry |
|
|
41
|
+
| No guest→user cart merge | Guest loses cart on login | Merge by `sessionId` on login, user cart takes priority for duplicates |
|
|
42
|
+
| No cart expiration | Abandoned carts accumulate forever | TTL-based cleanup (e.g., 7 days) |
|
|
43
|
+
|
|
44
|
+
## Checkout Flow (Reference)
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Cart Validation → Order Creation (PENDING) → Stock Reservation (15min) → Payment
|
|
48
|
+
├─ Success → Order PAID, Stock COMMIT, Send Confirmation
|
|
49
|
+
└─ Failure → Order FAILED, Stock RELEASE
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Related
|
|
53
|
+
|
|
54
|
+
See `e2e-commerce` skill for test scenarios covering these patterns (P0 duplicate payment, stock release on failure, etc.).
|
|
55
|
+
|
|
56
|
+
## Done Criteria (K4)
|
|
57
|
+
|
|
58
|
+
- [ ] Idempotency key on all payment requests
|
|
59
|
+
- [ ] Webhook handler is idempotent (dedup by eventId)
|
|
60
|
+
- [ ] Stock updates are atomic (SQL-level check)
|
|
61
|
+
- [ ] Two-phase reservation implemented with TTL
|
|
62
|
+
- [ ] Prices snapshot at cart add, revalidated at checkout
|
|
63
|
+
- [ ] Payment state machine covers all transitions
|