@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
package/lib/utils.mjs
ADDED
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
import {
|
|
2
|
+
readFileSync, writeFileSync, mkdirSync, cpSync,
|
|
3
|
+
readdirSync, existsSync, statSync,
|
|
4
|
+
} from 'fs'
|
|
5
|
+
import { join, resolve, dirname, relative } from 'path'
|
|
6
|
+
import { fileURLToPath } from 'url'
|
|
7
|
+
import { validateConfig, normalizeConfig } from './schema.mjs'
|
|
8
|
+
|
|
9
|
+
// ---------------------------------------------------------------------------
|
|
10
|
+
// Constants
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
|
|
13
|
+
export const MARKERS = {
|
|
14
|
+
md: '<!-- AUTO-GENERATED by AgentKit -->',
|
|
15
|
+
toml: '# AUTO-GENERATED by AgentKit',
|
|
16
|
+
mdc: '<!-- AUTO-GENERATED by AgentKit -->',
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export const CONFIG_FILE = '.ai/agentkit.json'
|
|
20
|
+
|
|
21
|
+
export const PLATFORMS = [
|
|
22
|
+
{ id: 'claude', name: 'Claude Code', rootFile: 'CLAUDE.md' },
|
|
23
|
+
{ id: 'cursor', name: 'Cursor', rootFile: '.cursor/rules/project.mdc' },
|
|
24
|
+
{ id: 'codex', name: 'Codex', rootFile: 'AGENTS.md' },
|
|
25
|
+
{ id: 'gemini', name: 'Gemini', rootFile: 'GEMINI.md' },
|
|
26
|
+
{ id: 'antigravity', name: 'Antigravity', rootFile: '.agent/rules.md' },
|
|
27
|
+
{ id: 'windsurf', name: 'Windsurf', rootFile: '.windsurfrules' },
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
export const WORKFLOW_PACKS = [
|
|
31
|
+
{
|
|
32
|
+
id: 'bmad',
|
|
33
|
+
name: 'BMAD Method',
|
|
34
|
+
description: 'Full-process dev methodology (PM, Architect, Dev, QA agents, 46+ commands)',
|
|
35
|
+
platformMapping: {
|
|
36
|
+
claude: { src: 'claude/commands_bmad', dest: '.claude/commands/bmad' },
|
|
37
|
+
cursor: { src: 'cursor/commands_bmad', dest: '.cursor/commands/bmad' },
|
|
38
|
+
gemini: { src: 'gemini/commands', dest: '.gemini/commands' },
|
|
39
|
+
antigravity: { src: 'agent/workflows_bmad', dest: '.agent/workflows/bmad' },
|
|
40
|
+
},
|
|
41
|
+
// Source files that command stubs reference via @_bmad/...
|
|
42
|
+
sourceDir: { src: '_bmad', dest: '_bmad' },
|
|
43
|
+
},
|
|
44
|
+
]
|
|
45
|
+
|
|
46
|
+
// Bundled skill bundles (multi-skill packs installed as a unit)
|
|
47
|
+
export const SKILL_BUNDLES = [
|
|
48
|
+
{
|
|
49
|
+
id: 'superpowers',
|
|
50
|
+
name: 'Superpowers (by obra)',
|
|
51
|
+
description: 'TDD, code-review, brainstorming, systematic debugging — 14 composable skills',
|
|
52
|
+
license: 'MIT',
|
|
53
|
+
url: 'https://github.com/obra/superpowers',
|
|
54
|
+
templateDir: 'superpowers-skills', // relative to templates/
|
|
55
|
+
},
|
|
56
|
+
]
|
|
57
|
+
|
|
58
|
+
// ---------------------------------------------------------------------------
|
|
59
|
+
// YAML Parser (simple key: value, no nesting needed)
|
|
60
|
+
// ---------------------------------------------------------------------------
|
|
61
|
+
|
|
62
|
+
export function parseManifest(content) {
|
|
63
|
+
const result = {}
|
|
64
|
+
for (const line of content.split('\n')) {
|
|
65
|
+
const match = line.match(/^(\w[\w-]*):\s*(.+)$/)
|
|
66
|
+
if (match) {
|
|
67
|
+
let value = match[2].trim()
|
|
68
|
+
if (
|
|
69
|
+
(value.startsWith('"') && value.endsWith('"')) ||
|
|
70
|
+
(value.startsWith("'") && value.endsWith("'"))
|
|
71
|
+
) {
|
|
72
|
+
value = value.slice(1, -1)
|
|
73
|
+
}
|
|
74
|
+
if (value === 'true') value = true
|
|
75
|
+
else if (value === 'false') value = false
|
|
76
|
+
result[match[1]] = value
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return result
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// ---------------------------------------------------------------------------
|
|
83
|
+
// Template Engine
|
|
84
|
+
// ---------------------------------------------------------------------------
|
|
85
|
+
|
|
86
|
+
/** Replace `{{var}}` placeholders in text */
|
|
87
|
+
export function templateReplace(text, vars) {
|
|
88
|
+
return text.replace(/\{\{(\w+)\}\}/g, (_, key) => {
|
|
89
|
+
return vars[key] !== undefined ? vars[key] : `{{${key}}}`
|
|
90
|
+
})
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// ---------------------------------------------------------------------------
|
|
94
|
+
// File Utilities
|
|
95
|
+
// ---------------------------------------------------------------------------
|
|
96
|
+
|
|
97
|
+
export function ensureDir(dir) {
|
|
98
|
+
mkdirSync(dir, { recursive: true })
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/** Recursively copy a directory, applying template vars to file contents */
|
|
102
|
+
export function copyDir(src, dest, vars = {}) {
|
|
103
|
+
ensureDir(dest)
|
|
104
|
+
for (const entry of readdirSync(src, { withFileTypes: true })) {
|
|
105
|
+
const srcPath = join(src, entry.name)
|
|
106
|
+
const destPath = join(dest, entry.name)
|
|
107
|
+
if (entry.isDirectory()) {
|
|
108
|
+
copyDir(srcPath, destPath, vars)
|
|
109
|
+
} else {
|
|
110
|
+
const content = readFileSync(srcPath, 'utf8')
|
|
111
|
+
ensureDir(dirname(destPath))
|
|
112
|
+
writeFileSync(destPath, Object.keys(vars).length ? templateReplace(content, vars) : content)
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** Write file only if it does not already exist */
|
|
118
|
+
export function writeIfNotExists(filePath, content) {
|
|
119
|
+
if (existsSync(filePath)) return false
|
|
120
|
+
ensureDir(dirname(filePath))
|
|
121
|
+
writeFileSync(filePath, content)
|
|
122
|
+
return true
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** Write file with auto-generated marker. Replaces only if marker is present (i.e., auto-generated). */
|
|
126
|
+
export function writeWithMarker(filePath, content, marker) {
|
|
127
|
+
if (existsSync(filePath)) {
|
|
128
|
+
const existing = readFileSync(filePath, 'utf8')
|
|
129
|
+
if (!existing.startsWith(marker)) {
|
|
130
|
+
// File was manually edited — skip
|
|
131
|
+
return false
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
ensureDir(dirname(filePath))
|
|
135
|
+
writeFileSync(filePath, marker + '\n' + content)
|
|
136
|
+
return true
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// ---------------------------------------------------------------------------
|
|
140
|
+
// Project Discovery
|
|
141
|
+
// ---------------------------------------------------------------------------
|
|
142
|
+
|
|
143
|
+
/** Walk up from cwd to find a directory containing package.json or .git */
|
|
144
|
+
export function findProjectRoot(startDir = process.cwd()) {
|
|
145
|
+
let dir = resolve(startDir)
|
|
146
|
+
while (dir !== dirname(dir)) {
|
|
147
|
+
if (existsSync(join(dir, 'package.json')) || existsSync(join(dir, '.git'))) {
|
|
148
|
+
return dir
|
|
149
|
+
}
|
|
150
|
+
dir = dirname(dir)
|
|
151
|
+
}
|
|
152
|
+
return process.cwd()
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/** Detect which AI platforms are already configured in the project */
|
|
156
|
+
export function detectPlatforms(projectRoot) {
|
|
157
|
+
return PLATFORMS
|
|
158
|
+
.filter(p => existsSync(join(projectRoot, p.rootFile)))
|
|
159
|
+
.map(p => p.id)
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/** Discover all skills in .ai/skills/ */
|
|
163
|
+
export function discoverSkills(projectRoot) {
|
|
164
|
+
const skillsDir = join(projectRoot, '.ai', 'skills')
|
|
165
|
+
if (!existsSync(skillsDir)) return []
|
|
166
|
+
|
|
167
|
+
return readdirSync(skillsDir, { withFileTypes: true })
|
|
168
|
+
.filter(d => d.isDirectory() && !d.name.startsWith('_'))
|
|
169
|
+
.map(d => {
|
|
170
|
+
const dir = join(skillsDir, d.name)
|
|
171
|
+
const manifestPath = join(dir, 'manifest.yaml')
|
|
172
|
+
const skillMdPath = join(dir, 'skill.md')
|
|
173
|
+
if (!existsSync(manifestPath) || !existsSync(skillMdPath)) return null
|
|
174
|
+
|
|
175
|
+
const manifest = parseManifest(readFileSync(manifestPath, 'utf8'))
|
|
176
|
+
return { name: d.name, dir, manifest, skillMdPath }
|
|
177
|
+
})
|
|
178
|
+
.filter(Boolean)
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/** Read .ai/agentkit.json config, or return null */
|
|
182
|
+
export function readConfig(projectRoot) {
|
|
183
|
+
const configPath = join(projectRoot, CONFIG_FILE)
|
|
184
|
+
if (!existsSync(configPath)) return null
|
|
185
|
+
|
|
186
|
+
try {
|
|
187
|
+
const config = JSON.parse(readFileSync(configPath, 'utf8'))
|
|
188
|
+
|
|
189
|
+
// Schema validation
|
|
190
|
+
const { valid, errors, warnings } = validateConfig(config)
|
|
191
|
+
if (!valid) {
|
|
192
|
+
console.error(`Invalid config in ${CONFIG_FILE}:`)
|
|
193
|
+
errors.forEach(e => console.error(` ✘ ${e}`))
|
|
194
|
+
process.exit(1)
|
|
195
|
+
}
|
|
196
|
+
// Show warnings but don't fail
|
|
197
|
+
if (warnings.length > 0) {
|
|
198
|
+
warnings.forEach(w => console.warn(` ⚠ ${w}`))
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
return normalizeConfig(config)
|
|
202
|
+
} catch (err) {
|
|
203
|
+
if (err instanceof SyntaxError) {
|
|
204
|
+
console.error(`Invalid JSON in ${CONFIG_FILE}: ${err.message}`)
|
|
205
|
+
} else {
|
|
206
|
+
console.error(`Error reading ${CONFIG_FILE}: ${err.message}`)
|
|
207
|
+
}
|
|
208
|
+
process.exit(1)
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/** Write .ai/agentkit.json */
|
|
213
|
+
export function writeConfig(projectRoot, config) {
|
|
214
|
+
const configPath = join(projectRoot, CONFIG_FILE)
|
|
215
|
+
ensureDir(dirname(configPath))
|
|
216
|
+
writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n')
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/** Get the templates directory bundled with this CLI */
|
|
220
|
+
export function getTemplatesDir() {
|
|
221
|
+
return resolve(dirname(fileURLToPath(import.meta.url)), '..', 'templates')
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Parse YAML frontmatter from a SKILL.md file.
|
|
226
|
+
* Handles both single-line and multi-line (indented continuation) values.
|
|
227
|
+
* Returns { name, description, ... } or null if no frontmatter.
|
|
228
|
+
*/
|
|
229
|
+
function parseFrontmatter(content) {
|
|
230
|
+
const match = content.match(/^---\s*\n([\s\S]*?)\n---/)
|
|
231
|
+
if (!match) return null
|
|
232
|
+
|
|
233
|
+
const result = {}
|
|
234
|
+
let currentKey = null
|
|
235
|
+
let currentValue = ''
|
|
236
|
+
|
|
237
|
+
for (const line of match[1].split('\n')) {
|
|
238
|
+
// New key: value line
|
|
239
|
+
const kvMatch = line.match(/^(\w[\w-]*):\s*(.*)$/)
|
|
240
|
+
if (kvMatch) {
|
|
241
|
+
// Save previous key
|
|
242
|
+
if (currentKey) {
|
|
243
|
+
result[currentKey] = cleanValue(currentValue.trim())
|
|
244
|
+
}
|
|
245
|
+
currentKey = kvMatch[1]
|
|
246
|
+
currentValue = kvMatch[2].trim()
|
|
247
|
+
} else if (currentKey && /^\s+/.test(line)) {
|
|
248
|
+
// Continuation line (indented)
|
|
249
|
+
currentValue += ' ' + line.trim()
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
// Save last key
|
|
253
|
+
if (currentKey) {
|
|
254
|
+
result[currentKey] = cleanValue(currentValue.trim())
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
return result
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
function cleanValue(value) {
|
|
261
|
+
if (
|
|
262
|
+
(value.startsWith('"') && value.endsWith('"')) ||
|
|
263
|
+
(value.startsWith("'") && value.endsWith("'"))
|
|
264
|
+
) {
|
|
265
|
+
value = value.slice(1, -1)
|
|
266
|
+
}
|
|
267
|
+
if (value === 'true') return true
|
|
268
|
+
if (value === 'false') return false
|
|
269
|
+
return value
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Auto-discover available skill packs from templates/skills/.
|
|
274
|
+
* Each subdirectory with a SKILL.md (containing frontmatter) is a skill pack.
|
|
275
|
+
* Returns [{ id, name, description }]
|
|
276
|
+
*/
|
|
277
|
+
export function discoverSkillPacks() {
|
|
278
|
+
const skillsDir = join(getTemplatesDir(), 'skills')
|
|
279
|
+
if (!existsSync(skillsDir)) return []
|
|
280
|
+
|
|
281
|
+
return readdirSync(skillsDir, { withFileTypes: true })
|
|
282
|
+
.filter(d => d.isDirectory() && !d.name.startsWith('.'))
|
|
283
|
+
.map(d => {
|
|
284
|
+
const skillMd = join(skillsDir, d.name, 'SKILL.md')
|
|
285
|
+
if (!existsSync(skillMd)) return null
|
|
286
|
+
|
|
287
|
+
const meta = parseFrontmatter(readFileSync(skillMd, 'utf8'))
|
|
288
|
+
return {
|
|
289
|
+
id: d.name,
|
|
290
|
+
name: meta?.name || d.name,
|
|
291
|
+
description: meta?.description || '',
|
|
292
|
+
}
|
|
293
|
+
})
|
|
294
|
+
.filter(Boolean)
|
|
295
|
+
.sort((a, b) => a.id.localeCompare(b.id))
|
|
296
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@siliconoid/agentkit",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "CLI tool to initialize and manage AI coding rules across multiple platforms",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"agentkit": "bin/cli.mjs"
|
|
8
|
+
},
|
|
9
|
+
"main": "./lib/index.mjs",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": "./lib/index.mjs",
|
|
12
|
+
"./cli": "./bin/cli.mjs"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"bin/",
|
|
16
|
+
"lib/",
|
|
17
|
+
"templates/",
|
|
18
|
+
"README.md",
|
|
19
|
+
"LICENSE"
|
|
20
|
+
],
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "git+https://github.com/nicepkg/agentkit.git"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://github.com/nicepkg/agentkit#readme",
|
|
26
|
+
"bugs": {
|
|
27
|
+
"url": "https://github.com/nicepkg/agentkit/issues"
|
|
28
|
+
},
|
|
29
|
+
"author": "superteam",
|
|
30
|
+
"keywords": [
|
|
31
|
+
"ai",
|
|
32
|
+
"coding-rules",
|
|
33
|
+
"claude",
|
|
34
|
+
"cursor",
|
|
35
|
+
"codex",
|
|
36
|
+
"gemini",
|
|
37
|
+
"windsurf",
|
|
38
|
+
"antigravity",
|
|
39
|
+
"agents-md",
|
|
40
|
+
"cli"
|
|
41
|
+
],
|
|
42
|
+
"license": "MIT",
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=18.0.0"
|
|
45
|
+
},
|
|
46
|
+
"dependencies": {
|
|
47
|
+
"@inquirer/prompts": "^7.4.0",
|
|
48
|
+
"commander": "^13.1.0",
|
|
49
|
+
"picocolors": "^1.1.1"
|
|
50
|
+
},
|
|
51
|
+
"directories": {
|
|
52
|
+
"lib": "lib"
|
|
53
|
+
},
|
|
54
|
+
"scripts": {
|
|
55
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Monthly changelog files for **{{projectName}}**.
|
|
4
|
+
|
|
5
|
+
## Format
|
|
6
|
+
|
|
7
|
+
Each month gets its own file: `YYYY-MM.md`
|
|
8
|
+
|
|
9
|
+
Entries follow this format:
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
## [YYYY-MM-DD] <type>: <short description>
|
|
13
|
+
|
|
14
|
+
- **What**: What was changed
|
|
15
|
+
- **Why**: The motivation
|
|
16
|
+
- **Impact**: What else is affected
|
|
17
|
+
- **Gotchas**: Non-obvious side effects (if any)
|
|
18
|
+
- **Related**: Links to ADRs, commits, issues
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Type values: `feat`, `fix`, `refactor`, `perf`, `config`, `deps`
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Architecture Decision Records (ADR)
|
|
2
|
+
|
|
3
|
+
This directory contains Architecture Decision Records for the {{projectName}} project.
|
|
4
|
+
|
|
5
|
+
## What is an ADR?
|
|
6
|
+
|
|
7
|
+
An ADR records an important architectural or technical decision, including the context, the decision itself, and its consequences. ADRs help AI agents and team members understand **why** decisions were made, not just what was done.
|
|
8
|
+
|
|
9
|
+
## File Naming
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
NNN-short-description.md
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
- `NNN`: Three-digit sequential number (001, 002, ...)
|
|
16
|
+
- `short-description`: Kebab-case summary of the decision
|
|
17
|
+
|
|
18
|
+
## Template
|
|
19
|
+
|
|
20
|
+
Use `.ai/decisions/_template.md` as the starting point for new ADRs.
|
|
21
|
+
|
|
22
|
+
## Status Values
|
|
23
|
+
|
|
24
|
+
| Status | Meaning |
|
|
25
|
+
|--------|---------|
|
|
26
|
+
| proposed | Under discussion, not yet decided |
|
|
27
|
+
| accepted | Decision made and in effect |
|
|
28
|
+
| deprecated | Was accepted but no longer applies |
|
|
29
|
+
| superseded | Replaced by a newer ADR (link to replacement) |
|
|
30
|
+
|
|
31
|
+
## Index
|
|
32
|
+
|
|
33
|
+
| # | Title | Status | Date |
|
|
34
|
+
|---|-------|--------|------|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# ADR-NNN: [Title]
|
|
2
|
+
|
|
3
|
+
## Status
|
|
4
|
+
proposed | accepted | deprecated | superseded by [ADR-XXX](XXX-title.md)
|
|
5
|
+
|
|
6
|
+
## Date
|
|
7
|
+
YYYY-MM-DD
|
|
8
|
+
|
|
9
|
+
## Context
|
|
10
|
+
<!-- What is the issue? What forces are at play? What is motivating this decision? -->
|
|
11
|
+
|
|
12
|
+
## Decision
|
|
13
|
+
<!-- What is the change that we're proposing and/or doing? -->
|
|
14
|
+
|
|
15
|
+
## Consequences
|
|
16
|
+
<!-- What becomes easier or more difficult because of this decision? -->
|
|
17
|
+
|
|
18
|
+
### Positive
|
|
19
|
+
- ...
|
|
20
|
+
|
|
21
|
+
### Negative
|
|
22
|
+
- ...
|
|
23
|
+
|
|
24
|
+
### Risks
|
|
25
|
+
- ...
|
|
26
|
+
|
|
27
|
+
## Related
|
|
28
|
+
<!-- Links to related ADRs, issues, PRs, or documentation -->
|
|
29
|
+
- ...
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Project Overview
|
|
2
|
+
|
|
3
|
+
**{{projectName}}** — {{projectDescription}}
|
|
4
|
+
|
|
5
|
+
## Tech Stack
|
|
6
|
+
|
|
7
|
+
| Category | Technology | Version |
|
|
8
|
+
|----------|-----------|---------|
|
|
9
|
+
| Framework | {{frameworkDisplay}} | {{frameworkVersion}} |
|
|
10
|
+
| Language | {{primaryLanguage}} | {{typescriptVersion}} |
|
|
11
|
+
| UI Components | {{uiLibrary}} | — |
|
|
12
|
+
| State Management | {{stateManagement}} | — |
|
|
13
|
+
| Styling | {{cssApproach}} | — |
|
|
14
|
+
| HTTP Client | {{httpClient}} | — |
|
|
15
|
+
| Testing | {{testingFramework}} | — |
|
|
16
|
+
| Build Tool | {{buildTool}} | — |
|
|
17
|
+
| Linter | {{linter}} | — |
|
|
18
|
+
| Package Manager | {{packageManager}} | — |
|
|
19
|
+
|
|
20
|
+
## Technology Constraints
|
|
21
|
+
|
|
22
|
+
- List any version constraints or limitations here
|
|
23
|
+
- Note which features are available or unavailable
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Describe the high-level architecture of **{{projectName}}** here.
|
|
6
|
+
|
|
7
|
+
## Request/Response Architecture
|
|
8
|
+
|
|
9
|
+
Describe your API patterns, authentication, and data flow.
|
|
10
|
+
|
|
11
|
+
## State Management
|
|
12
|
+
|
|
13
|
+
Describe how application state is managed (Redux, Zustand, Context, etc.).
|
|
14
|
+
|
|
15
|
+
## Component Layout System
|
|
16
|
+
|
|
17
|
+
Describe your layout system and page structure.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Coding Conventions
|
|
2
|
+
|
|
3
|
+
## Path Aliases
|
|
4
|
+
|
|
5
|
+
Define your path aliases (tsconfig paths, webpack aliases):
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
@/ → ./src/
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
**Always use path aliases instead of relative paths.**
|
|
12
|
+
|
|
13
|
+
## API Request Pattern
|
|
14
|
+
|
|
15
|
+
Describe your HTTP client usage and patterns.
|
|
16
|
+
|
|
17
|
+
## Internationalization
|
|
18
|
+
|
|
19
|
+
If applicable, describe your i18n setup and conventions.
|
|
20
|
+
|
|
21
|
+
## Import Order
|
|
22
|
+
|
|
23
|
+
1. External dependencies
|
|
24
|
+
2. Internal modules (path aliases)
|
|
25
|
+
3. Relative imports
|
|
26
|
+
4. Styles
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Directory Structure
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
{{projectName}}/
|
|
5
|
+
├── src/
|
|
6
|
+
│ ├── components/ # React/Vue components
|
|
7
|
+
│ ├── lib/ # Utility libraries
|
|
8
|
+
│ ├── pages/ # Pages / routes
|
|
9
|
+
│ └── styles/ # Global styles
|
|
10
|
+
├── public/ # Static assets
|
|
11
|
+
└── ...
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
> Update this tree to match your actual project structure.
|
|
15
|
+
|
|
16
|
+
## Key Files
|
|
17
|
+
|
|
18
|
+
| File | Purpose |
|
|
19
|
+
|------|---------|
|
|
20
|
+
| `src/...` | — |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Environment & Commands
|
|
2
|
+
|
|
3
|
+
## Development Commands
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm run dev # Development server
|
|
7
|
+
npm run build # Production build
|
|
8
|
+
npm run start # Production server
|
|
9
|
+
npm run lint # Lint code
|
|
10
|
+
npm run test # Run tests
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Environment Variables
|
|
14
|
+
|
|
15
|
+
### Required
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Add your required environment variables here
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Optional
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Add your optional environment variables here
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Critical Notes
|
|
28
|
+
|
|
29
|
+
- List any important build or runtime notes here
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# TypeScript
|
|
2
|
+
|
|
3
|
+
## Compiler Configuration
|
|
4
|
+
|
|
5
|
+
Key `tsconfig.json` settings for this project:
|
|
6
|
+
|
|
7
|
+
| Setting | Value | Notes |
|
|
8
|
+
|---------|-------|-------|
|
|
9
|
+
| `strict` | `true` | All strict checks enabled |
|
|
10
|
+
| `target` | `ES2020` | — |
|
|
11
|
+
|
|
12
|
+
## Strict Rules
|
|
13
|
+
|
|
14
|
+
- **Strict mode** is enabled — respect all strict checks.
|
|
15
|
+
- Prefer `interface` for object shapes; use `type` for unions, intersections, and mapped types.
|
|
16
|
+
- **Minimize `any`** — use `unknown` and narrow with type guards.
|
|
17
|
+
- Always type function parameters and return types for exported functions.
|
|
18
|
+
- Use `as const` for literal tuples and fixed arrays.
|
|
19
|
+
- No `// @ts-ignore` — use `// @ts-expect-error` with an explanation comment if absolutely necessary.
|
|
20
|
+
|
|
21
|
+
## Interface vs Type
|
|
22
|
+
|
|
23
|
+
| Use Case | Keyword |
|
|
24
|
+
|----------|---------|
|
|
25
|
+
| Object shapes, component props | `interface` |
|
|
26
|
+
| Union types, mapped types, primitives | `type` |
|
|
27
|
+
|
|
28
|
+
## `any` Strategy
|
|
29
|
+
|
|
30
|
+
- **New code**: Never use `any`. Use `unknown`, generics, or specific types.
|
|
31
|
+
- **Legacy code**: Tolerate existing `any` but do not expand its scope.
|
|
32
|
+
- **Never** add new `any` just to silence errors — fix the type instead.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# React
|
|
2
|
+
|
|
3
|
+
## Component Structure
|
|
4
|
+
|
|
5
|
+
Each component lives in its own directory:
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
components/common/my-component/
|
|
9
|
+
├── index.tsx # Component implementation
|
|
10
|
+
├── index.module.scss # Scoped styles
|
|
11
|
+
└── (optional sub-files)
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Function Components Only
|
|
15
|
+
|
|
16
|
+
Use function components for all new code. Do not introduce new class components.
|
|
17
|
+
|
|
18
|
+
## Props Handling
|
|
19
|
+
|
|
20
|
+
Destructure props in the function signature. Use default parameter values.
|
|
21
|
+
|
|
22
|
+
## Event Handler Naming
|
|
23
|
+
|
|
24
|
+
| Type | Prefix | Example |
|
|
25
|
+
|------|--------|---------|
|
|
26
|
+
| Internal handler | `handle` | `handleClick`, `handleSubmit` |
|
|
27
|
+
| Prop callback | `on` | `onClick`, `onSubmit` |
|
|
28
|
+
|
|
29
|
+
## Hooks Best Practices
|
|
30
|
+
|
|
31
|
+
- **One effect per concern** — separate data fetching, event listeners, and timers
|
|
32
|
+
- **Always clean up** — return a cleanup function for subscriptions, timers, and listeners
|
|
33
|
+
- `useCallback` — wrap callbacks passed to child components
|
|
34
|
+
- `useMemo` — use for computationally expensive derived values
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Styling
|
|
2
|
+
|
|
3
|
+
## CSS Modules (Primary Method)
|
|
4
|
+
|
|
5
|
+
All component styles use CSS Modules:
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import styles from './index.module.scss'
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Class Name Conventions
|
|
12
|
+
|
|
13
|
+
Use **camelCase** for CSS class names:
|
|
14
|
+
|
|
15
|
+
```scss
|
|
16
|
+
.container { ... }
|
|
17
|
+
.headerWrapper { ... }
|
|
18
|
+
.isActive { ... }
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## CSS Custom Properties (Theming)
|
|
22
|
+
|
|
23
|
+
Use CSS custom properties for theming values:
|
|
24
|
+
|
|
25
|
+
```scss
|
|
26
|
+
.button {
|
|
27
|
+
color: var(--primary-color);
|
|
28
|
+
background: var(--bg-color);
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Inline Styles
|
|
33
|
+
|
|
34
|
+
Only use inline styles for values computed at runtime.
|
|
35
|
+
|
|
36
|
+
## Responsive Breakpoints
|
|
37
|
+
|
|
38
|
+
Common breakpoints: `768px` (tablet), `1200px` (desktop).
|