@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,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Defer Non-Critical Third-Party Libraries
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: loads after hydration
|
|
5
|
+
tags: bundle, third-party, analytics, defer
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Defer Non-Critical Third-Party Libraries
|
|
9
|
+
|
|
10
|
+
Analytics, logging, and error tracking don't block user interaction. Load them after hydration.
|
|
11
|
+
|
|
12
|
+
**Incorrect (blocks initial bundle):**
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
import { Analytics } from '@vercel/analytics/react'
|
|
16
|
+
|
|
17
|
+
export default function RootLayout({ children }) {
|
|
18
|
+
return (
|
|
19
|
+
<html>
|
|
20
|
+
<body>
|
|
21
|
+
{children}
|
|
22
|
+
<Analytics />
|
|
23
|
+
</body>
|
|
24
|
+
</html>
|
|
25
|
+
)
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Correct (loads after hydration):**
|
|
30
|
+
|
|
31
|
+
```tsx
|
|
32
|
+
import dynamic from 'next/dynamic'
|
|
33
|
+
|
|
34
|
+
const Analytics = dynamic(
|
|
35
|
+
() => import('@vercel/analytics/react').then(m => m.Analytics),
|
|
36
|
+
{ ssr: false }
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
export default function RootLayout({ children }) {
|
|
40
|
+
return (
|
|
41
|
+
<html>
|
|
42
|
+
<body>
|
|
43
|
+
{children}
|
|
44
|
+
<Analytics />
|
|
45
|
+
</body>
|
|
46
|
+
</html>
|
|
47
|
+
)
|
|
48
|
+
}
|
|
49
|
+
```
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Dynamic Imports for Heavy Components
|
|
3
|
+
impact: CRITICAL
|
|
4
|
+
impactDescription: directly affects TTI and LCP
|
|
5
|
+
tags: bundle, dynamic-import, code-splitting, next-dynamic
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Dynamic Imports for Heavy Components
|
|
9
|
+
|
|
10
|
+
Use `next/dynamic` to lazy-load large components not needed on initial render.
|
|
11
|
+
|
|
12
|
+
**Incorrect (Monaco bundles with main chunk ~300KB):**
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
import { MonacoEditor } from './monaco-editor'
|
|
16
|
+
|
|
17
|
+
function CodePanel({ code }: { code: string }) {
|
|
18
|
+
return <MonacoEditor value={code} />
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Correct (Monaco loads on demand):**
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import dynamic from 'next/dynamic'
|
|
26
|
+
|
|
27
|
+
const MonacoEditor = dynamic(
|
|
28
|
+
() => import('./monaco-editor').then(m => m.MonacoEditor),
|
|
29
|
+
{ ssr: false }
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
function CodePanel({ code }: { code: string }) {
|
|
33
|
+
return <MonacoEditor value={code} />
|
|
34
|
+
}
|
|
35
|
+
```
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Preload Based on User Intent
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: reduces perceived latency
|
|
5
|
+
tags: bundle, preload, user-intent, hover
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Preload Based on User Intent
|
|
9
|
+
|
|
10
|
+
Preload heavy bundles before they're needed to reduce perceived latency.
|
|
11
|
+
|
|
12
|
+
**Example (preload on hover/focus):**
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
function EditorButton({ onClick }: { onClick: () => void }) {
|
|
16
|
+
const preload = () => {
|
|
17
|
+
if (typeof window !== 'undefined') {
|
|
18
|
+
void import('./monaco-editor')
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
return (
|
|
23
|
+
<button
|
|
24
|
+
onMouseEnter={preload}
|
|
25
|
+
onFocus={preload}
|
|
26
|
+
onClick={onClick}
|
|
27
|
+
>
|
|
28
|
+
Open Editor
|
|
29
|
+
</button>
|
|
30
|
+
)
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
**Example (preload when feature flag is enabled):**
|
|
35
|
+
|
|
36
|
+
```tsx
|
|
37
|
+
function FlagsProvider({ children, flags }: Props) {
|
|
38
|
+
useEffect(() => {
|
|
39
|
+
if (flags.editorEnabled && typeof window !== 'undefined') {
|
|
40
|
+
void import('./monaco-editor').then(mod => mod.init())
|
|
41
|
+
}
|
|
42
|
+
}, [flags.editorEnabled])
|
|
43
|
+
|
|
44
|
+
return <FlagsContext.Provider value={flags}>
|
|
45
|
+
{children}
|
|
46
|
+
</FlagsContext.Provider>
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The `typeof window !== 'undefined'` check prevents bundling preloaded modules for SSR, optimizing server bundle size and build speed.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Deduplicate Global Event Listeners
|
|
3
|
+
impact: LOW
|
|
4
|
+
impactDescription: single listener for N components
|
|
5
|
+
tags: client, swr, event-listeners, subscription
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Deduplicate Global Event Listeners
|
|
9
|
+
|
|
10
|
+
Use `useSWRSubscription()` to share global event listeners across component instances.
|
|
11
|
+
|
|
12
|
+
**Incorrect (N instances = N listeners):**
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
function useKeyboardShortcut(key: string, callback: () => void) {
|
|
16
|
+
useEffect(() => {
|
|
17
|
+
const handler = (e: KeyboardEvent) => {
|
|
18
|
+
if (e.metaKey && e.key === key) {
|
|
19
|
+
callback()
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
window.addEventListener('keydown', handler)
|
|
23
|
+
return () => window.removeEventListener('keydown', handler)
|
|
24
|
+
}, [key, callback])
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
When using the `useKeyboardShortcut` hook multiple times, each instance will register a new listener.
|
|
29
|
+
|
|
30
|
+
**Correct (N instances = 1 listener):**
|
|
31
|
+
|
|
32
|
+
```tsx
|
|
33
|
+
import useSWRSubscription from 'swr/subscription'
|
|
34
|
+
|
|
35
|
+
// Module-level Map to track callbacks per key
|
|
36
|
+
const keyCallbacks = new Map<string, Set<() => void>>()
|
|
37
|
+
|
|
38
|
+
function useKeyboardShortcut(key: string, callback: () => void) {
|
|
39
|
+
// Register this callback in the Map
|
|
40
|
+
useEffect(() => {
|
|
41
|
+
if (!keyCallbacks.has(key)) {
|
|
42
|
+
keyCallbacks.set(key, new Set())
|
|
43
|
+
}
|
|
44
|
+
keyCallbacks.get(key)!.add(callback)
|
|
45
|
+
|
|
46
|
+
return () => {
|
|
47
|
+
const set = keyCallbacks.get(key)
|
|
48
|
+
if (set) {
|
|
49
|
+
set.delete(callback)
|
|
50
|
+
if (set.size === 0) {
|
|
51
|
+
keyCallbacks.delete(key)
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}, [key, callback])
|
|
56
|
+
|
|
57
|
+
useSWRSubscription('global-keydown', () => {
|
|
58
|
+
const handler = (e: KeyboardEvent) => {
|
|
59
|
+
if (e.metaKey && keyCallbacks.has(e.key)) {
|
|
60
|
+
keyCallbacks.get(e.key)!.forEach(cb => cb())
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
window.addEventListener('keydown', handler)
|
|
64
|
+
return () => window.removeEventListener('keydown', handler)
|
|
65
|
+
})
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
function Profile() {
|
|
69
|
+
// Multiple shortcuts will share the same listener
|
|
70
|
+
useKeyboardShortcut('p', () => { /* ... */ })
|
|
71
|
+
useKeyboardShortcut('k', () => { /* ... */ })
|
|
72
|
+
// ...
|
|
73
|
+
}
|
|
74
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Version and Minimize localStorage Data
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: prevents schema conflicts, reduces storage size
|
|
5
|
+
tags: client, localStorage, storage, versioning, data-minimization
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Version and Minimize localStorage Data
|
|
9
|
+
|
|
10
|
+
Add version prefix to keys and store only needed fields. Prevents schema conflicts and accidental storage of sensitive data.
|
|
11
|
+
|
|
12
|
+
**Incorrect:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
// No version, stores everything, no error handling
|
|
16
|
+
localStorage.setItem('userConfig', JSON.stringify(fullUserObject))
|
|
17
|
+
const data = localStorage.getItem('userConfig')
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**Correct:**
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
const VERSION = 'v2'
|
|
24
|
+
|
|
25
|
+
function saveConfig(config: { theme: string; language: string }) {
|
|
26
|
+
try {
|
|
27
|
+
localStorage.setItem(`userConfig:${VERSION}`, JSON.stringify(config))
|
|
28
|
+
} catch {
|
|
29
|
+
// Throws in incognito/private browsing, quota exceeded, or disabled
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
function loadConfig() {
|
|
34
|
+
try {
|
|
35
|
+
const data = localStorage.getItem(`userConfig:${VERSION}`)
|
|
36
|
+
return data ? JSON.parse(data) : null
|
|
37
|
+
} catch {
|
|
38
|
+
return null
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
// Migration from v1 to v2
|
|
43
|
+
function migrate() {
|
|
44
|
+
try {
|
|
45
|
+
const v1 = localStorage.getItem('userConfig:v1')
|
|
46
|
+
if (v1) {
|
|
47
|
+
const old = JSON.parse(v1)
|
|
48
|
+
saveConfig({ theme: old.darkMode ? 'dark' : 'light', language: old.lang })
|
|
49
|
+
localStorage.removeItem('userConfig:v1')
|
|
50
|
+
}
|
|
51
|
+
} catch {}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Store minimal fields from server responses:**
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
// User object has 20+ fields, only store what UI needs
|
|
59
|
+
function cachePrefs(user: FullUser) {
|
|
60
|
+
try {
|
|
61
|
+
localStorage.setItem('prefs:v1', JSON.stringify({
|
|
62
|
+
theme: user.preferences.theme,
|
|
63
|
+
notifications: user.preferences.notifications
|
|
64
|
+
}))
|
|
65
|
+
} catch {}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**Always wrap in try-catch:** `getItem()` and `setItem()` throw in incognito/private browsing (Safari, Firefox), when quota exceeded, or when disabled.
|
|
70
|
+
|
|
71
|
+
**Benefits:** Schema evolution via versioning, reduced storage size, prevents storing tokens/PII/internal flags.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Use Passive Event Listeners for Scrolling Performance
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: eliminates scroll delay caused by event listeners
|
|
5
|
+
tags: client, event-listeners, scrolling, performance, touch, wheel
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Use Passive Event Listeners for Scrolling Performance
|
|
9
|
+
|
|
10
|
+
Add `{ passive: true }` to touch and wheel event listeners to enable immediate scrolling. Browsers normally wait for listeners to finish to check if `preventDefault()` is called, causing scroll delay.
|
|
11
|
+
|
|
12
|
+
**Incorrect:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
useEffect(() => {
|
|
16
|
+
const handleTouch = (e: TouchEvent) => console.log(e.touches[0].clientX)
|
|
17
|
+
const handleWheel = (e: WheelEvent) => console.log(e.deltaY)
|
|
18
|
+
|
|
19
|
+
document.addEventListener('touchstart', handleTouch)
|
|
20
|
+
document.addEventListener('wheel', handleWheel)
|
|
21
|
+
|
|
22
|
+
return () => {
|
|
23
|
+
document.removeEventListener('touchstart', handleTouch)
|
|
24
|
+
document.removeEventListener('wheel', handleWheel)
|
|
25
|
+
}
|
|
26
|
+
}, [])
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Correct:**
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
useEffect(() => {
|
|
33
|
+
const handleTouch = (e: TouchEvent) => console.log(e.touches[0].clientX)
|
|
34
|
+
const handleWheel = (e: WheelEvent) => console.log(e.deltaY)
|
|
35
|
+
|
|
36
|
+
document.addEventListener('touchstart', handleTouch, { passive: true })
|
|
37
|
+
document.addEventListener('wheel', handleWheel, { passive: true })
|
|
38
|
+
|
|
39
|
+
return () => {
|
|
40
|
+
document.removeEventListener('touchstart', handleTouch)
|
|
41
|
+
document.removeEventListener('wheel', handleWheel)
|
|
42
|
+
}
|
|
43
|
+
}, [])
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Use passive when:** tracking/analytics, logging, any listener that doesn't call `preventDefault()`.
|
|
47
|
+
|
|
48
|
+
**Don't use passive when:** implementing custom swipe gestures, custom zoom controls, or any listener that needs `preventDefault()`.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Use SWR for Automatic Deduplication
|
|
3
|
+
impact: MEDIUM-HIGH
|
|
4
|
+
impactDescription: automatic deduplication
|
|
5
|
+
tags: client, swr, deduplication, data-fetching
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Use SWR for Automatic Deduplication
|
|
9
|
+
|
|
10
|
+
SWR enables request deduplication, caching, and revalidation across component instances.
|
|
11
|
+
|
|
12
|
+
**Incorrect (no deduplication, each instance fetches):**
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
function UserList() {
|
|
16
|
+
const [users, setUsers] = useState([])
|
|
17
|
+
useEffect(() => {
|
|
18
|
+
fetch('/api/users')
|
|
19
|
+
.then(r => r.json())
|
|
20
|
+
.then(setUsers)
|
|
21
|
+
}, [])
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Correct (multiple instances share one request):**
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import useSWR from 'swr'
|
|
29
|
+
|
|
30
|
+
function UserList() {
|
|
31
|
+
const { data: users } = useSWR('/api/users', fetcher)
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**For immutable data:**
|
|
36
|
+
|
|
37
|
+
```tsx
|
|
38
|
+
import { useImmutableSWR } from '@/lib/swr'
|
|
39
|
+
|
|
40
|
+
function StaticContent() {
|
|
41
|
+
const { data } = useImmutableSWR('/api/config', fetcher)
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**For mutations:**
|
|
46
|
+
|
|
47
|
+
```tsx
|
|
48
|
+
import { useSWRMutation } from 'swr/mutation'
|
|
49
|
+
|
|
50
|
+
function UpdateButton() {
|
|
51
|
+
const { trigger } = useSWRMutation('/api/user', updateUser)
|
|
52
|
+
return <button onClick={() => trigger()}>Update</button>
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Reference: [https://swr.vercel.app](https://swr.vercel.app)
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Avoid Layout Thrashing
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: prevents forced synchronous layouts and reduces performance bottlenecks
|
|
5
|
+
tags: javascript, dom, css, performance, reflow, layout-thrashing
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Avoid Layout Thrashing
|
|
9
|
+
|
|
10
|
+
Avoid interleaving style writes with layout reads. When you read a layout property (like `offsetWidth`, `getBoundingClientRect()`, or `getComputedStyle()`) between style changes, the browser is forced to trigger a synchronous reflow.
|
|
11
|
+
|
|
12
|
+
**This is OK (browser batches style changes):**
|
|
13
|
+
```typescript
|
|
14
|
+
function updateElementStyles(element: HTMLElement) {
|
|
15
|
+
// Each line invalidates style, but browser batches the recalculation
|
|
16
|
+
element.style.width = '100px'
|
|
17
|
+
element.style.height = '200px'
|
|
18
|
+
element.style.backgroundColor = 'blue'
|
|
19
|
+
element.style.border = '1px solid black'
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Incorrect (interleaved reads and writes force reflows):**
|
|
24
|
+
```typescript
|
|
25
|
+
function layoutThrashing(element: HTMLElement) {
|
|
26
|
+
element.style.width = '100px'
|
|
27
|
+
const width = element.offsetWidth // Forces reflow
|
|
28
|
+
element.style.height = '200px'
|
|
29
|
+
const height = element.offsetHeight // Forces another reflow
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**Correct (batch writes, then read once):**
|
|
34
|
+
```typescript
|
|
35
|
+
function updateElementStyles(element: HTMLElement) {
|
|
36
|
+
// Batch all writes together
|
|
37
|
+
element.style.width = '100px'
|
|
38
|
+
element.style.height = '200px'
|
|
39
|
+
element.style.backgroundColor = 'blue'
|
|
40
|
+
element.style.border = '1px solid black'
|
|
41
|
+
|
|
42
|
+
// Read after all writes are done (single reflow)
|
|
43
|
+
const { width, height } = element.getBoundingClientRect()
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**Correct (batch reads, then writes):**
|
|
48
|
+
```typescript
|
|
49
|
+
function avoidThrashing(element: HTMLElement) {
|
|
50
|
+
// Read phase - all layout queries first
|
|
51
|
+
const rect1 = element.getBoundingClientRect()
|
|
52
|
+
const offsetWidth = element.offsetWidth
|
|
53
|
+
const offsetHeight = element.offsetHeight
|
|
54
|
+
|
|
55
|
+
// Write phase - all style changes after
|
|
56
|
+
element.style.width = '100px'
|
|
57
|
+
element.style.height = '200px'
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Better: use CSS classes**
|
|
62
|
+
```css
|
|
63
|
+
.highlighted-box {
|
|
64
|
+
width: 100px;
|
|
65
|
+
height: 200px;
|
|
66
|
+
background-color: blue;
|
|
67
|
+
border: 1px solid black;
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
```typescript
|
|
71
|
+
function updateElementStyles(element: HTMLElement) {
|
|
72
|
+
element.classList.add('highlighted-box')
|
|
73
|
+
|
|
74
|
+
const { width, height } = element.getBoundingClientRect()
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**React example:**
|
|
79
|
+
```tsx
|
|
80
|
+
// Incorrect: interleaving style changes with layout queries
|
|
81
|
+
function Box({ isHighlighted }: { isHighlighted: boolean }) {
|
|
82
|
+
const ref = useRef<HTMLDivElement>(null)
|
|
83
|
+
|
|
84
|
+
useEffect(() => {
|
|
85
|
+
if (ref.current && isHighlighted) {
|
|
86
|
+
ref.current.style.width = '100px'
|
|
87
|
+
const width = ref.current.offsetWidth // Forces layout
|
|
88
|
+
ref.current.style.height = '200px'
|
|
89
|
+
}
|
|
90
|
+
}, [isHighlighted])
|
|
91
|
+
|
|
92
|
+
return <div ref={ref}>Content</div>
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Correct: toggle class
|
|
96
|
+
function Box({ isHighlighted }: { isHighlighted: boolean }) {
|
|
97
|
+
return (
|
|
98
|
+
<div className={isHighlighted ? 'highlighted-box' : ''}>
|
|
99
|
+
Content
|
|
100
|
+
</div>
|
|
101
|
+
)
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Prefer CSS classes over inline styles when possible. CSS files are cached by the browser, and classes provide better separation of concerns and are easier to maintain.
|
|
106
|
+
|
|
107
|
+
See [this gist](https://gist.github.com/paulirish/5d52fb081b3570c81e3a) and [CSS Triggers](https://csstriggers.com/) for more information on layout-forcing operations.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Cache Repeated Function Calls
|
|
3
|
+
impact: MEDIUM
|
|
4
|
+
impactDescription: avoid redundant computation
|
|
5
|
+
tags: javascript, cache, memoization, performance
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Cache Repeated Function Calls
|
|
9
|
+
|
|
10
|
+
Use a module-level Map to cache function results when the same function is called repeatedly with the same inputs during render.
|
|
11
|
+
|
|
12
|
+
**Incorrect (redundant computation):**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
function ProjectList({ projects }: { projects: Project[] }) {
|
|
16
|
+
return (
|
|
17
|
+
<div>
|
|
18
|
+
{projects.map(project => {
|
|
19
|
+
// slugify() called 100+ times for same project names
|
|
20
|
+
const slug = slugify(project.name)
|
|
21
|
+
|
|
22
|
+
return <ProjectCard key={project.id} slug={slug} />
|
|
23
|
+
})}
|
|
24
|
+
</div>
|
|
25
|
+
)
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Correct (cached results):**
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
// Module-level cache
|
|
33
|
+
const slugifyCache = new Map<string, string>()
|
|
34
|
+
|
|
35
|
+
function cachedSlugify(text: string): string {
|
|
36
|
+
if (slugifyCache.has(text)) {
|
|
37
|
+
return slugifyCache.get(text)!
|
|
38
|
+
}
|
|
39
|
+
const result = slugify(text)
|
|
40
|
+
slugifyCache.set(text, result)
|
|
41
|
+
return result
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function ProjectList({ projects }: { projects: Project[] }) {
|
|
45
|
+
return (
|
|
46
|
+
<div>
|
|
47
|
+
{projects.map(project => {
|
|
48
|
+
// Computed only once per unique project name
|
|
49
|
+
const slug = cachedSlugify(project.name)
|
|
50
|
+
|
|
51
|
+
return <ProjectCard key={project.id} slug={slug} />
|
|
52
|
+
})}
|
|
53
|
+
</div>
|
|
54
|
+
)
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Simpler pattern for single-value functions:**
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
let isLoggedInCache: boolean | null = null
|
|
62
|
+
|
|
63
|
+
function isLoggedIn(): boolean {
|
|
64
|
+
if (isLoggedInCache !== null) {
|
|
65
|
+
return isLoggedInCache
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
isLoggedInCache = document.cookie.includes('auth=')
|
|
69
|
+
return isLoggedInCache
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Clear cache when auth changes
|
|
73
|
+
function onAuthChange() {
|
|
74
|
+
isLoggedInCache = null
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Use a Map (not a hook) so it works everywhere: utilities, event handlers, not just React components.
|
|
79
|
+
|
|
80
|
+
Reference: [How we made the Vercel Dashboard twice as fast](https://vercel.com/blog/how-we-made-the-vercel-dashboard-twice-as-fast)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Cache Property Access in Loops
|
|
3
|
+
impact: LOW-MEDIUM
|
|
4
|
+
impactDescription: reduces lookups
|
|
5
|
+
tags: javascript, loops, optimization, caching
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Cache Property Access in Loops
|
|
9
|
+
|
|
10
|
+
Cache object property lookups in hot paths.
|
|
11
|
+
|
|
12
|
+
**Incorrect (3 lookups × N iterations):**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
for (let i = 0; i < arr.length; i++) {
|
|
16
|
+
process(obj.config.settings.value)
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**Correct (1 lookup total):**
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
const value = obj.config.settings.value
|
|
24
|
+
const len = arr.length
|
|
25
|
+
for (let i = 0; i < len; i++) {
|
|
26
|
+
process(value)
|
|
27
|
+
}
|
|
28
|
+
```
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Cache Storage API Calls
|
|
3
|
+
impact: LOW-MEDIUM
|
|
4
|
+
impactDescription: reduces expensive I/O
|
|
5
|
+
tags: javascript, localStorage, storage, caching, performance
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Cache Storage API Calls
|
|
9
|
+
|
|
10
|
+
`localStorage`, `sessionStorage`, and `document.cookie` are synchronous and expensive. Cache reads in memory.
|
|
11
|
+
|
|
12
|
+
**Incorrect (reads storage on every call):**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
function getTheme() {
|
|
16
|
+
return localStorage.getItem('theme') ?? 'light'
|
|
17
|
+
}
|
|
18
|
+
// Called 10 times = 10 storage reads
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Correct (Map cache):**
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
const storageCache = new Map<string, string | null>()
|
|
25
|
+
|
|
26
|
+
function getLocalStorage(key: string) {
|
|
27
|
+
if (!storageCache.has(key)) {
|
|
28
|
+
storageCache.set(key, localStorage.getItem(key))
|
|
29
|
+
}
|
|
30
|
+
return storageCache.get(key)
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
function setLocalStorage(key: string, value: string) {
|
|
34
|
+
localStorage.setItem(key, value)
|
|
35
|
+
storageCache.set(key, value) // keep cache in sync
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Use a Map (not a hook) so it works everywhere: utilities, event handlers, not just React components.
|
|
40
|
+
|
|
41
|
+
**Cookie caching:**
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
let cookieCache: Record<string, string> | null = null
|
|
45
|
+
|
|
46
|
+
function getCookie(name: string) {
|
|
47
|
+
if (!cookieCache) {
|
|
48
|
+
cookieCache = Object.fromEntries(
|
|
49
|
+
document.cookie.split('; ').map(c => c.split('='))
|
|
50
|
+
)
|
|
51
|
+
}
|
|
52
|
+
return cookieCache[name]
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Important (invalidate on external changes):**
|
|
57
|
+
|
|
58
|
+
If storage can change externally (another tab, server-set cookies), invalidate cache:
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
window.addEventListener('storage', (e) => {
|
|
62
|
+
if (e.key) storageCache.delete(e.key)
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
document.addEventListener('visibilitychange', () => {
|
|
66
|
+
if (document.visibilityState === 'visible') {
|
|
67
|
+
storageCache.clear()
|
|
68
|
+
}
|
|
69
|
+
})
|
|
70
|
+
```
|