@gong-ym/ai-spec-auto 0.2.3
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/.agents/commands/README.md +33 -0
- package/.agents/commands/claude/spec-start-review.md +88 -0
- package/.agents/commands/codex/spec-continue.md +74 -0
- package/.agents/commands/codex/spec-orchestrate.md +35 -0
- package/.agents/commands/codex/spec-start-review.md +88 -0
- package/.agents/commands/codex/spec-start.md +67 -0
- package/.agents/commands/codex/spec-status.md +22 -0
- package/.agents/commands/codex/spec-stop.md +29 -0
- package/.agents/commands/codex/spec-update.md +40 -0
- package/.agents/commands/common/branch-review.md +117 -0
- package/.agents/commands/common/project-init.md +25 -0
- package/.agents/commands/common/spec-continue.md +74 -0
- package/.agents/commands/common/spec-orchestrate.md +35 -0
- package/.agents/commands/common/spec-start-review.md +82 -0
- package/.agents/commands/common/spec-start.md +67 -0
- package/.agents/commands/common/spec-status.md +22 -0
- package/.agents/commands/common/spec-stop.md +29 -0
- package/.agents/commands/common/spec-update.md +40 -0
- package/.agents/commands/cursor/opsx-apply.md +55 -0
- package/.agents/commands/cursor/opsx-archive.md +48 -0
- package/.agents/commands/cursor/opsx-explore.md +45 -0
- package/.agents/commands/cursor/opsx-propose.md +59 -0
- package/.agents/commands/cursor/spec-continue.md +63 -0
- package/.agents/commands/cursor/spec-orchestrate.md +53 -0
- package/.agents/commands/cursor/spec-start-review.md +78 -0
- package/.agents/commands/cursor/spec-start.md +59 -0
- package/.agents/commands/cursor/spec-status.md +30 -0
- package/.agents/commands/cursor/spec-stop.md +29 -0
- package/.agents/commands/cursor/spec-update.md +41 -0
- package/.agents/flows/FRONTMATTER.md +263 -0
- package/.agents/flows/RUN_OUTPUT.md +263 -0
- package/.agents/flows/common/README.md +29 -0
- package/.agents/flows/common/bugfix-to-verification.md +95 -0
- package/.agents/flows/common/change-to-architecture-review.md +89 -0
- package/.agents/flows/common/change-to-release.md +94 -0
- package/.agents/flows/common/prd-to-delivery.md +184 -0
- package/.agents/flows/common/requirement-to-observability.md +97 -0
- package/.agents/orchestration/README.md +22 -0
- package/.agents/orchestration/expert-dispatch-spec.md +155 -0
- package/.agents/orchestration/expert-executor-spec.md +84 -0
- package/.agents/orchestration/expert-runtime-action-spec.md +73 -0
- package/.agents/orchestration/runtime-state-handoff-spec.md +264 -0
- package/.agents/orchestration/task-anchor-spec.md +212 -0
- package/.agents/orchestration/task-orchestrator-adapter-payload.md +153 -0
- package/.agents/orchestration/task-orchestrator-bootstrap-payload.md +145 -0
- package/.agents/orchestration/task-orchestrator-output-extractor-spec.md +93 -0
- package/.agents/orchestration/task-orchestrator-run-plan-template.md +312 -0
- package/.agents/orchestration/task-orchestrator-runtime-hooks.md +214 -0
- package/.agents/registry/README.md +63 -0
- package/.agents/registry/flows.json +125 -0
- package/.agents/registry/profiles.json +101 -0
- package/.agents/registry/roles.json +1266 -0
- package/.agents/registry/rules.json +148 -0
- package/.agents/registry/scenario-packages.json +123 -0
- package/.agents/registry/skills.json +130 -0
- package/.agents/roles/INDEX.md +346 -0
- package/.agents/roles/common/README.md +76 -0
- package/.agents/roles/common/archive-change.md +80 -0
- package/.agents/roles/common/backend-implementer.md +92 -0
- package/.agents/roles/common/code-guardian.md +151 -0
- package/.agents/roles/common/frontend-implementer.md +146 -0
- package/.agents/roles/common/requirement-analyst.md +138 -0
- package/.agents/roles/common/task-orchestrator-routing.md +301 -0
- package/.agents/roles/common/task-orchestrator.md +224 -0
- package/.agents/roles/common/tooling-implementer.md +92 -0
- package/.agents/roles/domains/README.md +35 -0
- package/.agents/roles/domains/delivery/README.md +11 -0
- package/.agents/roles/domains/delivery/container-specialist.md +50 -0
- package/.agents/roles/domains/delivery/deployment-specialist.md +50 -0
- package/.agents/roles/domains/delivery/pipeline-specialist.md +50 -0
- package/.agents/roles/domains/demand-design/README.md +16 -0
- package/.agents/roles/domains/demand-design/api-contract-specialist.md +52 -0
- package/.agents/roles/domains/demand-design/design-collaborator.md +58 -0
- package/.agents/roles/domains/documentation/README.md +11 -0
- package/.agents/roles/domains/documentation/api-doc-specialist.md +50 -0
- package/.agents/roles/domains/documentation/component-doc-specialist.md +49 -0
- package/.agents/roles/domains/documentation/technical-writing-specialist.md +48 -0
- package/.agents/roles/domains/engineering/README.md +17 -0
- package/.agents/roles/domains/engineering/architecture-advisor.md +53 -0
- package/.agents/roles/domains/engineering/build-specialist.md +51 -0
- package/.agents/roles/domains/engineering/dependency-governor.md +52 -0
- package/.agents/roles/domains/governance/README.md +17 -0
- package/.agents/roles/domains/governance/api-governance-specialist.md +51 -0
- package/.agents/roles/domains/governance/lint-policy-specialist.md +49 -0
- package/.agents/roles/domains/governance/route-governance-specialist.md +52 -0
- package/.agents/roles/domains/observability/README.md +11 -0
- package/.agents/roles/domains/observability/error-tracker.md +50 -0
- package/.agents/roles/domains/observability/event-instrumentation-specialist.md +51 -0
- package/.agents/roles/domains/observability/rum-analyst.md +50 -0
- package/.agents/roles/domains/performance/README.md +11 -0
- package/.agents/roles/domains/performance/asset-optimizer.md +50 -0
- package/.agents/roles/domains/performance/performance-auditor.md +56 -0
- package/.agents/roles/domains/performance/vitals-analyst.md +50 -0
- package/.agents/roles/domains/security-a11y/README.md +11 -0
- package/.agents/roles/domains/security-a11y/a11y-auditor.md +50 -0
- package/.agents/roles/domains/security-a11y/aria-specialist.md +51 -0
- package/.agents/roles/domains/security-a11y/security-reviewer.md +49 -0
- package/.agents/roles/domains/testing/README.md +12 -0
- package/.agents/roles/domains/testing/coverage-analyst.md +50 -0
- package/.agents/roles/domains/testing/e2e-test-specialist.md +51 -0
- package/.agents/roles/domains/testing/unit-test-specialist.md +56 -0
- package/.agents/roles/domains/testing/verification-reviewer.md +67 -0
- package/.agents/rules/README.md +87 -0
- package/.agents/rules/common/02-/347/274/226/347/240/201/350/247/204/350/214/203.md +45 -0
- package/.agents/rules/common/08-/351/200/232/347/224/250/347/272/246/346/235/237.md +63 -0
- package/.agents/rules/common/10-/346/226/207/346/241/243/350/247/204/350/214/203.md +101 -0
- package/.agents/rules/common/12-Superpowers/346/211/247/350/241/214/350/247/204/350/214/203.md +46 -0
- package/.agents/rules/common/14-/345/256/241/350/256/241/346/261/207/346/212/245/350/247/204/350/214/203.md +107 -0
- package/.agents/rules/common/15-visual-gate-wait.md +90 -0
- package/.agents/rules/profiles/nestjs/01-/351/241/271/347/233/256/346/246/202/350/277/260.md +27 -0
- package/.agents/rules/profiles/nestjs/03-/351/241/271/347/233/256/347/273/223/346/236/204.md +20 -0
- package/.agents/rules/profiles/nestjs/04-/346/250/241/345/235/227/347/273/223/346/236/204/350/247/204/350/214/203.md +24 -0
- package/.agents/rules/profiles/nestjs/05-/346/216/245/345/217/243/344/270/216/345/245/221/347/272/246/350/247/204/350/214/203.md +24 -0
- package/.agents/rules/profiles/nestjs/06-/346/225/260/346/215/256/350/256/277/351/227/256/350/247/204/350/214/203.md +24 -0
- package/.agents/rules/profiles/nestjs/07-/351/205/215/347/275/256/344/270/216/350/277/220/350/241/214/346/227/266/350/247/204/350/214/203.md +20 -0
- package/.agents/rules/profiles/nestjs/09-/345/274/202/345/270/270/344/270/216/346/227/245/345/277/227/350/247/204/350/214/203.md +20 -0
- package/.agents/rules/profiles/nestjs/11-/346/265/213/350/257/225/350/247/204/350/214/203.md +24 -0
- package/.agents/rules/profiles/nestjs/13-/344/273/243/347/240/201/346/240/274/345/274/217/345/214/226/344/270/216/346/243/200/346/237/245.md +20 -0
- package/.agents/rules/profiles/node-tooling/01-/351/241/271/347/233/256/346/246/202/350/277/260.md +30 -0
- package/.agents/rules/profiles/node-tooling/03-/351/241/271/347/233/256/347/273/223/346/236/204.md +37 -0
- package/.agents/rules/profiles/node-tooling/04-CLI/344/270/216/346/250/241/345/235/227/350/247/204/350/214/203.md +42 -0
- package/.agents/rules/profiles/node-tooling/05-Contract/344/270/216Schema/350/247/204/350/214/203.md +42 -0
- package/.agents/rules/profiles/node-tooling/06-/350/277/220/350/241/214/346/227/266/346/226/207/344/273/266/350/247/204/350/214/203.md +30 -0
- package/.agents/rules/profiles/node-tooling/07-/346/227/245/345/277/227/344/270/216/351/224/231/350/257/257/345/244/204/347/220/206/350/247/204/350/214/203.md +60 -0
- package/.agents/rules/profiles/node-tooling/09-/350/204/232/346/234/254/344/270/216/345/205/245/345/217/243/350/247/204/350/214/203.md +45 -0
- package/.agents/rules/profiles/node-tooling/11-/346/265/213/350/257/225/350/247/204/350/214/203.md +41 -0
- package/.agents/rules/profiles/node-tooling/13-/344/273/243/347/240/201/346/240/274/345/274/217/345/214/226/344/270/216/346/243/200/346/237/245.md +55 -0
- package/.agents/rules/profiles/react/01-/351/241/271/347/233/256/346/246/202/350/277/260.md +29 -0
- package/.agents/rules/profiles/react/03-/351/241/271/347/233/256/347/273/223/346/236/204.md +104 -0
- package/.agents/rules/profiles/react/04-/347/273/204/344/273/266/350/247/204/350/214/203.md +46 -0
- package/.agents/rules/profiles/react/05-API/350/247/204/350/214/203.md +67 -0
- package/.agents/rules/profiles/react/06-/350/267/257/347/224/261/350/247/204/350/214/203.md +54 -0
- package/.agents/rules/profiles/react/07-/347/212/266/346/200/201/347/256/241/347/220/206.md +226 -0
- package/.agents/rules/profiles/react/09-/346/240/267/345/274/217/350/247/204/350/214/203.md +71 -0
- package/.agents/rules/profiles/react/11-/346/265/213/350/257/225/350/247/204/350/214/203.md +80 -0
- package/.agents/rules/profiles/react/13-/344/273/243/347/240/201/346/240/274/345/274/217/345/214/226/344/270/216/346/243/200/346/237/245.md +159 -0
- package/.agents/rules/profiles/springboot/01-/351/241/271/347/233/256/346/246/202/350/277/260.md +31 -0
- package/.agents/rules/profiles/springboot/03-/351/241/271/347/233/256/347/273/223/346/236/204.md +37 -0
- package/.agents/rules/profiles/springboot/04-/345/210/206/345/261/202/350/247/204/350/214/203.md +33 -0
- package/.agents/rules/profiles/springboot/05-/346/216/245/345/217/243/344/270/216/345/245/221/347/272/246/350/247/204/350/214/203.md +51 -0
- package/.agents/rules/profiles/springboot/06-/346/225/260/346/215/256/350/256/277/351/227/256/350/247/204/350/214/203.md +34 -0
- package/.agents/rules/profiles/springboot/07-/351/205/215/347/275/256/344/270/216/350/277/220/350/241/214/346/227/266/350/247/204/350/214/203.md +38 -0
- package/.agents/rules/profiles/springboot/09-/345/274/202/345/270/270/344/270/216/346/227/245/345/277/227/350/247/204/350/214/203.md +48 -0
- package/.agents/rules/profiles/springboot/11-/346/265/213/350/257/225/350/247/204/350/214/203.md +43 -0
- package/.agents/rules/profiles/springboot/13-/344/273/243/347/240/201/346/240/274/345/274/217/345/214/226/344/270/216/346/243/200/346/237/245.md +48 -0
- package/.agents/rules/profiles/vue/01-/351/241/271/347/233/256/346/246/202/350/277/260.md +47 -0
- package/.agents/rules/profiles/vue/03-/351/241/271/347/233/256/347/273/223/346/236/204.md +106 -0
- package/.agents/rules/profiles/vue/04-/347/273/204/344/273/266/350/247/204/350/214/203.md +61 -0
- package/.agents/rules/profiles/vue/05-API/350/247/204/350/214/203.md +67 -0
- package/.agents/rules/profiles/vue/06-/350/267/257/347/224/261/350/247/204/350/214/203.md +69 -0
- package/.agents/rules/profiles/vue/07-/347/212/266/346/200/201/347/256/241/347/220/206.md +93 -0
- package/.agents/rules/profiles/vue/09-/346/240/267/345/274/217/350/247/204/350/214/203.md +67 -0
- package/.agents/rules/profiles/vue/11-/346/265/213/350/257/225/350/247/204/350/214/203.md +80 -0
- package/.agents/rules/profiles/vue/13-/344/273/243/347/240/201/346/240/274/345/274/217/345/214/226/344/270/216/346/243/200/346/237/245.md +159 -0
- package/.agents/skills/README.md +171 -0
- package/.agents/skills/common/archive-change/SKILL.md +180 -0
- package/.agents/skills/common/branch-code-reviewer/SKILL.md +459 -0
- package/.agents/skills/common/branch-code-reviewer/references/business-risk-guide.md +293 -0
- package/.agents/skills/common/branch-code-reviewer/references/html-template-guide.md +121 -0
- package/.agents/skills/common/config-and-secret-scan/SKILL.md +99 -0
- package/.agents/skills/common/create-proposal/SKILL.md +192 -0
- package/.agents/skills/common/create-proposal/evals/evals.json +16 -0
- package/.agents/skills/common/create-proposal/evals/train_queries.json +18 -0
- package/.agents/skills/common/create-proposal/evals/validation_queries.json +18 -0
- package/.agents/skills/common/create-proposal/references/interaction-spec-template.md +42 -0
- package/.agents/skills/common/create-test/SKILL.md +292 -0
- package/.agents/skills/common/dependency-impact-graph/SKILL.md +80 -0
- package/.agents/skills/common/execute-task/SKILL.md +206 -0
- package/.agents/skills/common/execute-task/evals/evals.json +16 -0
- package/.agents/skills/common/execute-task/evals/train_queries.json +18 -0
- package/.agents/skills/common/execute-task/evals/validation_queries.json +18 -0
- package/.agents/skills/common/find-skills/SKILL.md +144 -0
- package/.agents/skills/common/install-ai-spec-auto/SKILL.md +260 -0
- package/.agents/skills/common/install-ai-spec-auto/evals/evals.json +17 -0
- package/.agents/skills/common/install-ai-spec-auto/evals/train_queries.json +18 -0
- package/.agents/skills/common/install-ai-spec-auto/evals/validation_queries.json +18 -0
- package/.agents/skills/common/project-init/SKILL.md +178 -0
- package/.agents/skills/common/project-init/evals/evals.json +16 -0
- package/.agents/skills/common/project-init/evals/train_queries.json +18 -0
- package/.agents/skills/common/project-init/evals/validation_queries.json +18 -0
- package/.agents/skills/common/project-init/references/custom-rule-generation.md +89 -0
- package/.agents/skills/common/project-init/references/deep-scan-rules.md +67 -0
- package/.agents/skills/common/project-init/references/output-contracts.md +71 -0
- package/.agents/skills/common/project-init/references/repo-fact-gathering.md +83 -0
- package/.agents/skills/common/project-init/references/scope-resolution.md +76 -0
- package/.agents/skills/common/project-init/scripts/inspect-project.js +112 -0
- package/.agents/skills/common/skill-creator/LICENSE.txt +202 -0
- package/.agents/skills/common/skill-creator/SKILL.md +370 -0
- package/.agents/skills/common/skill-creator/evals/evals.json +16 -0
- package/.agents/skills/common/skill-creator/evals/train_queries.json +18 -0
- package/.agents/skills/common/skill-creator/evals/validation_queries.json +18 -0
- package/.agents/skills/common/skill-creator/references/output-patterns.md +82 -0
- package/.agents/skills/common/skill-creator/references/workflows.md +28 -0
- package/.agents/skills/common/skill-creator/scripts/init_skill.py +209 -0
- package/.agents/skills/common/skill-creator/scripts/package_skill.py +110 -0
- package/.agents/skills/common/skill-creator/scripts/quick_validate.py +51 -0
- package/.agents/skills/common/skill-optimizer/SKILL.md +102 -0
- package/.agents/skills/common/skill-optimizer/evals/evals.json +16 -0
- package/.agents/skills/common/skill-optimizer/evals/train_queries.json +18 -0
- package/.agents/skills/common/skill-optimizer/evals/validation_queries.json +18 -0
- package/.agents/skills/common/skill-optimizer/references/design-patterns.md +26 -0
- package/.agents/skills/common/skill-optimizer/references/review-checklist.md +22 -0
- package/.agents/skills/common/using-superpowers/SKILL.md +151 -0
- package/.agents/skills/common/wait-for-gate-signal/SKILL.md +85 -0
- package/.agents/skills/domains/README.md +19 -0
- package/.agents/skills/domains/ui-ux-pro-max/SKILL.md +58 -0
- package/.agents/skills/domains/web/design-analysis/SKILL.md +89 -0
- package/.agents/skills/domains/web/design-analysis/rules/analysis-order.md +61 -0
- package/.agents/skills/domains/web/design-analysis/rules/analysis-priorities.md +136 -0
- package/.agents/skills/domains/web/design-analysis/rules/checklist-common-misses.md +107 -0
- package/.agents/skills/domains/web/design-analysis/rules/implementation-common-errors.md +204 -0
- package/.agents/skills/domains/web/design-analysis/rules/implementation-guidelines.md +211 -0
- package/.agents/skills/domains/web/design-analysis/rules/output-analysis-checklist.md +247 -0
- package/.agents/skills/domains/web/design-analysis/rules/tools-design-guidelines.md +108 -0
- package/.agents/skills/domains/web/design-analysis/rules/workflow-element-extraction.md +162 -0
- package/.agents/skills/domains/web/design-analysis/rules/workflow-layout-map.md +131 -0
- package/.agents/skills/domains/web/design-analysis/rules/workflow-output-checklist.md +70 -0
- package/.agents/skills/domains/web/design-analysis/rules/workflow-style-summary.md +91 -0
- package/.agents/skills/domains/web/route-permission-map/SKILL.md +103 -0
- package/.agents/skills/domains/web/ui-verification/SKILL.md +114 -0
- package/.agents/skills/domains/web/ui-verification/evals/evals.json +16 -0
- package/.agents/skills/domains/web/ui-verification/evals/train_queries.json +18 -0
- package/.agents/skills/domains/web/ui-verification/evals/validation_queries.json +18 -0
- package/.agents/skills/domains/web/ui-verification/rules/comparison-content-image.md +34 -0
- package/.agents/skills/domains/web/ui-verification/rules/comparison-content-text.md +30 -0
- package/.agents/skills/domains/web/ui-verification/rules/comparison-hierarchy.md +33 -0
- package/.agents/skills/domains/web/ui-verification/rules/comparison-layout.md +35 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-alignment.md +42 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-button-dimensions.md +28 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-button-position.md +25 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-css-priority.md +50 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-flex-column-width.md +46 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-flex-layout.md +46 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-grid-container-width.md +44 -0
- package/.agents/skills/domains/web/ui-verification/rules/errors-page-container-width.md +39 -0
- package/.agents/skills/domains/web/ui-verification/rules/tools-browser-navigation.md +53 -0
- package/.agents/skills/domains/web/ui-verification/rules/tools-design-guidelines.md +53 -0
- package/.agents/skills/domains/web/ui-verification/rules/workflow-checklist.md +27 -0
- package/.agents/skills/domains/web/ui-verification/rules/workflow-problem-list.md +56 -0
- package/.agents/skills/domains/web/ui-verification/rules/workflow-reflection.md +44 -0
- package/.agents/skills/domains/web/ui-verification/rules/writing-alignment.md +44 -0
- package/.agents/skills/domains/web/ui-verification/rules/writing-element-completeness.md +63 -0
- package/.agents/skills/domains/web/ui-verification/rules/writing-list-layout.md +75 -0
- package/.agents/skills/domains/web/ui-verification/rules/writing-page-container-width.md +37 -0
- package/.agents/skills/domains/web/web-design-guidelines/SKILL.md +40 -0
- package/.agents/skills/profiles/nestjs/README.md +4 -0
- package/.agents/skills/profiles/node-tooling/README.md +9 -0
- package/.agents/skills/profiles/react/create-api/SKILL.md +145 -0
- package/.agents/skills/profiles/react/create-component/SKILL.md +160 -0
- package/.agents/skills/profiles/react/create-route/SKILL.md +168 -0
- package/.agents/skills/profiles/react/create-store/SKILL.md +262 -0
- package/.agents/skills/profiles/react/theme-variables/SKILL.md +82 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/AGENTS.md +899 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/SKILL.md +81 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/state-context-interface.md +191 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/.agents/skills/profiles/react/vercel-composition-patterns/rules/state-lift-state.md +125 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/AGENTS.md +2934 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/SKILL.md +136 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/async-api-routes.md +38 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/async-defer-await.md +80 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/async-dependencies.md +51 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/async-parallel.md +28 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/bundle-barrel-imports.md +59 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/bundle-preload.md +50 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-early-exit.md +50 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-index-maps.md +37 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-activity.md +26 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-memo.md +44 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-cache-react.md +76 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/.agents/skills/profiles/react/vercel-react-best-practices/rules/server-serialization.md +38 -0
- package/.agents/skills/profiles/springboot/README.md +10 -0
- package/.agents/skills/profiles/vue/create-api/SKILL.md +105 -0
- package/.agents/skills/profiles/vue/create-component/SKILL.md +76 -0
- package/.agents/skills/profiles/vue/create-route/SKILL.md +141 -0
- package/.agents/skills/profiles/vue/create-store/SKILL.md +97 -0
- package/.agents/skills/profiles/vue/create-view/SKILL.md +81 -0
- package/.agents/skills/profiles/vue/theme-variables/SKILL.md +73 -0
- package/.agents/skills/profiles/vue/vue-best-practices/SKILL.md +166 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/animation-class-based-technique.md +254 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/animation-state-driven-technique.md +291 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-async.md +97 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-data-flow.md +307 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-keep-alive.md +137 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-slots.md +216 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-suspense.md +228 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-teleport.md +108 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-transition-group.md +128 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/component-transition.md +125 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/composables.md +290 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/directives.md +162 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/plugins.md +166 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/reactivity.md +344 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/render-functions.md +201 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/sfc.md +310 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/state-management.md +135 -0
- package/.agents/skills/profiles/vue/vue-best-practices/references/updated-hook-performance.md +187 -0
- package/.agents/templates/common/README.md +23 -0
- package/.agents/templates/common/bugfix.md +22 -0
- package/.agents/templates/common/create-expert-package.md +458 -0
- package/.agents/templates/common/mock-page.md +28 -0
- package/.agents/templates/common/new-component.md +25 -0
- package/.agents/templates/common/new-page.md +31 -0
- package/.cursor/mcp.json +36 -0
- package/.qoder/README.md +114 -0
- package/.qoder/commands +1 -0
- package/.qoder/mcp.json +26 -0
- package/.qoder/rules +1 -0
- package/.qoder/skills +1 -0
- package/LICENSE +21 -0
- package/README.md +433 -0
- package/bin/archive-change.js +474 -0
- package/bin/check-command.js +62 -0
- package/bin/cli.js +295 -0
- package/bin/command-template-renderer.js +40 -0
- package/bin/context-command.js +102 -0
- package/bin/demo-runtime-smoke.js +760 -0
- package/bin/execution-semantics.js +821 -0
- package/bin/executor-command.js +93 -0
- package/bin/expert-dispatch.js +334 -0
- package/bin/expert-executor.js +1148 -0
- package/bin/guard-command.js +52 -0
- package/bin/hub-command.js +876 -0
- package/bin/ide-command.js +242 -0
- package/bin/init-command.js +193 -0
- package/bin/install-workflow.js +2983 -0
- package/bin/manifest-export.js +34 -0
- package/bin/profile-registry.js +90 -0
- package/bin/protocol-workflow.js +446 -0
- package/bin/repair-command.js +161 -0
- package/bin/repo-map.js +177 -0
- package/bin/report-command.js +236 -0
- package/bin/runtime-bootstrap.js +428 -0
- package/bin/runtime-embedded.js +101 -0
- package/bin/runtime-fallback.js +106 -0
- package/bin/runtime-launcher.js +116 -0
- package/bin/runtime-paths.js +177 -0
- package/bin/runtime-registry.js +289 -0
- package/bin/runtime-state.js +2541 -0
- package/bin/scan.js +96 -0
- package/bin/self-upgrade.js +206 -0
- package/bin/skill-spec-validator.js +457 -0
- package/bin/spec-command.js +366 -0
- package/bin/superpowers.js +384 -0
- package/bin/sync-command.js +59 -0
- package/bin/sync.js +1904 -0
- package/bin/task-orchestrator-adapter.js +341 -0
- package/bin/task-orchestrator-extractor.js +274 -0
- package/bin/task-orchestrator-runner.js +1208 -0
- package/bin/telemetry/README.md +66 -0
- package/bin/telemetry/aspect.js +153 -0
- package/bin/telemetry/collect.js +67 -0
- package/bin/telemetry/config.js +114 -0
- package/bin/telemetry/defaults.json +5 -0
- package/bin/telemetry/healthcheck.js +195 -0
- package/bin/telemetry/identity.js +53 -0
- package/bin/telemetry/index.js +25 -0
- package/bin/telemetry/reporter.js +83 -0
- package/bin/telemetry/safe.js +39 -0
- package/bin/validate-registry.js +740 -0
- package/bin/visual-bridge-config.js +117 -0
- package/bin/visual-bridge.js +287 -0
- package/bin/visual-command.js +432 -0
- package/bin/worktree-command.js +194 -0
- package/configs/common/.editorconfig +15 -0
- package/configs/common/.husky/commit-msg +4 -0
- package/configs/common/.husky/pre-commit +4 -0
- package/configs/common/.lintstagedrc +11 -0
- package/configs/common/.prettierignore +11 -0
- package/configs/common/.prettierrc.json +11 -0
- package/configs/common/.stylelintignore +14 -0
- package/configs/common/.stylelintrc.json +21 -0
- package/configs/common/commitlint.config.js +3 -0
- package/configs/profiles/nestjs/.gitkeep +1 -0
- package/configs/profiles/node-tooling/.gitkeep +1 -0
- package/configs/profiles/react/.eslintignore +6 -0
- package/configs/profiles/react/.eslintrc.js +16 -0
- package/configs/profiles/react/.stylelintrc.json +18 -0
- package/configs/profiles/springboot/.gitkeep +1 -0
- package/configs/profiles/vue/.eslintignore +7 -0
- package/configs/profiles/vue/.eslintrc.cjs +17 -0
- package/contracts/README.md +28 -0
- package/contracts/fixtures/asset-package.fixture.json +26 -0
- package/contracts/fixtures/asset-usage-feedback.fixture.json +14 -0
- package/contracts/fixtures/evidence-report.fixture.json +28 -0
- package/contracts/fixtures/manifest.fixture.json +20 -0
- package/contracts/fixtures/run-event.fixture.json +15 -0
- package/contracts/schemas/asset-package.schema.json +76 -0
- package/contracts/schemas/asset-usage-feedback.schema.json +57 -0
- package/contracts/schemas/evidence-report.schema.json +60 -0
- package/contracts/schemas/manifest.schema.json +63 -0
- package/contracts/schemas/run-event.schema.json +72 -0
- package/install.ps1 +35 -0
- package/install.sh +17 -0
- package/internal/ai-protocol-workflow.js +5600 -0
- package/internal/hub-client.js +98 -0
- package/internal/hub-sync-selection.js +69 -0
- package/internal/visual-hooks/README.md +481 -0
- package/internal/visual-hooks/config-loader.js +218 -0
- package/internal/visual-hooks/control-puller.js +206 -0
- package/internal/visual-hooks/gate-signal.js +150 -0
- package/internal/visual-hooks/inbox-consumer.js +469 -0
- package/internal/visual-hooks/index.js +197 -0
- package/internal/visual-hooks/push-client.js +189 -0
- package/internal/visual-hooks/receipt-pusher.js +176 -0
- package/internal/visual-hooks/runtime-state-pusher.js +128 -0
- package/openspec/changes/.gitkeep +0 -0
- package/openspec/changes/archive/.gitkeep +0 -0
- package/openspec/config.yaml.template +52 -0
- package/openspec/schemas/expert-delivery/schema.yaml +68 -0
- package/openspec/schemas/expert-delivery/templates/checklist.md +39 -0
- package/openspec/schemas/expert-delivery/templates/design.md +61 -0
- package/openspec/schemas/expert-delivery/templates/iterations.md +25 -0
- package/openspec/schemas/expert-delivery/templates/proposal.md +45 -0
- package/openspec/schemas/expert-delivery/templates/spec.md +29 -0
- package/openspec/schemas/expert-delivery/templates/tasks.md +24 -0
- package/openspec/specs/.gitkeep +0 -0
- package/package.json +73 -0
- package/scripts/acceptance-zero-intrusion.sh +168 -0
- package/scripts/hub-sync-assets.config.example.json +296 -0
- package/scripts/hub-sync-assets.js +2038 -0
- package/scripts/local-verify.sh +280 -0
- package/scripts/post-publish-auto-fix-check.js +404 -0
- package/scripts/post-publish-verify.sh +175 -0
- package/scripts/setup-cursor-manual-test.sh +107 -0
- package/scripts/setup-cursor-spec-archive-test.sh +111 -0
- package/scripts/setup-visual-integration.sh +225 -0
- package/scripts/test-integration.sh +176 -0
- package/scripts/update-test-project.sh +93 -0
- package/scripts/upload-four-web.sh +57 -0
- package/scripts/verify-install-ps1-bom.js +26 -0
- package/src/agent/agent-context.js +259 -0
- package/src/agent/agent-profile.js +185 -0
- package/src/agent/agent-templates.js +161 -0
- package/src/agent/agent-types.js +108 -0
- package/src/agent/collaboration-protocol.js +333 -0
- package/src/agent/conflict-handler.js +364 -0
- package/src/agent/file-permission.js +121 -0
- package/src/agent/index.js +38 -0
- package/src/agent/permission-audit.js +151 -0
- package/src/agent/review-repair-loop.js +270 -0
- package/src/agent/tool-permission.js +101 -0
- package/src/asset/asset-dependency.js +322 -0
- package/src/asset/asset-feedback.js +350 -0
- package/src/asset/asset-fork.js +300 -0
- package/src/asset/asset-install.js +278 -0
- package/src/asset/asset-installer.js +497 -0
- package/src/asset/asset-lifecycle.js +324 -0
- package/src/asset/asset-manager.js +245 -0
- package/src/asset/asset-package-manager.js +349 -0
- package/src/asset/asset-package.js +186 -0
- package/src/asset/asset-quality.js +262 -0
- package/src/asset/asset-registry.js +387 -0
- package/src/asset/asset-version.js +293 -0
- package/src/asset/index.js +86 -0
- package/src/cache/agent-profile-cache.js +59 -0
- package/src/cache/asset-cache.js +63 -0
- package/src/cache/global-cache.js +61 -0
- package/src/cache/manifest-cache.js +30 -0
- package/src/check/check-service.js +32 -0
- package/src/config/config-layer.js +343 -0
- package/src/config/config-loader.js +60 -0
- package/src/config/defaults.js +49 -0
- package/src/connectors/hub/asset-package.js +72 -0
- package/src/connectors/hub/asset-usage-feedback.js +46 -0
- package/src/connectors/hub/hub-connector.js +44 -0
- package/src/connectors/hub/index.js +21 -0
- package/src/connectors/visual/evidence-report.js +49 -0
- package/src/connectors/visual/index.js +15 -0
- package/src/connectors/visual/queue.js +41 -0
- package/src/connectors/visual/run-event.js +81 -0
- package/src/connectors/visual/visual-connector.js +77 -0
- package/src/context/context-budget.js +59 -0
- package/src/context/context-builder.js +285 -0
- package/src/context/context-loader.js +116 -0
- package/src/context/context-planner.js +158 -0
- package/src/context/types.js +96 -0
- package/src/contracts/index.js +63 -0
- package/src/executor/executor-registry.js +78 -0
- package/src/executor/executor-result-parser.js +44 -0
- package/src/executor/executor-runner.js +141 -0
- package/src/executor/executor-selector.js +139 -0
- package/src/executor/executor-timeout.js +36 -0
- package/src/executor/providers/base-provider-utils.js +189 -0
- package/src/executor/providers/claude-code-executor-provider.js +128 -0
- package/src/executor/providers/codex-executor-provider.js +126 -0
- package/src/executor/providers/cursor-executor-provider.js +99 -0
- package/src/executor/types.js +137 -0
- package/src/git/branch-manager.js +71 -0
- package/src/git/dirty-checker.js +43 -0
- package/src/git/dirty-strategy-handler.js +29 -0
- package/src/git/git-command.js +37 -0
- package/src/git/git-repository-detector.js +45 -0
- package/src/git/multi-repo-worktree-planner.js +88 -0
- package/src/git/policy.js +19 -0
- package/src/git/strategies/block-dirty-strategy.js +34 -0
- package/src/git/strategies/ignore-dirty-strategy.js +33 -0
- package/src/git/strategies/patch-snapshot-strategy.js +53 -0
- package/src/git/strategies/wip-commit-strategy.js +38 -0
- package/src/git/types.js +71 -0
- package/src/git/worktree-manager.js +85 -0
- package/src/governance/asset-review.js +351 -0
- package/src/governance/audit-log.js +368 -0
- package/src/governance/gray-release.js +312 -0
- package/src/governance/index.js +31 -0
- package/src/governance/policy-types.js +56 -0
- package/src/governance/rbac-types.js +171 -0
- package/src/governance/rbac.js +382 -0
- package/src/governance/rollback.js +360 -0
- package/src/governance/security-policy.js +354 -0
- package/src/hook/hook-config-writer.js +125 -0
- package/src/hub/hub-client.js +186 -0
- package/src/hub/hub-config.js +39 -0
- package/src/hub/project-facts.js +31 -0
- package/src/hub/runtime-feedback-reporter.js +55 -0
- package/src/ide/adapters/adapter-protocol.js +385 -0
- package/src/ide/adapters/claude-adapter.js +419 -0
- package/src/ide/adapters/codex-adapter.js +60 -0
- package/src/ide/adapters/cursor-adapter.js +484 -0
- package/src/ide/adapters/index.js +24 -0
- package/src/ide/anchors/markdown-anchor-writer.js +152 -0
- package/src/ide/ide-service.js +270 -0
- package/src/ide/ide-types.js +94 -0
- package/src/ide/links/link-mode-resolver.js +160 -0
- package/src/ide/registry/ide-registry-builder.js +165 -0
- package/src/incident/incident-writer.js +47 -0
- package/src/incident/types.js +22 -0
- package/src/init/ide-linker.js +126 -0
- package/src/init/ide-pointer-injector.js +75 -0
- package/src/init/init-applier.js +197 -0
- package/src/init/init-plan.js +294 -0
- package/src/init/init-service.js +65 -0
- package/src/init/manifest-installer.js +302 -0
- package/src/init/types.js +26 -0
- package/src/project/config-writer.js +83 -0
- package/src/project/context-index-writer.js +82 -0
- package/src/project/json-utils.js +72 -0
- package/src/project/local-state-writer.js +50 -0
- package/src/project/lock-file-writer.js +98 -0
- package/src/project/manifest-writer.js +126 -0
- package/src/project/policy-config-writer.js +91 -0
- package/src/project/project-config-writer.js +74 -0
- package/src/project/project-files.js +39 -0
- package/src/project/registry-index-writer.js +43 -0
- package/src/project/workspace-config-writer.js +63 -0
- package/src/run/index.js +11 -0
- package/src/run/run-id.js +32 -0
- package/src/run/run-service.js +269 -0
- package/src/run/run-store.js +80 -0
- package/src/scanner/aggregator/detection-aggregator.js +23 -0
- package/src/scanner/boundary/boundary-resolver.js +229 -0
- package/src/scanner/detectors/detector-registry.js +44 -0
- package/src/scanner/detectors/fastapi-detector.js +46 -0
- package/src/scanner/detectors/go-detector.js +46 -0
- package/src/scanner/detectors/nestjs-detector.js +57 -0
- package/src/scanner/detectors/nextjs-detector.js +52 -0
- package/src/scanner/detectors/react-vite-detector.js +52 -0
- package/src/scanner/detectors/react-webpack-detector.js +57 -0
- package/src/scanner/detectors/springboot-detector.js +46 -0
- package/src/scanner/detectors/springcloud-detector.js +46 -0
- package/src/scanner/detectors/springmvc-detector.js +46 -0
- package/src/scanner/detectors/vue-vite-detector.js +52 -0
- package/src/scanner/engine.js +72 -0
- package/src/scanner/facts/fact-extractor.js +211 -0
- package/src/scanner/types.js +30 -0
- package/src/security/asset-tamper-checker.js +188 -0
- package/src/security/checksum.js +40 -0
- package/src/spec/spec-writer.js +302 -0
- package/src/state-machine/circuit-breaker.js +112 -0
- package/src/state-machine/escape-hatch.js +49 -0
- package/src/state-machine/stage-runner.js +281 -0
- package/src/state-machine/state-machine.js +24 -0
- package/src/state-machine/transition-guard.js +36 -0
- package/src/state-machine/types.js +37 -0
- package/src/sync/sync-service.js +192 -0
- package/src/visual/agent-visual.js +142 -0
- package/src/visual/event-gateway.js +357 -0
- package/src/visual/event-mapper.js +128 -0
- package/src/visual/hook-dashboard.js +216 -0
- package/src/visual/index.js +27 -0
- package/src/visual/metrics.js +287 -0
- package/src/visual/privacy-filter.js +100 -0
- package/src/visual/risk-board.js +252 -0
- package/src/visual/timeline.js +245 -0
- package/src/visual/visual-client.js +94 -0
- package/src/visual/visual-config.js +40 -0
- package/src/visual/visual-reporter.js +88 -0
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: React 项目的测试规范,包括测试框架选型(Vitest + @testing-library/react)、文件约定、测试范围、编写规范与质量门禁。当编写测试或评审测试代码时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 测试规范(React)
|
|
7
|
+
|
|
8
|
+
## 测试框架
|
|
9
|
+
|
|
10
|
+
- 统一使用 **Vitest** 作为测试运行器(与 Vite 生态原生集成,兼容 Jest API)
|
|
11
|
+
- 组件测试库:
|
|
12
|
+
- Vue:`@vue/test-utils`
|
|
13
|
+
- React:`@testing-library/react`
|
|
14
|
+
- 页面元素定位统一使用 `data-testid` 属性,禁止依赖 CSS class 或 DOM 结构
|
|
15
|
+
|
|
16
|
+
## 测试文件约定
|
|
17
|
+
|
|
18
|
+
| 项目 | 约定 |
|
|
19
|
+
|------|------|
|
|
20
|
+
| 文件位置 | 与源文件同目录 |
|
|
21
|
+
| 文件命名 | `<name>.test.ts` / `<name>.spec.ts` 或 `<name>.test.js` / `<name>.spec.js`(与源文件扩展名一致) |
|
|
22
|
+
| 组件测试 | `<name>.test.tsx` / `<name>.test.jsx`(React)/ `<name>.test.ts` 或 `<name>.test.js`(Vue) |
|
|
23
|
+
| 公共 Mock / 工具 | `tests/` 或 `src/__tests__/helpers/` |
|
|
24
|
+
| 测试配置 | 项目根目录 `vitest.config.ts` 或 `vitest.config.js` |
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
src/utils/
|
|
28
|
+
├── formatDate.ts
|
|
29
|
+
└── formatDate.test.ts # 与源文件同目录
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 测试范围
|
|
33
|
+
|
|
34
|
+
| 级别 | 说明 | 要求 |
|
|
35
|
+
|------|------|------|
|
|
36
|
+
| 必须测试 | 工具函数、Store 逻辑、复杂业务计算、数据转换 | 新增时必须附带测试 |
|
|
37
|
+
| 建议测试 | 关键用户交互流程的组件测试、表单验证逻辑 | 核心页面推荐覆盖 |
|
|
38
|
+
| 不要测试 | 组件内部实现细节、第三方库本身、纯 UI 展示 | 避免脆弱测试 |
|
|
39
|
+
|
|
40
|
+
## 编写规范
|
|
41
|
+
|
|
42
|
+
### 测试描述
|
|
43
|
+
|
|
44
|
+
- `describe` 和 `it` / `test` 的描述使用中文(与 08-通用约束一致)
|
|
45
|
+
- 描述应表达预期行为,而非实现步骤
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
describe('formatDate', () => {
|
|
49
|
+
it('应将时间戳转换为 YYYY-MM-DD 格式', () => {
|
|
50
|
+
expect(formatDate(1700000000000)).toBe('2023-11-15');
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('传入无效值时应返回空字符串', () => {
|
|
54
|
+
expect(formatDate(null)).toBe('');
|
|
55
|
+
});
|
|
56
|
+
});
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 编写模式
|
|
60
|
+
|
|
61
|
+
- 遵循 **Arrange-Act-Assert**(准备-执行-断言)模式
|
|
62
|
+
- 测试行为而非实现:关注输入输出,不断言内部状态
|
|
63
|
+
- 每个 `it` 只验证一个行为点
|
|
64
|
+
- Mock 外部依赖(API、定时器),不 Mock 被测模块内部
|
|
65
|
+
|
|
66
|
+
### 禁止模式
|
|
67
|
+
|
|
68
|
+
| 禁止项 | 原因 |
|
|
69
|
+
|--------|------|
|
|
70
|
+
| 测试依赖执行顺序 | 测试应互相独立,可单独运行 |
|
|
71
|
+
| 快照测试滥用 | 仅用于关键 UI 结构,禁止对大段 HTML 做快照 |
|
|
72
|
+
| 硬编码延时(`setTimeout`) | 使用 `vi.useFakeTimers()` 或 `waitFor` |
|
|
73
|
+
|
|
74
|
+
## 质量门禁(NON-NEGOTIABLE)
|
|
75
|
+
|
|
76
|
+
- **TypeScript 项目**:必须通过 **`tsc --noEmit`**(或项目等价类型检查脚本)。
|
|
77
|
+
- **纯 JavaScript 项目**:不强制 `tsc`;以 **ESLint**(及团队约定的检查脚本)为零 error 准绳。
|
|
78
|
+
- 所有项目必须通过 **ESLint 检查**(零 error)。
|
|
79
|
+
- 新增工具函数和 Store 必须附带测试用例。
|
|
80
|
+
- 测试必须能独立运行,不依赖特定环境或执行顺序。
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: React 项目的代码格式化与静态检查规范,包括 ESLint、Prettier 的工具链职责、统一配置规则与开发流程集成。当配置或调整 lint/format 工具时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 代码格式化与检查(React)
|
|
7
|
+
|
|
8
|
+
## 工具链
|
|
9
|
+
|
|
10
|
+
| 工具 | 职责 | 配置文件 |
|
|
11
|
+
|------|------|----------|
|
|
12
|
+
| **Prettier** | 代码格式化(缩进、引号、分号等) | `.prettierrc.json` |
|
|
13
|
+
| **ESLint** | 代码质量与风格检查(未使用变量、潜在 bug 等) | `.eslintrc.cjs` / `.eslintrc.js` |
|
|
14
|
+
| **Stylelint** | 样式文件检查(CSS/SCSS/Less 规范) | `.stylelintrc.json` |
|
|
15
|
+
|
|
16
|
+
三者职责不重叠:Prettier 管格式,ESLint 管逻辑,Stylelint 管样式。
|
|
17
|
+
|
|
18
|
+
## 配置来源
|
|
19
|
+
|
|
20
|
+
- 项目根目录的 lint/format 配置文件由**规范库统一管理**
|
|
21
|
+
- `install.sh init` 时自动部署到目标项目,`update` 时同步更新
|
|
22
|
+
- 项目可在基础配置上**扩展**(如追加 i18n 插件),但不应修改基础规则
|
|
23
|
+
|
|
24
|
+
## Prettier 统一规则
|
|
25
|
+
|
|
26
|
+
| 配置项 | 值 | 说明 |
|
|
27
|
+
|--------|-----|------|
|
|
28
|
+
| `semi` | `true` | 语句末尾加分号 |
|
|
29
|
+
| `tabWidth` | `2` | 缩进 2 空格 |
|
|
30
|
+
| `singleQuote` | `true` | 使用单引号 |
|
|
31
|
+
| `printWidth` | `100` | 单行最大宽度 |
|
|
32
|
+
| `trailingComma` | `"es5"` | 对象/数组末尾加逗号(减少 diff 噪音) |
|
|
33
|
+
| `endOfLine` | `"auto"` | 自动适配换行符 |
|
|
34
|
+
| `arrowParens` | `"avoid"` | 单参数箭头函数省略括号 |
|
|
35
|
+
| `proseWrap` | `"never"` | Markdown 不自动换行 |
|
|
36
|
+
|
|
37
|
+
## ESLint 核心规则
|
|
38
|
+
|
|
39
|
+
### 通用基础
|
|
40
|
+
|
|
41
|
+
- 项目根据自身技术栈在 `extends` 中配置合适的共享规则集
|
|
42
|
+
- 项目可追加插件(如 `@intlify/vue-i18n`、`eslint-plugin-import` 等)
|
|
43
|
+
|
|
44
|
+
### Vue 项目
|
|
45
|
+
|
|
46
|
+
```js
|
|
47
|
+
// .eslintrc.cjs
|
|
48
|
+
module.exports = {
|
|
49
|
+
root: true,
|
|
50
|
+
// 项目按需配置 extends(如 eslint:recommended、plugin:vue/vue3-recommended 等)
|
|
51
|
+
};
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### React 项目
|
|
55
|
+
|
|
56
|
+
```js
|
|
57
|
+
// .eslintrc.js
|
|
58
|
+
module.exports = {
|
|
59
|
+
root: true,
|
|
60
|
+
settings: {
|
|
61
|
+
'import/resolver': {
|
|
62
|
+
alias: [['@', './src']],
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
// 项目按需配置 extends(如 eslint:recommended、plugin:react/recommended 等)
|
|
66
|
+
};
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Stylelint 核心规则
|
|
70
|
+
|
|
71
|
+
- 继承 `stylelint-config-standard` 基础规则
|
|
72
|
+
- Vue 项目追加 `stylelint-config-html/vue` 和 `stylelint-config-recommended-vue`
|
|
73
|
+
- 使用 `postcss-html` 作为自定义语法解析器(解析 `.vue` 文件中的 `<style>`)
|
|
74
|
+
- 忽略与业务组件库冲突的规则(如 `no-descending-specificity`)
|
|
75
|
+
|
|
76
|
+
## 开发流程集成
|
|
77
|
+
|
|
78
|
+
### IDE 保存时自动格式化(推荐)
|
|
79
|
+
|
|
80
|
+
项目可在 `.vscode/settings.json` 中配置:
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"editor.formatOnSave": true,
|
|
85
|
+
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
|
86
|
+
"editor.codeActionsOnSave": {
|
|
87
|
+
"source.fixAll.eslint": "explicit",
|
|
88
|
+
"source.fixAll.stylelint": "explicit"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 提交前自动检查(husky + lint-staged)
|
|
94
|
+
|
|
95
|
+
使用 `husky` 注册 Git hooks,`lint-staged` 只检查暂存文件:
|
|
96
|
+
|
|
97
|
+
| 工具 | 职责 | 配置文件 |
|
|
98
|
+
|------|------|----------|
|
|
99
|
+
| husky | 注册 Git hooks(pre-commit、commit-msg) | `.husky/` |
|
|
100
|
+
| lint-staged | 对暂存文件执行 lint/format | `.lintstagedrc` |
|
|
101
|
+
| commitlint | 校验 commit message 格式 | `commitlint.config.js` |
|
|
102
|
+
|
|
103
|
+
**部署前提**:上述 `.husky/`、`.lintstagedrc`、`commitlint.config.js` 仅在执行 `install.sh` / `install.ps1` 时**选择安装提交校验**(`--husky` 或交互选 Y)后才会复制到目标项目并配合 `husky install` 注册 Git hooks。若选择跳过提交校验(`--no-husky` 或交互选 N),则不会下发这些文件;仅安装 lint/format 时只会得到 ESLint、Prettier、Stylelint 等配置。
|
|
104
|
+
|
|
105
|
+
**lint-staged 检查范围**:
|
|
106
|
+
|
|
107
|
+
```json
|
|
108
|
+
{
|
|
109
|
+
"src/**/*.{vue,less,scss,css}": [
|
|
110
|
+
"stylelint --fix"
|
|
111
|
+
],
|
|
112
|
+
"src/**/*.{js,ts,jsx,tsx,json,vue}": [
|
|
113
|
+
"eslint --fix"
|
|
114
|
+
]
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Commit Message 规范(Conventional Commits)
|
|
119
|
+
|
|
120
|
+
统一使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式,由 commitlint 强制校验:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
<type>(<scope>): <subject>
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
| type | 说明 |
|
|
127
|
+
|------|------|
|
|
128
|
+
| `feat` | 新功能 |
|
|
129
|
+
| `fix` | 修复 bug |
|
|
130
|
+
| `docs` | 文档变更 |
|
|
131
|
+
| `style` | 代码格式(不影响逻辑) |
|
|
132
|
+
| `refactor` | 重构(非新功能、非修复) |
|
|
133
|
+
| `test` | 测试相关 |
|
|
134
|
+
| `chore` | 构建、工具、依赖等杂项 |
|
|
135
|
+
|
|
136
|
+
**示例**:
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
feat(order): 新增工单批量导出功能
|
|
140
|
+
fix(auth): 修复 token 过期后未跳转登录页的问题
|
|
141
|
+
docs(api): 补充资产库接口类型定义
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
- `scope` 可选,建议填写业务模块名
|
|
145
|
+
- `subject` 使用中文,简明扼要
|
|
146
|
+
|
|
147
|
+
## 忽略文件约定
|
|
148
|
+
|
|
149
|
+
各工具的 ignore 文件遵循统一基线,至少忽略以下目录:
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
node_modules
|
|
153
|
+
dist
|
|
154
|
+
lib
|
|
155
|
+
assets
|
|
156
|
+
public
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
项目可根据实际情况追加特有的忽略路径。
|
package/.agents/rules/profiles/springboot/01-/351/241/271/347/233/256/346/246/202/350/277/260.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目概述,描述项目定位、技术栈、模块结构与核心依赖。当了解项目背景或进行整体规划时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 项目概述(Spring Boot)
|
|
7
|
+
|
|
8
|
+
> 本文件由 `project-init` 技能根据仓库实际情况生成,请勿手动覆盖自动生成的内容。
|
|
9
|
+
|
|
10
|
+
## 项目定位
|
|
11
|
+
|
|
12
|
+
<!-- 描述项目的业务定位与核心职责 -->
|
|
13
|
+
|
|
14
|
+
## 技术栈
|
|
15
|
+
|
|
16
|
+
| 层次 | 技术 |
|
|
17
|
+
|------|------|
|
|
18
|
+
| 框架 | Spring Boot |
|
|
19
|
+
| 构建工具 | Maven / Gradle |
|
|
20
|
+
| 数据访问 | MyBatis / JPA / Spring Data |
|
|
21
|
+
| 数据库 | MySQL / PostgreSQL |
|
|
22
|
+
| 缓存 | Redis(按需) |
|
|
23
|
+
| 消息队列 | RabbitMQ / Kafka(按需) |
|
|
24
|
+
|
|
25
|
+
## 模块结构
|
|
26
|
+
|
|
27
|
+
<!-- 描述多模块结构(若适用) -->
|
|
28
|
+
|
|
29
|
+
## 核心依赖
|
|
30
|
+
|
|
31
|
+
<!-- 列出关键 starter 与第三方依赖 -->
|
package/.agents/rules/profiles/springboot/03-/351/241/271/347/233/256/347/273/223/346/236/204.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目结构规范,包括多模块目录约定、包名规则、资源目录组织方式。当新建模块、包或文件时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 项目结构(Spring Boot)
|
|
7
|
+
|
|
8
|
+
> 本文件由 `project-init` 技能根据仓库实际情况生成,请勿手动覆盖自动生成的内容。
|
|
9
|
+
|
|
10
|
+
## 典型目录结构
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
<root>/
|
|
14
|
+
├── <module>-api/ # 对外接口定义(DTO、接口声明)
|
|
15
|
+
├── <module>-service/ # 业务实现
|
|
16
|
+
│ └── src/main/java/com/<org>/<module>/
|
|
17
|
+
│ ├── controller/ # HTTP 控制器
|
|
18
|
+
│ ├── service/ # 业务服务接口与实现
|
|
19
|
+
│ ├── repository/ # 数据访问层
|
|
20
|
+
│ ├── domain/ # 领域模型(Entity、VO)
|
|
21
|
+
│ ├── dto/ # 数据传输对象
|
|
22
|
+
│ ├── config/ # 配置类
|
|
23
|
+
│ └── exception/ # 异常定义
|
|
24
|
+
└── <module>-start/ # 启动模块(含 application.yml)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 包命名规则
|
|
28
|
+
|
|
29
|
+
- 顶层包:`com.<org>.<project>`
|
|
30
|
+
- 按职责分层,禁止跨层直接调用(Controller → Service → Repository)
|
|
31
|
+
- 禁止在 Controller 中直接操作 Repository
|
|
32
|
+
|
|
33
|
+
## 资源目录
|
|
34
|
+
|
|
35
|
+
- `src/main/resources/application.yml`:主配置
|
|
36
|
+
- `src/main/resources/application-<env>.yml`:环境配置
|
|
37
|
+
- `src/main/resources/mapper/`:MyBatis XML(如适用)
|
package/.agents/rules/profiles/springboot/04-/345/210/206/345/261/202/350/247/204/350/214/203.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的分层规范,包括 Controller / Service / Repository 职责边界、禁止跨层直接调用的约束。当新增或修改业务代码时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 分层规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## 分层职责
|
|
9
|
+
|
|
10
|
+
| 层次 | 职责 | 禁止事项 |
|
|
11
|
+
|------|------|----------|
|
|
12
|
+
| Controller | 接收 HTTP 请求、参数校验、调用 Service、返回响应 | 禁止包含业务逻辑、禁止直接调用 Repository |
|
|
13
|
+
| Service | 业务逻辑编排、事务管理、跨模块调用 | 禁止直接处理 HTTP 请求 / 响应对象 |
|
|
14
|
+
| Repository | 数据访问、SQL / ORM 操作 | 禁止包含业务逻辑 |
|
|
15
|
+
| Domain / Entity | 领域模型定义 | 禁止依赖 Service 或 Repository |
|
|
16
|
+
| DTO | 数据传输对象,用于跨层传递 | 禁止包含业务逻辑 |
|
|
17
|
+
|
|
18
|
+
## 调用规则(NON-NEGOTIABLE)
|
|
19
|
+
|
|
20
|
+
- Controller 只调用 Service,不直接调用 Repository
|
|
21
|
+
- Service 调用 Repository 或其它 Service(同层可调用)
|
|
22
|
+
- Repository 只负责数据操作,不引用 Service
|
|
23
|
+
|
|
24
|
+
## 事务管理
|
|
25
|
+
|
|
26
|
+
- 事务注解 `@Transactional` 加在 Service 层
|
|
27
|
+
- 只读操作使用 `@Transactional(readOnly = true)` 提升性能
|
|
28
|
+
- 跨 Service 的复杂事务需明确传播行为(`REQUIRED` / `REQUIRES_NEW`)
|
|
29
|
+
|
|
30
|
+
## 接口与实现分离
|
|
31
|
+
|
|
32
|
+
- Service 层优先定义接口(`XxxService`),由 `XxxServiceImpl` 实现
|
|
33
|
+
- 单实现场景下可酌情省略接口,但需团队统一约定
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的接口与契约规范,包括 RESTful 接口设计、统一响应体、版本控制与参数校验约定。当新增或修改 HTTP 接口时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 接口与契约规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## RESTful 设计原则
|
|
9
|
+
|
|
10
|
+
| 操作 | HTTP 方法 | URI 示例 |
|
|
11
|
+
|------|-----------|----------|
|
|
12
|
+
| 查询列表 | GET | `/api/v1/orders` |
|
|
13
|
+
| 查询详情 | GET | `/api/v1/orders/{id}` |
|
|
14
|
+
| 创建 | POST | `/api/v1/orders` |
|
|
15
|
+
| 更新(全量) | PUT | `/api/v1/orders/{id}` |
|
|
16
|
+
| 更新(部分) | PATCH | `/api/v1/orders/{id}` |
|
|
17
|
+
| 删除 | DELETE | `/api/v1/orders/{id}` |
|
|
18
|
+
|
|
19
|
+
## 统一响应体(NON-NEGOTIABLE)
|
|
20
|
+
|
|
21
|
+
所有接口必须返回统一的响应结构:
|
|
22
|
+
|
|
23
|
+
```java
|
|
24
|
+
public class Result<T> {
|
|
25
|
+
private int code; // 状态码,成功为 0 或 200
|
|
26
|
+
private String message; // 描述信息
|
|
27
|
+
private T data; // 业务数据
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- 不允许直接返回裸数据,必须包装成统一响应体
|
|
32
|
+
- 异常响应同样遵循此格式
|
|
33
|
+
|
|
34
|
+
## API 版本控制
|
|
35
|
+
|
|
36
|
+
- URI 路径版本:`/api/v1/`、`/api/v2/`
|
|
37
|
+
- 新版本接口不应破坏已有版本的兼容性
|
|
38
|
+
|
|
39
|
+
## 参数校验
|
|
40
|
+
|
|
41
|
+
- 使用 JSR-303/380(`@Valid`、`@Validated`)进行请求参数校验
|
|
42
|
+
- Controller 层统一触发校验,不在 Service 层重复校验入参格式
|
|
43
|
+
- 自定义校验注解放在 `common` 模块的 `validation` 包
|
|
44
|
+
|
|
45
|
+
## DTO 命名约定
|
|
46
|
+
|
|
47
|
+
| 场景 | 命名 | 示例 |
|
|
48
|
+
|------|------|------|
|
|
49
|
+
| 请求参数 | `XxxRequest` / `XxxReqDTO` | `CreateOrderRequest` |
|
|
50
|
+
| 响应数据 | `XxxResponse` / `XxxRespDTO` | `OrderDetailResponse` |
|
|
51
|
+
| 查询条件 | `XxxQuery` | `OrderListQuery` |
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的数据访问规范,包括 ORM 框架选型约定、Repository 命名、SQL 管理与事务边界。当编写数据访问层代码时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 数据访问规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## ORM 框架约定
|
|
9
|
+
|
|
10
|
+
- 项目统一使用团队约定的 ORM 框架(MyBatis / JPA / Spring Data),禁止混用
|
|
11
|
+
- MyBatis 项目:SQL 写在 XML 中(`src/main/resources/mapper/`),禁止直接在注解里写复杂 SQL
|
|
12
|
+
- JPA 项目:简单查询使用 Repository 方法命名,复杂查询使用 `@Query` 或 Specification
|
|
13
|
+
|
|
14
|
+
## Repository 命名
|
|
15
|
+
|
|
16
|
+
- 接口命名:`XxxMapper`(MyBatis)或 `XxxRepository`(JPA)
|
|
17
|
+
- 每个实体对应一个 Mapper / Repository,禁止跨实体混合操作
|
|
18
|
+
|
|
19
|
+
## 分页查询
|
|
20
|
+
|
|
21
|
+
- 统一使用框架提供的分页机制(MyBatis-Plus `Page`、Spring Data `Pageable`)
|
|
22
|
+
- 禁止手写 `LIMIT offset, size` 做内存分页
|
|
23
|
+
|
|
24
|
+
## SQL 安全
|
|
25
|
+
|
|
26
|
+
- 禁止字符串拼接构造 SQL(防 SQL 注入)
|
|
27
|
+
- 动态 SQL 使用框架提供的条件拼接(`<if>`、`Criteria`)
|
|
28
|
+
- 批量操作使用框架批量接口,禁止循环单条操作
|
|
29
|
+
|
|
30
|
+
## 实体设计
|
|
31
|
+
|
|
32
|
+
- 主键统一通过框架生成策略管理(雪花 ID、自增、UUID 按项目选一)
|
|
33
|
+
- 审计字段(创建时间、更新时间、创建人、更新人)统一由基类或 `@EntityListeners` 自动填充
|
|
34
|
+
- 逻辑删除字段统一命名(如 `is_deleted`),不做物理删除
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的配置与运行时规范,包括配置文件分层、环境隔离、敏感配置管理与 Bean 生命周期约定。当新增或修改配置时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 配置与运行时规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## 配置文件分层
|
|
9
|
+
|
|
10
|
+
```text
|
|
11
|
+
src/main/resources/
|
|
12
|
+
├── application.yml # 公共配置(不含敏感信息)
|
|
13
|
+
├── application-dev.yml # 开发环境
|
|
14
|
+
├── application-test.yml # 测试环境
|
|
15
|
+
├── application-prod.yml # 生产环境
|
|
16
|
+
└── bootstrap.yml # 配置中心加载(如使用)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
- 通过 `spring.profiles.active` 激活环境配置
|
|
20
|
+
- 公共配置放 `application.yml`,环境差异放对应的 profile 文件
|
|
21
|
+
|
|
22
|
+
## 敏感配置管理(NON-NEGOTIABLE)
|
|
23
|
+
|
|
24
|
+
- 数据库密码、中间件密码、第三方 API 密钥禁止写入 Git
|
|
25
|
+
- 生产敏感配置通过配置中心(Nacos / Apollo)或环境变量注入
|
|
26
|
+
- 本地开发可使用 `.env` 文件(已加入 `.gitignore`)存储敏感值
|
|
27
|
+
|
|
28
|
+
## 配置类约定
|
|
29
|
+
|
|
30
|
+
- 自定义配置使用 `@ConfigurationProperties` 而非多处 `@Value`
|
|
31
|
+
- 配置类放在 `config/` 包,命名为 `XxxProperties` 或 `XxxConfig`
|
|
32
|
+
- 配置校验:在 `@ConfigurationProperties` 类上使用 `@Validated` 及 JSR-303 注解
|
|
33
|
+
|
|
34
|
+
## Bean 生命周期
|
|
35
|
+
|
|
36
|
+
- 使用构造函数注入(而非字段注入),便于测试与不变性保证
|
|
37
|
+
- 避免循环依赖;若存在,优先通过重构消除,而非使用 `@Lazy`
|
|
38
|
+
- `ApplicationRunner` / `CommandLineRunner` 仅用于应用启动后的一次性初始化
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的异常与日志规范,包括全局异常处理、自定义异常体系、日志级别与结构化日志约定。当编写异常处理或日志相关代码时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 异常与日志规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## 异常体系
|
|
9
|
+
|
|
10
|
+
- 定义统一的业务异常基类(如 `BusinessException`)
|
|
11
|
+
- 不同业务模块可扩展自己的子类(如 `OrderNotFoundException`)
|
|
12
|
+
- 禁止直接抛出 `RuntimeException` 或 `Exception`,必须使用有语义的异常类型
|
|
13
|
+
|
|
14
|
+
## 全局异常处理(NON-NEGOTIABLE)
|
|
15
|
+
|
|
16
|
+
- 使用 `@RestControllerAdvice` + `@ExceptionHandler` 统一捕获异常
|
|
17
|
+
- 全局处理器返回统一响应体(参考接口契约规范)
|
|
18
|
+
- 以下异常必须全局处理:
|
|
19
|
+
- `BusinessException` 及其子类
|
|
20
|
+
- `MethodArgumentNotValidException`(参数校验失败)
|
|
21
|
+
- `HttpMessageNotReadableException`(请求体解析失败)
|
|
22
|
+
- 兜底 `Exception`(避免泄露堆栈信息到响应中)
|
|
23
|
+
|
|
24
|
+
## 日志规范
|
|
25
|
+
|
|
26
|
+
- 使用 `SLF4J` + `Logback` 或 `Log4j2`,禁止直接使用 `System.out.println`
|
|
27
|
+
- 通过 `@Slf4j`(Lombok)或手动 `LoggerFactory.getLogger` 获取 Logger
|
|
28
|
+
- 生产环境禁止 DEBUG 日志;开发/测试环境可开启
|
|
29
|
+
|
|
30
|
+
### 日志级别使用场景
|
|
31
|
+
|
|
32
|
+
| 级别 | 适用场景 |
|
|
33
|
+
|------|----------|
|
|
34
|
+
| ERROR | 系统异常、不可预期错误、需立即处理的问题 |
|
|
35
|
+
| WARN | 可恢复的业务异常、配置缺失但有兜底 |
|
|
36
|
+
| INFO | 关键业务操作节点(订单创建、支付完成等) |
|
|
37
|
+
| DEBUG | 开发调试信息,生产禁止输出 |
|
|
38
|
+
|
|
39
|
+
### 结构化日志
|
|
40
|
+
|
|
41
|
+
- 关键操作日志包含:操作类型、业务 ID、操作人、耗时
|
|
42
|
+
- 推荐使用 MDC 注入 traceId / requestId,便于链路追踪
|
|
43
|
+
|
|
44
|
+
## 禁止事项
|
|
45
|
+
|
|
46
|
+
- 禁止在 catch 块中吞掉异常(即 catch 后不记录、不抛出)
|
|
47
|
+
- 禁止将异常堆栈直接返回给客户端
|
|
48
|
+
- 禁止在循环内大量打印日志(性能风险)
|
package/.agents/rules/profiles/springboot/11-/346/265/213/350/257/225/350/247/204/350/214/203.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的测试规范,包括测试框架(JUnit 5 + Mockito + Spring Boot Test)、测试分层策略、测试文件约定与质量门禁。当编写测试或评审测试代码时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 测试规范(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## 测试框架
|
|
9
|
+
|
|
10
|
+
- 统一使用 **JUnit 5**(`@ExtendWith(SpringExtension.class)` 或 `@SpringBootTest`)
|
|
11
|
+
- Mock 框架:**Mockito**(`@MockBean`、`@Mock`、`@InjectMocks`)
|
|
12
|
+
- 断言库:**AssertJ**(推荐)或 JUnit 5 原生 `Assertions`
|
|
13
|
+
|
|
14
|
+
## 测试分层策略
|
|
15
|
+
|
|
16
|
+
| 层次 | 注解 | 范围 | 说明 |
|
|
17
|
+
|------|------|------|------|
|
|
18
|
+
| 单元测试 | 无 Spring 上下文 | Service / 工具类 | 使用 Mockito 模拟依赖,运行最快 |
|
|
19
|
+
| 切片测试 | `@WebMvcTest`、`@DataJpaTest` | Controller / Repository | 只加载对应层的 Spring 上下文 |
|
|
20
|
+
| 集成测试 | `@SpringBootTest` | 全链路 | 加载完整上下文,速度慢,按需使用 |
|
|
21
|
+
|
|
22
|
+
## 测试文件约定
|
|
23
|
+
|
|
24
|
+
| 项目 | 约定 |
|
|
25
|
+
|------|------|
|
|
26
|
+
| 文件位置 | `src/test/java/<same-package-as-source>/` |
|
|
27
|
+
| 文件命名 | `XxxTest.java`(单元测试)、`XxxIT.java`(集成测试) |
|
|
28
|
+
| 测试配置 | `src/test/resources/application-test.yml` |
|
|
29
|
+
|
|
30
|
+
## 编写规范
|
|
31
|
+
|
|
32
|
+
- 测试方法命名使用中文或英文描述,表达预期行为而非实现步骤
|
|
33
|
+
- 遵循 **Arrange-Act-Assert** 模式
|
|
34
|
+
- 每个测试方法只验证一个行为点
|
|
35
|
+
- 测试应互相独立,不依赖执行顺序
|
|
36
|
+
- 使用 `@TestPropertySource` 或测试配置文件覆盖生产配置
|
|
37
|
+
|
|
38
|
+
## 质量门禁(NON-NEGOTIABLE)
|
|
39
|
+
|
|
40
|
+
- 所有 Service 层核心业务逻辑必须有单元测试覆盖
|
|
41
|
+
- `@SpringBootTest` 集成测试按需使用,不要求全覆盖
|
|
42
|
+
- 测试必须能独立运行,不依赖外部真实服务(使用 Mock 或嵌入式数据库)
|
|
43
|
+
- 新增工具类必须附带测试用例
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: Spring Boot 项目的代码格式化与静态检查规范,包括 Checkstyle、SpotBugs、Google Java Format 等工具链职责与配置约定。当配置或调整代码检查工具时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 代码格式化与检查(Spring Boot)
|
|
7
|
+
|
|
8
|
+
## 工具链
|
|
9
|
+
|
|
10
|
+
| 工具 | 职责 | 配置文件 |
|
|
11
|
+
|------|------|----------|
|
|
12
|
+
| **Google Java Format** / **Spotless** | Java 代码格式化(缩进、括号等) | `pom.xml` / `build.gradle` 中的插件配置 |
|
|
13
|
+
| **Checkstyle** | 代码风格检查(命名、注释等) | `checkstyle.xml` |
|
|
14
|
+
| **SpotBugs** | 静态分析(潜在 bug 检测) | `spotbugs-exclude.xml` |
|
|
15
|
+
|
|
16
|
+
## 格式化规则
|
|
17
|
+
|
|
18
|
+
- 统一使用项目约定的 Java 格式化风格(Google Style 或 Alibaba Java Style)
|
|
19
|
+
- 缩进:4 个空格,禁止使用 Tab
|
|
20
|
+
- 单行最大宽度:120 字符
|
|
21
|
+
- 所有 `import` 按字母顺序排列,禁止 wildcard import(`import java.util.*`)
|
|
22
|
+
|
|
23
|
+
## Checkstyle 核心规则
|
|
24
|
+
|
|
25
|
+
- 类、方法、字段命名遵循 Java 命名约定
|
|
26
|
+
- 公共类和公共方法必须有 Javadoc 注释
|
|
27
|
+
- 禁止空 catch 块(必须有注释说明忽略原因)
|
|
28
|
+
|
|
29
|
+
## Maven / Gradle 集成
|
|
30
|
+
|
|
31
|
+
```xml
|
|
32
|
+
<!-- Maven 示例:Spotless 格式化插件 -->
|
|
33
|
+
<plugin>
|
|
34
|
+
<groupId>com.diffplug.spotless</groupId>
|
|
35
|
+
<artifactId>spotless-maven-plugin</artifactId>
|
|
36
|
+
<configuration>
|
|
37
|
+
<java>
|
|
38
|
+
<googleJavaFormat/>
|
|
39
|
+
</java>
|
|
40
|
+
</configuration>
|
|
41
|
+
</plugin>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## 开发流程集成
|
|
45
|
+
|
|
46
|
+
- 提交前通过 Maven/Gradle 的 `verify` 阶段执行 Checkstyle 和 SpotBugs
|
|
47
|
+
- IDE 推荐安装 Checkstyle 插件,实时提示规范问题
|
|
48
|
+
- CI 流水线必须包含 `checkstyle:check` 步骤,失败则阻断合并
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
alwaysApply: false
|
|
3
|
+
description: 项目定位与技术栈概览。当需要了解项目背景、使用的技术栈时读取此规则。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 项目概述
|
|
7
|
+
|
|
8
|
+
## 项目定位
|
|
9
|
+
|
|
10
|
+
一个基于 Vue 3 + TypeScript 的单页应用(SPA)。
|
|
11
|
+
|
|
12
|
+
> **与 JavaScript 存量项目的关系**:本文件默认描述团队推荐的 **Vue + TypeScript**。若 `package.json` 的 `dependencies` / `devDependencies` 中**未**声明 `typescript`,以「初始化项目规范」技能生成的 **01-项目概述.md** 为准,并遵循 **02-编码规范** 中的 JavaScript 小节。
|
|
13
|
+
|
|
14
|
+
## 技术栈
|
|
15
|
+
|
|
16
|
+
| 领域 | 技术 | 说明 |
|
|
17
|
+
|------|------|------|
|
|
18
|
+
| UI 框架 | Vue ^3.5 | 强制使用 Composition API + `<script setup>` |
|
|
19
|
+
| 类型系统 | TypeScript 5.x | 推荐;新代码优先 TS。纯 JS 项目见 02-编码规范 |
|
|
20
|
+
| 构建工具 | Vite 6.x | 开发与生产构建 |
|
|
21
|
+
| 路由管理 | Vue Router ^4.5 | - |
|
|
22
|
+
| 状态管理 | Pinia ^3.0 | 统一使用,禁止 Vuex 或其他方案 |
|
|
23
|
+
| 组件库 | Element Plus ^2.9 | 所有交互 UI 优先基于 Element Plus 封装(可按项目替换) |
|
|
24
|
+
| 样式方案 | SCSS Modules / Scoped Style | 推荐 CSS Modules,允许 `<style scoped>` |
|
|
25
|
+
| HTTP 请求 | axios ^1.7 | 统一封装请求实例 |
|
|
26
|
+
| 工具函数 | VueUse ^12.0 | 编写 composable 前,优先查找 VueUse 是否已提供 |
|
|
27
|
+
| 通用工具 | lodash-es 4.17.21 | 编写工具函数前,优先考虑 lodash 已有实现 |
|
|
28
|
+
| 时间工具 | dayjs 1.11.x | 涉及日期时间的处理统一用 dayjs |
|
|
29
|
+
|
|
30
|
+
## 技术约束
|
|
31
|
+
|
|
32
|
+
- Vue 组件**必须**使用 `<script setup>`,禁止 Options API。**TypeScript 项目**使用 `lang="ts"`;**JavaScript 项目**无 `lang` 或 `lang="js"`,类型与 JSDoc 见 02-编码规范
|
|
33
|
+
- **TypeScript 项目**:禁止 `any`,Props、Emits、API 响应须有明确类型。**JavaScript 项目**:见 02 中 JavaScript 与 JSDoc 约定
|
|
34
|
+
- 新增依赖前必须评估 bundle size 影响,优先使用 tree-shakable 的 ESM 包
|
|
35
|
+
- 所有第三方组件库的二次封装必须基于项目指定组件库(默认 Element Plus)
|
|
36
|
+
|
|
37
|
+
## 开发规范
|
|
38
|
+
|
|
39
|
+
- 包管理器:统一使用 pnpm
|
|
40
|
+
- 代码格式化:ESLint + Prettier,提交前自动格式化
|
|
41
|
+
- Git 提交:遵循 Conventional Commits 规范
|
|
42
|
+
- 路径别名:`@/` 指向 `src/` 目录
|
|
43
|
+
|
|
44
|
+
## 浏览器兼容性
|
|
45
|
+
|
|
46
|
+
- 支持现代浏览器(Chrome / Firefox / Safari / Edge 最近两个主版本)
|
|
47
|
+
- 不支持 IE 11
|