@siliconoid/agentkit 0.1.0
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 -0
- package/README.md +247 -0
- package/bin/cli.mjs +134 -0
- package/lib/adapters/antigravity.mjs +70 -0
- package/lib/adapters/claude.mjs +85 -0
- package/lib/adapters/codex.mjs +60 -0
- package/lib/adapters/cursor.mjs +58 -0
- package/lib/adapters/gemini.mjs +69 -0
- package/lib/adapters/windsurf.mjs +65 -0
- package/lib/commands/add-platform.mjs +73 -0
- package/lib/commands/add-skill-pack.mjs +49 -0
- package/lib/commands/add-skill.mjs +78 -0
- package/lib/commands/diff.mjs +110 -0
- package/lib/commands/doctor.mjs +196 -0
- package/lib/commands/init.mjs +261 -0
- package/lib/commands/install.mjs +236 -0
- package/lib/commands/list.mjs +105 -0
- package/lib/commands/remove.mjs +126 -0
- package/lib/commands/sync.mjs +155 -0
- package/lib/commands/update.mjs +113 -0
- package/lib/index.mjs +233 -0
- package/lib/log.mjs +89 -0
- package/lib/prompts.mjs +348 -0
- package/lib/scaffold.mjs +385 -0
- package/lib/schema.mjs +135 -0
- package/lib/utils.mjs +296 -0
- package/package.json +57 -0
- package/templates/base/.ai/changelog/README.md +21 -0
- package/templates/base/.ai/decisions/README.md +34 -0
- package/templates/base/.ai/decisions/_template.md +29 -0
- package/templates/base/.ai/memory/debugging-patterns.md +5 -0
- package/templates/base/.ai/memory/known-issues.md +5 -0
- package/templates/base/.ai/memory/refactoring-log.md +5 -0
- package/templates/base/.ai/rules/01-project-overview.md +23 -0
- package/templates/base/.ai/rules/02-architecture.md +17 -0
- package/templates/base/.ai/rules/03-coding-conventions.md +26 -0
- package/templates/base/.ai/rules/04-directory-structure.md +20 -0
- package/templates/base/.ai/rules/05-environment.md +29 -0
- package/templates/base/.ai/rules/06-typescript.md +32 -0
- package/templates/base/.ai/rules/07-react.md +34 -0
- package/templates/base/.ai/rules/08-styling.md +38 -0
- package/templates/base/.ai/rules/09-naming.md +40 -0
- package/templates/base/.ai/rules/10-git-workflow.md +48 -0
- package/templates/base/.ai/rules/11-testing.md +19 -0
- package/templates/base/.ai/rules/12-forbidden-patterns.md +13 -0
- package/templates/base/.ai/rules/13-ai-agent.md +23 -0
- package/templates/base/.ai/scripts/sync-skills.mjs +15 -0
- package/templates/base/.ai/skills/adr/manifest.yaml +4 -0
- package/templates/base/.ai/skills/adr/skill.md +64 -0
- package/templates/base/.ai/skills/devlog/manifest.yaml +4 -0
- package/templates/base/.ai/skills/devlog/skill.md +63 -0
- package/templates/base/.ai/skills/wrap-up/manifest.yaml +4 -0
- package/templates/base/.ai/skills/wrap-up/skill.md +85 -0
- package/templates/base/.specs/README.md +37 -0
- package/templates/base/.specs/epics/.gitkeep +0 -0
- package/templates/base/.specs/stories/.gitkeep +0 -0
- package/templates/base/.specs/tasks/draft/.gitkeep +0 -0
- package/templates/bmad/_bmad/_config/agent-manifest.csv +11 -0
- package/templates/bmad/_bmad/_config/agents/bmm-analyst.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-architect.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-dev.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-pm.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-quick-flow-solo-dev.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-sm.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-tea.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-tech-writer.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/bmm-ux-designer.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/agents/core-bmad-master.customize.yaml +41 -0
- package/templates/bmad/_bmad/_config/files-manifest.csv +290 -0
- package/templates/bmad/_bmad/_config/ides/claude-code.yaml +6 -0
- package/templates/bmad/_bmad/_config/ides/codex.yaml +5 -0
- package/templates/bmad/_bmad/_config/manifest.yaml +8 -0
- package/templates/bmad/_bmad/_config/task-manifest.csv +5 -0
- package/templates/bmad/_bmad/_config/tool-manifest.csv +1 -0
- package/templates/bmad/_bmad/_config/workflow-manifest.csv +35 -0
- package/templates/bmad/_bmad/bmm/agents/analyst.md +76 -0
- package/templates/bmad/_bmad/bmm/agents/architect.md +68 -0
- package/templates/bmad/_bmad/bmm/agents/dev.md +70 -0
- package/templates/bmad/_bmad/bmm/agents/pm.md +72 -0
- package/templates/bmad/_bmad/bmm/agents/quick-flow-solo-dev.md +68 -0
- package/templates/bmad/_bmad/bmm/agents/sm.md +71 -0
- package/templates/bmad/_bmad/bmm/agents/tea.md +71 -0
- package/templates/bmad/_bmad/bmm/agents/tech-writer.md +72 -0
- package/templates/bmad/_bmad/bmm/agents/ux-designer.md +68 -0
- package/templates/bmad/_bmad/bmm/config.yaml +18 -0
- package/templates/bmad/_bmad/bmm/data/README.md +29 -0
- package/templates/bmad/_bmad/bmm/data/documentation-standards.md +262 -0
- package/templates/bmad/_bmad/bmm/data/project-context-template.md +40 -0
- package/templates/bmad/_bmad/bmm/teams/default-party.csv +21 -0
- package/templates/bmad/_bmad/bmm/teams/team-fullstack.yaml +12 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/api-request.md +442 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/auth-session.md +552 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/burn-in.md +273 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/data-factories.md +500 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/email-auth.md +721 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/error-handling.md +725 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/file-utils.md +463 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/intercept-network-call.md +430 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/log.md +429 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/network-error-monitor.md +405 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/network-first.md +486 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/network-recorder.md +527 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/overview.md +286 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/recurse.md +421 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/test-quality.md +664 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/templates/bmad/_bmad/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/templates/bmad/_bmad/bmm/testarch/tea-index.csv +34 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +194 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
- package/templates/bmad/_bmad/bmm/workflows/1-analysis/research/workflow.md +173 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/templates/bmad/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/templates/bmad/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +50 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +58 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +59 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +25 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +57 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
- package/templates/bmad/_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +35 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +173 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/templates/bmad/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/checklist.md +245 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/instructions.md +221 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/workflow.yaml +28 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/templates/bmad/_bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +26 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +26 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +26 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
- package/templates/bmad/_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +26 -0
- package/templates/bmad/_bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/templates/bmad/_bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/templates/bmad/_bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/templates/bmad/_bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/templates/bmad/_bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/atdd/checklist.md +374 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/atdd/instructions.md +806 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/atdd/workflow.yaml +45 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/automate/checklist.md +582 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/automate/instructions.md +1324 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/automate/workflow.yaml +52 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/ci/checklist.md +248 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/ci/instructions.md +536 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/ci/workflow.yaml +45 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/framework/checklist.md +321 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/framework/instructions.md +481 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/framework/workflow.yaml +47 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +47 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-design/checklist.md +235 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-design/instructions.md +788 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-design/workflow.yaml +54 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-review/checklist.md +472 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-review/instructions.md +628 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/test-review/workflow.yaml +46 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/trace/checklist.md +655 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/trace/instructions.md +1047 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/templates/bmad/_bmad/bmm/workflows/testarch/trace/workflow.yaml +55 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/init/instructions.md +346 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/init/workflow.yaml +29 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/instructions.md +395 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
- package/templates/bmad/_bmad/bmm/workflows/workflow-status/workflow.yaml +30 -0
- package/templates/bmad/_bmad/config.yaml +7 -0
- package/templates/bmad/_bmad/core/agents/bmad-master.md +57 -0
- package/templates/bmad/_bmad/core/resources/excalidraw/README.md +160 -0
- package/templates/bmad/_bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -0
- package/templates/bmad/_bmad/core/resources/excalidraw/library-loader.md +50 -0
- package/templates/bmad/_bmad/core/resources/excalidraw/validate-json-instructions.md +79 -0
- package/templates/bmad/_bmad/core/tasks/index-docs.xml +65 -0
- package/templates/bmad/_bmad/core/tasks/review-adversarial-general.xml +41 -0
- package/templates/bmad/_bmad/core/tasks/shard-doc.xml +109 -0
- package/templates/bmad/_bmad/core/tasks/workflow.xml +235 -0
- package/templates/bmad/_bmad/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/templates/bmad/_bmad/core/workflows/advanced-elicitation/workflow.xml +117 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/template.md +15 -0
- package/templates/bmad/_bmad/core/workflows/brainstorming/workflow.md +58 -0
- package/templates/bmad/_bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +139 -0
- package/templates/bmad/_bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +204 -0
- package/templates/bmad/_bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +159 -0
- package/templates/bmad/_bmad/core/workflows/party-mode/workflow.md +206 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-analyst.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-architect.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-dev.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-pm.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-quick-flow-solo-dev.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-sm.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-tea.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-tech-writer.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-agents-ux-designer.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-check-implementation-readiness.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-code-review.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-correct-course.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-architecture.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-epics-and-stories.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-excalidraw-dataflow.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-excalidraw-diagram.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-excalidraw-flowchart.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-excalidraw-wireframe.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-product-brief.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-story.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-create-ux-design.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-dev-story.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-document-project.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-generate-project-context.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-prd.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-quick-dev.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-quick-spec.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-research.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-retrospective.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-sprint-planning.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-sprint-status.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-atdd.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-automate.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-ci.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-framework.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-nfr.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-test-design.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-test-review.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-testarch-trace.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-workflow-init.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-bmm-workflows-workflow-status.md +13 -0
- package/templates/bmad/agent/workflows_bmad/bmad-core-agents-bmad-master.md +14 -0
- package/templates/bmad/agent/workflows_bmad/bmad-core-workflows-brainstorming.md +5 -0
- package/templates/bmad/agent/workflows_bmad/bmad-core-workflows-party-mode.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/analyst.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/architect.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/dev.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/pm.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/quick-flow-solo-dev.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/sm.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/tea.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/tech-writer.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/agents/ux-designer.md +14 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/check-implementation-readiness.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/code-review.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/correct-course.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-architecture.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-epics-and-stories.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-excalidraw-dataflow.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-excalidraw-diagram.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-excalidraw-flowchart.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-excalidraw-wireframe.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-product-brief.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-story.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/create-ux-design.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/dev-story.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/document-project.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/generate-project-context.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/prd.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/quick-dev.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/quick-spec.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/research.md +5 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/retrospective.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/sprint-planning.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/sprint-status.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-atdd.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-automate.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-ci.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-framework.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-nfr.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-test-design.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-test-review.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/testarch-trace.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/workflow-init.md +13 -0
- package/templates/bmad/claude/commands_bmad/bmm/workflows/workflow-status.md +13 -0
- package/templates/bmad/claude/commands_bmad/core/agents/bmad-master.md +14 -0
- package/templates/bmad/claude/commands_bmad/core/tasks/index-docs.md +9 -0
- package/templates/bmad/claude/commands_bmad/core/tasks/shard-doc.md +9 -0
- package/templates/bmad/claude/commands_bmad/core/workflows/brainstorming.md +5 -0
- package/templates/bmad/claude/commands_bmad/core/workflows/party-mode.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/analyst.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/architect.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/dev.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/pm.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/quick-flow-solo-dev.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/sm.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/tea.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/tech-writer.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/agents/ux-designer.md +14 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/check-implementation-readiness.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/code-review.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/correct-course.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-architecture.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-epics-and-stories.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-excalidraw-dataflow.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-excalidraw-diagram.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-excalidraw-flowchart.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-excalidraw-wireframe.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-product-brief.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-story.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/create-ux-design.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/dev-story.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/document-project.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/generate-project-context.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/prd.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/quick-dev.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/quick-spec.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/research.md +5 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/retrospective.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/sprint-planning.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/sprint-status.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-atdd.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-automate.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-ci.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-framework.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-nfr.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-test-design.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-test-review.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/testarch-trace.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/workflow-init.md +13 -0
- package/templates/bmad/cursor/commands_bmad/bmm/workflows/workflow-status.md +13 -0
- package/templates/bmad/cursor/commands_bmad/core/agents/bmad-master.md +14 -0
- package/templates/bmad/cursor/commands_bmad/core/tasks/index-docs.md +9 -0
- package/templates/bmad/cursor/commands_bmad/core/tasks/shard-doc.md +9 -0
- package/templates/bmad/cursor/commands_bmad/core/workflows/brainstorming.md +5 -0
- package/templates/bmad/cursor/commands_bmad/core/workflows/party-mode.md +5 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-analyst.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-architect.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-dev.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-pm.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-quick-flow-solo-dev.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-sm.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-tea.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-tech-writer.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-bmm-ux-designer.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-agent-core-bmad-master.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-task-core-index-docs.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-task-core-review-adversarial-general.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-task-core-shard-doc.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-task-core-workflow.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-check-implementation-readiness.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-code-review.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-correct-course.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-architecture.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-epics-and-stories.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-excalidraw-dataflow.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-excalidraw-diagram.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-excalidraw-flowchart.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-excalidraw-wireframe.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-product-brief.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-story.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-create-ux-design.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-dev-story.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-document-project.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-generate-project-context.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-prd.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-quick-dev.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-quick-spec.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-research.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-retrospective.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-sprint-planning.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-sprint-status.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-atdd.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-automate.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-ci.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-framework.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-nfr.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-test-design.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-test-review.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-testarch-trace.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-workflow-init.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-bmm-workflow-status.toml +12 -0
- package/templates/bmad/gemini/commands/bmad-workflow-core-brainstorming.toml +4 -0
- package/templates/bmad/gemini/commands/bmad-workflow-core-party-mode.toml +4 -0
- package/templates/frameworks/nextjs-app/.ai/rules/01-project-overview.md +25 -0
- package/templates/frameworks/nextjs-app/.ai/rules/02-architecture.md +36 -0
- package/templates/frameworks/nextjs-app/.ai/rules/07-react.md +56 -0
- package/templates/frameworks/nextjs-pages/.ai/rules/01-project-overview.md +25 -0
- package/templates/frameworks/nextjs-pages/.ai/rules/02-architecture.md +30 -0
- package/templates/frameworks/nextjs-pages/.ai/rules/07-react.md +51 -0
- package/templates/frameworks/nodejs/.ai/rules/01-project-overview.md +20 -0
- package/templates/frameworks/nodejs/.ai/rules/02-architecture.md +21 -0
- package/templates/frameworks/nodejs/.ai/rules/07-react.md +26 -0
- package/templates/frameworks/react-spa/.ai/rules/01-project-overview.md +49 -0
- package/templates/frameworks/react-spa/.ai/rules/02-architecture.md +40 -0
- package/templates/frameworks/react-spa/.ai/rules/03-coding-conventions.md +26 -0
- package/templates/frameworks/react-spa/.ai/rules/06-typescript.md +30 -0
- package/templates/frameworks/react-spa/.ai/rules/07-react.md +60 -0
- package/templates/frameworks/react-spa/.ai/rules/08-styling.md +22 -0
- package/templates/frameworks/react-spa/.ai/rules/09-naming.md +25 -0
- package/templates/frameworks/react-spa/.ai/rules/10-git-workflow.md +7 -0
- package/templates/frameworks/react-spa/.ai/rules/11-testing.md +8 -0
- package/templates/frameworks/react-spa/.ai/rules/12-forbidden-patterns.md +16 -0
- package/templates/frameworks/vue/.ai/rules/01-project-overview.md +25 -0
- package/templates/frameworks/vue/.ai/rules/02-architecture.md +47 -0
- package/templates/frameworks/vue/.ai/rules/07-react.md +90 -0
- package/templates/skills/frontend-design/LICENSE.txt +177 -0
- package/templates/skills/frontend-design/SKILL.md +42 -0
- package/templates/skills/next-best-practices/SKILL.md +153 -0
- package/templates/skills/next-best-practices/async-patterns.md +87 -0
- package/templates/skills/next-best-practices/bundling.md +180 -0
- package/templates/skills/next-best-practices/data-patterns.md +297 -0
- package/templates/skills/next-best-practices/debug-tricks.md +105 -0
- package/templates/skills/next-best-practices/directives.md +73 -0
- package/templates/skills/next-best-practices/error-handling.md +227 -0
- package/templates/skills/next-best-practices/file-conventions.md +140 -0
- package/templates/skills/next-best-practices/font.md +245 -0
- package/templates/skills/next-best-practices/functions.md +108 -0
- package/templates/skills/next-best-practices/hydration-error.md +91 -0
- package/templates/skills/next-best-practices/image.md +173 -0
- package/templates/skills/next-best-practices/metadata.md +301 -0
- package/templates/skills/next-best-practices/parallel-routes.md +287 -0
- package/templates/skills/next-best-practices/route-handlers.md +146 -0
- package/templates/skills/next-best-practices/rsc-boundaries.md +159 -0
- package/templates/skills/next-best-practices/runtime-selection.md +39 -0
- package/templates/skills/next-best-practices/scripts.md +141 -0
- package/templates/skills/next-best-practices/self-hosting.md +371 -0
- package/templates/skills/next-best-practices/suspense-boundaries.md +67 -0
- package/templates/skills/security-best-practices/LICENSE.txt +201 -0
- package/templates/skills/security-best-practices/SKILL.md +86 -0
- package/templates/skills/security-best-practices/agents/openai.yaml +4 -0
- package/templates/skills/security-best-practices/references/golang-general-backend-security.md +826 -0
- package/templates/skills/security-best-practices/references/javascript-express-web-server-security.md +1158 -0
- package/templates/skills/security-best-practices/references/javascript-general-web-frontend-security.md +747 -0
- package/templates/skills/security-best-practices/references/javascript-jquery-web-frontend-security.md +678 -0
- package/templates/skills/security-best-practices/references/javascript-typescript-nextjs-web-server-security.md +1144 -0
- package/templates/skills/security-best-practices/references/javascript-typescript-react-web-frontend-security.md +990 -0
- package/templates/skills/security-best-practices/references/javascript-typescript-vue-web-frontend-security.md +791 -0
- package/templates/skills/security-best-practices/references/python-django-web-server-security.md +882 -0
- package/templates/skills/security-best-practices/references/python-fastapi-web-server-security.md +1036 -0
- package/templates/skills/security-best-practices/references/python-flask-web-server-security.md +705 -0
- package/templates/skills/vercel-composition-patterns/AGENTS.md +946 -0
- package/templates/skills/vercel-composition-patterns/SKILL.md +89 -0
- package/templates/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/templates/skills/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/templates/skills/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/templates/skills/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/templates/skills/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/templates/skills/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/templates/skills/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/templates/skills/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/templates/skills/vercel-react-best-practices/AGENTS.md +2975 -0
- package/templates/skills/vercel-react-best-practices/SKILL.md +137 -0
- package/templates/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/templates/skills/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/templates/skills/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/templates/skills/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/templates/skills/vercel-react-best-practices/rules/async-defer-await.md +80 -0
- package/templates/skills/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/templates/skills/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/templates/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/templates/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +59 -0
- package/templates/skills/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/templates/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/templates/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/templates/skills/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/templates/skills/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/templates/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/templates/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/templates/skills/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/templates/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/templates/skills/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/templates/skills/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/templates/skills/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/templates/skills/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/templates/skills/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/templates/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/templates/skills/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/templates/skills/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/templates/skills/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/templates/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/templates/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/templates/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/templates/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/templates/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/templates/skills/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/templates/skills/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/templates/skills/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/templates/skills/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/templates/skills/vercel-react-best-practices/rules/server-hoist-static-io.md +142 -0
- package/templates/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/templates/skills/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/templates/skills/web-design-guidelines/SKILL.md +39 -0
- package/templates/superpowers-skills/LICENSE +21 -0
- package/templates/superpowers-skills/_agents/code-reviewer.md +48 -0
- package/templates/superpowers-skills/brainstorming/SKILL.md +147 -0
- package/templates/superpowers-skills/brainstorming/spec-document-reviewer-prompt.md +50 -0
- package/templates/superpowers-skills/brainstorming/visual-companion.md +260 -0
- package/templates/superpowers-skills/dispatching-parallel-agents/SKILL.md +180 -0
- package/templates/superpowers-skills/executing-plans/SKILL.md +70 -0
- package/templates/superpowers-skills/finishing-a-development-branch/SKILL.md +200 -0
- package/templates/superpowers-skills/receiving-code-review/SKILL.md +213 -0
- package/templates/superpowers-skills/requesting-code-review/SKILL.md +105 -0
- package/templates/superpowers-skills/requesting-code-review/code-reviewer.md +146 -0
- package/templates/superpowers-skills/subagent-driven-development/SKILL.md +275 -0
- package/templates/superpowers-skills/subagent-driven-development/code-quality-reviewer-prompt.md +26 -0
- package/templates/superpowers-skills/subagent-driven-development/implementer-prompt.md +113 -0
- package/templates/superpowers-skills/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/templates/superpowers-skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/templates/superpowers-skills/systematic-debugging/SKILL.md +296 -0
- package/templates/superpowers-skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/templates/superpowers-skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/templates/superpowers-skills/systematic-debugging/defense-in-depth.md +122 -0
- package/templates/superpowers-skills/systematic-debugging/find-polluter.sh +63 -0
- package/templates/superpowers-skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/templates/superpowers-skills/systematic-debugging/test-academic.md +14 -0
- package/templates/superpowers-skills/systematic-debugging/test-pressure-1.md +58 -0
- package/templates/superpowers-skills/systematic-debugging/test-pressure-2.md +68 -0
- package/templates/superpowers-skills/systematic-debugging/test-pressure-3.md +69 -0
- package/templates/superpowers-skills/test-driven-development/SKILL.md +371 -0
- package/templates/superpowers-skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/templates/superpowers-skills/using-git-worktrees/SKILL.md +218 -0
- package/templates/superpowers-skills/using-superpowers/SKILL.md +113 -0
- package/templates/superpowers-skills/using-superpowers/references/codex-tools.md +25 -0
- package/templates/superpowers-skills/verification-before-completion/SKILL.md +139 -0
- package/templates/superpowers-skills/writing-plans/SKILL.md +147 -0
- package/templates/superpowers-skills/writing-plans/plan-document-reviewer-prompt.md +52 -0
- package/templates/superpowers-skills/writing-skills/SKILL.md +655 -0
- package/templates/superpowers-skills/writing-skills/anthropic-best-practices.md +1150 -0
- package/templates/superpowers-skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/templates/superpowers-skills/writing-skills/graphviz-conventions.dot +172 -0
- package/templates/superpowers-skills/writing-skills/persuasion-principles.md +187 -0
- package/templates/superpowers-skills/writing-skills/render-graphs.js +168 -0
- package/templates/superpowers-skills/writing-skills/testing-skills-with-subagents.md +384 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
**{{projectName}}** is a Node.js backend application.
|
|
6
|
+
|
|
7
|
+
## API Design
|
|
8
|
+
|
|
9
|
+
Describe your API design patterns (REST, GraphQL, etc.).
|
|
10
|
+
|
|
11
|
+
## Database
|
|
12
|
+
|
|
13
|
+
Describe your database setup and ORM/query builder.
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Describe your authentication and authorization approach.
|
|
18
|
+
|
|
19
|
+
## Error Handling
|
|
20
|
+
|
|
21
|
+
Describe your error handling strategy.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- This file replaces the base 07-react.md for Node.js backend projects -->
|
|
2
|
+
# Backend Patterns
|
|
3
|
+
|
|
4
|
+
## Module Structure
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
src/
|
|
8
|
+
├── routes/ # API route handlers
|
|
9
|
+
├── services/ # Business logic
|
|
10
|
+
├── models/ # Data models / ORM entities
|
|
11
|
+
├── middleware/ # Express/Fastify middleware
|
|
12
|
+
├── utils/ # Utility functions
|
|
13
|
+
└── config/ # Configuration
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Error Handling
|
|
17
|
+
|
|
18
|
+
Use typed errors and centralized error handling middleware.
|
|
19
|
+
|
|
20
|
+
## Validation
|
|
21
|
+
|
|
22
|
+
Validate all input at API boundaries. Use a validation library (zod, joi, etc.).
|
|
23
|
+
|
|
24
|
+
## Logging
|
|
25
|
+
|
|
26
|
+
Use structured logging. Never log sensitive data (passwords, tokens, PII).
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Project Overview
|
|
2
|
+
|
|
3
|
+
**{{projectName}}** — {{projectDescription}}
|
|
4
|
+
|
|
5
|
+
## Tech Stack
|
|
6
|
+
|
|
7
|
+
| Category | Technology | Version |
|
|
8
|
+
|----------|-----------|---------|
|
|
9
|
+
| Framework | React | {{reactVersion}} |
|
|
10
|
+
| Bundler | {{buildTool}} | — |
|
|
11
|
+
| Language | {{primaryLanguage}} | {{typescriptVersion}} |
|
|
12
|
+
| UI Components | {{uiLibrary}} | — |
|
|
13
|
+
| State Management | {{stateManagement}} | — |
|
|
14
|
+
| Styling | {{cssApproach}} | — |
|
|
15
|
+
| HTTP Client | {{httpClient}} | — |
|
|
16
|
+
| Testing | {{testingFramework}} | — |
|
|
17
|
+
| Linter | {{linter}} | — |
|
|
18
|
+
| Package Manager | {{packageManager}} | — |
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
| Command | Description |
|
|
23
|
+
|---------|-------------|
|
|
24
|
+
| `{{packageManager}} run dev` | Start dev server |
|
|
25
|
+
| `{{packageManager}} run build` | Production build |
|
|
26
|
+
| `{{packageManager}} run test` | Run tests |
|
|
27
|
+
| `{{packageManager}} run lint` | Run linter |
|
|
28
|
+
|
|
29
|
+
## Directory Structure
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
src/
|
|
33
|
+
assets/ # Static assets (images, SVGs)
|
|
34
|
+
components/ # Shared/reusable components
|
|
35
|
+
hooks/ # Custom React hooks
|
|
36
|
+
pages/ # Route-level page components
|
|
37
|
+
services/ # API functions & HTTP utilities
|
|
38
|
+
stores/ # State management
|
|
39
|
+
styles/ # Global styles & design tokens
|
|
40
|
+
types/ # Shared TypeScript declarations
|
|
41
|
+
utils/ # Pure utility functions
|
|
42
|
+
App.tsx # Root component
|
|
43
|
+
main.tsx # Entry point
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Environment Variables
|
|
47
|
+
|
|
48
|
+
- All client-side env vars **must** be prefixed with `VITE_`.
|
|
49
|
+
- Never commit `.env` files (they are gitignored).
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
**{{projectName}}** is a React single-page application built with Vite.
|
|
6
|
+
|
|
7
|
+
## Routing
|
|
8
|
+
|
|
9
|
+
Client-side routing via React Router. Use `React.lazy()` + `<Suspense>` for page-level code splitting.
|
|
10
|
+
|
|
11
|
+
## API Services — Axios Wrapper & Typing
|
|
12
|
+
|
|
13
|
+
- All HTTP requests go through the Axios wrapper at `src/services/http.ts`.
|
|
14
|
+
- Domain-specific API functions go in `src/services/xxxApi.ts` (e.g., `userApi.ts`, `orderApi.ts`).
|
|
15
|
+
- Always type request parameters and response data:
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
// src/services/userApi.ts
|
|
19
|
+
import http from '@/services/http';
|
|
20
|
+
|
|
21
|
+
interface UserListParams {
|
|
22
|
+
page: number;
|
|
23
|
+
pageSize: number;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
interface UserListResponse {
|
|
27
|
+
list: User[];
|
|
28
|
+
total: number;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export function getUserList(params: UserListParams) {
|
|
32
|
+
return http.get<UserListResponse>('/users', { params });
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## State Management
|
|
37
|
+
|
|
38
|
+
- **Zustand** (recommended) for global state.
|
|
39
|
+
- **React Context** acceptable for small-scale, component-tree-scoped state.
|
|
40
|
+
- Store files go in `src/stores/` with `xxxStore.ts` naming.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Coding Conventions
|
|
2
|
+
|
|
3
|
+
## Path Aliases
|
|
4
|
+
|
|
5
|
+
- **`@/` alias is mandatory** for all `src/` imports — never use relative `../` paths.
|
|
6
|
+
- Relative `./` is allowed only within the same component directory (e.g., `./UserCard.module.scss`).
|
|
7
|
+
|
|
8
|
+
## Import Order
|
|
9
|
+
|
|
10
|
+
Auto-sorted by import organizer:
|
|
11
|
+
|
|
12
|
+
1. `react` / `react-dom`
|
|
13
|
+
2. Third-party libraries (`antd`, `axios`, `zustand`, etc.)
|
|
14
|
+
3. `@/` aliased imports
|
|
15
|
+
4. Relative imports (`./`)
|
|
16
|
+
5. Style / asset imports
|
|
17
|
+
|
|
18
|
+
## API Request Pattern
|
|
19
|
+
|
|
20
|
+
Use the Axios wrapper at `src/services/http.ts`. Never use raw `axios` or `fetch`.
|
|
21
|
+
|
|
22
|
+
Domain-specific API functions go in `src/services/xxxApi.ts`.
|
|
23
|
+
|
|
24
|
+
## Internationalization
|
|
25
|
+
|
|
26
|
+
If applicable, use `react-i18next` with `useTranslation()` hook. Never hardcode user-facing strings.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TypeScript
|
|
2
|
+
|
|
3
|
+
## Compiler Configuration
|
|
4
|
+
|
|
5
|
+
| Setting | Value | Notes |
|
|
6
|
+
|---------|-------|-------|
|
|
7
|
+
| `strict` | `true` | All strict checks enabled |
|
|
8
|
+
| `target` | `ESNext` | Vite handles transpilation |
|
|
9
|
+
|
|
10
|
+
## Strict Rules
|
|
11
|
+
|
|
12
|
+
- **Strict mode** is enabled — respect all strict checks.
|
|
13
|
+
- Prefer `interface` for object shapes; use `type` for unions, intersections, and mapped types.
|
|
14
|
+
- **Never use `any`** — use `unknown` and narrow with type guards.
|
|
15
|
+
- No non-null assertion (`!`) except for `document.getElementById()` where the element is guaranteed.
|
|
16
|
+
- Always type function parameters and return types for exported functions.
|
|
17
|
+
- Use `as const` for literal tuples and fixed arrays.
|
|
18
|
+
- No `// @ts-ignore` — use `// @ts-expect-error` with an explanation comment if absolutely necessary.
|
|
19
|
+
|
|
20
|
+
## Interface vs Type
|
|
21
|
+
|
|
22
|
+
| Use Case | Keyword |
|
|
23
|
+
|----------|---------|
|
|
24
|
+
| Object shapes, component props | `interface` |
|
|
25
|
+
| Union types, mapped types, primitives | `type` |
|
|
26
|
+
|
|
27
|
+
## `any` Strategy
|
|
28
|
+
|
|
29
|
+
- **Never use `any`** in new code.
|
|
30
|
+
- Use `unknown` + type guards, generics, or specific types.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# React — Components, Hooks, Error Handling, Performance
|
|
2
|
+
|
|
3
|
+
## Component Patterns
|
|
4
|
+
|
|
5
|
+
- **Functional components only** — no class components.
|
|
6
|
+
- Props defined via `interface XxxProps {}` above the component.
|
|
7
|
+
- **Pages** (route-level): `export default function XxxPage()` — default export.
|
|
8
|
+
- **Shared components**: named export — `export function Button()`.
|
|
9
|
+
- Co-locate styles as `Xxx.module.scss` in the same directory.
|
|
10
|
+
- Co-locate tests as `Xxx.test.tsx` in the same directory.
|
|
11
|
+
- Use `index.ts` barrel files only at the component/page directory level.
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
// src/components/UserCard/UserCard.tsx
|
|
15
|
+
import styles from './UserCard.module.scss';
|
|
16
|
+
|
|
17
|
+
interface UserCardProps {
|
|
18
|
+
name: string;
|
|
19
|
+
avatar: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export function UserCard({ name, avatar }: UserCardProps) {
|
|
23
|
+
return (
|
|
24
|
+
<div className={styles.wrapper}>
|
|
25
|
+
<img src={avatar} alt={name} />
|
|
26
|
+
<span>{name}</span>
|
|
27
|
+
</div>
|
|
28
|
+
);
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Hooks
|
|
33
|
+
|
|
34
|
+
- Name: always `useXxx`.
|
|
35
|
+
- Place reusable hooks in `src/hooks/`.
|
|
36
|
+
- Component-specific hooks can live in the component file if small, or in a dedicated `useXxx.ts` alongside the component.
|
|
37
|
+
- Always specify dependency arrays for `useEffect`, `useMemo`, `useCallback`.
|
|
38
|
+
- Always return cleanup functions from `useEffect` when subscribing to events, timers, or external resources.
|
|
39
|
+
|
|
40
|
+
## Event Handler Naming
|
|
41
|
+
|
|
42
|
+
| Type | Prefix | Example |
|
|
43
|
+
|------|--------|---------|
|
|
44
|
+
| Internal handler | `handle` | `handleClick`, `handleSubmit` |
|
|
45
|
+
| Prop callback | `on` | `onClick`, `onSubmit` |
|
|
46
|
+
|
|
47
|
+
## Error Handling
|
|
48
|
+
|
|
49
|
+
- Wrap route-level components with `ErrorBoundary`.
|
|
50
|
+
- Use `try-catch` in all async service calls.
|
|
51
|
+
- **Never swallow errors silently** — at minimum, log to a monitoring service or re-throw.
|
|
52
|
+
- Display user-friendly error messages via Ant Design's `message` or `notification` components.
|
|
53
|
+
|
|
54
|
+
## Performance
|
|
55
|
+
|
|
56
|
+
- **Route splitting**: Use `React.lazy()` + `<Suspense>` for page-level code splitting.
|
|
57
|
+
- Use `useMemo` / `useCallback` only when there is a measured performance need — do not apply prematurely.
|
|
58
|
+
- Avoid creating new object/array literals in JSX props (causes unnecessary re-renders).
|
|
59
|
+
- Use Ant Design's virtual scroll for long lists.
|
|
60
|
+
- Images: prefer SVG for icons (via `vite-plugin-svgr`), use WebP/AVIF for photos with fallback.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Styling — CSS Modules, SCSS, Theming
|
|
2
|
+
|
|
3
|
+
- **Component styles**: `Xxx.module.scss` (CSS Modules) — import as `import styles from './Xxx.module.scss'`.
|
|
4
|
+
- **Global styles**: `src/styles/global.scss` — imported once in `main.tsx`.
|
|
5
|
+
- **Design tokens**: `src/styles/_variables.scss` — auto-injected via Vite `additionalData`, no manual `@use` needed in component files.
|
|
6
|
+
- **Theming**: Prefer Ant Design's `ConfigProvider` token system for theming. Use SCSS variables for non-Ant custom tokens only.
|
|
7
|
+
- **No inline styles** — use CSS Modules or Ant Design's `style` prop for dynamic values only when CSS Modules cannot achieve the result.
|
|
8
|
+
- Class composition: use `composes` in CSS Modules or `classnames`/`clsx` utility for conditional classes.
|
|
9
|
+
|
|
10
|
+
## Class Name Conventions
|
|
11
|
+
|
|
12
|
+
Use **camelCase** in CSS Modules (matches JS object property access):
|
|
13
|
+
|
|
14
|
+
```scss
|
|
15
|
+
.wrapper { ... }
|
|
16
|
+
.cardTitle { ... }
|
|
17
|
+
.isActive { ... }
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Responsive Breakpoints
|
|
21
|
+
|
|
22
|
+
Common breakpoints: `768px` (tablet), `1200px` (desktop).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Naming Conventions
|
|
2
|
+
|
|
3
|
+
| Target | Convention | Example |
|
|
4
|
+
|--------|-----------|---------|
|
|
5
|
+
| Component files | PascalCase | `UserProfile.tsx` |
|
|
6
|
+
| Component directories | PascalCase | `UserProfile/` |
|
|
7
|
+
| Hook files | camelCase, `use` prefix | `useAuth.ts` |
|
|
8
|
+
| Utility files | camelCase | `formatDate.ts` |
|
|
9
|
+
| API service files | camelCase, `Api` suffix | `userApi.ts` |
|
|
10
|
+
| Store files | camelCase, `Store` suffix | `authStore.ts` |
|
|
11
|
+
| Style modules | PascalCase, `.module.scss` | `UserProfile.module.scss` |
|
|
12
|
+
| Test files | Match source + `.test` | `UserProfile.test.tsx` |
|
|
13
|
+
| Variables & functions | camelCase | `const userName = ...` |
|
|
14
|
+
| Constants | UPPER_SNAKE_CASE | `const MAX_RETRY = 3` |
|
|
15
|
+
| Types | PascalCase | `type UserRole = ...` |
|
|
16
|
+
| Interfaces | PascalCase | `interface UserProps {}` |
|
|
17
|
+
| Enums | PascalCase (members too) | `enum Status { Active }` |
|
|
18
|
+
| CSS class names | camelCase (via CSS Modules) | `styles.cardWrapper` |
|
|
19
|
+
|
|
20
|
+
## Anti-Patterns
|
|
21
|
+
|
|
22
|
+
- **No Hungarian notation**: Don't prefix with type indicators
|
|
23
|
+
- **No obscure abbreviations**: Use `info` not `inf`
|
|
24
|
+
- **No single-letter variables**: Except `i`, `j`, `k` in loops
|
|
25
|
+
- **No numbered suffixes**: Don't use `data2`, `handleClick2`
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Git Workflow
|
|
2
|
+
|
|
3
|
+
- **Branch naming**: `feat/xxx`, `fix/xxx`, `chore/xxx`, `refactor/xxx`, `docs/xxx`
|
|
4
|
+
- **Commit messages**: Conventional Commits enforced by commitlint.
|
|
5
|
+
- Allowed types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
|
|
6
|
+
- **Pull requests**: Squash merge into `main`.
|
|
7
|
+
- **Before pushing**: Ensure `npm run lint`, `npm run lint:css`, and `npm run build` all pass.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Testing — Vitest, MSW, Component Testing
|
|
2
|
+
|
|
3
|
+
- **Framework**: Vitest (Vite-native, zero-config with this setup).
|
|
4
|
+
- **Test files**: Co-located as `Xxx.test.tsx` next to the source file.
|
|
5
|
+
- **Pattern**: `describe` → `it` / `test` blocks.
|
|
6
|
+
- **API mocking**: Use MSW (Mock Service Worker) for intercepting network requests.
|
|
7
|
+
- **Component testing**: Use `@testing-library/react` for rendering and assertions.
|
|
8
|
+
- Name test cases descriptively: `it('should display error when API fails')`.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Forbidden Patterns
|
|
2
|
+
|
|
3
|
+
The following are **not allowed** in this codebase:
|
|
4
|
+
|
|
5
|
+
| Pattern | Reason |
|
|
6
|
+
|---------|--------|
|
|
7
|
+
| Class components | Use functional components with hooks |
|
|
8
|
+
| `any` type | Use `unknown` + type guards |
|
|
9
|
+
| `var` keyword | Use `const` / `let` |
|
|
10
|
+
| Relative `../` imports | Use `@/` alias |
|
|
11
|
+
| Inline `style={}` props | Use CSS Modules |
|
|
12
|
+
| Committed `console.log` | Removed in production build; use proper logging |
|
|
13
|
+
| `// @ts-ignore` | Use `// @ts-expect-error` with explanation |
|
|
14
|
+
| Non-null assertion `!` (except DOM) | Use proper null checks |
|
|
15
|
+
| `enum` (runtime) without justification | Prefer `as const` objects or union types for simple cases |
|
|
16
|
+
| Barrel `index.ts` re-exporting everything | Only at component/page directory level |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Project Overview
|
|
2
|
+
|
|
3
|
+
**{{projectName}}** — {{projectDescription}}
|
|
4
|
+
|
|
5
|
+
## Tech Stack
|
|
6
|
+
|
|
7
|
+
| Category | Technology | Version |
|
|
8
|
+
|----------|-----------|---------|
|
|
9
|
+
| Framework | Vue | {{frameworkVersion}} |
|
|
10
|
+
| Build Tool | {{buildTool}} | — |
|
|
11
|
+
| Language | {{primaryLanguage}} | {{typescriptVersion}} |
|
|
12
|
+
| State Management | {{stateManagement}} | — |
|
|
13
|
+
| UI Components | {{uiLibrary}} | — |
|
|
14
|
+
| Styling | {{cssApproach}} | — |
|
|
15
|
+
| HTTP Client | {{httpClient}} | — |
|
|
16
|
+
| Router | Vue Router | — |
|
|
17
|
+
| Testing | {{testingFramework}} | — |
|
|
18
|
+
| Linter | {{linter}} | — |
|
|
19
|
+
| Package Manager | {{packageManager}} | — |
|
|
20
|
+
|
|
21
|
+
## Technology Constraints
|
|
22
|
+
|
|
23
|
+
- Vue 3 Composition API preferred over Options API
|
|
24
|
+
- TypeScript strict mode for new files
|
|
25
|
+
- Single File Components (`.vue`) for all components
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Application Structure
|
|
4
|
+
|
|
5
|
+
Vue 3 single-page application with Composition API and TypeScript.
|
|
6
|
+
|
|
7
|
+
### Key Directories
|
|
8
|
+
|
|
9
|
+
| Directory | Purpose |
|
|
10
|
+
|-----------|---------|
|
|
11
|
+
| `src/components/` | Reusable Vue components |
|
|
12
|
+
| `src/views/` or `src/pages/` | Route-level page components |
|
|
13
|
+
| `src/composables/` | Composition API composables (`use*`) |
|
|
14
|
+
| `src/stores/` | Pinia stores |
|
|
15
|
+
| `src/router/` | Vue Router configuration |
|
|
16
|
+
| `src/services/` or `src/api/` | API service layer |
|
|
17
|
+
| `src/types/` | TypeScript type definitions |
|
|
18
|
+
| `src/assets/` | Static assets (images, fonts) |
|
|
19
|
+
| `src/styles/` | Global styles |
|
|
20
|
+
|
|
21
|
+
## State Management
|
|
22
|
+
|
|
23
|
+
Use **Pinia** for global state. Use component-local `ref()`/`reactive()` for local state.
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
// stores/user.ts
|
|
27
|
+
export const useUserStore = defineStore('user', () => {
|
|
28
|
+
const user = ref<User | null>(null)
|
|
29
|
+
const isLoggedIn = computed(() => !!user.value)
|
|
30
|
+
|
|
31
|
+
async function login(credentials: LoginParams) { ... }
|
|
32
|
+
function logout() { user.value = null }
|
|
33
|
+
|
|
34
|
+
return { user, isLoggedIn, login, logout }
|
|
35
|
+
})
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Routing
|
|
39
|
+
|
|
40
|
+
Use Vue Router with lazy-loaded route components:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
const routes = [
|
|
44
|
+
{ path: '/', component: () => import('@/views/Home.vue') },
|
|
45
|
+
{ path: '/about', component: () => import('@/views/About.vue') },
|
|
46
|
+
]
|
|
47
|
+
```
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Vue Components
|
|
2
|
+
|
|
3
|
+
## Composition API (Preferred)
|
|
4
|
+
|
|
5
|
+
Use `<script setup lang="ts">` for all new components:
|
|
6
|
+
|
|
7
|
+
```vue
|
|
8
|
+
<script setup lang="ts">
|
|
9
|
+
import { ref, computed, onMounted } from 'vue'
|
|
10
|
+
|
|
11
|
+
interface Props {
|
|
12
|
+
title: string
|
|
13
|
+
count?: number
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const props = withDefaults(defineProps<Props>(), {
|
|
17
|
+
count: 0,
|
|
18
|
+
})
|
|
19
|
+
|
|
20
|
+
const emit = defineEmits<{
|
|
21
|
+
update: [value: number]
|
|
22
|
+
}>()
|
|
23
|
+
|
|
24
|
+
const localCount = ref(props.count)
|
|
25
|
+
const doubled = computed(() => localCount.value * 2)
|
|
26
|
+
|
|
27
|
+
function increment() {
|
|
28
|
+
localCount.value++
|
|
29
|
+
emit('update', localCount.value)
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
onMounted(() => {
|
|
33
|
+
console.log('Component mounted')
|
|
34
|
+
})
|
|
35
|
+
</script>
|
|
36
|
+
|
|
37
|
+
<template>
|
|
38
|
+
<div>
|
|
39
|
+
<h2>{{ title }}</h2>
|
|
40
|
+
<button @click="increment">{{ localCount }}</button>
|
|
41
|
+
</div>
|
|
42
|
+
</template>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Component File Structure
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
components/
|
|
49
|
+
├── BaseButton/
|
|
50
|
+
│ ├── BaseButton.vue
|
|
51
|
+
│ └── index.ts # re-export
|
|
52
|
+
├── UserCard/
|
|
53
|
+
│ ├── UserCard.vue
|
|
54
|
+
│ └── index.ts
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Naming Conventions
|
|
58
|
+
|
|
59
|
+
| Item | Convention | Example |
|
|
60
|
+
|------|-----------|---------|
|
|
61
|
+
| Component file | PascalCase `.vue` | `UserCard.vue` |
|
|
62
|
+
| Component usage | PascalCase in template | `<UserCard />` |
|
|
63
|
+
| Composable | `use` prefix, camelCase | `useAuth.ts` |
|
|
64
|
+
| Store | `use` prefix + `Store` | `useUserStore` |
|
|
65
|
+
| Event handler (emit) | camelCase verb | `@update`, `@submit` |
|
|
66
|
+
| Props | camelCase | `:userName`, `:isActive` |
|
|
67
|
+
|
|
68
|
+
## Composables
|
|
69
|
+
|
|
70
|
+
Extract reusable logic into composables in `src/composables/`:
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
// composables/useAuth.ts
|
|
74
|
+
export function useAuth() {
|
|
75
|
+
const user = ref<User | null>(null)
|
|
76
|
+
const isAuthenticated = computed(() => !!user.value)
|
|
77
|
+
|
|
78
|
+
async function login(params: LoginParams) { ... }
|
|
79
|
+
function logout() { ... }
|
|
80
|
+
|
|
81
|
+
return { user, isAuthenticated, login, logout }
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Anti-Patterns
|
|
86
|
+
|
|
87
|
+
- **No Options API** in new components — use `<script setup>` exclusively
|
|
88
|
+
- **No `this`** — Composition API does not use `this`
|
|
89
|
+
- **No mixins** — use composables instead
|
|
90
|
+
- **No global event bus** — use Pinia stores or provide/inject
|