cokit-cli 1.2.6 → 1.3.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/README.md +9 -42
- package/agents/brainstormer.agent.md +28 -14
- package/agents/code-reviewer.agent.md +101 -67
- package/agents/code-simplifier.agent.md +36 -41
- package/agents/debugger.agent.md +29 -24
- package/agents/docs-manager.agent.md +15 -23
- package/agents/fullstack-developer.agent.md +16 -6
- package/agents/git-manager.agent.md +0 -3
- package/agents/planner.agent.md +16 -34
- package/agents/project-manager.agent.md +24 -0
- package/agents/researcher.agent.md +15 -13
- package/agents/tester.agent.md +43 -20
- package/agents/ui-ux-designer.agent.md +16 -49
- package/docs/README.md +8 -9
- package/docs/Skills Orchestration Layer - Training Slides - en.pdf +0 -0
- package/docs/Skills Orchestration Layer - Training Slides - vi.pdf +0 -0
- package/docs/code-standards.md +1 -2
- package/docs/codebase-summary.md +35 -66
- package/docs/cokit-commands-usage-guide.md +27 -73
- package/docs/cokit-comprehensive-mapping-guide.md +9 -15
- package/docs/cokit-slides.md +4 -9
- package/docs/cokit-sync-and-maintenance-guide.md +42 -190
- package/docs/cokit-team-presentation.md +6 -11
- package/docs/copilot-processing-flow.md +3 -3
- package/docs/migration-guide.md +15 -15
- package/docs/project-overview-pdr.md +6 -7
- package/docs/project-roadmap.md +13 -15
- package/docs/skills-and-orchestration-layer-en.md +404 -0
- package/docs/skills-and-orchestration-layer-vi.md +404 -0
- package/docs/system-architecture.md +14 -20
- package/docs/{claudekit-porting-rules.md → upstream-porting-rules.md} +15 -16
- package/package.json +3 -4
- package/prompts/ck-ask.prompt.md +0 -1
- package/prompts/ck-bootstrap.prompt.md +0 -3
- package/prompts/ck-brainstorm.prompt.md +0 -1
- package/prompts/ck-cook.prompt.md +0 -1
- package/prompts/ck-debug.prompt.md +0 -1
- package/prompts/ck-deploy.prompt.md +22 -0
- package/prompts/ck-docs.prompt.md +0 -1
- package/prompts/ck-frontend.prompt.md +20 -0
- package/prompts/ck-help.prompt.md +0 -1
- package/prompts/ck-plan-fast.prompt.md +0 -3
- package/prompts/ck-plan-hard.prompt.md +0 -3
- package/prompts/ck-plan.prompt.md +0 -3
- package/prompts/ck-project.prompt.md +20 -0
- package/prompts/ck-review.prompt.md +0 -3
- package/prompts/ck-scout.prompt.md +0 -1
- package/prompts/ck-security.prompt.md +22 -0
- package/prompts/ck-ship.prompt.md +22 -0
- package/prompts/ck-test.prompt.md +0 -2
- package/prompts/ck-watzup.prompt.md +0 -1
- package/skills/agent-browser/SKILL.md +11 -8
- package/skills/agent-browser/references/agent-browser-vs-chrome-devtools.md +112 -0
- package/skills/bootstrap/SKILL.md +102 -0
- package/skills/bootstrap/references/shared-phases.md +59 -0
- package/skills/bootstrap/references/workflow-auto.md +52 -0
- package/skills/bootstrap/references/workflow-fast.md +50 -0
- package/skills/bootstrap/references/workflow-full.md +60 -0
- package/skills/bootstrap/references/workflow-parallel.md +59 -0
- package/skills/brainstorm/SKILL.md +63 -15
- package/skills/code-review/SKILL.md +138 -135
- package/skills/code-review/references/adversarial-review.md +223 -0
- package/skills/code-review/references/checklist-workflow.md +100 -0
- package/skills/code-review/references/checklists/api.md +52 -0
- package/skills/code-review/references/checklists/base.md +100 -0
- package/skills/code-review/references/checklists/web-app.md +54 -0
- package/skills/code-review/references/code-review-reception.md +48 -144
- package/skills/code-review/references/codebase-scan-workflow.md +30 -0
- package/skills/code-review/references/edge-case-scouting.md +119 -0
- package/skills/code-review/references/input-mode-resolution.md +135 -0
- package/skills/code-review/references/parallel-review-workflow.md +76 -0
- package/skills/code-review/references/requesting-code-review.md +115 -104
- package/skills/code-review/references/spec-compliance-review.md +43 -0
- package/skills/code-review/references/task-management-reviews.md +155 -0
- package/skills/common/README.md +2 -12
- package/skills/common/api_key_helper.py +7 -37
- package/skills/context-engineering/SKILL.md +4 -3
- package/skills/context-engineering/references/context-degradation.md +2 -2
- package/skills/context-engineering/references/runtime-awareness.md +5 -47
- package/skills/cook/README.md +13 -13
- package/skills/cook/SKILL.md +86 -58
- package/skills/cook/references/intent-detection.md +7 -7
- package/skills/cook/references/review-cycle.md +2 -2
- package/skills/cook/references/subagent-patterns.md +75 -0
- package/skills/cook/references/workflow-steps.md +75 -23
- package/skills/databases/SKILL.md +3 -30
- package/skills/databases/db-design.md +1 -1
- package/skills/debug/SKILL.md +47 -105
- package/skills/debug/references/frontend-verification.md +103 -0
- package/skills/debug/references/investigation-methodology.md +101 -0
- package/skills/debug/references/log-and-ci-analysis.md +97 -0
- package/skills/debug/references/performance-diagnostics.md +113 -0
- package/skills/debug/references/reporting-standards.md +122 -0
- package/skills/debug/references/task-management-debugging.md +155 -0
- package/skills/deploy/SKILL.md +154 -0
- package/skills/deploy/references/platform-config-templates.md +35 -0
- package/skills/deploy/references/platforms/aws.md +58 -0
- package/skills/deploy/references/platforms/cloudflare.md +41 -0
- package/skills/deploy/references/platforms/coolify.md +32 -0
- package/skills/deploy/references/platforms/digitalocean.md +45 -0
- package/skills/deploy/references/platforms/dokploy.md +29 -0
- package/skills/deploy/references/platforms/flyio.md +54 -0
- package/skills/deploy/references/platforms/gcp.md +45 -0
- package/skills/deploy/references/platforms/github-pages.md +56 -0
- package/skills/deploy/references/platforms/heroku.md +31 -0
- package/skills/deploy/references/platforms/netlify.md +39 -0
- package/skills/deploy/references/platforms/railway.md +38 -0
- package/skills/deploy/references/platforms/render.md +39 -0
- package/skills/deploy/references/platforms/tose.md +35 -0
- package/skills/deploy/references/platforms/vercel.md +37 -0
- package/skills/deploy/references/platforms/vultr.md +27 -0
- package/skills/devops/SKILL.md +6 -12
- package/skills/docs-seeker/SKILL.md +2 -1
- package/skills/docs-seeker/references/context7-patterns.md +4 -0
- package/skills/docs-seeker/scripts/fetch-docs.js +1 -2
- package/skills/docs-seeker/scripts/utils/env-loader.js +4 -4
- package/skills/docs-seeker/workflows/library-search.md +1 -0
- package/skills/fix/SKILL.md +141 -44
- package/skills/fix/references/complexity-assessment.md +21 -9
- package/skills/fix/references/diagnosis-protocol.md +133 -0
- package/skills/fix/references/mode-selection.md +27 -11
- package/skills/fix/references/parallel-exploration.md +35 -12
- package/skills/fix/references/prevention-gate.md +87 -0
- package/skills/fix/references/review-cycle.md +3 -3
- package/skills/fix/references/skill-activation-matrix.md +64 -31
- package/skills/fix/references/task-orchestration.md +110 -0
- package/skills/fix/references/workflow-deep.md +110 -47
- package/skills/fix/references/workflow-logs.md +46 -10
- package/skills/fix/references/workflow-quick.md +43 -20
- package/skills/fix/references/workflow-standard.md +75 -41
- package/skills/fix/references/workflow-test.md +49 -10
- package/skills/fix/references/workflow-ui.md +56 -18
- package/skills/frontend-design/SKILL.md +109 -77
- package/skills/frontend-design/references/ai-multimodal-overview.md +165 -0
- package/skills/frontend-design/references/anti-slop-rules.md +103 -0
- package/skills/frontend-design/references/asset-generation.md +284 -108
- package/skills/frontend-design/references/bento-motion-engine.md +142 -0
- package/skills/frontend-design/references/magicui-components.md +129 -0
- package/skills/frontend-design/references/performance-guardrails.md +169 -0
- package/skills/frontend-design/references/premium-design-patterns.md +93 -0
- package/skills/frontend-design/references/redesign-audit-checklist.md +114 -0
- package/skills/frontend-design/references/visual-analysis-overview.md +1 -1
- package/skills/frontend-design/references/workflow-3d.md +98 -0
- package/skills/frontend-design/references/workflow-describe.md +4 -3
- package/skills/frontend-design/references/workflow-immersive.md +82 -0
- package/skills/frontend-design/references/workflow-quick.md +10 -12
- package/skills/frontend-design/references/workflow-screenshot.md +9 -8
- package/skills/frontend-design/references/workflow-video.md +74 -0
- package/skills/frontend-development/SKILL.md +400 -0
- package/skills/frontend-development/resources/common-patterns.md +331 -0
- package/skills/frontend-development/resources/complete-examples.md +872 -0
- package/skills/frontend-development/resources/component-patterns.md +502 -0
- package/skills/frontend-development/resources/data-fetching.md +767 -0
- package/skills/frontend-development/resources/file-organization.md +502 -0
- package/skills/frontend-development/resources/loading-and-error-states.md +501 -0
- package/skills/frontend-development/resources/performance.md +406 -0
- package/skills/frontend-development/resources/routing-guide.md +364 -0
- package/skills/frontend-development/resources/styling-guide.md +428 -0
- package/skills/frontend-development/resources/typescript-standards.md +418 -0
- package/skills/git/SKILL.md +18 -4
- package/skills/git/references/commit-standards.md +3 -3
- package/skills/git/references/workflow-commit.md +3 -3
- package/skills/git/references/workflow-merge.md +1 -1
- package/skills/git/references/workflow-pr.md +1 -1
- package/skills/git/references/workflow-push.md +1 -1
- package/skills/mcp-management/README.md +18 -18
- package/skills/mcp-management/SKILL.md +16 -15
- package/skills/mcp-management/references/configuration.md +4 -4
- package/skills/mcp-management/references/gemini-cli-integration.md +12 -12
- package/skills/mcp-management/scripts/.env.example +2 -2
- package/skills/mcp-management/scripts/dist/mcp-client.js +1 -1
- package/skills/mcp-management/scripts/mcp-client.ts +1 -1
- package/skills/mermaidjs-v11/SKILL.md +1 -0
- package/skills/planning/SKILL.md +122 -91
- package/skills/planning/references/archive-workflow.md +53 -0
- package/skills/planning/references/codebase-understanding.md +1 -1
- package/skills/planning/references/output-standards.md +17 -13
- package/skills/planning/references/plan-organization.md +52 -30
- package/skills/planning/references/red-team-personas.md +69 -0
- package/skills/planning/references/red-team-workflow.md +77 -0
- package/skills/planning/references/scope-challenge.md +90 -0
- package/skills/planning/references/task-management.md +134 -0
- package/skills/planning/references/validate-question-framework.md +80 -0
- package/skills/planning/references/validate-workflow.md +65 -0
- package/skills/planning/references/workflow-modes.md +154 -0
- package/skills/problem-solving/SKILL.md +1 -0
- package/skills/project-management/SKILL.md +133 -0
- package/skills/project-management/references/documentation-triggers.md +60 -0
- package/skills/project-management/references/hydration-workflow.md +89 -0
- package/skills/project-management/references/progress-tracking.md +120 -0
- package/skills/project-management/references/reporting-patterns.md +94 -0
- package/skills/project-management/references/task-operations.md +87 -0
- package/skills/repomix/SKILL.md +3 -2
- package/skills/repomix/references/usage-patterns.md +2 -2
- package/skills/repomix/scripts/README.md +1 -1
- package/skills/repomix/scripts/repomix_batch.py +2 -2
- package/skills/research/SKILL.md +7 -4
- package/skills/scout/SKILL.md +24 -24
- package/skills/scout/references/external-scouting.md +17 -17
- package/skills/scout/references/internal-scouting.md +9 -9
- package/skills/scout/references/task-management-scouting.md +125 -0
- package/skills/security/SKILL.md +139 -0
- package/skills/security/references/stride-owasp-checklist.md +128 -0
- package/skills/sequential-thinking/README.md +3 -3
- package/skills/sequential-thinking/SKILL.md +2 -0
- package/skills/sequential-thinking/package.json +1 -1
- package/skills/ship/SKILL.md +116 -0
- package/skills/ship/references/auto-detect.md +103 -0
- package/skills/ship/references/pr-template.md +90 -0
- package/skills/ship/references/ship-workflow.md +241 -0
- package/skills/test/SKILL.md +111 -0
- package/skills/test/references/report-format.md +58 -0
- package/skills/test/references/test-execution-workflow.md +103 -0
- package/skills/test/references/ui-testing-workflow.md +65 -0
- package/skills/ui-styling/SKILL.md +2 -0
- package/skills/web-testing/SKILL.md +8 -60
- package/src/commands/add.js +0 -1
- package/src/commands/doctor.js +2 -2
- package/src/commands/init.js +19 -28
- package/src/commands/update.js +1 -1
- package/templates/repo/.github/agents/brainstormer.agent.md +28 -14
- package/templates/repo/.github/agents/code-reviewer.agent.md +101 -67
- package/templates/repo/.github/agents/code-simplifier.agent.md +36 -41
- package/templates/repo/.github/agents/debugger.agent.md +29 -24
- package/templates/repo/.github/agents/docs-manager.agent.md +15 -23
- package/templates/repo/.github/agents/fullstack-developer.agent.md +16 -6
- package/templates/repo/.github/agents/git-manager.agent.md +0 -3
- package/templates/repo/.github/agents/planner.agent.md +16 -34
- package/templates/repo/.github/agents/project-manager.agent.md +24 -0
- package/templates/repo/.github/agents/researcher.agent.md +15 -13
- package/templates/repo/.github/agents/tester.agent.md +43 -20
- package/templates/repo/.github/agents/ui-ux-designer.agent.md +16 -49
- package/templates/repo/.github/prompts/ck-ask.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-bootstrap.prompt.md +0 -3
- package/templates/repo/.github/prompts/ck-brainstorm.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-cook.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-debug.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-deploy.prompt.md +22 -0
- package/templates/repo/.github/prompts/ck-docs.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-frontend.prompt.md +20 -0
- package/templates/repo/.github/prompts/ck-help.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-plan-fast.prompt.md +0 -3
- package/templates/repo/.github/prompts/ck-plan-hard.prompt.md +0 -3
- package/templates/repo/.github/prompts/ck-plan.prompt.md +0 -3
- package/templates/repo/.github/prompts/ck-project.prompt.md +20 -0
- package/templates/repo/.github/prompts/ck-review.prompt.md +0 -3
- package/templates/repo/.github/prompts/ck-scout.prompt.md +0 -1
- package/templates/repo/.github/prompts/ck-security.prompt.md +22 -0
- package/templates/repo/.github/prompts/ck-ship.prompt.md +22 -0
- package/templates/repo/.github/prompts/ck-test.prompt.md +0 -2
- package/templates/repo/.github/prompts/ck-watzup.prompt.md +0 -1
- package/templates/repo/.github/skills/agent-browser/SKILL.md +11 -8
- package/templates/repo/.github/skills/agent-browser/references/agent-browser-vs-chrome-devtools.md +112 -0
- package/templates/repo/.github/skills/bootstrap/SKILL.md +102 -0
- package/templates/repo/.github/skills/bootstrap/references/shared-phases.md +59 -0
- package/templates/repo/.github/skills/bootstrap/references/workflow-auto.md +52 -0
- package/templates/repo/.github/skills/bootstrap/references/workflow-fast.md +50 -0
- package/templates/repo/.github/skills/bootstrap/references/workflow-full.md +60 -0
- package/templates/repo/.github/skills/bootstrap/references/workflow-parallel.md +59 -0
- package/templates/repo/.github/skills/brainstorm/SKILL.md +63 -15
- package/templates/repo/.github/skills/code-review/SKILL.md +138 -135
- package/templates/repo/.github/skills/code-review/references/adversarial-review.md +223 -0
- package/templates/repo/.github/skills/code-review/references/checklist-workflow.md +100 -0
- package/templates/repo/.github/skills/code-review/references/checklists/api.md +52 -0
- package/templates/repo/.github/skills/code-review/references/checklists/base.md +100 -0
- package/templates/repo/.github/skills/code-review/references/checklists/web-app.md +54 -0
- package/templates/repo/.github/skills/code-review/references/code-review-reception.md +48 -144
- package/templates/repo/.github/skills/code-review/references/codebase-scan-workflow.md +30 -0
- package/templates/repo/.github/skills/code-review/references/edge-case-scouting.md +119 -0
- package/templates/repo/.github/skills/code-review/references/input-mode-resolution.md +135 -0
- package/templates/repo/.github/skills/code-review/references/parallel-review-workflow.md +76 -0
- package/templates/repo/.github/skills/code-review/references/requesting-code-review.md +19 -8
- package/templates/repo/.github/skills/code-review/references/spec-compliance-review.md +43 -0
- package/templates/repo/.github/skills/code-review/references/task-management-reviews.md +155 -0
- package/templates/repo/.github/skills/common/README.md +2 -12
- package/templates/repo/.github/skills/common/api_key_helper.py +7 -37
- package/templates/repo/.github/skills/context-engineering/SKILL.md +4 -3
- package/templates/repo/.github/skills/context-engineering/references/context-degradation.md +2 -2
- package/templates/repo/.github/skills/context-engineering/references/runtime-awareness.md +5 -47
- package/templates/repo/.github/skills/cook/README.md +13 -13
- package/templates/repo/.github/skills/cook/SKILL.md +86 -58
- package/templates/repo/.github/skills/cook/references/intent-detection.md +7 -7
- package/templates/repo/.github/skills/cook/references/review-cycle.md +2 -2
- package/templates/repo/.github/skills/cook/references/subagent-patterns.md +75 -0
- package/templates/repo/.github/skills/cook/references/workflow-steps.md +75 -23
- package/templates/repo/.github/skills/databases/SKILL.md +3 -30
- package/templates/repo/.github/skills/databases/db-design.md +1 -1
- package/templates/repo/.github/skills/debug/SKILL.md +47 -105
- package/templates/repo/.github/skills/debug/references/frontend-verification.md +103 -0
- package/templates/repo/.github/skills/debug/references/investigation-methodology.md +101 -0
- package/templates/repo/.github/skills/debug/references/log-and-ci-analysis.md +97 -0
- package/templates/repo/.github/skills/debug/references/performance-diagnostics.md +113 -0
- package/templates/repo/.github/skills/debug/references/reporting-standards.md +122 -0
- package/templates/repo/.github/skills/debug/references/task-management-debugging.md +155 -0
- package/templates/repo/.github/skills/deploy/SKILL.md +154 -0
- package/templates/repo/.github/skills/deploy/references/platform-config-templates.md +35 -0
- package/templates/repo/.github/skills/deploy/references/platforms/aws.md +58 -0
- package/templates/repo/.github/skills/deploy/references/platforms/cloudflare.md +41 -0
- package/templates/repo/.github/skills/deploy/references/platforms/coolify.md +32 -0
- package/templates/repo/.github/skills/deploy/references/platforms/digitalocean.md +45 -0
- package/templates/repo/.github/skills/deploy/references/platforms/dokploy.md +29 -0
- package/templates/repo/.github/skills/deploy/references/platforms/flyio.md +54 -0
- package/templates/repo/.github/skills/deploy/references/platforms/gcp.md +45 -0
- package/templates/repo/.github/skills/deploy/references/platforms/github-pages.md +56 -0
- package/templates/repo/.github/skills/deploy/references/platforms/heroku.md +31 -0
- package/templates/repo/.github/skills/deploy/references/platforms/netlify.md +39 -0
- package/templates/repo/.github/skills/deploy/references/platforms/railway.md +38 -0
- package/templates/repo/.github/skills/deploy/references/platforms/render.md +39 -0
- package/templates/repo/.github/skills/deploy/references/platforms/tose.md +35 -0
- package/templates/repo/.github/skills/deploy/references/platforms/vercel.md +37 -0
- package/templates/repo/.github/skills/deploy/references/platforms/vultr.md +27 -0
- package/templates/repo/.github/skills/devops/SKILL.md +6 -12
- package/templates/repo/.github/skills/docs-seeker/SKILL.md +2 -1
- package/templates/repo/.github/skills/docs-seeker/references/context7-patterns.md +4 -0
- package/templates/repo/.github/skills/docs-seeker/scripts/fetch-docs.js +1 -2
- package/templates/repo/.github/skills/docs-seeker/scripts/utils/env-loader.js +4 -4
- package/templates/repo/.github/skills/docs-seeker/workflows/library-search.md +1 -0
- package/templates/repo/.github/skills/fix/SKILL.md +141 -44
- package/templates/repo/.github/skills/fix/references/complexity-assessment.md +21 -9
- package/templates/repo/.github/skills/fix/references/diagnosis-protocol.md +133 -0
- package/templates/repo/.github/skills/fix/references/mode-selection.md +27 -11
- package/templates/repo/.github/skills/fix/references/parallel-exploration.md +35 -12
- package/templates/repo/.github/skills/fix/references/prevention-gate.md +87 -0
- package/templates/repo/.github/skills/fix/references/review-cycle.md +3 -3
- package/templates/repo/.github/skills/fix/references/skill-activation-matrix.md +64 -31
- package/templates/repo/.github/skills/fix/references/task-orchestration.md +110 -0
- package/templates/repo/.github/skills/fix/references/workflow-deep.md +110 -47
- package/templates/repo/.github/skills/fix/references/workflow-logs.md +46 -10
- package/templates/repo/.github/skills/fix/references/workflow-quick.md +43 -20
- package/templates/repo/.github/skills/fix/references/workflow-standard.md +75 -41
- package/templates/repo/.github/skills/fix/references/workflow-test.md +49 -10
- package/templates/repo/.github/skills/fix/references/workflow-ui.md +56 -18
- package/templates/repo/.github/skills/frontend-design/SKILL.md +49 -17
- package/templates/repo/.github/skills/frontend-design/references/ai-multimodal-overview.md +165 -0
- package/templates/repo/.github/skills/frontend-design/references/anti-slop-rules.md +103 -0
- package/templates/repo/.github/skills/frontend-design/references/asset-generation.md +284 -108
- package/templates/repo/.github/skills/frontend-design/references/bento-motion-engine.md +142 -0
- package/templates/repo/.github/skills/frontend-design/references/magicui-components.md +129 -0
- package/templates/repo/.github/skills/frontend-design/references/performance-guardrails.md +169 -0
- package/templates/repo/.github/skills/frontend-design/references/premium-design-patterns.md +93 -0
- package/templates/repo/.github/skills/frontend-design/references/redesign-audit-checklist.md +114 -0
- package/templates/repo/.github/skills/frontend-design/references/visual-analysis-overview.md +1 -1
- package/templates/repo/.github/skills/frontend-design/references/workflow-3d.md +98 -0
- package/templates/repo/.github/skills/frontend-design/references/workflow-describe.md +4 -3
- package/templates/repo/.github/skills/frontend-design/references/workflow-immersive.md +82 -0
- package/templates/repo/.github/skills/frontend-design/references/workflow-quick.md +10 -12
- package/templates/repo/.github/skills/frontend-design/references/workflow-screenshot.md +9 -8
- package/templates/repo/.github/skills/frontend-design/references/workflow-video.md +74 -0
- package/templates/repo/.github/skills/frontend-development/SKILL.md +400 -0
- package/templates/repo/.github/skills/frontend-development/resources/common-patterns.md +331 -0
- package/templates/repo/.github/skills/frontend-development/resources/complete-examples.md +872 -0
- package/templates/repo/.github/skills/frontend-development/resources/component-patterns.md +502 -0
- package/templates/repo/.github/skills/frontend-development/resources/data-fetching.md +767 -0
- package/templates/repo/.github/skills/frontend-development/resources/file-organization.md +502 -0
- package/templates/repo/.github/skills/frontend-development/resources/loading-and-error-states.md +501 -0
- package/templates/repo/.github/skills/frontend-development/resources/performance.md +406 -0
- package/templates/repo/.github/skills/frontend-development/resources/routing-guide.md +364 -0
- package/templates/repo/.github/skills/frontend-development/resources/styling-guide.md +428 -0
- package/templates/repo/.github/skills/frontend-development/resources/typescript-standards.md +418 -0
- package/templates/repo/.github/skills/git/SKILL.md +18 -4
- package/templates/repo/.github/skills/git/references/commit-standards.md +3 -3
- package/templates/repo/.github/skills/git/references/workflow-commit.md +3 -3
- package/templates/repo/.github/skills/git/references/workflow-merge.md +1 -1
- package/templates/repo/.github/skills/git/references/workflow-pr.md +1 -1
- package/templates/repo/.github/skills/git/references/workflow-push.md +1 -1
- package/templates/repo/.github/skills/mcp-management/README.md +18 -18
- package/templates/repo/.github/skills/mcp-management/SKILL.md +16 -15
- package/templates/repo/.github/skills/mcp-management/references/configuration.md +4 -4
- package/templates/repo/.github/skills/mcp-management/references/gemini-cli-integration.md +12 -12
- package/templates/repo/.github/skills/mcp-management/scripts/.env.example +2 -2
- package/templates/repo/.github/skills/mcp-management/scripts/mcp-client.ts +1 -1
- package/templates/repo/.github/skills/mermaidjs-v11/SKILL.md +1 -0
- package/templates/repo/.github/skills/planning/SKILL.md +122 -91
- package/templates/repo/.github/skills/planning/references/archive-workflow.md +53 -0
- package/templates/repo/.github/skills/planning/references/codebase-understanding.md +1 -1
- package/templates/repo/.github/skills/planning/references/output-standards.md +17 -13
- package/templates/repo/.github/skills/planning/references/plan-organization.md +52 -30
- package/templates/repo/.github/skills/planning/references/red-team-personas.md +69 -0
- package/templates/repo/.github/skills/planning/references/red-team-workflow.md +77 -0
- package/templates/repo/.github/skills/planning/references/scope-challenge.md +90 -0
- package/templates/repo/.github/skills/planning/references/task-management.md +134 -0
- package/templates/repo/.github/skills/planning/references/validate-question-framework.md +80 -0
- package/templates/repo/.github/skills/planning/references/validate-workflow.md +65 -0
- package/templates/repo/.github/skills/planning/references/workflow-modes.md +154 -0
- package/templates/repo/.github/skills/problem-solving/SKILL.md +1 -0
- package/templates/repo/.github/skills/project-management/SKILL.md +133 -0
- package/templates/repo/.github/skills/project-management/references/documentation-triggers.md +60 -0
- package/templates/repo/.github/skills/project-management/references/hydration-workflow.md +89 -0
- package/templates/repo/.github/skills/project-management/references/progress-tracking.md +120 -0
- package/templates/repo/.github/skills/project-management/references/reporting-patterns.md +94 -0
- package/templates/repo/.github/skills/project-management/references/task-operations.md +87 -0
- package/templates/repo/.github/skills/repomix/SKILL.md +3 -2
- package/templates/repo/.github/skills/repomix/references/usage-patterns.md +2 -2
- package/templates/repo/.github/skills/repomix/scripts/README.md +1 -1
- package/templates/repo/.github/skills/repomix/scripts/repomix_batch.py +2 -2
- package/templates/repo/.github/skills/research/SKILL.md +7 -4
- package/templates/repo/.github/skills/scout/SKILL.md +24 -24
- package/templates/repo/.github/skills/scout/references/external-scouting.md +17 -17
- package/templates/repo/.github/skills/scout/references/internal-scouting.md +9 -9
- package/templates/repo/.github/skills/scout/references/task-management-scouting.md +125 -0
- package/templates/repo/.github/skills/security/SKILL.md +139 -0
- package/templates/repo/.github/skills/security/references/stride-owasp-checklist.md +128 -0
- package/templates/repo/.github/skills/sequential-thinking/README.md +3 -3
- package/templates/repo/.github/skills/sequential-thinking/SKILL.md +2 -0
- package/templates/repo/.github/skills/sequential-thinking/package-lock.json +3652 -0
- package/templates/repo/.github/skills/sequential-thinking/package.json +1 -1
- package/templates/repo/.github/skills/ship/SKILL.md +116 -0
- package/templates/repo/.github/skills/ship/references/auto-detect.md +103 -0
- package/templates/repo/.github/skills/ship/references/pr-template.md +90 -0
- package/templates/repo/.github/skills/ship/references/ship-workflow.md +241 -0
- package/templates/repo/.github/skills/test/SKILL.md +111 -0
- package/templates/repo/.github/skills/test/references/report-format.md +58 -0
- package/templates/repo/.github/skills/test/references/test-execution-workflow.md +103 -0
- package/templates/repo/.github/skills/test/references/ui-testing-workflow.md +65 -0
- package/templates/repo/.github/skills/ui-styling/SKILL.md +2 -0
- package/templates/repo/.github/skills/web-testing/SKILL.md +8 -60
- package/docs/guide-next-steps-speckit-cokit-implementation.md +0 -187
- package/prompts/ck-spec-analyze.prompt.md +0 -201
- package/prompts/ck-spec-checklist.prompt.md +0 -308
- package/prompts/ck-spec-clarify.prompt.md +0 -190
- package/prompts/ck-spec-constitution.prompt.md +0 -92
- package/prompts/ck-spec-implement.prompt.md +0 -157
- package/prompts/ck-spec-plan.prompt.md +0 -95
- package/prompts/ck-spec-specify.prompt.md +0 -261
- package/prompts/ck-spec-tasks.prompt.md +0 -181
- package/templates/repo/.github/AGENTS.md +0 -103
- package/templates/repo/.github/prompts/ck-spec-analyze.prompt.md +0 -201
- package/templates/repo/.github/prompts/ck-spec-checklist.prompt.md +0 -308
- package/templates/repo/.github/prompts/ck-spec-clarify.prompt.md +0 -190
- package/templates/repo/.github/prompts/ck-spec-constitution.prompt.md +0 -92
- package/templates/repo/.github/prompts/ck-spec-implement.prompt.md +0 -157
- package/templates/repo/.github/prompts/ck-spec-plan.prompt.md +0 -95
- package/templates/repo/.github/prompts/ck-spec-specify.prompt.md +0 -261
- package/templates/repo/.github/prompts/ck-spec-tasks.prompt.md +0 -181
- package/templates/repo/.github/skills/databases/stacks/bigquery.md +0 -231
- package/templates/repo/.github/skills/databases/stacks/d1_cloudflare.md +0 -137
- package/templates/repo/.github/skills/databases/stacks/mysql.md +0 -216
- package/templates/repo/.github/skills/databases/stacks/postgres.md +0 -235
- package/templates/repo/.github/skills/databases/stacks/sqlite.md +0 -244
- package/templates/repo/.github/skills/mcp-management/assets/tools.json +0 -3146
- package/templates/repo/.github/skills/mcp-management/scripts/dist/analyze-tools.js +0 -70
- package/templates/repo/.github/skills/mcp-management/scripts/dist/cli.js +0 -160
- package/templates/repo/.github/skills/mcp-management/scripts/dist/mcp-client.js +0 -183
- package/templates/repo/.github/skills/ui-styling/LICENSE.txt +0 -202
- package/templates/repo/.github/spec-kit/memory/constitution.md +0 -50
- package/templates/repo/.github/spec-kit/scripts/bash/check-prerequisites.sh +0 -166
- package/templates/repo/.github/spec-kit/scripts/bash/common.sh +0 -156
- package/templates/repo/.github/spec-kit/scripts/bash/create-new-feature.sh +0 -297
- package/templates/repo/.github/spec-kit/scripts/bash/setup-plan.sh +0 -61
- package/templates/repo/.github/spec-kit/scripts/bash/update-agent-context.sh +0 -799
- package/templates/repo/.github/spec-kit/scripts/powershell/check-prerequisites.ps1 +0 -148
- package/templates/repo/.github/spec-kit/scripts/powershell/common.ps1 +0 -137
- package/templates/repo/.github/spec-kit/scripts/powershell/create-new-feature.ps1 +0 -283
- package/templates/repo/.github/spec-kit/scripts/powershell/setup-plan.ps1 +0 -61
- package/templates/repo/.github/spec-kit/scripts/powershell/update-agent-context.ps1 +0 -448
- package/templates/repo/.github/spec-kit/templates/agent-file-template.md +0 -28
- package/templates/repo/.github/spec-kit/templates/checklist-template.md +0 -40
- package/templates/repo/.github/spec-kit/templates/commands/analyze.md +0 -187
- package/templates/repo/.github/spec-kit/templates/commands/checklist.md +0 -297
- package/templates/repo/.github/spec-kit/templates/commands/clarify.md +0 -184
- package/templates/repo/.github/spec-kit/templates/commands/constitution.md +0 -82
- package/templates/repo/.github/spec-kit/templates/commands/implement.md +0 -138
- package/templates/repo/.github/spec-kit/templates/commands/plan.md +0 -95
- package/templates/repo/.github/spec-kit/templates/commands/specify.md +0 -261
- package/templates/repo/.github/spec-kit/templates/commands/tasks.md +0 -140
- package/templates/repo/.github/spec-kit/templates/commands/taskstoissues.md +0 -33
- package/templates/repo/.github/spec-kit/templates/plan-template.md +0 -104
- package/templates/repo/.github/spec-kit/templates/spec-template.md +0 -115
- package/templates/repo/.github/spec-kit/templates/tasks-phase-template.md +0 -42
- package/templates/repo/.github/spec-kit/templates/tasks-template.md +0 -268
- package/templates/repo/.github/spec-kit/templates/vscode-settings.json +0 -14
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Immersive Design Workflow
|
|
2
|
+
|
|
3
|
+
Create award-quality designs with storytelling, 3D experiences, and micro-interactions.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
- Activate `ui-ux-pro-max` skill (if available) first
|
|
7
|
+
|
|
8
|
+
## Initial Research
|
|
9
|
+
```bash
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Workflow Steps
|
|
13
|
+
|
|
14
|
+
### 1. Research Phase
|
|
15
|
+
Use `researcher` subagent to investigate:
|
|
16
|
+
- Design style and current trends
|
|
17
|
+
- Font combinations and typography
|
|
18
|
+
- Color theory for the context
|
|
19
|
+
- Border and spacing patterns
|
|
20
|
+
- Element positioning principles
|
|
21
|
+
- Animation and interaction patterns
|
|
22
|
+
|
|
23
|
+
### 2. Design Implementation
|
|
24
|
+
Use `ui-ux-designer` subagent:
|
|
25
|
+
- Build step by step from research
|
|
26
|
+
- Create plan with `## Naming` pattern
|
|
27
|
+
- Default to HTML/CSS/JS if unspecified
|
|
28
|
+
|
|
29
|
+
### 3. Storytelling Elements
|
|
30
|
+
Incorporate:
|
|
31
|
+
- Narrative flow through scroll
|
|
32
|
+
- Emotional pacing
|
|
33
|
+
- Visual hierarchy for story beats
|
|
34
|
+
- Progressive disclosure of content
|
|
35
|
+
|
|
36
|
+
### 4. 3D Experiences
|
|
37
|
+
If applicable, integrate:
|
|
38
|
+
- Three.js scenes
|
|
39
|
+
- Interactive 3D elements
|
|
40
|
+
- Parallax depth effects
|
|
41
|
+
- WebGL enhancements
|
|
42
|
+
|
|
43
|
+
### 5. Micro-interactions
|
|
44
|
+
Add polish:
|
|
45
|
+
- Button feedback
|
|
46
|
+
- Form interactions
|
|
47
|
+
- Loading states
|
|
48
|
+
- Hover effects
|
|
49
|
+
- Scroll responses
|
|
50
|
+
|
|
51
|
+
### 6. Asset Generation
|
|
52
|
+
Use `ai-multimodal` (if available) skill:
|
|
53
|
+
- Generate high-quality visuals
|
|
54
|
+
- Create unique imagery
|
|
55
|
+
- Verify asset quality
|
|
56
|
+
- Remove backgrounds as needed
|
|
57
|
+
|
|
58
|
+
### 7. Verify & Report
|
|
59
|
+
- Review against inspiration
|
|
60
|
+
- Report to user
|
|
61
|
+
- Request approval
|
|
62
|
+
- Update `./docs/design-guidelines.md`
|
|
63
|
+
|
|
64
|
+
## Quality Standards
|
|
65
|
+
Match award-winning sites:
|
|
66
|
+
- Dribbble top shots
|
|
67
|
+
- Behance featured
|
|
68
|
+
- Awwwards winners
|
|
69
|
+
- Mobbin patterns
|
|
70
|
+
- TheFWA selections
|
|
71
|
+
|
|
72
|
+
## Design Principles
|
|
73
|
+
- **Bold aesthetic choices**: Commit fully to direction
|
|
74
|
+
- **Attention to detail**: Every pixel matters
|
|
75
|
+
- **Cohesive experience**: All elements work together
|
|
76
|
+
- **Memorable moments**: Create surprise and delight
|
|
77
|
+
- **Technical excellence**: Performance + polish
|
|
78
|
+
|
|
79
|
+
## Related
|
|
80
|
+
- `workflow-3d.md` - 3D implementation details
|
|
81
|
+
- `animejs.md` - Animation patterns
|
|
82
|
+
- `technical-best-practices.md` - Quality guidelines
|
|
@@ -3,18 +3,16 @@
|
|
|
3
3
|
Rapid design creation with minimal planning overhead.
|
|
4
4
|
|
|
5
5
|
## Prerequisites
|
|
6
|
-
- Activate `ui-
|
|
6
|
+
- Activate `ui-ux-pro-max` skill (if available) first
|
|
7
7
|
|
|
8
8
|
## Initial Research
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
- Tailwind CSS utility classes
|
|
12
|
-
- Color and typography defaults
|
|
9
|
+
```bash
|
|
10
|
+
```
|
|
13
11
|
|
|
14
12
|
## Workflow Steps
|
|
15
13
|
|
|
16
14
|
### 1. Start Design Process
|
|
17
|
-
Use `ui-ux-designer`
|
|
15
|
+
Use `ui-ux-designer` subagent directly:
|
|
18
16
|
- Skip extensive planning
|
|
19
17
|
- Move to implementation quickly
|
|
20
18
|
- Make design decisions on-the-fly
|
|
@@ -24,11 +22,11 @@ Use `ui-ux-designer` agent directly:
|
|
|
24
22
|
- Focus on core functionality
|
|
25
23
|
- Maintain quality despite speed
|
|
26
24
|
|
|
27
|
-
### 3.
|
|
28
|
-
Use
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
25
|
+
### 3. Generate Assets
|
|
26
|
+
Use `ai-multimodal` (if available) skill:
|
|
27
|
+
- Generate required visuals
|
|
28
|
+
- Verify quality quickly
|
|
29
|
+
- Use `media-processing` for adjustments
|
|
32
30
|
|
|
33
31
|
### 4. Report & Approve
|
|
34
32
|
- Summarize changes briefly
|
|
@@ -50,5 +48,5 @@ While moving fast, maintain:
|
|
|
50
48
|
- Clean code structure
|
|
51
49
|
|
|
52
50
|
## Related
|
|
53
|
-
- `workflow-
|
|
51
|
+
- `workflow-immersive.md` - For comprehensive designs
|
|
54
52
|
- `technical-overview.md` - Quick reference
|
|
@@ -3,12 +3,13 @@
|
|
|
3
3
|
Replicate a design exactly from a provided screenshot.
|
|
4
4
|
|
|
5
5
|
## Prerequisites
|
|
6
|
-
- Activate `ui-
|
|
6
|
+
- Activate `ui-ux-pro-max` skill (if available) first for design intelligence
|
|
7
|
+
- Have `ai-multimodal` (if available) skill ready for visual analysis
|
|
7
8
|
|
|
8
9
|
## Workflow Steps
|
|
9
10
|
|
|
10
11
|
### 1. Analyze Screenshot Details
|
|
11
|
-
|
|
12
|
+
Use `ai-multimodal` (if available) skill to extract:
|
|
12
13
|
- Design style and visual trends
|
|
13
14
|
- Font names (predict Google Fonts), sizes, weights
|
|
14
15
|
- Color palette with exact hex codes
|
|
@@ -22,7 +23,7 @@ Extract from screenshot:
|
|
|
22
23
|
**Font Prediction**: Avoid defaulting to Inter/Poppins. Match actual fonts visible.
|
|
23
24
|
|
|
24
25
|
### 2. Create Implementation Plan
|
|
25
|
-
Use `ui-ux-designer`
|
|
26
|
+
Use `ui-ux-designer` subagent:
|
|
26
27
|
- Create plan directory (use `## Naming` pattern from hooks)
|
|
27
28
|
- Write `plan.md` (<80 lines, generic overview)
|
|
28
29
|
- Add `phase-XX-name.md` files with:
|
|
@@ -36,11 +37,11 @@ Use `ui-ux-designer` agent:
|
|
|
36
37
|
- Default to HTML/CSS/JS if no framework specified
|
|
37
38
|
- Match screenshot precisely
|
|
38
39
|
|
|
39
|
-
### 4.
|
|
40
|
-
Use
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
40
|
+
### 4. Generate Assets
|
|
41
|
+
Use `ai-multimodal` (if available) skill:
|
|
42
|
+
- Generate images, icons, backgrounds
|
|
43
|
+
- Verify generated assets match design
|
|
44
|
+
- Remove backgrounds if needed with `media-processing`
|
|
44
45
|
|
|
45
46
|
### 5. Verify & Report
|
|
46
47
|
- Compare implementation to screenshot
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Video Replication Workflow
|
|
2
|
+
|
|
3
|
+
Replicate a design including animations/interactions from a provided video.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
- Activate `ui-ux-pro-max` skill (if available) first
|
|
7
|
+
- Have `ai-multimodal` (if available) skill ready for video analysis
|
|
8
|
+
|
|
9
|
+
## Workflow Steps
|
|
10
|
+
|
|
11
|
+
### 1. Analyze Video Details
|
|
12
|
+
Use `ai-multimodal` (if available) skill to describe:
|
|
13
|
+
- Every visible element and its properties
|
|
14
|
+
- All interactions and user flows
|
|
15
|
+
- Animation timing, easing, duration
|
|
16
|
+
- Transitions between states/pages
|
|
17
|
+
- Color palette with hex codes
|
|
18
|
+
- Typography (predict Google Fonts)
|
|
19
|
+
- Borders, spacing, sizing
|
|
20
|
+
- Textures, materials, lighting
|
|
21
|
+
- Shadows, reflections, blur, glow
|
|
22
|
+
- Background effects
|
|
23
|
+
|
|
24
|
+
**Font Prediction**: Avoid defaulting to Inter/Poppins.
|
|
25
|
+
|
|
26
|
+
### 2. Create Implementation Plan
|
|
27
|
+
Use `ui-ux-designer` subagent:
|
|
28
|
+
- Create plan directory (use `## Naming` pattern)
|
|
29
|
+
- Write `plan.md` (<80 lines overview)
|
|
30
|
+
- Add `phase-XX-name.md` files with full sections
|
|
31
|
+
- Keep research reports under 150 lines
|
|
32
|
+
|
|
33
|
+
### 3. Implement
|
|
34
|
+
- Follow plan step by step
|
|
35
|
+
- Default to HTML/CSS/JS if unspecified
|
|
36
|
+
- Prioritize animation accuracy
|
|
37
|
+
|
|
38
|
+
### 4. Animation Implementation
|
|
39
|
+
Focus on:
|
|
40
|
+
- Timing functions matching video
|
|
41
|
+
- State transitions
|
|
42
|
+
- Micro-interactions
|
|
43
|
+
- Scroll-triggered effects
|
|
44
|
+
- Hover/focus states
|
|
45
|
+
- Loading animations
|
|
46
|
+
|
|
47
|
+
Use `animejs.md` reference for animation patterns.
|
|
48
|
+
|
|
49
|
+
### 5. Generate Assets
|
|
50
|
+
Use `ai-multimodal` (if available) skill:
|
|
51
|
+
- Generate static assets
|
|
52
|
+
- Create animated sprites if needed
|
|
53
|
+
- Verify quality matches video
|
|
54
|
+
- Use `media-processing` for processing
|
|
55
|
+
|
|
56
|
+
### 6. Verify & Report
|
|
57
|
+
- Compare implementation to video
|
|
58
|
+
- Test all interactions
|
|
59
|
+
- Report summary to user
|
|
60
|
+
- Request approval
|
|
61
|
+
|
|
62
|
+
### 7. Document
|
|
63
|
+
If approved, update `./docs/design-guidelines.md`
|
|
64
|
+
|
|
65
|
+
## Quality Standards
|
|
66
|
+
- Frame-accurate animation timing
|
|
67
|
+
- Smooth 60fps performance
|
|
68
|
+
- Responsive behavior preserved
|
|
69
|
+
- All interactions functional
|
|
70
|
+
|
|
71
|
+
## Related
|
|
72
|
+
- `animejs.md` - Animation library reference
|
|
73
|
+
- `design-extraction-overview.md` - Guidelines extraction
|
|
74
|
+
- `technical-optimization.md` - Performance tips
|
|
@@ -0,0 +1,400 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: frontend-development
|
|
3
|
+
description: Build React/TypeScript frontends with modern patterns. Use for components, Suspense, lazy loading, useSuspenseQuery, MUI v7 styling, TanStack Router, performance optimization.
|
|
4
|
+
argument-hint: "[component or feature]"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Frontend Development Guidelines
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
|
|
11
|
+
Comprehensive guide for modern React development, emphasizing Suspense-based data fetching, lazy loading, proper file organization, and performance optimization.
|
|
12
|
+
|
|
13
|
+
## When to Use This Skill
|
|
14
|
+
|
|
15
|
+
- Creating new components or pages
|
|
16
|
+
- Building new features
|
|
17
|
+
- Fetching data with TanStack Query
|
|
18
|
+
- Setting up routing with TanStack Router
|
|
19
|
+
- Styling components with MUI v7
|
|
20
|
+
- Performance optimization
|
|
21
|
+
- Organizing frontend code
|
|
22
|
+
- TypeScript best practices
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Quick Start
|
|
27
|
+
|
|
28
|
+
### New Component Checklist
|
|
29
|
+
|
|
30
|
+
Creating a component? Follow this checklist:
|
|
31
|
+
|
|
32
|
+
- [ ] Use `React.FC<Props>` pattern with TypeScript
|
|
33
|
+
- [ ] Lazy load if heavy component: `React.lazy(() => import())`
|
|
34
|
+
- [ ] Wrap in `<SuspenseLoader>` for loading states
|
|
35
|
+
- [ ] Use `useSuspenseQuery` for data fetching
|
|
36
|
+
- [ ] Import aliases: `@/`, `~types`, `~components`, `~features`
|
|
37
|
+
- [ ] Styles: Inline if <100 lines, separate file if >100 lines
|
|
38
|
+
- [ ] Use `useCallback` for event handlers passed to children
|
|
39
|
+
- [ ] Default export at bottom
|
|
40
|
+
- [ ] No early returns with loading spinners
|
|
41
|
+
- [ ] Use `useMuiSnackbar` for user notifications
|
|
42
|
+
|
|
43
|
+
### New Feature Checklist
|
|
44
|
+
|
|
45
|
+
Creating a feature? Set up this structure:
|
|
46
|
+
|
|
47
|
+
- [ ] Create `features/{feature-name}/` directory
|
|
48
|
+
- [ ] Create subdirectories: `api/`, `components/`, `hooks/`, `helpers/`, `types/`
|
|
49
|
+
- [ ] Create API service file: `api/{feature}Api.ts`
|
|
50
|
+
- [ ] Set up TypeScript types in `types/`
|
|
51
|
+
- [ ] Create route in `routes/{feature-name}/index.tsx`
|
|
52
|
+
- [ ] Lazy load feature components
|
|
53
|
+
- [ ] Use Suspense boundaries
|
|
54
|
+
- [ ] Export public API from feature `index.ts`
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Import Aliases Quick Reference
|
|
59
|
+
|
|
60
|
+
| Alias | Resolves To | Example |
|
|
61
|
+
|-------|-------------|---------|
|
|
62
|
+
| `@/` | `src/` | `import { apiClient } from '@/lib/apiClient'` |
|
|
63
|
+
| `~types` | `src/types` | `import type { User } from '~types/user'` |
|
|
64
|
+
| `~components` | `src/components` | `import { SuspenseLoader } from '~components/SuspenseLoader'` |
|
|
65
|
+
| `~features` | `src/features` | `import { authApi } from '~features/auth'` |
|
|
66
|
+
|
|
67
|
+
Defined in: [vite.config.ts](../../vite.config.ts) lines 180-185
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Common Imports Cheatsheet
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
// React & Lazy Loading
|
|
75
|
+
import React, { useState, useCallback, useMemo } from 'react';
|
|
76
|
+
const Heavy = React.lazy(() => import('./Heavy'));
|
|
77
|
+
|
|
78
|
+
// MUI Components
|
|
79
|
+
import { Box, Paper, Typography, Button, Grid } from '@mui/material';
|
|
80
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
81
|
+
|
|
82
|
+
// TanStack Query (Suspense)
|
|
83
|
+
import { useSuspenseQuery, useQueryClient } from '@tanstack/react-query';
|
|
84
|
+
|
|
85
|
+
// TanStack Router
|
|
86
|
+
import { createFileRoute } from '@tanstack/react-router';
|
|
87
|
+
|
|
88
|
+
// Project Components
|
|
89
|
+
import { SuspenseLoader } from '~components/SuspenseLoader';
|
|
90
|
+
|
|
91
|
+
// Hooks
|
|
92
|
+
import { useAuth } from '@/hooks/useAuth';
|
|
93
|
+
import { useMuiSnackbar } from '@/hooks/useMuiSnackbar';
|
|
94
|
+
|
|
95
|
+
// Types
|
|
96
|
+
import type { Post } from '~types/post';
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Topic Guides
|
|
102
|
+
|
|
103
|
+
### 🎨 Component Patterns
|
|
104
|
+
|
|
105
|
+
**Modern React components use:**
|
|
106
|
+
- `React.FC<Props>` for type safety
|
|
107
|
+
- `React.lazy()` for code splitting
|
|
108
|
+
- `SuspenseLoader` for loading states
|
|
109
|
+
- Named const + default export pattern
|
|
110
|
+
|
|
111
|
+
**Key Concepts:**
|
|
112
|
+
- Lazy load heavy components (DataGrid, charts, editors)
|
|
113
|
+
- Always wrap lazy components in Suspense
|
|
114
|
+
- Use SuspenseLoader component (with fade animation)
|
|
115
|
+
- Component structure: Props → Hooks → Handlers → Render → Export
|
|
116
|
+
|
|
117
|
+
**[📖 Complete Guide: resources/component-patterns.md](resources/component-patterns.md)**
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
### 📊 Data Fetching
|
|
122
|
+
|
|
123
|
+
**PRIMARY PATTERN: useSuspenseQuery**
|
|
124
|
+
- Use with Suspense boundaries
|
|
125
|
+
- Cache-first strategy (check grid cache before API)
|
|
126
|
+
- Replaces `isLoading` checks
|
|
127
|
+
- Type-safe with generics
|
|
128
|
+
|
|
129
|
+
**API Service Layer:**
|
|
130
|
+
- Create `features/{feature}/api/{feature}Api.ts`
|
|
131
|
+
- Use `apiClient` axios instance
|
|
132
|
+
- Centralized methods per feature
|
|
133
|
+
- Route format: `/form/route` (NOT `/api/form/route`)
|
|
134
|
+
|
|
135
|
+
**[📖 Complete Guide: resources/data-fetching.md](resources/data-fetching.md)**
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
### 📁 File Organization
|
|
140
|
+
|
|
141
|
+
**features/ vs components/:**
|
|
142
|
+
- `features/`: Domain-specific (posts, comments, auth)
|
|
143
|
+
- `components/`: Truly reusable (SuspenseLoader, CustomAppBar)
|
|
144
|
+
|
|
145
|
+
**Feature Subdirectories:**
|
|
146
|
+
```
|
|
147
|
+
features/
|
|
148
|
+
my-feature/
|
|
149
|
+
api/ # API service layer
|
|
150
|
+
components/ # Feature components
|
|
151
|
+
hooks/ # Custom hooks
|
|
152
|
+
helpers/ # Utility functions
|
|
153
|
+
types/ # TypeScript types
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
**[📖 Complete Guide: resources/file-organization.md](resources/file-organization.md)**
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
### 🎨 Styling
|
|
161
|
+
|
|
162
|
+
**Inline vs Separate:**
|
|
163
|
+
- <100 lines: Inline `const styles: Record<string, SxProps<Theme>>`
|
|
164
|
+
- >100 lines: Separate `.styles.ts` file
|
|
165
|
+
|
|
166
|
+
**Primary Method:**
|
|
167
|
+
- Use `sx` prop for MUI components
|
|
168
|
+
- Type-safe with `SxProps<Theme>`
|
|
169
|
+
- Theme access: `(theme) => theme.palette.primary.main`
|
|
170
|
+
|
|
171
|
+
**MUI v7 Grid:**
|
|
172
|
+
```typescript
|
|
173
|
+
<Grid size={{ xs: 12, md: 6 }}> // ✅ v7 syntax
|
|
174
|
+
<Grid xs={12} md={6}> // ❌ Old syntax
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**[📖 Complete Guide: resources/styling-guide.md](resources/styling-guide.md)**
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
### 🛣️ Routing
|
|
182
|
+
|
|
183
|
+
**TanStack Router - Folder-Based:**
|
|
184
|
+
- Directory: `routes/my-route/index.tsx`
|
|
185
|
+
- Lazy load components
|
|
186
|
+
- Use `createFileRoute`
|
|
187
|
+
- Breadcrumb data in loader
|
|
188
|
+
|
|
189
|
+
**Example:**
|
|
190
|
+
```typescript
|
|
191
|
+
import { createFileRoute } from '@tanstack/react-router';
|
|
192
|
+
import { lazy } from 'react';
|
|
193
|
+
|
|
194
|
+
const MyPage = lazy(() => import('@/features/my-feature/components/MyPage'));
|
|
195
|
+
|
|
196
|
+
export const Route = createFileRoute('/my-route/')({
|
|
197
|
+
component: MyPage,
|
|
198
|
+
loader: () => ({ crumb: 'My Route' }),
|
|
199
|
+
});
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
**[📖 Complete Guide: resources/routing-guide.md](resources/routing-guide.md)**
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
### ⏳ Loading & Error States
|
|
207
|
+
|
|
208
|
+
**CRITICAL RULE: No Early Returns**
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
// ❌ NEVER - Causes layout shift
|
|
212
|
+
if (isLoading) {
|
|
213
|
+
return <LoadingSpinner />;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// ✅ ALWAYS - Consistent layout
|
|
217
|
+
<SuspenseLoader>
|
|
218
|
+
<Content />
|
|
219
|
+
</SuspenseLoader>
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
**Why:** Prevents Cumulative Layout Shift (CLS), better UX
|
|
223
|
+
|
|
224
|
+
**Error Handling:**
|
|
225
|
+
- Use `useMuiSnackbar` for user feedback
|
|
226
|
+
- NEVER `react-toastify`
|
|
227
|
+
- TanStack Query `onError` callbacks
|
|
228
|
+
|
|
229
|
+
**[📖 Complete Guide: resources/loading-and-error-states.md](resources/loading-and-error-states.md)**
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
### ⚡ Performance
|
|
234
|
+
|
|
235
|
+
**Optimization Patterns:**
|
|
236
|
+
- `useMemo`: Expensive computations (filter, sort, map)
|
|
237
|
+
- `useCallback`: Event handlers passed to children
|
|
238
|
+
- `React.memo`: Expensive components
|
|
239
|
+
- Debounced search (300-500ms)
|
|
240
|
+
- Memory leak prevention (cleanup in useEffect)
|
|
241
|
+
|
|
242
|
+
**[📖 Complete Guide: resources/performance.md](resources/performance.md)**
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
### 📘 TypeScript
|
|
247
|
+
|
|
248
|
+
**Standards:**
|
|
249
|
+
- Strict mode, no `any` type
|
|
250
|
+
- Explicit return types on functions
|
|
251
|
+
- Type imports: `import type { User } from '~types/user'`
|
|
252
|
+
- Component prop interfaces with JSDoc
|
|
253
|
+
|
|
254
|
+
**[📖 Complete Guide: resources/typescript-standards.md](resources/typescript-standards.md)**
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
### 🔧 Common Patterns
|
|
259
|
+
|
|
260
|
+
**Covered Topics:**
|
|
261
|
+
- React Hook Form with Zod validation
|
|
262
|
+
- DataGrid wrapper contracts
|
|
263
|
+
- Dialog component standards
|
|
264
|
+
- `useAuth` hook for current user
|
|
265
|
+
- Mutation patterns with cache invalidation
|
|
266
|
+
|
|
267
|
+
**[📖 Complete Guide: resources/common-patterns.md](resources/common-patterns.md)**
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
### 📚 Complete Examples
|
|
272
|
+
|
|
273
|
+
**Full working examples:**
|
|
274
|
+
- Modern component with all patterns
|
|
275
|
+
- Complete feature structure
|
|
276
|
+
- API service layer
|
|
277
|
+
- Route with lazy loading
|
|
278
|
+
- Suspense + useSuspenseQuery
|
|
279
|
+
- Form with validation
|
|
280
|
+
|
|
281
|
+
**[📖 Complete Guide: resources/complete-examples.md](resources/complete-examples.md)**
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
## Navigation Guide
|
|
286
|
+
|
|
287
|
+
| Need to... | Read this resource |
|
|
288
|
+
|------------|-------------------|
|
|
289
|
+
| Create a component | [component-patterns.md](resources/component-patterns.md) |
|
|
290
|
+
| Fetch data | [data-fetching.md](resources/data-fetching.md) |
|
|
291
|
+
| Organize files/folders | [file-organization.md](resources/file-organization.md) |
|
|
292
|
+
| Style components | [styling-guide.md](resources/styling-guide.md) |
|
|
293
|
+
| Set up routing | [routing-guide.md](resources/routing-guide.md) |
|
|
294
|
+
| Handle loading/errors | [loading-and-error-states.md](resources/loading-and-error-states.md) |
|
|
295
|
+
| Optimize performance | [performance.md](resources/performance.md) |
|
|
296
|
+
| TypeScript types | [typescript-standards.md](resources/typescript-standards.md) |
|
|
297
|
+
| Forms/Auth/DataGrid | [common-patterns.md](resources/common-patterns.md) |
|
|
298
|
+
| See full examples | [complete-examples.md](resources/complete-examples.md) |
|
|
299
|
+
|
|
300
|
+
---
|
|
301
|
+
|
|
302
|
+
## Core Principles
|
|
303
|
+
|
|
304
|
+
1. **Lazy Load Everything Heavy**: Routes, DataGrid, charts, editors
|
|
305
|
+
2. **Suspense for Loading**: Use SuspenseLoader, not early returns
|
|
306
|
+
3. **useSuspenseQuery**: Primary data fetching pattern for new code
|
|
307
|
+
4. **Features are Organized**: api/, components/, hooks/, helpers/ subdirs
|
|
308
|
+
5. **Styles Based on Size**: <100 inline, >100 separate
|
|
309
|
+
6. **Import Aliases**: Use @/, ~types, ~components, ~features
|
|
310
|
+
7. **No Early Returns**: Prevents layout shift
|
|
311
|
+
8. **useMuiSnackbar**: For all user notifications
|
|
312
|
+
|
|
313
|
+
---
|
|
314
|
+
|
|
315
|
+
## Quick Reference: File Structure
|
|
316
|
+
|
|
317
|
+
```
|
|
318
|
+
src/
|
|
319
|
+
features/
|
|
320
|
+
my-feature/
|
|
321
|
+
api/
|
|
322
|
+
myFeatureApi.ts # API service
|
|
323
|
+
components/
|
|
324
|
+
MyFeature.tsx # Main component
|
|
325
|
+
SubComponent.tsx # Related components
|
|
326
|
+
hooks/
|
|
327
|
+
useMyFeature.ts # Custom hooks
|
|
328
|
+
useSuspenseMyFeature.ts # Suspense hooks
|
|
329
|
+
helpers/
|
|
330
|
+
myFeatureHelpers.ts # Utilities
|
|
331
|
+
types/
|
|
332
|
+
index.ts # TypeScript types
|
|
333
|
+
index.ts # Public exports
|
|
334
|
+
|
|
335
|
+
components/
|
|
336
|
+
SuspenseLoader/
|
|
337
|
+
SuspenseLoader.tsx # Reusable loader
|
|
338
|
+
CustomAppBar/
|
|
339
|
+
CustomAppBar.tsx # Reusable app bar
|
|
340
|
+
|
|
341
|
+
routes/
|
|
342
|
+
my-route/
|
|
343
|
+
index.tsx # Route component
|
|
344
|
+
create/
|
|
345
|
+
index.tsx # Nested route
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## Modern Component Template (Quick Copy)
|
|
351
|
+
|
|
352
|
+
```typescript
|
|
353
|
+
import React, { useState, useCallback } from 'react';
|
|
354
|
+
import { Box, Paper } from '@mui/material';
|
|
355
|
+
import { useSuspenseQuery } from '@tanstack/react-query';
|
|
356
|
+
import { featureApi } from '../api/featureApi';
|
|
357
|
+
import type { FeatureData } from '~types/feature';
|
|
358
|
+
|
|
359
|
+
interface MyComponentProps {
|
|
360
|
+
id: number;
|
|
361
|
+
onAction?: () => void;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
export const MyComponent: React.FC<MyComponentProps> = ({ id, onAction }) => {
|
|
365
|
+
const [state, setState] = useState<string>('');
|
|
366
|
+
|
|
367
|
+
const { data } = useSuspenseQuery({
|
|
368
|
+
queryKey: ['feature', id],
|
|
369
|
+
queryFn: () => featureApi.getFeature(id),
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
const handleAction = useCallback(() => {
|
|
373
|
+
setState('updated');
|
|
374
|
+
onAction?.();
|
|
375
|
+
}, [onAction]);
|
|
376
|
+
|
|
377
|
+
return (
|
|
378
|
+
<Box sx={{ p: 2 }}>
|
|
379
|
+
<Paper sx={{ p: 3 }}>
|
|
380
|
+
{/* Content */}
|
|
381
|
+
</Paper>
|
|
382
|
+
</Box>
|
|
383
|
+
);
|
|
384
|
+
};
|
|
385
|
+
|
|
386
|
+
export default MyComponent;
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
For complete examples, see [resources/complete-examples.md](resources/complete-examples.md)
|
|
390
|
+
|
|
391
|
+
---
|
|
392
|
+
|
|
393
|
+
## Related Skills
|
|
394
|
+
|
|
395
|
+
- **error-tracking**: Error tracking with Sentry (applies to frontend too)
|
|
396
|
+
- **backend-dev-guidelines**: Backend API patterns that frontend consumes
|
|
397
|
+
|
|
398
|
+
---
|
|
399
|
+
|
|
400
|
+
**Skill Status**: Modular structure with progressive loading for optimal context management
|