@su-record/vibe 3.2.1 → 3.2.2
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/CLAUDE.md +1 -1
- package/README.en.md +4 -4
- package/README.md +4 -4
- package/dist/__tests__/skill-namespace.test.d.ts +2 -0
- package/dist/__tests__/skill-namespace.test.d.ts.map +1 -0
- package/dist/__tests__/skill-namespace.test.js +60 -0
- package/dist/__tests__/skill-namespace.test.js.map +1 -0
- package/dist/__tests__/wiring-integrity.test.js +5 -5
- package/dist/__tests__/wiring-integrity.test.js.map +1 -1
- package/dist/cli/generate-release-notes.d.ts +3 -0
- package/dist/cli/generate-release-notes.d.ts.map +1 -0
- package/dist/cli/generate-release-notes.js +47 -0
- package/dist/cli/generate-release-notes.js.map +1 -0
- package/dist/cli/postinstall/constants.d.ts +6 -6
- package/dist/cli/postinstall/constants.d.ts.map +1 -1
- package/dist/cli/postinstall/constants.js +114 -46
- package/dist/cli/postinstall/constants.js.map +1 -1
- package/dist/cli/postinstall/fs-utils.d.ts +1 -0
- package/dist/cli/postinstall/fs-utils.d.ts.map +1 -1
- package/dist/cli/postinstall/fs-utils.js +25 -0
- package/dist/cli/postinstall/fs-utils.js.map +1 -1
- package/dist/cli/postinstall/fs-utils.test.js +46 -11
- package/dist/cli/postinstall/fs-utils.test.js.map +1 -1
- package/dist/cli/postinstall/main.d.ts.map +1 -1
- package/dist/cli/postinstall/main.js +3 -2
- package/dist/cli/postinstall/main.js.map +1 -1
- package/dist/tests/curated-release-notes.test.d.ts +2 -0
- package/dist/tests/curated-release-notes.test.d.ts.map +1 -0
- package/dist/tests/curated-release-notes.test.js +106 -0
- package/dist/tests/curated-release-notes.test.js.map +1 -0
- package/dist/tools/release/releaseNotes.d.ts +21 -0
- package/dist/tools/release/releaseNotes.d.ts.map +1 -0
- package/dist/tools/release/releaseNotes.js +105 -0
- package/dist/tools/release/releaseNotes.js.map +1 -0
- package/hooks/scripts/__tests__/.vibe/command-log.txt +3 -3
- package/package.json +2 -2
- package/skills/{agents-md → vibe.agents-md}/SKILL.md +1 -1
- package/skills/{brand-assets → vibe.brand-assets}/SKILL.md +1 -1
- package/skills/{capability-loop → vibe.capability-loop}/SKILL.md +1 -1
- package/skills/{chub-usage → vibe.chub-usage}/SKILL.md +1 -1
- package/skills/vibe.clone/SKILL.md +295 -3
- package/skills/{commerce-patterns → vibe.commerce-patterns}/SKILL.md +1 -1
- package/skills/{commit-push-pr → vibe.commit-push-pr}/SKILL.md +2 -2
- package/skills/{context7-usage → vibe.context7-usage}/SKILL.md +1 -1
- package/skills/vibe.contract/SKILL.md +162 -1
- package/skills/{create-prd → vibe.create-prd}/SKILL.md +2 -2
- package/skills/{design-refine → vibe.design-refine}/SKILL.md +1 -1
- package/skills/{design-review → vibe.design-review}/SKILL.md +1 -1
- package/skills/{design-teach → vibe.design-teach}/SKILL.md +1 -1
- package/skills/{devlog → vibe.devlog}/SKILL.md +1 -1
- package/skills/vibe.docs/SKILL.md +256 -1
- package/skills/{e2e-commerce → vibe.e2e-commerce}/SKILL.md +1 -1
- package/skills/vibe.educational-content/SKILL.md +157 -0
- package/skills/vibe.educational-content/references/learning-design.md +81 -0
- package/skills/vibe.educational-content/references/output-patterns.md +109 -0
- package/skills/vibe.educational-content/references/source-method.md +40 -0
- package/skills/{event-comms → vibe.event-comms}/SKILL.md +1 -1
- package/skills/{event-ops → vibe.event-ops}/SKILL.md +1 -1
- package/skills/{event-planning → vibe.event-planning}/SKILL.md +1 -1
- package/skills/vibe.figma/SKILL.md +473 -21
- package/skills/vibe.figma/references/branch-phases.md +1 -1
- package/skills/{git-worktree → vibe.git-worktree}/SKILL.md +1 -1
- package/skills/{handoff → vibe.handoff}/SKILL.md +1 -1
- package/skills/{parallel-research → vibe.parallel-research}/SKILL.md +2 -2
- package/skills/{presentation → vibe.presentation}/SKILL.md +1 -1
- package/skills/{prioritization-frameworks → vibe.prioritization}/SKILL.md +2 -2
- package/skills/{priority-todos → vibe.priority-todos}/SKILL.md +1 -1
- package/skills/{vercel-react-best-practices → vibe.react-best-practices}/SKILL.md +1 -1
- package/skills/vibe.regress/SKILL.md +182 -2
- package/skills/vibe.run/SKILL.md +388 -1
- package/skills/{arch-guard → vibe.run/internal/arch-guard}/templates/violation-report.md +1 -1
- package/skills/{seo-checklist → vibe.seo-checklist}/SKILL.md +1 -1
- package/skills/vibe.spec/SKILL.md +122 -1
- package/skills/vibe.test/SKILL.md +138 -2
- package/skills/{tool-fallback → vibe.tool-fallback}/SKILL.md +1 -1
- package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/SKILL.md +6 -6
- package/skills/{user-personas → vibe.user-personas}/SKILL.md +2 -2
- package/skills/vibe.verify/SKILL.md +2 -2
- package/skills/{video-production → vibe.video-production}/SKILL.md +1 -1
- package/skills/arch-guard/SKILL.md +0 -183
- package/skills/clone/SKILL.md +0 -296
- package/skills/contract/SKILL.md +0 -165
- package/skills/docs/SKILL.md +0 -259
- package/skills/exec-plan/SKILL.md +0 -151
- package/skills/figma/SKILL.md +0 -456
- package/skills/regress/SKILL.md +0 -184
- package/skills/restraint/SKILL.md +0 -72
- package/skills/spec/SKILL.md +0 -125
- package/skills/test/SKILL.md +0 -140
- /package/skills/{agents-md → vibe.agents-md}/rubrics/what-to-keep.md +0 -0
- /package/skills/{agents-md → vibe.agents-md}/templates/agents-md.md +0 -0
- /package/skills/{agents-md → vibe.agents-md}/templates/claude-md.md +0 -0
- /package/skills/{brand-assets → vibe.brand-assets}/rubrics/asset-checklist.md +0 -0
- /package/skills/{brand-assets → vibe.brand-assets}/templates/brand-guide.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/agents/capability-designer.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/agents/failure-analyst.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/agents/implementer.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/agents/tester.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/templates/capability-spec.md +0 -0
- /package/skills/{capability-loop → vibe.capability-loop}/templates/failure-analysis.md +0 -0
- /package/skills/{clone → vibe.clone}/references/capture-rules.md +0 -0
- /package/skills/{clone → vibe.clone}/references/legal-and-error-recovery.md +0 -0
- /package/skills/{clone → vibe.clone}/references/refine-rules.md +0 -0
- /package/skills/{clone → vibe.clone}/references/scaffold-phases.md +0 -0
- /package/skills/{clone → vibe.clone}/references/setup-and-layout.md +0 -0
- /package/skills/{commerce-patterns → vibe.commerce-patterns}/rubrics/checkout-flow.md +0 -0
- /package/skills/{commerce-patterns → vibe.commerce-patterns}/templates/product-schema.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/agents/change-analyzer.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/agents/message-writer.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/agents/pr-writer.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/agents/reviewer.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/rubrics/commit-message.md +0 -0
- /package/skills/{commit-push-pr → vibe.commit-push-pr}/templates/pr-body.md +0 -0
- /package/skills/{context7-usage → vibe.context7-usage}/rubrics/when-to-use.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/agents/edge-case-finder.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/agents/prioritizer.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/agents/requirements-writer.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/agents/researcher.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/agents/reviewer.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/frameworks/jobs-to-be-done.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/frameworks/rice-scoring.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/orchestrator.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/rubrics/completeness.md +0 -0
- /package/skills/{create-prd → vibe.create-prd}/templates/prd.md +0 -0
- /package/skills/{design-refine → vibe.design-refine}/rubrics/polish-checklist.md +0 -0
- /package/skills/{design-refine → vibe.design-refine}/rubrics/token-naming.md +0 -0
- /package/skills/{design-refine → vibe.design-refine}/templates/design-system.md +0 -0
- /package/skills/{design-refine → vibe.design-refine}/templates/polish-report.md +0 -0
- /package/skills/{design-refine → vibe.design-refine}/templates/token-audit.md +0 -0
- /package/skills/{design-review → vibe.design-review}/agents/a11y-auditor.md +0 -0
- /package/skills/{design-review → vibe.design-review}/agents/performance-auditor.md +0 -0
- /package/skills/{design-review → vibe.design-review}/agents/responsive-auditor.md +0 -0
- /package/skills/{design-review → vibe.design-review}/agents/scorer.md +0 -0
- /package/skills/{design-review → vibe.design-review}/agents/slop-detector.md +0 -0
- /package/skills/{design-review → vibe.design-review}/frameworks/core-web-vitals.md +0 -0
- /package/skills/{design-review → vibe.design-review}/frameworks/wcag-checklist.md +0 -0
- /package/skills/{design-review → vibe.design-review}/orchestrator.md +0 -0
- /package/skills/{design-review → vibe.design-review}/rubrics/ai-slop-patterns.md +0 -0
- /package/skills/{design-review → vibe.design-review}/rubrics/scoring.md +0 -0
- /package/skills/{design-review → vibe.design-review}/rubrics/ux-heuristics.md +0 -0
- /package/skills/{design-review → vibe.design-review}/templates/critique-report.md +0 -0
- /package/skills/{design-review → vibe.design-review}/templates/report.md +0 -0
- /package/skills/{design-teach → vibe.design-teach}/rubrics/brand-personality.md +0 -0
- /package/skills/{design-teach → vibe.design-teach}/templates/design-context.json +0 -0
- /package/skills/{docs → vibe.docs}/references/api-docs-changelog.md +0 -0
- /package/skills/{docs → vibe.docs}/references/codemaps-output.md +0 -0
- /package/skills/{docs → vibe.docs}/references/diagram-spec.md +0 -0
- /package/skills/{docs → vibe.docs}/templates/architecture.md +0 -0
- /package/skills/{docs → vibe.docs}/templates/behavioral-principles.md +0 -0
- /package/skills/{docs → vibe.docs}/templates/readme.md +0 -0
- /package/skills/{docs → vibe.docs}/templates/release-notes.md +0 -0
- /package/skills/{e2e-commerce → vibe.e2e-commerce}/templates/test-scenarios.md +0 -0
- /package/skills/{event-comms → vibe.event-comms}/templates/email-invite.md +0 -0
- /package/skills/{event-comms → vibe.event-comms}/templates/sns-post.md +0 -0
- /package/skills/{event-ops → vibe.event-ops}/rubrics/contingency.md +0 -0
- /package/skills/{event-ops → vibe.event-ops}/templates/d-day-checklist.md +0 -0
- /package/skills/{event-planning → vibe.event-planning}/rubrics/timeline.md +0 -0
- /package/skills/{event-planning → vibe.event-planning}/templates/event-plan.md +0 -0
- /package/skills/{figma → vibe.figma}/rubrics/conversion-rules.md +0 -0
- /package/skills/{figma → vibe.figma}/rubrics/css-mapping.md +0 -0
- /package/skills/{figma → vibe.figma}/rubrics/extraction-checklist.md +0 -0
- /package/skills/{figma → vibe.figma}/rubrics/image-rules.md +0 -0
- /package/skills/{figma → vibe.figma}/templates/component-index.md +0 -0
- /package/skills/{figma → vibe.figma}/templates/component-spec.md +0 -0
- /package/skills/{figma → vibe.figma}/templates/component.md +0 -0
- /package/skills/{figma → vibe.figma}/templates/figma-handoff.md +0 -0
- /package/skills/{figma → vibe.figma}/templates/remapped-tree.md +0 -0
- /package/skills/{git-worktree → vibe.git-worktree}/rubrics/when-to-use.md +0 -0
- /package/skills/{handoff → vibe.handoff}/agents/context-summarizer.md +0 -0
- /package/skills/{handoff → vibe.handoff}/agents/document-writer.md +0 -0
- /package/skills/{handoff → vibe.handoff}/agents/state-collector.md +0 -0
- /package/skills/{handoff → vibe.handoff}/agents/verifier.md +0 -0
- /package/skills/{handoff → vibe.handoff}/rubrics/completeness.md +0 -0
- /package/skills/{handoff → vibe.handoff}/templates/handoff.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/agents/best-practices.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/agents/codebase-patterns.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/agents/framework-docs.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/agents/security-advisory.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/agents/synthesizer.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/experts/best-practices.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/experts/codebase-patterns.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/experts/framework-docs.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/experts/security-advisory.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/orchestrator.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/templates/awesome-list.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/templates/paper.md +0 -0
- /package/skills/{parallel-research → vibe.parallel-research}/templates/synthesis.md +0 -0
- /package/skills/{presentation → vibe.presentation}/references/style-presets.md +0 -0
- /package/skills/{prioritization-frameworks → vibe.prioritization}/rubrics/frameworks.md +0 -0
- /package/skills/{prioritization-frameworks → vibe.prioritization}/templates/scoring-matrix.md +0 -0
- /package/skills/{priority-todos → vibe.priority-todos}/rubrics/prioritization.md +0 -0
- /package/skills/{priority-todos → vibe.priority-todos}/templates/todo-board.md +0 -0
- /package/skills/{vercel-react-best-practices → vibe.react-best-practices}/rubrics/performance.md +0 -0
- /package/skills/{vercel-react-best-practices → vibe.react-best-practices}/rubrics/server-components.md +0 -0
- /package/skills/{regress → vibe.regress}/templates/bug.md +0 -0
- /package/skills/{regress → vibe.regress}/templates/test-jest.md +0 -0
- /package/skills/{regress → vibe.regress}/templates/test-vitest.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/agents/detector.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/agents/reporter.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/agents/rule-generator.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/agents/violation-checker.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/frameworks/clean-architecture.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/frameworks/solid.md +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/scripts/check-boundaries.js +0 -0
- /package/skills/{arch-guard → vibe.run/internal/arch-guard}/templates/arch-rules.json +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/agents/decomposer.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/agents/dependency-mapper.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/agents/estimator.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/agents/validator.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/orchestrator.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/rubrics/complexity-scoring.md +0 -0
- /package/skills/{exec-plan → vibe.run/internal/exec-plan}/templates/plan.md +0 -0
- /package/skills/{seo-checklist → vibe.seo-checklist}/frameworks/structured-data.md +0 -0
- /package/skills/{seo-checklist → vibe.seo-checklist}/rubrics/content-seo.md +0 -0
- /package/skills/{seo-checklist → vibe.seo-checklist}/rubrics/technical-seo.md +0 -0
- /package/skills/{tool-fallback → vibe.tool-fallback}/rubrics/fallback-chain.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/color-and-contrast.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/interaction-design.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/motion-design.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/responsive-design.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/spatial-design.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/typography.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/reference/ux-writing.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/rubrics/interaction-states.md +0 -0
- /package/skills/{ui-ux-pro-max → vibe.ui-ux-pro-max}/rubrics/responsive-breakpoints.md +0 -0
- /package/skills/{user-personas → vibe.user-personas}/rubrics/research-methods.md +0 -0
- /package/skills/{user-personas → vibe.user-personas}/templates/persona.md +0 -0
- /package/skills/{video-production → vibe.video-production}/rubrics/quality-checklist.md +0 -0
- /package/skills/{video-production → vibe.video-production}/templates/production-plan.md +0 -0
package/skills/docs/SKILL.md
DELETED
|
@@ -1,259 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: docs
|
|
3
|
-
description: 프로젝트 문서 생성 본체 — README / 아키텍처 / 사용자 가이드 / 릴리즈 노트 / Mermaid 다이어그램 / codemaps.
|
|
4
|
-
when_to_use: /vibe.docs 진입점에서 체인 호출. 직접 호출 금지.
|
|
5
|
-
user-invocable: false
|
|
6
|
-
tier: standard
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# vibe.docs — Project Documentation Generator
|
|
10
|
-
|
|
11
|
-
Generate or update project documentation by analyzing the actual codebase.
|
|
12
|
-
|
|
13
|
-
## Subcommands
|
|
14
|
-
|
|
15
|
-
### `/vibe.docs readme` — README Generation
|
|
16
|
-
|
|
17
|
-
Analyze the codebase and generate a complete README.md:
|
|
18
|
-
|
|
19
|
-
1. **Detect project nature**: Read package.json, CLAUDE.md, existing README
|
|
20
|
-
2. **Extract key info**: Tech stack, installation, usage, API surface
|
|
21
|
-
3. **Generate sections**:
|
|
22
|
-
|
|
23
|
-
```markdown
|
|
24
|
-
# Project Name
|
|
25
|
-
> One-line description from package.json
|
|
26
|
-
|
|
27
|
-
## What is this?
|
|
28
|
-
[2-3 sentences explaining the problem and solution]
|
|
29
|
-
|
|
30
|
-
## Quick Start
|
|
31
|
-
[Installation + minimal usage example]
|
|
32
|
-
|
|
33
|
-
## Features
|
|
34
|
-
[Auto-detected from codebase — exported functions, CLI commands, API endpoints]
|
|
35
|
-
|
|
36
|
-
## Architecture
|
|
37
|
-
[High-level module diagram if 5+ source directories]
|
|
38
|
-
|
|
39
|
-
## Configuration
|
|
40
|
-
[Detected config files and their purposes]
|
|
41
|
-
|
|
42
|
-
## Development
|
|
43
|
-
[Build, test, lint commands from package.json scripts]
|
|
44
|
-
|
|
45
|
-
## License
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
**Analysis approach:**
|
|
49
|
-
```
|
|
50
|
-
Read: package.json → name, description, scripts, dependencies
|
|
51
|
-
Glob: src/**/*.ts → module structure
|
|
52
|
-
Grep: pattern="export (function|class|const)" → public API surface
|
|
53
|
-
Grep: pattern="(app|router)\.(get|post|put|delete)" → API endpoints
|
|
54
|
-
Read: CLAUDE.md → project conventions
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
### `/vibe.docs guide` — User Guide
|
|
58
|
-
|
|
59
|
-
Generate a step-by-step user guide:
|
|
60
|
-
|
|
61
|
-
1. **Installation**: Detect package manager, prerequisites
|
|
62
|
-
2. **Configuration**: Find all config files, document each option
|
|
63
|
-
3. **Usage**: Extract CLI commands or API usage patterns
|
|
64
|
-
4. **FAQ**: Common issues from error handling patterns
|
|
65
|
-
5. **Troubleshooting**: Known edge cases from test files
|
|
66
|
-
|
|
67
|
-
Output: `docs/GUIDE.md`
|
|
68
|
-
|
|
69
|
-
**Analysis approach:**
|
|
70
|
-
```
|
|
71
|
-
Read: package.json → bin, scripts, peerDependencies
|
|
72
|
-
Glob: src/cli/commands/*.ts → CLI command list
|
|
73
|
-
Grep: pattern="throw new|Error\(" → common error scenarios
|
|
74
|
-
Grep: pattern="(process\.env|config)\.\w+" → configuration options
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### `/vibe.docs arch` — Architecture Documentation
|
|
78
|
-
|
|
79
|
-
Generate architecture overview with diagrams:
|
|
80
|
-
|
|
81
|
-
1. **Module map**: Directory structure → responsibility mapping
|
|
82
|
-
2. **Dependency graph**: Import analysis → Mermaid diagram
|
|
83
|
-
3. **Data flow**: Entry points → processing → output
|
|
84
|
-
4. **Key decisions**: Extract from CLAUDE.md and code comments
|
|
85
|
-
|
|
86
|
-
Output: `docs/ARCHITECTURE.md`
|
|
87
|
-
|
|
88
|
-
**Mermaid diagram generation:**
|
|
89
|
-
```
|
|
90
|
-
Glob: src/**/ → module list
|
|
91
|
-
Grep: pattern="^import .+ from" → dependency edges
|
|
92
|
-
Read: CLAUDE.md → architecture notes
|
|
93
|
-
|
|
94
|
-
Generate:
|
|
95
|
-
graph TD
|
|
96
|
-
CLI[CLI Commands] --> Core[Core Logic]
|
|
97
|
-
Core --> Infra[Infrastructure]
|
|
98
|
-
Infra --> DB[(Database)]
|
|
99
|
-
Infra --> API[External APIs]
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### `/vibe.docs agent` — Agent Instruction Files (CLAUDE.md / AGENTS.md)
|
|
103
|
-
|
|
104
|
-
**CLI ↔ file mapping:**
|
|
105
|
-
|
|
106
|
-
| CLI | File | Support |
|
|
107
|
-
|---|---|---|
|
|
108
|
-
| Claude Code | `CLAUDE.md` | 100% (Primary) |
|
|
109
|
-
| Codex | `AGENTS.md` | 100% (Primary) |
|
|
110
|
-
| Antigravity CLI | `GEMINI.md` | 100% |
|
|
111
|
-
|
|
112
|
-
Cursor is not supported — do not generate or check Cursor-specific context files.
|
|
113
|
-
|
|
114
|
-
**Source of truth:**
|
|
115
|
-
- **`CLAUDE.md` is the content SSOT.** Always edit it first; `AGENTS.md` is a regenerated derivative.
|
|
116
|
-
- Behavioral block: `skills/docs/templates/behavioral-principles.md` (4 Karpathy principles, wrapped in `<!-- VIBE-BEHAVIORAL:START/END -->` markers).
|
|
117
|
-
|
|
118
|
-
**Procedure (applies to both creation and modification):**
|
|
119
|
-
|
|
120
|
-
1. **Detect state** — check which of `CLAUDE.md` / `AGENTS.md` / `GEMINI.md` exist in project root. **`CLAUDE.md` is always the SSOT**; if missing, create it first (never derive from AGENTS.md).
|
|
121
|
-
2. **For `AGENTS.md`**:
|
|
122
|
-
- **If missing** → create by cloning `CLAUDE.md` + applying CLI substitution (below).
|
|
123
|
-
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
124
|
-
3. **For `GEMINI.md`**:
|
|
125
|
-
- **If missing** → create by cloning `CLAUDE.md` + applying Antigravity substitution.
|
|
126
|
-
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
127
|
-
4. **CLI substitution for `AGENTS.md`** (Codex): `Claude Code` → `Codex` · `~/.claude/` → `~/.codex/` · `.claude/` → `.codex/` · `CLAUDE.md` → `AGENTS.md`. `CLAUDE.md` itself gets no substitution.
|
|
128
|
-
5. **CLI substitution for `GEMINI.md`** (Antigravity): `Claude Code` → `Antigravity CLI` · `~/.claude/` → `~/.gemini/` · `.claude/` → `.gemini/` · `CLAUDE.md` → `GEMINI.md`.
|
|
129
|
-
6. **Validate every touched file (whether newly created or modified)** via the `agents-md` skill — see validation block below. **Never write or save without running this step.**
|
|
130
|
-
7. Report per file: created / updated / skipped / validation warnings.
|
|
131
|
-
|
|
132
|
-
**Idempotent:** Re-running re-syncs the behavioral block and re-applies substitutions without duplication.
|
|
133
|
-
|
|
134
|
-
**Mandatory validation (every create & every update) — Load skill `agents-md`:**
|
|
135
|
-
|
|
136
|
-
- Size target 60–150 lines (Optimal). Warn at 200+, force split/trim at 300+.
|
|
137
|
-
- 4-question check per line (outside `VIBE-BEHAVIORAL` block):
|
|
138
|
-
- Would the agent make a mistake without this? (No → delete)
|
|
139
|
-
- Needed every session? (No → move to SPEC/plan)
|
|
140
|
-
- Can a linter/hook replace it? (Yes → move)
|
|
141
|
-
- Discoverable from code? (Yes → delete)
|
|
142
|
-
- Lost-in-the-Middle: critical rules at top, frequently-violated rules at bottom.
|
|
143
|
-
- Addy Osmani test: "Can the agent discover this by reading the code?" → Yes = delete.
|
|
144
|
-
- Strip tech-stack name-drops already stated in `package.json`.
|
|
145
|
-
|
|
146
|
-
Report line ranges to trim per file. Do not auto-delete; surface findings for user approval before finalizing.
|
|
147
|
-
|
|
148
|
-
**When to run:**
|
|
149
|
-
- After `vibe init` / `vibe update` if `CLAUDE.md` or `AGENTS.md` is missing or out of sync.
|
|
150
|
-
- After upgrading `@su-record/vibe` when the behavioral template changes.
|
|
151
|
-
- Whenever the SSOT file is edited — re-sync `AGENTS.md`.
|
|
152
|
-
- User explicitly asks to refresh agent instructions.
|
|
153
|
-
|
|
154
|
-
### `/vibe.docs release` — Release Notes
|
|
155
|
-
|
|
156
|
-
Generate release notes from git history:
|
|
157
|
-
|
|
158
|
-
1. **Collect**: `git log` since last tag
|
|
159
|
-
2. **Classify**: feat/fix/refactor/docs/chore from commit messages
|
|
160
|
-
3. **Group**: By category with breaking changes highlighted
|
|
161
|
-
4. **Format**: Semantic versioning suggestion
|
|
162
|
-
|
|
163
|
-
Output: `RELEASE_NOTES.md` or append to `CHANGELOG.md`
|
|
164
|
-
|
|
165
|
-
**Output format:**
|
|
166
|
-
```markdown
|
|
167
|
-
## [x.y.z] - YYYY-MM-DD
|
|
168
|
-
|
|
169
|
-
### Breaking Changes
|
|
170
|
-
- ...
|
|
171
|
-
|
|
172
|
-
### Features
|
|
173
|
-
- feat: description (#PR)
|
|
174
|
-
|
|
175
|
-
### Bug Fixes
|
|
176
|
-
- fix: description (#PR)
|
|
177
|
-
|
|
178
|
-
### Other
|
|
179
|
-
- refactor/docs/chore items
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
### `/vibe.docs diagram` — Diagram Generation
|
|
183
|
-
|
|
184
|
-
Generate Mermaid diagrams for architecture, ERD, flowchart, or sequence
|
|
185
|
-
visualization directly (native capability — no dedicated agent). Ground the
|
|
186
|
-
diagram in sources first: folder structure and imports for architecture;
|
|
187
|
-
`models/`, `migrations/`, `schema.*`, ORM definitions for ERDs; the real
|
|
188
|
-
branch/return structure of the code for flowcharts.
|
|
189
|
-
|
|
190
|
-
**Options:**
|
|
191
|
-
- `/vibe.docs diagram` (default): Architecture overview
|
|
192
|
-
- `/vibe.docs diagram --er`: Entity-Relationship Diagram
|
|
193
|
-
- `/vibe.docs diagram --flow`: Flowchart
|
|
194
|
-
- `/vibe.docs diagram --seq`: Sequence Diagram
|
|
195
|
-
|
|
196
|
-
> Read `references/diagram-spec.md` for the full output conventions (Mermaid syntax per diagram type, save location, accuracy constraints).
|
|
197
|
-
|
|
198
|
-
**Example:**
|
|
199
|
-
```
|
|
200
|
-
/vibe.docs diagram --er
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### `/vibe.docs codemaps` — Codemaps Generation
|
|
204
|
-
|
|
205
|
-
Generate auto-documentation from codebase structure directly (native
|
|
206
|
-
capability — no dedicated agent).
|
|
207
|
-
|
|
208
|
-
**Output Location:** `docs/CODEMAPS/`
|
|
209
|
-
|
|
210
|
-
> Read `references/codemaps-output.md` for the full generated-files tree, per-file contents, and tools used.
|
|
211
|
-
|
|
212
|
-
**Example:**
|
|
213
|
-
```
|
|
214
|
-
/vibe.docs codemaps
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
## Pipeline Integration
|
|
218
|
-
|
|
219
|
-
`/vibe.docs` completes the development pipeline:
|
|
220
|
-
|
|
221
|
-
```
|
|
222
|
-
/vibe.spec → Design (what to build)
|
|
223
|
-
/vibe.run → Implement (build it)
|
|
224
|
-
/vibe.trace → Verify (prove it works)
|
|
225
|
-
/vibe.docs → Document (explain it)
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
### Auto-trigger after `/vibe.trace`
|
|
229
|
-
|
|
230
|
-
When `/vibe.trace` completes with all scenarios passing, suggest:
|
|
231
|
-
> "All scenarios verified. Run `/vibe.docs readme` to update documentation?"
|
|
232
|
-
|
|
233
|
-
## Guidelines
|
|
234
|
-
|
|
235
|
-
### DO
|
|
236
|
-
- Read the actual codebase before generating — never guess
|
|
237
|
-
- Preserve existing documentation that's still accurate
|
|
238
|
-
- Include concrete code examples from the actual project
|
|
239
|
-
- Keep language consistent with project (Korean/English based on CLAUDE.md)
|
|
240
|
-
- For `/vibe.docs release` (changelog mode), follow `references/api-docs-changelog.md` natively — no dedicated agent
|
|
241
|
-
- For API-heavy projects (api-docs mode), follow `references/api-docs-changelog.md` natively
|
|
242
|
-
- For `/vibe.docs arch` and `/vibe.docs diagram` Mermaid generation, follow `references/diagram-spec.md` natively
|
|
243
|
-
- Use the `agents-md` skill for `/vibe.docs agent` — applies equally to CLAUDE.md and AGENTS.md
|
|
244
|
-
|
|
245
|
-
### DON'T
|
|
246
|
-
- Don't generate placeholder text ("Lorem ipsum", "TODO: fill in")
|
|
247
|
-
- Don't document internal implementation details in user-facing docs
|
|
248
|
-
- Don't create files without reading existing ones first
|
|
249
|
-
- Don't assume features — verify by reading code
|
|
250
|
-
|
|
251
|
-
## Quality Checklist
|
|
252
|
-
|
|
253
|
-
Before finalizing any document:
|
|
254
|
-
|
|
255
|
-
- [ ] All code examples are runnable (copy-paste ready)
|
|
256
|
-
- [ ] Installation steps tested against package.json
|
|
257
|
-
- [ ] Links and paths are valid
|
|
258
|
-
- [ ] No placeholder text remaining
|
|
259
|
-
- [ ] Consistent with project language (Korean/English)
|
|
@@ -1,151 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: exec-plan
|
|
3
|
-
user-invocable: false
|
|
4
|
-
invocation: [auto, chain]
|
|
5
|
-
tier: core
|
|
6
|
-
description: "Convert a SPEC (3+ phases or multi-file) into a self-contained execution plan — explicit file paths, interfaces, acceptance criteria — that agents can run autonomously."
|
|
7
|
-
triggers: [exec plan, execution plan, autonomous plan, self-contained plan, execute this spec, run this plan, parallel implementation]
|
|
8
|
-
priority: 60
|
|
9
|
-
chain-next: [commit-push-pr]
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
# ExecPlan — Self-Contained Execution Plan Generator
|
|
13
|
-
|
|
14
|
-
> **Principle**: "If the agent can't see it, it doesn't exist." Every decision, file path, pattern, and verification step must be explicit in the plan — no implicit knowledge allowed.
|
|
15
|
-
|
|
16
|
-
## When to Use
|
|
17
|
-
|
|
18
|
-
Before `/vibe.run`, generate an ExecPlan to make execution deterministic:
|
|
19
|
-
|
|
20
|
-
| Scenario | Signal |
|
|
21
|
-
|----------|--------|
|
|
22
|
-
| Complex SPEC (3+ phases) | Agent needs long autonomous execution |
|
|
23
|
-
| Team/multi-agent execution | Multiple agents need shared understanding |
|
|
24
|
-
| Context window pressure | Plan survives `/new` session handoff |
|
|
25
|
-
| Unfamiliar codebase | Agent can't rely on implicit knowledge |
|
|
26
|
-
|
|
27
|
-
## Core Flow
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
SPEC + Feature → ANALYZE → RESOLVE → GENERATE → PERSIST
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### Step 1: ANALYZE — Extract Everything Needed
|
|
34
|
-
|
|
35
|
-
Read the SPEC and Feature files, then extract:
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
For each Phase → For each Scenario:
|
|
39
|
-
1. Requirements (REQ-* IDs)
|
|
40
|
-
2. Given/When/Then conditions
|
|
41
|
-
3. Affected files (MUST exist — verify with Glob)
|
|
42
|
-
4. Dependencies (imports, packages)
|
|
43
|
-
5. Existing patterns to follow (read actual code, don't assume)
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
**Parallel exploration** (3+ agents):
|
|
47
|
-
- Agent 1: Map all file paths mentioned/implied in SPEC → verify they exist
|
|
48
|
-
- Agent 2: For each affected file, extract current interfaces/types/exports
|
|
49
|
-
- Agent 3: Find existing patterns (naming conventions, error handling, test structure)
|
|
50
|
-
|
|
51
|
-
### Step 2: RESOLVE — Eliminate All Ambiguity
|
|
52
|
-
|
|
53
|
-
For every decision point in the SPEC, resolve it NOW:
|
|
54
|
-
|
|
55
|
-
| Ambiguity | Resolution |
|
|
56
|
-
|-----------|------------|
|
|
57
|
-
| "Add validation" | → Which fields? What rules? What error messages? |
|
|
58
|
-
| "Handle errors" | → Which error codes? What response format? |
|
|
59
|
-
| "Follow existing pattern" | → Copy the ACTUAL pattern code into the plan |
|
|
60
|
-
| "Update tests" | → Which test file? What test framework? What assertions? |
|
|
61
|
-
|
|
62
|
-
**Rule**: If you'd need to "figure it out later", resolve it now. The plan must be executable by an agent with ZERO codebase knowledge.
|
|
63
|
-
|
|
64
|
-
### Step 3: GENERATE — Write the ExecPlan
|
|
65
|
-
|
|
66
|
-
Output format: `.vibe/specs/{feature-name}-execplan.md`
|
|
67
|
-
|
|
68
|
-
```markdown
|
|
69
|
-
# ExecPlan: {feature-name}
|
|
70
|
-
|
|
71
|
-
## Meta
|
|
72
|
-
- SPEC: .vibe/specs/{name}.md
|
|
73
|
-
- Feature: .vibe/features/{name}.feature
|
|
74
|
-
- Generated: {timestamp}
|
|
75
|
-
- Phases: {count}
|
|
76
|
-
- Scenarios: {count}
|
|
77
|
-
|
|
78
|
-
## Pre-flight Checks
|
|
79
|
-
- [ ] `npm run build` passes
|
|
80
|
-
- [ ] `npx vitest run` passes (baseline)
|
|
81
|
-
- [ ] Required files exist: {list}
|
|
82
|
-
|
|
83
|
-
## Phase {N}: {phase-name}
|
|
84
|
-
|
|
85
|
-
### Environment
|
|
86
|
-
- Files to modify: {exact paths}
|
|
87
|
-
- Files to create: {exact paths}
|
|
88
|
-
- Dependencies to add: {package@version}
|
|
89
|
-
- Patterns to follow: (inline code snippets from codebase)
|
|
90
|
-
|
|
91
|
-
### Scenario {N}.{M}: {scenario-name}
|
|
92
|
-
|
|
93
|
-
**Given**: {precondition}
|
|
94
|
-
→ Setup: {exact code/commands to establish precondition}
|
|
95
|
-
|
|
96
|
-
**When**: {action}
|
|
97
|
-
→ Implement: {step-by-step implementation instructions}
|
|
98
|
-
- File: {path}
|
|
99
|
-
- Location: after line containing `{anchor text}`
|
|
100
|
-
- Code: (inline snippet)
|
|
101
|
-
- Imports needed: {list}
|
|
102
|
-
|
|
103
|
-
**Then**: {expected result}
|
|
104
|
-
→ Verify:
|
|
105
|
-
- Command: `{test command}`
|
|
106
|
-
- Expected: {output/behavior}
|
|
107
|
-
- Fallback: {what to do if verification fails}
|
|
108
|
-
|
|
109
|
-
### Phase {N} Gate
|
|
110
|
-
- [ ] Build: `npm run build`
|
|
111
|
-
- [ ] Tests: `npx vitest run {relevant-test-files}`
|
|
112
|
-
- [ ] Type check: `npx tsc --noEmit`
|
|
113
|
-
|
|
114
|
-
## Completion Criteria
|
|
115
|
-
- Coverage threshold: ≥95%
|
|
116
|
-
- All scenarios passing
|
|
117
|
-
- No regressions in existing tests
|
|
118
|
-
- RTM: `generateTraceabilityMatrix("{feature-name}")`
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### Step 4: PERSIST — Save and Link
|
|
122
|
-
|
|
123
|
-
1. Save ExecPlan to `.vibe/specs/{feature-name}-execplan.md`
|
|
124
|
-
2. Save session context: `save_memory("execplan-{feature}", {summary})`
|
|
125
|
-
3. Output execution command:
|
|
126
|
-
|
|
127
|
-
```
|
|
128
|
-
Ready to execute:
|
|
129
|
-
/vibe.run "{feature-name}" ultrawork
|
|
130
|
-
|
|
131
|
-
Or hand off to new session:
|
|
132
|
-
/vibe.continue
|
|
133
|
-
→ Load: .vibe/specs/{feature-name}-execplan.md
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
## Quality Checks
|
|
137
|
-
|
|
138
|
-
| Check | Criteria |
|
|
139
|
-
|-------|----------|
|
|
140
|
-
| No implicit knowledge | Every file path verified with Glob |
|
|
141
|
-
| No "figure it out" | Every decision resolved with actual code |
|
|
142
|
-
| Survives handoff | Plan readable without any prior context |
|
|
143
|
-
| Inline patterns | Actual code snippets, not "follow existing pattern" |
|
|
144
|
-
| Verification steps | Every scenario has a concrete verification command |
|
|
145
|
-
|
|
146
|
-
## Anti-patterns
|
|
147
|
-
|
|
148
|
-
- "See the existing implementation" → Copy the relevant code inline
|
|
149
|
-
- "Follow the pattern in X" → Show the actual pattern
|
|
150
|
-
- "Standard error handling" → Specify exact error codes and messages
|
|
151
|
-
- "Update tests accordingly" → Name the test file, framework, and assertions
|