universal-dev-standards 6.14.0-beta.9 → 6.14.1-beta.1
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/bin/uds.js +12 -1
- package/bundled/ai/options/commit-message/traditional-chinese.ai.yaml +69 -67
- package/bundled/ai/standards/commit-message.ai.yaml +12 -2
- package/bundled/ai/standards/mock-boundary.ai.yaml +138 -2
- package/bundled/ai/standards/secret-management-standards.ai.yaml +12 -1
- package/bundled/ai/standards/turn-completion-integrity.ai.yaml +6 -2
- package/bundled/core/commit-message-guide.md +22 -19
- package/bundled/core/mock-boundary.md +70 -2
- package/bundled/core/secret-management-standards.md +13 -1
- package/bundled/core/turn-completion-integrity.md +8 -2
- package/bundled/extensions/locales/zh-tw.md +19 -19
- package/bundled/hooks/check-dangerous-cmd.mjs +161 -26
- package/bundled/hooks/check-logging-standard.mjs +35 -6
- package/bundled/hooks/validate-commit-msg.mjs +317 -28
- package/bundled/locales/zh-CN/CHANGELOG.md +2323 -1099
- package/bundled/locales/zh-CN/CLAUDE.md +987 -101
- package/bundled/locales/zh-CN/README.md +3 -3
- package/bundled/locales/zh-CN/SECURITY.md +4 -3
- package/bundled/locales/zh-CN/STANDARDS-MAPPING.md +103 -6
- package/bundled/locales/zh-CN/adoption/ADOPTION-GUIDE.md +68 -97
- package/bundled/locales/zh-CN/adoption/DAILY-WORKFLOW-GUIDE.md +2 -1
- package/bundled/locales/zh-CN/adoption/STATIC-DYNAMIC-GUIDE.md +8 -9
- package/bundled/locales/zh-CN/adoption/checklists/enterprise.md +81 -80
- package/bundled/locales/zh-CN/adoption/checklists/minimal.md +18 -14
- package/bundled/locales/zh-CN/adoption/checklists/recommended.md +49 -46
- package/bundled/locales/zh-CN/ai/MAINTENANCE.md +44 -9
- package/bundled/locales/zh-CN/ai/options/commit-message/traditional-chinese.ai.yaml +63 -55
- package/bundled/locales/zh-CN/core/acceptance-criteria-traceability.md +61 -14
- package/bundled/locales/zh-CN/core/acceptance-test-driven-development.md +2 -1
- package/bundled/locales/zh-CN/core/accessibility-standards.md +871 -62
- package/bundled/locales/zh-CN/core/adr-standards.md +155 -32
- package/bundled/locales/zh-CN/core/agent-communication-protocol.md +2 -1
- package/bundled/locales/zh-CN/core/agent-dispatch.md +68 -33
- package/bundled/locales/zh-CN/core/ai-agreement-standards.md +23 -22
- package/bundled/locales/zh-CN/core/ai-command-behavior.md +2 -1
- package/bundled/locales/zh-CN/core/ai-friendly-architecture.md +311 -72
- package/bundled/locales/zh-CN/core/ai-instruction-standards.md +71 -49
- package/bundled/locales/zh-CN/core/ai-response-navigation.md +2 -1
- package/bundled/locales/zh-CN/core/alerting-standards.md +231 -36
- package/bundled/locales/zh-CN/core/anti-hallucination.md +116 -697
- package/bundled/locales/zh-CN/core/anti-sycophancy-prompting.md +34 -33
- package/bundled/locales/zh-CN/core/api-design-standards.md +144 -58
- package/bundled/locales/zh-CN/core/behavior-driven-development.md +2 -1
- package/bundled/locales/zh-CN/core/branch-completion.md +75 -20
- package/bundled/locales/zh-CN/core/capability-declaration.md +44 -94
- package/bundled/locales/zh-CN/core/change-batching-standards.md +2 -1
- package/bundled/locales/zh-CN/core/changelog-standards.md +485 -63
- package/bundled/locales/zh-CN/core/chaos-engineering-standards.md +141 -39
- package/bundled/locales/zh-CN/core/checkin-standards.md +176 -116
- package/bundled/locales/zh-CN/core/circuit-breaker.md +43 -77
- package/bundled/locales/zh-CN/core/code-review-checklist.md +37 -23
- package/bundled/locales/zh-CN/core/commit-message-guide.md +892 -69
- package/bundled/locales/zh-CN/core/containerization-standards.md +259 -57
- package/bundled/locales/zh-CN/core/context-aware-loading.md +103 -29
- package/bundled/locales/zh-CN/core/database-standards.md +115 -114
- package/bundled/locales/zh-CN/core/deprecation-standards.md +155 -40
- package/bundled/locales/zh-CN/core/design-document-standards.md +265 -55
- package/bundled/locales/zh-CN/core/developer-memory.md +150 -60
- package/bundled/locales/zh-CN/core/documentation-lifecycle.md +20 -16
- package/bundled/locales/zh-CN/core/documentation-structure.md +1284 -127
- package/bundled/locales/zh-CN/core/documentation-writing-standards.md +649 -259
- package/bundled/locales/zh-CN/core/dual-phase-output.md +37 -70
- package/bundled/locales/zh-CN/core/environment-standards.md +251 -73
- package/bundled/locales/zh-CN/core/error-code-standards.md +501 -60
- package/bundled/locales/zh-CN/core/estimation-standards.md +174 -41
- package/bundled/locales/zh-CN/core/execution-history.md +2 -1
- package/bundled/locales/zh-CN/core/failure-source-taxonomy.md +71 -84
- package/bundled/locales/zh-CN/core/feature-flag-standards.md +202 -57
- package/bundled/locales/zh-CN/core/forward-derivation-standards.md +613 -154
- package/bundled/locales/zh-CN/core/frontend-design-standards.md +361 -78
- package/bundled/locales/zh-CN/core/git-workflow.md +148 -262
- package/bundled/locales/zh-CN/core/git-worktree.md +59 -26
- package/bundled/locales/zh-CN/core/guides/file-placement-guide.md +132 -48
- package/bundled/locales/zh-CN/core/guides/performance-guide.md +61 -59
- package/bundled/locales/zh-CN/core/guides/security-guide.md +2 -0
- package/bundled/locales/zh-CN/core/health-check-standards.md +46 -104
- package/bundled/locales/zh-CN/core/immutability-first.md +83 -60
- package/bundled/locales/zh-CN/core/knowledge-transfer-standards.md +94 -31
- package/bundled/locales/zh-CN/core/mock-boundary.md +74 -6
- package/bundled/locales/zh-CN/core/mutation-testing.md +45 -6
- package/bundled/locales/zh-CN/core/observability-standards.md +281 -37
- package/bundled/locales/zh-CN/core/performance-standards.md +402 -42
- package/bundled/locales/zh-CN/core/pipeline-integration-standards.md +2 -1
- package/bundled/locales/zh-CN/core/postmortem-standards.md +358 -53
- package/bundled/locales/zh-CN/core/privacy-standards.md +148 -40
- package/bundled/locales/zh-CN/core/project-context-memory.md +182 -48
- package/bundled/locales/zh-CN/core/project-structure.md +550 -170
- package/bundled/locales/zh-CN/core/recovery-recipe-registry.md +54 -114
- package/bundled/locales/zh-CN/core/refactoring-standards.md +141 -556
- package/bundled/locales/zh-CN/core/requirement-engineering.md +7 -6
- package/bundled/locales/zh-CN/core/retrospective-standards.md +215 -22
- package/bundled/locales/zh-CN/core/retry-standards.md +46 -101
- package/bundled/locales/zh-CN/core/reverse-engineering-standards.md +370 -120
- package/bundled/locales/zh-CN/core/runbook-standards.md +294 -48
- package/bundled/locales/zh-CN/core/security-decision.md +45 -70
- package/bundled/locales/zh-CN/core/security-standards.md +169 -16
- package/bundled/locales/zh-CN/core/skill-standard-alignment-check.md +105 -71
- package/bundled/locales/zh-CN/core/slo-standards.md +296 -44
- package/bundled/locales/zh-CN/core/spec-driven-development.md +37 -6
- package/bundled/locales/zh-CN/core/standard-admission-criteria.md +25 -31
- package/bundled/locales/zh-CN/core/standard-lifecycle-management.md +49 -57
- package/bundled/locales/zh-CN/core/structured-task-definition.md +2 -1
- package/bundled/locales/zh-CN/core/supply-chain-security-standards.md +159 -32
- package/bundled/locales/zh-CN/core/systematic-debugging.md +87 -42
- package/bundled/locales/zh-CN/core/tech-debt-standards.md +202 -86
- package/bundled/locales/zh-CN/core/test-completeness-dimensions.md +262 -190
- package/bundled/locales/zh-CN/core/test-data-standards.md +252 -30
- package/bundled/locales/zh-CN/core/test-driven-development.md +21 -1022
- package/bundled/locales/zh-CN/core/test-governance.md +94 -43
- package/bundled/locales/zh-CN/core/testing-standards.md +83 -37
- package/bundled/locales/zh-CN/core/timeout-standards.md +45 -85
- package/bundled/locales/zh-CN/core/token-budget.md +44 -80
- package/bundled/locales/zh-CN/core/translation-lifecycle-standards.md +48 -36
- package/bundled/locales/zh-CN/core/turn-completion-integrity.md +8 -6
- package/bundled/locales/zh-CN/core/verification-evidence.md +44 -22
- package/bundled/locales/zh-CN/core/versioning.md +737 -73
- package/bundled/locales/zh-CN/core/virtual-organization-standards.md +30 -29
- package/bundled/locales/zh-CN/core/workflow-enforcement.md +9 -8
- package/bundled/locales/zh-CN/core/workflow-state-protocol.md +9 -8
- package/bundled/locales/zh-CN/docs/CHEATSHEET.md +2 -1
- package/bundled/locales/zh-CN/docs/CLI-FLOW.md +2 -1
- package/bundled/locales/zh-CN/docs/CLI-INIT-OPTIONS.md +19 -10
- package/bundled/locales/zh-CN/docs/FEATURE-REFERENCE.md +8 -6
- package/bundled/locales/zh-CN/docs/STANDARDS-REFERENCE.md +2 -1
- package/bundled/locales/zh-CN/docs/USAGE-MODES-COMPARISON.md +133 -132
- package/bundled/locales/zh-CN/docs/USER-MANUAL.md +11 -3
- package/bundled/locales/zh-CN/docs/WINDOWS-GUIDE.md +5 -2
- package/bundled/locales/zh-CN/docs/specs/system/memory-adoption-strategy.md +2 -0
- package/bundled/locales/zh-CN/docs/user/FAQ.md +2 -0
- package/bundled/locales/zh-CN/docs/user/GETTING-STARTED.md +2 -0
- package/bundled/locales/zh-CN/docs/user/GLOSSARY.md +2 -0
- package/bundled/locales/zh-CN/docs/user/README.md +4 -2
- package/bundled/locales/zh-CN/docs/user/TROUBLESHOOTING.md +2 -0
- package/bundled/locales/zh-CN/integrations/codex/AGENTS.md +136 -2
- package/bundled/locales/zh-CN/integrations/codex/README.md +62 -10
- package/bundled/locales/zh-CN/integrations/gemini-cli/GEMINI.md +59 -1
- package/bundled/locales/zh-CN/integrations/gemini-cli/README.md +9 -2
- package/bundled/locales/zh-CN/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +7 -1
- package/bundled/locales/zh-CN/integrations/github-copilot/README.md +8 -2
- package/bundled/locales/zh-CN/integrations/github-copilot/copilot-instructions.md +146 -12
- package/bundled/locales/zh-CN/integrations/github-copilot/skills-mapping.md +7 -1
- package/bundled/locales/zh-CN/integrations/google-antigravity/AGENTS.md +110 -3
- package/bundled/locales/zh-CN/integrations/google-antigravity/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/opencode/AGENTS.md +140 -2
- package/bundled/locales/zh-CN/integrations/opencode/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/opencode/skills-mapping.md +8 -2
- package/bundled/locales/zh-CN/integrations/openspec/AGENTS.md +46 -1
- package/bundled/locales/zh-CN/integrations/openspec/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/spec-kit/AGENTS.md +20 -2
- package/bundled/locales/zh-CN/integrations/spec-kit/README.md +7 -1
- package/bundled/locales/zh-CN/options/changelog/auto-generated.md +2 -0
- package/bundled/locales/zh-CN/options/changelog/keep-a-changelog.md +2 -0
- package/bundled/locales/zh-CN/options/code-review/automated-review.md +2 -0
- package/bundled/locales/zh-CN/options/code-review/pair-programming.md +2 -0
- package/bundled/locales/zh-CN/options/commit-message/bilingual.md +139 -50
- package/bundled/locales/zh-CN/options/commit-message/english.md +159 -42
- package/bundled/locales/zh-CN/options/commit-message/traditional-chinese.md +156 -75
- package/bundled/locales/zh-CN/options/documentation/api-docs.md +3 -1
- package/bundled/locales/zh-CN/options/documentation/markdown-docs.md +2 -0
- package/bundled/locales/zh-CN/options/documentation/wiki-style.md +2 -0
- package/bundled/locales/zh-CN/options/git-workflow/gitflow.md +105 -77
- package/bundled/locales/zh-CN/options/git-workflow/github-flow.md +75 -57
- package/bundled/locales/zh-CN/options/git-workflow/merge-commit.md +155 -44
- package/bundled/locales/zh-CN/options/git-workflow/rebase-ff.md +168 -53
- package/bundled/locales/zh-CN/options/git-workflow/squash-merge.md +122 -37
- package/bundled/locales/zh-CN/options/git-workflow/trunk-based.md +108 -61
- package/bundled/locales/zh-CN/options/project-structure/dotnet.md +266 -47
- package/bundled/locales/zh-CN/options/project-structure/go.md +301 -43
- package/bundled/locales/zh-CN/options/project-structure/java.md +268 -48
- package/bundled/locales/zh-CN/options/project-structure/kotlin.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/nodejs.md +168 -51
- package/bundled/locales/zh-CN/options/project-structure/php.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/python.md +210 -52
- package/bundled/locales/zh-CN/options/project-structure/ruby.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/rust.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/swift.md +2 -0
- package/bundled/locales/zh-CN/options/testing/contract-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/e2e-testing.md +227 -66
- package/bundled/locales/zh-CN/options/testing/industry-pyramid.md +2 -0
- package/bundled/locales/zh-CN/options/testing/integration-testing.md +185 -73
- package/bundled/locales/zh-CN/options/testing/istqb-framework.md +2 -0
- package/bundled/locales/zh-CN/options/testing/performance-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/security-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/system-testing.md +270 -96
- package/bundled/locales/zh-CN/options/testing/unit-testing.md +185 -71
- package/bundled/locales/zh-CN/skills/CONTRIBUTING.template.md +43 -42
- package/bundled/locales/zh-CN/skills/INTEGRATION-GUIDE.md +2 -1
- package/bundled/locales/zh-CN/skills/README.md +2 -1
- package/bundled/locales/zh-CN/skills/_shared/README.md +2 -1
- package/bundled/locales/zh-CN/skills/adr-assistant/guide.md +240 -4
- package/bundled/locales/zh-CN/skills/agents/README.md +180 -82
- package/bundled/locales/zh-CN/skills/agents/code-architect.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/doc-writer.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/reviewer.md +4 -2
- package/bundled/locales/zh-CN/skills/agents/spec-analyst.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/test-specialist.md +3 -1
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/SKILL.md +91 -81
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/anti-hallucination.md +79 -59
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/certainty-labels.md +66 -40
- package/bundled/locales/zh-CN/skills/ai-friendly-architecture/SKILL.md +23 -36
- package/bundled/locales/zh-CN/skills/ai-instruction-standards/SKILL.md +217 -137
- package/bundled/locales/zh-CN/skills/api-design-assistant/SKILL.md +13 -2
- package/bundled/locales/zh-CN/skills/atdd-assistant/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/atdd-assistant/acceptance-criteria-guide.md +2 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/atdd-workflow.md +98 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/guide.md +148 -132
- package/bundled/locales/zh-CN/skills/audit-assistant/SKILL.md +5 -2
- package/bundled/locales/zh-CN/skills/bdd-assistant/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/bdd-assistant/bdd-workflow.md +2 -1
- package/bundled/locales/zh-CN/skills/bdd-assistant/gherkin-guide.md +2 -1
- package/bundled/locales/zh-CN/skills/bdd-assistant/guide.md +122 -121
- package/bundled/locales/zh-CN/skills/changelog-guide/SKILL.md +9 -2
- package/bundled/locales/zh-CN/skills/changelog-guide/guide.md +91 -88
- package/bundled/locales/zh-CN/skills/checkin-assistant/SKILL.md +12 -2
- package/bundled/locales/zh-CN/skills/checkin-assistant/guide.md +211 -210
- package/bundled/locales/zh-CN/skills/ci-cd-assistant/SKILL.md +14 -2
- package/bundled/locales/zh-CN/skills/code-review-assistant/SKILL.md +12 -2
- package/bundled/locales/zh-CN/skills/code-review-assistant/checkin-checklist.md +79 -78
- package/bundled/locales/zh-CN/skills/code-review-assistant/guide.md +119 -45
- package/bundled/locales/zh-CN/skills/code-review-assistant/review-checklist.md +89 -88
- package/bundled/locales/zh-CN/skills/commands/ac-coverage.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/api-design.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/atdd.md +71 -1
- package/bundled/locales/zh-CN/skills/commands/audit.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/bdd.md +160 -62
- package/bundled/locales/zh-CN/skills/commands/changelog.md +36 -1
- package/bundled/locales/zh-CN/skills/commands/check.md +53 -1
- package/bundled/locales/zh-CN/skills/commands/checkin.md +45 -1
- package/bundled/locales/zh-CN/skills/commands/ci-cd.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/code-review.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/commit.md +56 -1
- package/bundled/locales/zh-CN/skills/commands/config.md +50 -1
- package/bundled/locales/zh-CN/skills/commands/coverage.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/database.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/derive-all.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/derive-atdd.md +35 -1
- package/bundled/locales/zh-CN/skills/commands/derive-bdd.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/derive-tdd.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/derive.md +60 -4
- package/bundled/locales/zh-CN/skills/commands/dev-workflow.md +58 -8
- package/bundled/locales/zh-CN/skills/commands/discover.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/docgen.md +37 -1
- package/bundled/locales/zh-CN/skills/commands/docs.md +136 -5
- package/bundled/locales/zh-CN/skills/commands/durable.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/e2e.md +85 -1
- package/bundled/locales/zh-CN/skills/commands/guide.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/incident.md +5 -4
- package/bundled/locales/zh-CN/skills/commands/init.md +57 -1
- package/bundled/locales/zh-CN/skills/commands/methodology.md +166 -77
- package/bundled/locales/zh-CN/skills/commands/metrics.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/migrate.md +5 -4
- package/bundled/locales/zh-CN/skills/commands/observability.md +48 -3
- package/bundled/locales/zh-CN/skills/commands/pr.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/refactor.md +76 -38
- package/bundled/locales/zh-CN/skills/commands/release.md +82 -1
- package/bundled/locales/zh-CN/skills/commands/requirement.md +40 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-bdd.md +36 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-sdd.md +44 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-tdd.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/reverse.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/runbook.md +50 -3
- package/bundled/locales/zh-CN/skills/commands/scan.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/sdd-retro.md +50 -1
- package/bundled/locales/zh-CN/skills/commands/sdd.md +182 -1
- package/bundled/locales/zh-CN/skills/commands/security.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/slo.md +51 -3
- package/bundled/locales/zh-CN/skills/commands/tdd.md +74 -5
- package/bundled/locales/zh-CN/skills/commands/update.md +70 -8
- package/bundled/locales/zh-CN/skills/commit-standards/SKILL.md +4 -4
- package/bundled/locales/zh-CN/skills/commit-standards/conventional-commits.md +45 -44
- package/bundled/locales/zh-CN/skills/commit-standards/guide.md +172 -52
- package/bundled/locales/zh-CN/skills/commit-standards/language-options.md +50 -47
- package/bundled/locales/zh-CN/skills/contract-test-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/contract-test-assistant/guide.md +76 -1
- package/bundled/locales/zh-CN/skills/database-assistant/SKILL.md +18 -5
- package/bundled/locales/zh-CN/skills/dev-methodology/SKILL.md +4 -2
- package/bundled/locales/zh-CN/skills/dev-methodology/create-methodology.md +2 -0
- package/bundled/locales/zh-CN/skills/dev-methodology/runtime.md +2 -0
- package/bundled/locales/zh-CN/skills/docs-generator/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/docs-generator/guide.md +8 -7
- package/bundled/locales/zh-CN/skills/documentation-guide/SKILL.md +209 -184
- package/bundled/locales/zh-CN/skills/documentation-guide/documentation-structure.md +73 -72
- package/bundled/locales/zh-CN/skills/documentation-guide/readme-template.md +37 -36
- package/bundled/locales/zh-CN/skills/durable-execution-assistant/SKILL.md +28 -2
- package/bundled/locales/zh-CN/skills/e2e-assistant/SKILL.md +21 -6
- package/bundled/locales/zh-CN/skills/error-code-guide/SKILL.md +76 -95
- package/bundled/locales/zh-CN/skills/git-workflow-guide/SKILL.md +80 -87
- package/bundled/locales/zh-CN/skills/git-workflow-guide/branch-naming.md +44 -43
- package/bundled/locales/zh-CN/skills/git-workflow-guide/git-workflow.md +66 -65
- package/bundled/locales/zh-CN/skills/incident-response-assistant/SKILL.md +31 -13
- package/bundled/locales/zh-CN/skills/metrics-dashboard-assistant/SKILL.md +38 -2
- package/bundled/locales/zh-CN/skills/observability-assistant/SKILL.md +75 -1
- package/bundled/locales/zh-CN/skills/pr-automation-assistant/SKILL.md +32 -6
- package/bundled/locales/zh-CN/skills/project-discovery/SKILL.md +8 -2
- package/bundled/locales/zh-CN/skills/project-discovery/guide.md +158 -157
- package/bundled/locales/zh-CN/skills/project-structure-guide/SKILL.md +49 -46
- package/bundled/locales/zh-CN/skills/project-structure-guide/language-patterns.md +8 -7
- package/bundled/locales/zh-CN/skills/refactoring-assistant/SKILL.md +22 -2
- package/bundled/locales/zh-CN/skills/refactoring-assistant/guide.md +172 -171
- package/bundled/locales/zh-CN/skills/release-standards/SKILL.md +66 -23
- package/bundled/locales/zh-CN/skills/release-standards/changelog-format.md +42 -41
- package/bundled/locales/zh-CN/skills/release-standards/guide.md +51 -43
- package/bundled/locales/zh-CN/skills/release-standards/release-workflow.md +131 -95
- package/bundled/locales/zh-CN/skills/release-standards/semantic-versioning.md +62 -61
- package/bundled/locales/zh-CN/skills/requirement-assistant/SKILL.md +24 -15
- package/bundled/locales/zh-CN/skills/requirement-assistant/guide.md +88 -79
- package/bundled/locales/zh-CN/skills/requirement-assistant/requirement-checklist.md +128 -127
- package/bundled/locales/zh-CN/skills/requirement-assistant/requirement-writing.md +121 -120
- package/bundled/locales/zh-CN/skills/retrospective-assistant/guide.md +206 -2
- package/bundled/locales/zh-CN/skills/reverse-engineer/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/reverse-engineer/bdd-extraction.md +2 -1
- package/bundled/locales/zh-CN/skills/reverse-engineer/guide.md +297 -173
- package/bundled/locales/zh-CN/skills/reverse-engineer/tdd-analysis.md +2 -1
- package/bundled/locales/zh-CN/skills/reverse-engineer/workflow.md +2 -1
- package/bundled/locales/zh-CN/skills/runbook-assistant/SKILL.md +9 -2
- package/bundled/locales/zh-CN/skills/security-assistant/SKILL.md +24 -6
- package/bundled/locales/zh-CN/skills/security-scan-assistant/SKILL.md +34 -10
- package/bundled/locales/zh-CN/skills/slo-assistant/SKILL.md +2 -1
- package/bundled/locales/zh-CN/skills/spec-derivation/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/spec-driven-dev/guide.md +38 -6
- package/bundled/locales/zh-CN/skills/tdd-assistant/SKILL.md +16 -3
- package/bundled/locales/zh-CN/skills/tdd-assistant/guide.md +217 -156
- package/bundled/locales/zh-CN/skills/tdd-assistant/language-examples.md +727 -82
- package/bundled/locales/zh-CN/skills/tdd-assistant/tdd-workflow.md +396 -214
- package/bundled/locales/zh-CN/skills/test-coverage-assistant/SKILL.md +14 -5
- package/bundled/locales/zh-CN/skills/test-coverage-assistant/guide.md +25 -12
- package/bundled/locales/zh-CN/skills/testing-guide/testing-pyramid.md +99 -98
- package/bundled/locales/zh-CN/skills/testing-guide/testing-theory.md +3 -1
- package/bundled/locales/zh-CN/skills/tools/cline/README.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/copilot/README.md +65 -18
- package/bundled/locales/zh-CN/skills/tools/copilot/copilot-instructions.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/cursor/README.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/windsurf/README.md +2 -1
- package/bundled/locales/zh-CN/skills/workflows/README.md +4 -2
- package/bundled/locales/zh-CN/templates/reverse-spec-template.md +50 -1
- package/bundled/locales/zh-TW/CHANGELOG.md +2323 -1128
- package/bundled/locales/zh-TW/CLAUDE.md +962 -76
- package/bundled/locales/zh-TW/README.md +3 -3
- package/bundled/locales/zh-TW/SECURITY.md +4 -3
- package/bundled/locales/zh-TW/STANDARDS-MAPPING.md +103 -6
- package/bundled/locales/zh-TW/adoption/ADOPTION-GUIDE.md +46 -93
- package/bundled/locales/zh-TW/adoption/DAILY-WORKFLOW-GUIDE.md +2 -1
- package/bundled/locales/zh-TW/adoption/STATIC-DYNAMIC-GUIDE.md +3 -1
- package/bundled/locales/zh-TW/adoption/checklists/enterprise.md +10 -9
- package/bundled/locales/zh-TW/adoption/checklists/minimal.md +6 -2
- package/bundled/locales/zh-TW/adoption/checklists/recommended.md +7 -4
- package/bundled/locales/zh-TW/ai/MAINTENANCE.md +34 -14
- package/bundled/locales/zh-TW/ai/options/commit-message/traditional-chinese.ai.yaml +48 -40
- package/bundled/locales/zh-TW/core/acceptance-criteria-traceability.md +56 -10
- package/bundled/locales/zh-TW/core/acceptance-test-driven-development.md +2 -1
- package/bundled/locales/zh-TW/core/accessibility-standards.md +895 -46
- package/bundled/locales/zh-TW/core/adr-standards.md +2 -1
- package/bundled/locales/zh-TW/core/agent-communication-protocol.md +2 -1
- package/bundled/locales/zh-TW/core/agent-dispatch.md +102 -33
- package/bundled/locales/zh-TW/core/ai-agreement-standards.md +58 -41
- package/bundled/locales/zh-TW/core/ai-command-behavior.md +2 -1
- package/bundled/locales/zh-TW/core/ai-friendly-architecture.md +306 -67
- package/bundled/locales/zh-TW/core/ai-instruction-standards.md +16 -13
- package/bundled/locales/zh-TW/core/ai-response-navigation.md +3 -3
- package/bundled/locales/zh-TW/core/alerting-standards.md +257 -35
- package/bundled/locales/zh-TW/core/anti-hallucination.md +169 -40
- package/bundled/locales/zh-TW/core/anti-sycophancy-prompting.md +2 -1
- package/bundled/locales/zh-TW/core/api-design-standards.md +2 -1
- package/bundled/locales/zh-TW/core/behavior-driven-development.md +3 -17
- package/bundled/locales/zh-TW/core/branch-completion.md +130 -34
- package/bundled/locales/zh-TW/core/capability-declaration.md +41 -79
- package/bundled/locales/zh-TW/core/change-batching-standards.md +2 -1
- package/bundled/locales/zh-TW/core/changelog-standards.md +14 -9
- package/bundled/locales/zh-TW/core/chaos-engineering-standards.md +138 -36
- package/bundled/locales/zh-TW/core/checkin-standards.md +84 -26
- package/bundled/locales/zh-TW/core/circuit-breaker.md +48 -87
- package/bundled/locales/zh-TW/core/code-review-checklist.md +19 -7
- package/bundled/locales/zh-TW/core/commit-message-guide.md +218 -87
- package/bundled/locales/zh-TW/core/containerization-standards.md +259 -57
- package/bundled/locales/zh-TW/core/context-aware-loading.md +121 -27
- package/bundled/locales/zh-TW/core/database-standards.md +2 -1
- package/bundled/locales/zh-TW/core/deprecation-standards.md +139 -37
- package/bundled/locales/zh-TW/core/design-document-standards.md +265 -55
- package/bundled/locales/zh-TW/core/developer-memory.md +102 -12
- package/bundled/locales/zh-TW/core/documentation-lifecycle.md +2 -1
- package/bundled/locales/zh-TW/core/documentation-structure.md +17 -8
- package/bundled/locales/zh-TW/core/dual-phase-output.md +28 -90
- package/bundled/locales/zh-TW/core/environment-standards.md +250 -72
- package/bundled/locales/zh-TW/core/error-code-standards.md +17 -6
- package/bundled/locales/zh-TW/core/estimation-standards.md +177 -44
- package/bundled/locales/zh-TW/core/execution-history.md +2 -1
- package/bundled/locales/zh-TW/core/failure-source-taxonomy.md +59 -117
- package/bundled/locales/zh-TW/core/feature-flag-standards.md +202 -57
- package/bundled/locales/zh-TW/core/forward-derivation-standards.md +592 -133
- package/bundled/locales/zh-TW/core/frontend-design-standards.md +120 -8
- package/bundled/locales/zh-TW/core/git-workflow.md +197 -37
- package/bundled/locales/zh-TW/core/git-worktree.md +79 -49
- package/bundled/locales/zh-TW/core/guides/anti-hallucination-guide.md +234 -487
- package/bundled/locales/zh-TW/core/guides/file-placement-guide.md +86 -2
- package/bundled/locales/zh-TW/core/guides/git-workflow-guide.md +411 -464
- package/bundled/locales/zh-TW/core/guides/performance-guide.md +2 -0
- package/bundled/locales/zh-TW/core/guides/refactoring-guide.md +237 -484
- package/bundled/locales/zh-TW/core/guides/security-guide.md +2 -0
- package/bundled/locales/zh-TW/core/health-check-standards.md +46 -104
- package/bundled/locales/zh-TW/core/immutability-first.md +45 -85
- package/bundled/locales/zh-TW/core/knowledge-graph-memory.md +2 -1
- package/bundled/locales/zh-TW/core/knowledge-transfer-standards.md +103 -40
- package/bundled/locales/zh-TW/core/mock-boundary.md +74 -6
- package/bundled/locales/zh-TW/core/observability-standards.md +284 -40
- package/bundled/locales/zh-TW/core/performance-standards.md +387 -86
- package/bundled/locales/zh-TW/core/pipeline-integration-standards.md +2 -1
- package/bundled/locales/zh-TW/core/postmortem-standards.md +367 -36
- package/bundled/locales/zh-TW/core/privacy-standards.md +153 -46
- package/bundled/locales/zh-TW/core/project-context-memory.md +210 -31
- package/bundled/locales/zh-TW/core/project-structure.md +240 -19
- package/bundled/locales/zh-TW/core/recovery-recipe-registry.md +54 -114
- package/bundled/locales/zh-TW/core/refactoring-standards.md +153 -48
- package/bundled/locales/zh-TW/core/requirement-engineering.md +8 -37
- package/bundled/locales/zh-TW/core/retrospective-standards.md +127 -7
- package/bundled/locales/zh-TW/core/retry-standards.md +41 -105
- package/bundled/locales/zh-TW/core/reverse-engineering-standards.md +5 -1
- package/bundled/locales/zh-TW/core/runbook-standards.md +296 -23
- package/bundled/locales/zh-TW/core/secret-management-standards.md +12 -4
- package/bundled/locales/zh-TW/core/security-decision.md +43 -84
- package/bundled/locales/zh-TW/core/security-standards.md +204 -25
- package/bundled/locales/zh-TW/core/self-review-protocol.md +2 -1
- package/bundled/locales/zh-TW/core/skill-standard-alignment-check.md +103 -69
- package/bundled/locales/zh-TW/core/slo-standards.md +301 -49
- package/bundled/locales/zh-TW/core/spec-driven-development.md +36 -7
- package/bundled/locales/zh-TW/core/standard-admission-criteria.md +22 -28
- package/bundled/locales/zh-TW/core/standard-lifecycle-management.md +40 -48
- package/bundled/locales/zh-TW/core/structured-task-definition.md +2 -1
- package/bundled/locales/zh-TW/core/supply-chain-security-standards.md +137 -10
- package/bundled/locales/zh-TW/core/systematic-debugging.md +94 -38
- package/bundled/locales/zh-TW/core/tech-debt-standards.md +170 -54
- package/bundled/locales/zh-TW/core/test-completeness-dimensions.md +101 -12
- package/bundled/locales/zh-TW/core/test-data-standards.md +245 -23
- package/bundled/locales/zh-TW/core/test-driven-development.md +4 -1
- package/bundled/locales/zh-TW/core/test-governance.md +92 -32
- package/bundled/locales/zh-TW/core/testing-standards.md +61 -14
- package/bundled/locales/zh-TW/core/timeout-standards.md +45 -85
- package/bundled/locales/zh-TW/core/token-budget.md +41 -112
- package/bundled/locales/zh-TW/core/translation-lifecycle-standards.md +28 -16
- package/bundled/locales/zh-TW/core/turn-completion-integrity.md +8 -6
- package/bundled/locales/zh-TW/core/verification-evidence.md +2 -1
- package/bundled/locales/zh-TW/core/versioning.md +6 -2
- package/bundled/locales/zh-TW/core/virtual-organization-standards.md +42 -36
- package/bundled/locales/zh-TW/core/workflow-enforcement.md +2 -1
- package/bundled/locales/zh-TW/core/workflow-state-protocol.md +2 -1
- package/bundled/locales/zh-TW/docs/CHEATSHEET.md +2 -1
- package/bundled/locales/zh-TW/docs/CLI-FLOW.md +2 -1
- package/bundled/locales/zh-TW/docs/CLI-INIT-OPTIONS.md +12 -3
- package/bundled/locales/zh-TW/docs/DEV-WORKFLOW-MAPPING.md +2 -1
- package/bundled/locales/zh-TW/docs/FEATURE-REFERENCE.md +8 -6
- package/bundled/locales/zh-TW/docs/STANDARDS-REFERENCE.md +2 -1
- package/bundled/locales/zh-TW/docs/USAGE-MODES-COMPARISON.md +2 -1
- package/bundled/locales/zh-TW/docs/USER-MANUAL.md +9 -1
- package/bundled/locales/zh-TW/docs/WINDOWS-GUIDE.md +4 -1
- package/bundled/locales/zh-TW/docs/specs/system/memory-adoption-strategy.md +2 -0
- package/bundled/locales/zh-TW/docs/user/FAQ.md +2 -0
- package/bundled/locales/zh-TW/docs/user/GETTING-STARTED.md +2 -0
- package/bundled/locales/zh-TW/docs/user/GLOSSARY.md +2 -0
- package/bundled/locales/zh-TW/docs/user/README.md +2 -0
- package/bundled/locales/zh-TW/docs/user/TROUBLESHOOTING.md +2 -0
- package/bundled/locales/zh-TW/integrations/claude-code/README.md +2 -1
- package/bundled/locales/zh-TW/integrations/codex/AGENTS.md +136 -2
- package/bundled/locales/zh-TW/integrations/codex/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/gemini-cli/GEMINI.md +59 -1
- package/bundled/locales/zh-TW/integrations/gemini-cli/README.md +8 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +7 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/README.md +9 -3
- package/bundled/locales/zh-TW/integrations/github-copilot/copilot-instructions.md +146 -12
- package/bundled/locales/zh-TW/integrations/github-copilot/skills-mapping.md +7 -1
- package/bundled/locales/zh-TW/integrations/google-antigravity/AGENTS.md +110 -3
- package/bundled/locales/zh-TW/integrations/google-antigravity/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/opencode/AGENTS.md +140 -2
- package/bundled/locales/zh-TW/integrations/opencode/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/opencode/skills-mapping.md +8 -2
- package/bundled/locales/zh-TW/integrations/openspec/AGENTS.md +46 -1
- package/bundled/locales/zh-TW/integrations/openspec/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/spec-kit/AGENTS.md +20 -2
- package/bundled/locales/zh-TW/integrations/spec-kit/README.md +7 -1
- package/bundled/locales/zh-TW/methodologies/guides/tdd-guide.md +584 -475
- package/bundled/locales/zh-TW/options/changelog/auto-generated.md +2 -0
- package/bundled/locales/zh-TW/options/changelog/keep-a-changelog.md +2 -0
- package/bundled/locales/zh-TW/options/code-review/automated-review.md +2 -0
- package/bundled/locales/zh-TW/options/code-review/pair-programming.md +2 -0
- package/bundled/locales/zh-TW/options/commit-message/bilingual.md +93 -5
- package/bundled/locales/zh-TW/options/commit-message/english.md +118 -1
- package/bundled/locales/zh-TW/options/commit-message/traditional-chinese.md +82 -1
- package/bundled/locales/zh-TW/options/documentation/api-docs.md +2 -0
- package/bundled/locales/zh-TW/options/documentation/markdown-docs.md +2 -0
- package/bundled/locales/zh-TW/options/documentation/wiki-style.md +2 -0
- package/bundled/locales/zh-TW/options/git-workflow/gitflow.md +99 -71
- package/bundled/locales/zh-TW/options/git-workflow/github-flow.md +68 -50
- package/bundled/locales/zh-TW/options/git-workflow/merge-commit.md +131 -20
- package/bundled/locales/zh-TW/options/git-workflow/rebase-ff.md +142 -27
- package/bundled/locales/zh-TW/options/git-workflow/squash-merge.md +100 -15
- package/bundled/locales/zh-TW/options/git-workflow/trunk-based.md +103 -56
- package/bundled/locales/zh-TW/options/project-structure/dotnet.md +233 -14
- package/bundled/locales/zh-TW/options/project-structure/go.md +270 -12
- package/bundled/locales/zh-TW/options/project-structure/java.md +235 -15
- package/bundled/locales/zh-TW/options/project-structure/kotlin.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/nodejs.md +136 -19
- package/bundled/locales/zh-TW/options/project-structure/php.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/python.md +177 -19
- package/bundled/locales/zh-TW/options/project-structure/ruby.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/rust.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/swift.md +2 -0
- package/bundled/locales/zh-TW/options/testing/contract-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/e2e-testing.md +182 -21
- package/bundled/locales/zh-TW/options/testing/industry-pyramid.md +2 -0
- package/bundled/locales/zh-TW/options/testing/integration-testing.md +134 -22
- package/bundled/locales/zh-TW/options/testing/istqb-framework.md +2 -0
- package/bundled/locales/zh-TW/options/testing/performance-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/security-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/system-testing.md +175 -1
- package/bundled/locales/zh-TW/options/testing/unit-testing.md +123 -9
- package/bundled/locales/zh-TW/skills/CONTRIBUTING.template.md +3 -2
- package/bundled/locales/zh-TW/skills/INTEGRATION-GUIDE.md +2 -1
- package/bundled/locales/zh-TW/skills/README.md +2 -1
- package/bundled/locales/zh-TW/skills/_shared/README.md +2 -1
- package/bundled/locales/zh-TW/skills/ac-coverage/SKILL.md +15 -4
- package/bundled/locales/zh-TW/skills/adr-assistant/guide.md +123 -3
- package/bundled/locales/zh-TW/skills/agents/README.md +99 -1
- package/bundled/locales/zh-TW/skills/agents/code-architect.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/doc-writer.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/reviewer.md +3 -1
- package/bundled/locales/zh-TW/skills/agents/spec-analyst.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/test-specialist.md +2 -0
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/SKILL.md +48 -37
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/anti-hallucination.md +22 -2
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/certainty-labels.md +29 -3
- package/bundled/locales/zh-TW/skills/ai-friendly-architecture/SKILL.md +23 -36
- package/bundled/locales/zh-TW/skills/ai-instruction-standards/SKILL.md +12 -36
- package/bundled/locales/zh-TW/skills/api-design-assistant/SKILL.md +21 -5
- package/bundled/locales/zh-TW/skills/atdd-assistant/SKILL.md +40 -15
- package/bundled/locales/zh-TW/skills/atdd-assistant/acceptance-criteria-guide.md +2 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/atdd-workflow.md +98 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/guide.md +24 -8
- package/bundled/locales/zh-TW/skills/audit-assistant/SKILL.md +8 -2
- package/bundled/locales/zh-TW/skills/bdd-assistant/SKILL.md +29 -6
- package/bundled/locales/zh-TW/skills/bdd-assistant/bdd-workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/bdd-assistant/gherkin-guide.md +2 -1
- package/bundled/locales/zh-TW/skills/bdd-assistant/guide.md +9 -8
- package/bundled/locales/zh-TW/skills/changelog-guide/SKILL.md +12 -3
- package/bundled/locales/zh-TW/skills/changelog-guide/guide.md +11 -7
- package/bundled/locales/zh-TW/skills/checkin-assistant/SKILL.md +19 -3
- package/bundled/locales/zh-TW/skills/checkin-assistant/guide.md +5 -3
- package/bundled/locales/zh-TW/skills/ci-cd-assistant/SKILL.md +35 -16
- package/bundled/locales/zh-TW/skills/code-review-assistant/SKILL.md +19 -2
- package/bundled/locales/zh-TW/skills/code-review-assistant/checkin-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/code-review-assistant/guide.md +81 -6
- package/bundled/locales/zh-TW/skills/code-review-assistant/review-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/ac-coverage.md +47 -2
- package/bundled/locales/zh-TW/skills/commands/api-design.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/atdd.md +80 -10
- package/bundled/locales/zh-TW/skills/commands/audit.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/bdd.md +114 -16
- package/bundled/locales/zh-TW/skills/commands/changelog.md +45 -9
- package/bundled/locales/zh-TW/skills/commands/check.md +74 -21
- package/bundled/locales/zh-TW/skills/commands/checkin.md +56 -11
- package/bundled/locales/zh-TW/skills/commands/ci-cd.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/code-review.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/commit.md +58 -4
- package/bundled/locales/zh-TW/skills/commands/config.md +52 -4
- package/bundled/locales/zh-TW/skills/commands/coverage.md +45 -4
- package/bundled/locales/zh-TW/skills/commands/database.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/derive-all.md +44 -2
- package/bundled/locales/zh-TW/skills/commands/derive-atdd.md +37 -2
- package/bundled/locales/zh-TW/skills/commands/derive-bdd.md +44 -3
- package/bundled/locales/zh-TW/skills/commands/derive-tdd.md +45 -3
- package/bundled/locales/zh-TW/skills/commands/derive.md +62 -5
- package/bundled/locales/zh-TW/skills/commands/dev-workflow.md +60 -9
- package/bundled/locales/zh-TW/skills/commands/discover.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/docgen.md +39 -2
- package/bundled/locales/zh-TW/skills/commands/docs.md +139 -7
- package/bundled/locales/zh-TW/skills/commands/durable.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/e2e.md +86 -3
- package/bundled/locales/zh-TW/skills/commands/guide.md +4 -2
- package/bundled/locales/zh-TW/skills/commands/incident.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/init.md +72 -15
- package/bundled/locales/zh-TW/skills/commands/methodology.md +117 -28
- package/bundled/locales/zh-TW/skills/commands/metrics.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/migrate.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/observability.md +45 -2
- package/bundled/locales/zh-TW/skills/commands/pr.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/refactor.md +54 -13
- package/bundled/locales/zh-TW/skills/commands/release.md +83 -2
- package/bundled/locales/zh-TW/skills/commands/requirement.md +41 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-bdd.md +37 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-sdd.md +45 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-tdd.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/reverse.md +44 -2
- package/bundled/locales/zh-TW/skills/commands/runbook.md +47 -2
- package/bundled/locales/zh-TW/skills/commands/scan.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/sdd-retro.md +52 -3
- package/bundled/locales/zh-TW/skills/commands/sdd.md +209 -28
- package/bundled/locales/zh-TW/skills/commands/security.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/slo.md +48 -2
- package/bundled/locales/zh-TW/skills/commands/tdd.md +71 -2
- package/bundled/locales/zh-TW/skills/commands/update.md +64 -2
- package/bundled/locales/zh-TW/skills/commit-standards/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/commit-standards/conventional-commits.md +2 -1
- package/bundled/locales/zh-TW/skills/commit-standards/guide.md +137 -17
- package/bundled/locales/zh-TW/skills/commit-standards/language-options.md +21 -18
- package/bundled/locales/zh-TW/skills/contract-test-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/contract-test-assistant/guide.md +81 -1
- package/bundled/locales/zh-TW/skills/database-assistant/SKILL.md +21 -5
- package/bundled/locales/zh-TW/skills/deploy-assistant/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/SKILL.md +4 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/create-methodology.md +2 -0
- package/bundled/locales/zh-TW/skills/dev-methodology/runtime.md +2 -0
- package/bundled/locales/zh-TW/skills/docs-generator/SKILL.md +19 -2
- package/bundled/locales/zh-TW/skills/docs-generator/guide.md +4 -3
- package/bundled/locales/zh-TW/skills/documentation-guide/SKILL.md +67 -42
- package/bundled/locales/zh-TW/skills/documentation-guide/documentation-structure.md +2 -1
- package/bundled/locales/zh-TW/skills/documentation-guide/readme-template.md +2 -1
- package/bundled/locales/zh-TW/skills/durable-execution-assistant/SKILL.md +32 -3
- package/bundled/locales/zh-TW/skills/e2e-assistant/SKILL.md +25 -7
- package/bundled/locales/zh-TW/skills/error-code-guide/SKILL.md +17 -34
- package/bundled/locales/zh-TW/skills/git-workflow-guide/SKILL.md +33 -38
- package/bundled/locales/zh-TW/skills/git-workflow-guide/branch-naming.md +2 -1
- package/bundled/locales/zh-TW/skills/git-workflow-guide/git-workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/incident-response-assistant/SKILL.md +35 -14
- package/bundled/locales/zh-TW/skills/journey-test-assistant/SKILL.md +2 -14
- package/bundled/locales/zh-TW/skills/knowledge-graph/SKILL.md +6 -2
- package/bundled/locales/zh-TW/skills/metrics-dashboard-assistant/SKILL.md +42 -3
- package/bundled/locales/zh-TW/skills/observability-assistant/SKILL.md +85 -18
- package/bundled/locales/zh-TW/skills/pr-automation-assistant/SKILL.md +27 -3
- package/bundled/locales/zh-TW/skills/project-discovery/SKILL.md +11 -3
- package/bundled/locales/zh-TW/skills/project-discovery/guide.md +5 -3
- package/bundled/locales/zh-TW/skills/project-discovery/workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/project-structure-guide/SKILL.md +19 -16
- package/bundled/locales/zh-TW/skills/project-structure-guide/language-patterns.md +2 -1
- package/bundled/locales/zh-TW/skills/refactoring-assistant/SKILL.md +26 -3
- package/bundled/locales/zh-TW/skills/refactoring-assistant/guide.md +4 -2
- package/bundled/locales/zh-TW/skills/release-standards/SKILL.md +91 -45
- package/bundled/locales/zh-TW/skills/release-standards/changelog-format.md +4 -3
- package/bundled/locales/zh-TW/skills/release-standards/guide.md +14 -5
- package/bundled/locales/zh-TW/skills/release-standards/release-workflow.md +5 -1
- package/bundled/locales/zh-TW/skills/release-standards/semantic-versioning.md +2 -1
- package/bundled/locales/zh-TW/skills/requirement-assistant/SKILL.md +15 -6
- package/bundled/locales/zh-TW/skills/requirement-assistant/guide.md +18 -8
- package/bundled/locales/zh-TW/skills/requirement-assistant/requirement-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/requirement-assistant/requirement-writing.md +2 -1
- package/bundled/locales/zh-TW/skills/retrospective-assistant/guide.md +200 -6
- package/bundled/locales/zh-TW/skills/reverse-engineer/bdd-extraction.md +2 -1
- package/bundled/locales/zh-TW/skills/reverse-engineer/guide.md +161 -36
- package/bundled/locales/zh-TW/skills/reverse-engineer/tdd-analysis.md +2 -1
- package/bundled/locales/zh-TW/skills/reverse-engineer/workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/runbook-assistant/SKILL.md +9 -1
- package/bundled/locales/zh-TW/skills/security-assistant/SKILL.md +25 -5
- package/bundled/locales/zh-TW/skills/security-scan-assistant/SKILL.md +34 -8
- package/bundled/locales/zh-TW/skills/skill-builder/SKILL.md +3 -21
- package/bundled/locales/zh-TW/skills/slo-assistant/SKILL.md +3 -1
- package/bundled/locales/zh-TW/skills/spec-derivation/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/spec-driven-dev/guide.md +35 -2
- package/bundled/locales/zh-TW/skills/sweep/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/tdd-assistant/SKILL.md +10 -2
- package/bundled/locales/zh-TW/skills/tdd-assistant/guide.md +68 -9
- package/bundled/locales/zh-TW/skills/tdd-assistant/language-examples.md +693 -47
- package/bundled/locales/zh-TW/skills/tdd-assistant/tdd-workflow.md +183 -1
- package/bundled/locales/zh-TW/skills/test-coverage-assistant/SKILL.md +15 -5
- package/bundled/locales/zh-TW/skills/test-coverage-assistant/guide.md +26 -13
- package/bundled/locales/zh-TW/skills/testing-guide/testing-pyramid.md +2 -1
- package/bundled/locales/zh-TW/skills/testing-guide/testing-theory.md +3 -1
- package/bundled/locales/zh-TW/skills/tools/cline/README.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/copilot/README.md +65 -18
- package/bundled/locales/zh-TW/skills/tools/copilot/copilot-instructions.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/cursor/README.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/windsurf/README.md +2 -1
- package/bundled/locales/zh-TW/skills/workflows/README.md +11 -9
- package/bundled/locales/zh-TW/templates/reverse-spec-template.md +50 -1
- package/bundled/skills/.claude-plugin/plugin.json +71 -0
- package/bundled/skills/commit-standards/SKILL.md +2 -2
- package/bundled/skills/commit-standards/guide.md +3 -2
- package/bundled/skills/commit-standards/language-options.md +19 -17
- package/package.json +2 -2
- package/src/commands/audit.js +28 -1
- package/src/commands/check.js +72 -3
- package/src/commands/compile.js +37 -4
- package/src/commands/config.js +49 -24
- package/src/commands/init.js +78 -30
- package/src/commands/open-work.js +6 -2
- package/src/commands/release-messages.js +228 -0
- package/src/commands/release.js +127 -68
- package/src/commands/run-intent.js +11 -0
- package/src/commands/spec.js +4 -2
- package/src/commands/update.js +227 -47
- package/src/compilers/claude-code-compiler.js +9 -1
- package/src/config/ai-agent-paths.js +14 -1
- package/src/core/installed-formats.js +15 -0
- package/src/core/open-work-config.js +20 -1
- package/src/core/project-config.js +55 -0
- package/src/i18n/messages.js +106 -2
- package/src/installers/hooks-installer.js +1 -1
- package/src/installers/manifest-installer.js +1 -1
- package/src/installers/skills-installer.js +1 -1
- package/src/installers/standards-installer.js +3 -1
- package/src/mcp/server.js +9 -3
- package/src/prompts/init.js +26 -22
- package/src/reconciler/actual-state-scanner.js +2 -8
- package/src/reconciler/backup-locations.js +5 -0
- package/src/reconciler/backup-manager.js +19 -11
- package/src/reconciler/desired-state-calculator.js +89 -57
- package/src/reconciler/plan-executor.js +101 -8
- package/src/reconciler/recorded-versions.js +49 -0
- package/src/reconciler/relative-path.js +23 -0
- package/src/uninstallers/hook-uninstaller.js +9 -1
- package/src/uninstallers/skills-uninstaller.js +22 -3
- package/src/utils/available-standards-report.js +25 -4
- package/src/utils/available-standards.js +13 -3
- package/src/utils/build-manifest.js +1 -1
- package/src/utils/commit-message-judge.js +60 -13
- package/src/utils/friction-detector.js +23 -11
- package/src/utils/git-hooks.js +106 -4
- package/src/utils/integration-generator.js +95 -67
- package/src/utils/legacy-hook-migration.js +121 -2
- package/src/utils/open-work-tracking.mjs +105 -16
- package/src/utils/sdd-header.js +16 -4
- package/src/utils/skills-installer.js +2 -1
- package/src/utils/spinner.js +14 -4
- package/src/utils/standard-validator.js +3 -2
- package/standards-registry.json +10 -8
- package/bundled/locales/zh-TW/core/guides/testing-guide.md +0 -2280
|
@@ -2,173 +2,235 @@
|
|
|
2
2
|
source: ../../../core/project-structure.md
|
|
3
3
|
source_version: 1.2.0
|
|
4
4
|
translation_version: 1.2.0
|
|
5
|
-
last_synced: 2026-
|
|
5
|
+
last_synced: 2026-10-16
|
|
6
|
+
source_hash: d7c93796b9e4
|
|
6
7
|
status: current
|
|
7
8
|
---
|
|
8
9
|
|
|
9
|
-
> **语言**: [English](../../../core/project-structure.md) | [简体中文](../../zh-TW/core/project-structure.md) | 简体中文
|
|
10
|
-
|
|
11
10
|
# 项目结构标准
|
|
12
11
|
|
|
13
12
|
**版本**: 1.2.0
|
|
14
13
|
**最后更新**: 2026-03-04
|
|
15
14
|
**适用范围**: 所有软件项目
|
|
15
|
+
**范围**: 部分
|
|
16
|
+
**行业标准**: Maven Standard Directory Layout
|
|
17
|
+
**参考资料**: [github.com](https://github.com/golang-standards/project-layout)
|
|
18
|
+
|
|
19
|
+
**English** | [繁體中文](../../zh-TW/core/project-structure.md)
|
|
16
20
|
|
|
17
21
|
---
|
|
18
22
|
|
|
19
23
|
## 目的
|
|
20
24
|
|
|
21
|
-
|
|
25
|
+
本标准定义了除文档文件之外的项目目录结构规范。它涵盖了工具、构建输出的通用目录以及特定语言的规范。
|
|
22
26
|
|
|
23
27
|
---
|
|
24
28
|
|
|
25
|
-
##
|
|
29
|
+
## 通用项目目录
|
|
26
30
|
|
|
27
|
-
###
|
|
31
|
+
### 推荐目录结构
|
|
28
32
|
|
|
29
33
|
```
|
|
30
34
|
project-root/
|
|
31
|
-
├──
|
|
32
|
-
├──
|
|
33
|
-
├──
|
|
34
|
-
├──
|
|
35
|
-
│
|
|
36
|
-
|
|
37
|
-
│ └──
|
|
38
|
-
|
|
39
|
-
├──
|
|
40
|
-
|
|
41
|
-
|
|
35
|
+
├── README.md # Project overview
|
|
36
|
+
├── CONTRIBUTING.md # Contribution guidelines
|
|
37
|
+
├── CHANGELOG.md # Version history
|
|
38
|
+
├── LICENSE # License file
|
|
39
|
+
│
|
|
40
|
+
├── .standards/ or .claude/ # Development standards
|
|
41
|
+
│ └── ...
|
|
42
|
+
│
|
|
43
|
+
├── docs/ # Documentation
|
|
44
|
+
│ └── ...
|
|
45
|
+
│
|
|
46
|
+
├── src/ # Source code (language-dependent)
|
|
47
|
+
│ └── ...
|
|
48
|
+
│
|
|
49
|
+
├── tests/ # Test files (if separate from src)
|
|
50
|
+
│ └── ...
|
|
51
|
+
│
|
|
52
|
+
├── tools/ # Development/deployment scripts
|
|
53
|
+
│ ├── deployment/ # Deployment scripts
|
|
54
|
+
│ ├── migration/ # Database migration tools
|
|
55
|
+
│ └── scripts/ # Utility scripts
|
|
56
|
+
│
|
|
57
|
+
├── examples/ # Usage examples
|
|
58
|
+
│ └── ...
|
|
59
|
+
│
|
|
60
|
+
├── dist/ # Build output (gitignored)
|
|
61
|
+
├── build/ # Compiled artifacts (gitignored)
|
|
62
|
+
└── publish/ # Release packages (partially gitignored)
|
|
42
63
|
```
|
|
43
64
|
|
|
44
65
|
---
|
|
45
66
|
|
|
46
|
-
##
|
|
67
|
+
## 目录定义
|
|
68
|
+
|
|
69
|
+
### 源代码与构建目录
|
|
70
|
+
|
|
71
|
+
| 目录 | 用途 | gitignore? | 备注 |
|
|
72
|
+
|-----------|---------|------------|-------|
|
|
73
|
+
| `src/` | 源代码 | 否 | 视语言而定;参见下文规范 |
|
|
74
|
+
| `lib/` | 库/依赖代码 | 视情况而定 | Vendored 依赖可能会被提交 |
|
|
75
|
+
| `dist/` | 分发/构建输出 | **是** | 生成的文件,切勿提交 |
|
|
76
|
+
| `build/` | 编译产物 | **是** | 中间构建文件 |
|
|
77
|
+
| `out/` | 输出目录 | **是** | dist/build 的替代方案 |
|
|
78
|
+
| `bin/` | 二进制可执行文件 | **是** | 编译后的二进制文件 |
|
|
79
|
+
| `obj/` | 目标文件 | **是** | .NET 中间文件 |
|
|
80
|
+
|
|
81
|
+
### 工具与脚本目录
|
|
82
|
+
|
|
83
|
+
| 目录 | 用途 | gitignore? | 备注 |
|
|
84
|
+
|-----------|---------|------------|-------|
|
|
85
|
+
| `tools/` | 开发/部署工具 | 否 | Shell 脚本、Python 工具等 |
|
|
86
|
+
| `scripts/` | 构建/CI 脚本 | 否 | 通常位于根目录下或 tools/ 下 |
|
|
87
|
+
| `.github/` | GitHub 特定配置 | 否 | Actions、模板、工作流 |
|
|
88
|
+
| `.gitlab/` | GitLab 特定配置 | 否 | CI 模板 |
|
|
89
|
+
|
|
90
|
+
### 数据与配置目录
|
|
91
|
+
|
|
92
|
+
| 目录 | 用途 | gitignore? | 备注 |
|
|
93
|
+
|-----------|---------|------------|-------|
|
|
94
|
+
| `data/` | 测试/种子数据 | 视情况而定 | 大文件应当被 gitignore |
|
|
95
|
+
| `config/` | 配置文件 | 视情况而定 | 机密信息必须被 gitignore |
|
|
96
|
+
| `assets/` | 静态资源 | 否 | 图像、模板等 |
|
|
97
|
+
| `resources/` | 资源文件 | 否 | assets/ 的替代方案 |
|
|
98
|
+
|
|
99
|
+
### 发布与发布包目录
|
|
47
100
|
|
|
48
|
-
| 目录 | 用途 |
|
|
49
|
-
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
| bin/ | 二进制文件 |
|
|
101
|
+
| 目录 | 用途 | gitignore? | 备注 |
|
|
102
|
+
|-----------|---------|------------|-------|
|
|
103
|
+
| `publish/` | 发布包 | 部分 | 可保留发布说明,gitignore 二进制文件 |
|
|
104
|
+
| `release/` | 发布产物 | **是** | 生成的发布文件 |
|
|
105
|
+
| `packages/` | Monorepo 包 | 否 | 用于 monorepo 项目 |
|
|
54
106
|
|
|
55
107
|
---
|
|
56
108
|
|
|
57
|
-
##
|
|
109
|
+
## 语言特定规范
|
|
58
110
|
|
|
59
|
-
###
|
|
111
|
+
### .NET / C#
|
|
60
112
|
|
|
61
113
|
```
|
|
62
|
-
project/
|
|
63
|
-
├──
|
|
64
|
-
|
|
65
|
-
│ ├──
|
|
66
|
-
│ ├──
|
|
67
|
-
│ ├──
|
|
68
|
-
│ └──
|
|
69
|
-
├──
|
|
114
|
+
project-root/
|
|
115
|
+
├── ProjectName.sln # Solution file at root
|
|
116
|
+
├── ProjectName/ # Main project
|
|
117
|
+
│ ├── ProjectName.csproj
|
|
118
|
+
│ ├── Program.cs
|
|
119
|
+
│ ├── Controllers/
|
|
120
|
+
│ └── ...
|
|
121
|
+
├── ProjectName.Domain/ # Domain layer (Clean Architecture)
|
|
122
|
+
├── ProjectName.Application/ # Application layer
|
|
123
|
+
├── ProjectName.Infrastructure/ # Infrastructure layer
|
|
124
|
+
├── ProjectName.Tests/ # Test project
|
|
125
|
+
└── docs/
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**规范**: 项目是根目录的子目录,不在 `src/` 下。解决方案文件(`.sln`)保留在根目录下。
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
### Node.js / TypeScript
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
project-root/
|
|
70
136
|
├── package.json
|
|
71
|
-
|
|
137
|
+
├── tsconfig.json # If TypeScript
|
|
138
|
+
├── src/ # Source code
|
|
139
|
+
│ ├── index.ts
|
|
140
|
+
│ ├── controllers/
|
|
141
|
+
│ └── services/
|
|
142
|
+
├── dist/ # Compiled output (gitignored)
|
|
143
|
+
├── tests/ or __tests__/ # Test files
|
|
144
|
+
├── node_modules/ # Dependencies (gitignored)
|
|
145
|
+
└── docs/
|
|
72
146
|
```
|
|
73
147
|
|
|
148
|
+
**规范**: 源代码放在 `src/` 中,编译输出放在 `dist/` 中。测试可以放在 `tests/`、`__tests__/`,或与源代码同目录放置。
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
74
152
|
### Python
|
|
75
153
|
|
|
76
154
|
```
|
|
77
|
-
project/
|
|
78
|
-
├──
|
|
155
|
+
project-root/
|
|
156
|
+
├── pyproject.toml or setup.py
|
|
157
|
+
├── src/ # src-layout (recommended)
|
|
79
158
|
│ └── package_name/
|
|
80
159
|
│ ├── __init__.py
|
|
81
|
-
│ └──
|
|
160
|
+
│ └── module.py
|
|
82
161
|
├── tests/
|
|
83
|
-
|
|
84
|
-
|
|
162
|
+
│ └── test_module.py
|
|
163
|
+
├── docs/
|
|
164
|
+
├── .venv/ # Virtual environment (gitignored)
|
|
165
|
+
└── dist/ # Built packages (gitignored)
|
|
85
166
|
```
|
|
86
167
|
|
|
87
|
-
|
|
168
|
+
**规范**: 库建议使用 src 布局(`src/package_name/`)。对于应用程序,扁平布局(根目录下的 `package_name/`)是可接受的。
|
|
88
169
|
|
|
89
|
-
|
|
90
|
-
project/
|
|
91
|
-
├── cmd/
|
|
92
|
-
│ └── appname/
|
|
93
|
-
│ └── main.go
|
|
94
|
-
├── internal/
|
|
95
|
-
├── pkg/
|
|
96
|
-
├── go.mod
|
|
97
|
-
└── .gitignore
|
|
98
|
-
```
|
|
170
|
+
---
|
|
99
171
|
|
|
100
|
-
### Java/
|
|
172
|
+
### Java / Maven
|
|
101
173
|
|
|
102
174
|
```
|
|
103
|
-
project/
|
|
175
|
+
project-root/
|
|
176
|
+
├── pom.xml
|
|
104
177
|
├── src/
|
|
105
178
|
│ ├── main/
|
|
106
|
-
│ │
|
|
179
|
+
│ │ ├── java/
|
|
180
|
+
│ │ │ └── com/example/
|
|
181
|
+
│ │ └── resources/
|
|
107
182
|
│ └── test/
|
|
108
|
-
│
|
|
109
|
-
|
|
110
|
-
|
|
183
|
+
│ ├── java/
|
|
184
|
+
│ └── resources/
|
|
185
|
+
├── target/ # Build output (gitignored)
|
|
186
|
+
└── docs/
|
|
111
187
|
```
|
|
112
188
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
## Gitignore 模式
|
|
116
|
-
|
|
117
|
-
### 通用模式
|
|
189
|
+
**规范**: Maven 标准目录布局。切勿偏离。
|
|
118
190
|
|
|
119
|
-
|
|
120
|
-
# 构建输出
|
|
121
|
-
dist/
|
|
122
|
-
build/
|
|
123
|
-
out/
|
|
124
|
-
bin/
|
|
125
|
-
|
|
126
|
-
# 环境文件
|
|
127
|
-
.env
|
|
128
|
-
.env.*
|
|
191
|
+
---
|
|
129
192
|
|
|
130
|
-
|
|
131
|
-
.idea/
|
|
132
|
-
.vscode/
|
|
133
|
-
*.swp
|
|
193
|
+
### Go
|
|
134
194
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
195
|
+
```
|
|
196
|
+
project-root/
|
|
197
|
+
├── go.mod
|
|
198
|
+
├── go.sum
|
|
199
|
+
├── main.go # Or cmd/app/main.go for multiple binaries
|
|
200
|
+
├── cmd/ # Application entry points
|
|
201
|
+
│ └── myapp/
|
|
202
|
+
│ └── main.go
|
|
203
|
+
├── pkg/ # Public library code
|
|
204
|
+
│ └── mylib/
|
|
205
|
+
├── internal/ # Private application code
|
|
206
|
+
│ └── ...
|
|
207
|
+
├── api/ # API definitions (protobuf, OpenAPI)
|
|
208
|
+
└── docs/
|
|
138
209
|
```
|
|
139
210
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
| 语言 | 模式 |
|
|
143
|
-
|------|------|
|
|
144
|
-
| Node.js | node_modules/, *.log |
|
|
145
|
-
| Python | __pycache__/, *.pyc, .venv/ |
|
|
146
|
-
| Go | vendor/ |
|
|
147
|
-
| Java | *.class, target/ |
|
|
148
|
-
| .NET | bin/, obj/ |
|
|
211
|
+
**规范**: 二进制文件使用 `cmd/`,私有代码使用 `internal/`,公开库使用 `pkg/`。
|
|
149
212
|
|
|
150
213
|
---
|
|
151
214
|
|
|
152
|
-
##
|
|
153
|
-
|
|
154
|
-
### 标准目录
|
|
215
|
+
## Monorepo 结构
|
|
155
216
|
|
|
156
|
-
|
|
157
|
-
|------|------|-----------|
|
|
158
|
-
| src/ | 源代码 | 否 |
|
|
159
|
-
| tests/ | 测试文件 | 否 |
|
|
160
|
-
| docs/ | 文档 | 否 |
|
|
161
|
-
| dist/ | 构建输出 | 是 |
|
|
162
|
-
| build/ | 编译产物 | 是 |
|
|
163
|
-
| node_modules/ | 依赖 | 是 |
|
|
217
|
+
适用于包含多个包/应用程序的项目:
|
|
164
218
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
-
|
|
170
|
-
-
|
|
171
|
-
-
|
|
219
|
+
```
|
|
220
|
+
project-root/
|
|
221
|
+
├── package.json # Root package.json (if using npm/yarn workspaces)
|
|
222
|
+
├── packages/ # Shared packages
|
|
223
|
+
│ ├── shared-utils/
|
|
224
|
+
│ ├── ui-components/
|
|
225
|
+
│ └── api-client/
|
|
226
|
+
├── apps/ # Applications
|
|
227
|
+
│ ├── web/
|
|
228
|
+
│ ├── mobile/
|
|
229
|
+
│ └── api-server/
|
|
230
|
+
├── tools/ # Shared build tools
|
|
231
|
+
├── docs/ # Shared documentation
|
|
232
|
+
└── README.md
|
|
233
|
+
```
|
|
172
234
|
|
|
173
235
|
---
|
|
174
236
|
|
|
@@ -176,28 +238,59 @@ Thumbs.db
|
|
|
176
238
|
|
|
177
239
|
### 决策矩阵
|
|
178
240
|
|
|
241
|
+
使用此矩阵确定哪种方式适合您的项目:
|
|
242
|
+
|
|
179
243
|
| 因素 | Monorepo 适合 | Polyrepo 适合 |
|
|
180
|
-
|
|
181
|
-
| **代码共享** |
|
|
244
|
+
|------|---------------|---------------|
|
|
245
|
+
| **代码共享** | 高(共享库、组件) | 低(独立服务) |
|
|
182
246
|
| **团队结构** | 单一团队或紧密协作 | 自治团队 |
|
|
183
247
|
| **发布节奏** | 协调发布 | 独立发布 |
|
|
184
|
-
| **CI/CD 复杂度** |
|
|
248
|
+
| **CI/CD 复杂度** | 可接受统一管线 | 需要隔离管线 |
|
|
185
249
|
| **仓库大小** | < 5GB,< 100万文件 | 大型资产、长历史 |
|
|
250
|
+
| **依赖管理** | 集中式版本控制 | 允许团队特定版本 |
|
|
251
|
+
| **工具投入** | 愿意投入工具 | 偏好简单 git 工作流 |
|
|
186
252
|
|
|
187
|
-
###
|
|
188
|
-
|
|
189
|
-
**选择 Monorepo 当**:
|
|
190
|
-
- 多个项目共享大量代码或依赖
|
|
191
|
-
- 团队愿意投资于工具
|
|
253
|
+
### 决策流程图
|
|
192
254
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
255
|
+
```
|
|
256
|
+
┌─────────────────────────────────────────┐
|
|
257
|
+
│ Do multiple projects share significant │
|
|
258
|
+
│ code or dependencies? │
|
|
259
|
+
└───────────────┬─────────────────────────┘
|
|
260
|
+
│
|
|
261
|
+
┌───────┴───────┐
|
|
262
|
+
▼ ▼
|
|
263
|
+
YES NO
|
|
264
|
+
│ │
|
|
265
|
+
▼ ▼
|
|
266
|
+
┌───────────────┐ ┌─────────────────────┐
|
|
267
|
+
│ Consider │ │ Do teams need │
|
|
268
|
+
│ MONOREPO │ │ release independence│
|
|
269
|
+
└───────┬───────┘ └──────────┬──────────┘
|
|
270
|
+
│ │
|
|
271
|
+
▼ ┌───────┴───────┐
|
|
272
|
+
┌───────────────┐ ▼ ▼
|
|
273
|
+
│ Can you invest│ YES NO
|
|
274
|
+
│ in tooling? │ │ │
|
|
275
|
+
└───────┬───────┘ ▼ ▼
|
|
276
|
+
│ ┌──────────┐ ┌──────────┐
|
|
277
|
+
┌───────┴───────┐│ POLYREPO │ │ MONOREPO │
|
|
278
|
+
▼ ▼└──────────┘ │ may work │
|
|
279
|
+
YES NO └──────────┘
|
|
280
|
+
│ │
|
|
281
|
+
▼ ▼
|
|
282
|
+
┌──────────┐ ┌──────────┐
|
|
283
|
+
│ MONOREPO │ │ POLYREPO │
|
|
284
|
+
│ (full) │ │ (simpler)│
|
|
285
|
+
└──────────┘ └──────────┘
|
|
286
|
+
```
|
|
196
287
|
|
|
197
288
|
---
|
|
198
289
|
|
|
199
290
|
## Monorepo 工具比较
|
|
200
291
|
|
|
292
|
+
### 工具选择矩阵
|
|
293
|
+
|
|
201
294
|
| 功能 | Turborepo | Nx | Lerna | Rush |
|
|
202
295
|
|------|-----------|----|----|------|
|
|
203
296
|
| **主要用途** | 任务执行 | 完整框架 | 发布 | 企业级 |
|
|
@@ -205,7 +298,85 @@ Thumbs.db
|
|
|
205
298
|
| **构建速度** | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐ |
|
|
206
299
|
| **远程缓存** | ✅ 内置 | ✅ Nx Cloud | ❌ 手动 | ✅ 内置 |
|
|
207
300
|
| **代码生成** | ❌ | ✅ 丰富 | ❌ | ❌ |
|
|
208
|
-
|
|
|
301
|
+
| **受影响检测** | ✅ | ✅ | ✅ | ✅ |
|
|
302
|
+
| **框架支持** | 框架无关 | React、Angular 等 | 任意 | 任意 |
|
|
303
|
+
| **维护方** | Vercel | Nrwl | Lerna-Lite fork | Microsoft |
|
|
304
|
+
| **最适合** | 中小型团队 | 大型团队、企业 | 简单发布 | 企业规模 |
|
|
305
|
+
|
|
306
|
+
### 快速选择指南
|
|
307
|
+
|
|
308
|
+
**选择 Turborepo 当**:
|
|
309
|
+
- 您希望最小化配置
|
|
310
|
+
- 主要需求是带缓存的快速构建
|
|
311
|
+
- 团队规模较小到中等(< 50 名开发者)
|
|
312
|
+
- 您更偏好约定优于配置
|
|
313
|
+
|
|
314
|
+
**选择 Nx 当**:
|
|
315
|
+
- 您需要代码生成和脚手架
|
|
316
|
+
- 您希望拥有内置的框架集成
|
|
317
|
+
- 团队规模较大或达到企业级
|
|
318
|
+
- 您需要高级依赖图可视化
|
|
319
|
+
|
|
320
|
+
**选择 Lerna 当**:
|
|
321
|
+
- 主要需求是 npm 包发布
|
|
322
|
+
- 您希望使用简单、熟悉的工具
|
|
323
|
+
- 您正在从独立包进行迁移
|
|
324
|
+
|
|
325
|
+
**选择 Rush 当**:
|
|
326
|
+
- 您处于企业级环境中
|
|
327
|
+
- 您需要严格的依赖隔离
|
|
328
|
+
- 您拥有复杂的审批工作流
|
|
329
|
+
- 您在大规模使用 pnpm
|
|
330
|
+
|
|
331
|
+
### Turborepo 示例
|
|
332
|
+
|
|
333
|
+
```json
|
|
334
|
+
// turbo.json
|
|
335
|
+
{
|
|
336
|
+
"$schema": "https://turbo.build/schema.json",
|
|
337
|
+
"globalDependencies": [".env"],
|
|
338
|
+
"tasks": {
|
|
339
|
+
"build": {
|
|
340
|
+
"dependsOn": ["^build"],
|
|
341
|
+
"outputs": ["dist/**", ".next/**"]
|
|
342
|
+
},
|
|
343
|
+
"test": {
|
|
344
|
+
"dependsOn": ["build"],
|
|
345
|
+
"inputs": ["src/**", "test/**"]
|
|
346
|
+
},
|
|
347
|
+
"lint": {
|
|
348
|
+
"dependsOn": ["^lint"]
|
|
349
|
+
},
|
|
350
|
+
"dev": {
|
|
351
|
+
"cache": false,
|
|
352
|
+
"persistent": true
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Nx 示例
|
|
359
|
+
|
|
360
|
+
```json
|
|
361
|
+
// nx.json
|
|
362
|
+
{
|
|
363
|
+
"$schema": "./node_modules/nx/schemas/nx-schema.json",
|
|
364
|
+
"targetDefaults": {
|
|
365
|
+
"build": {
|
|
366
|
+
"dependsOn": ["^build"],
|
|
367
|
+
"cache": true
|
|
368
|
+
},
|
|
369
|
+
"test": {
|
|
370
|
+
"cache": true
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"namedInputs": {
|
|
374
|
+
"default": ["{projectRoot}/**/*"],
|
|
375
|
+
"production": ["default", "!{projectRoot}/**/*.spec.ts"]
|
|
376
|
+
},
|
|
377
|
+
"defaultBase": "main"
|
|
378
|
+
}
|
|
379
|
+
```
|
|
209
380
|
|
|
210
381
|
---
|
|
211
382
|
|
|
@@ -221,11 +392,56 @@ packages:
|
|
|
221
392
|
- 'tools/*'
|
|
222
393
|
```
|
|
223
394
|
|
|
395
|
+
```json
|
|
396
|
+
// package.json (root)
|
|
397
|
+
{
|
|
398
|
+
"name": "my-monorepo",
|
|
399
|
+
"private": true,
|
|
400
|
+
"scripts": {
|
|
401
|
+
"build": "turbo run build",
|
|
402
|
+
"dev": "turbo run dev",
|
|
403
|
+
"test": "turbo run test",
|
|
404
|
+
"lint": "turbo run lint"
|
|
405
|
+
},
|
|
406
|
+
"devDependencies": {
|
|
407
|
+
"turbo": "^2.0.0"
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
```
|
|
411
|
+
|
|
224
412
|
### Yarn Workspaces
|
|
225
413
|
|
|
226
414
|
```json
|
|
415
|
+
// package.json (root)
|
|
227
416
|
{
|
|
228
|
-
"
|
|
417
|
+
"name": "my-monorepo",
|
|
418
|
+
"private": true,
|
|
419
|
+
"workspaces": [
|
|
420
|
+
"apps/*",
|
|
421
|
+
"packages/*"
|
|
422
|
+
],
|
|
423
|
+
"scripts": {
|
|
424
|
+
"build": "yarn workspaces foreach -pt run build",
|
|
425
|
+
"test": "yarn workspaces foreach run test"
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### npm Workspaces
|
|
431
|
+
|
|
432
|
+
```json
|
|
433
|
+
// package.json (root)
|
|
434
|
+
{
|
|
435
|
+
"name": "my-monorepo",
|
|
436
|
+
"private": true,
|
|
437
|
+
"workspaces": [
|
|
438
|
+
"apps/*",
|
|
439
|
+
"packages/*"
|
|
440
|
+
],
|
|
441
|
+
"scripts": {
|
|
442
|
+
"build": "npm run build --workspaces",
|
|
443
|
+
"test": "npm run test --workspaces --if-present"
|
|
444
|
+
}
|
|
229
445
|
}
|
|
230
446
|
```
|
|
231
447
|
|
|
@@ -235,28 +451,141 @@ packages:
|
|
|
235
451
|
|
|
236
452
|
### 概念
|
|
237
453
|
|
|
238
|
-
|
|
454
|
+
基于包的架构按**功能边界**而非技术层次组织代码。每个包都是具有清晰接口的自包含单元。
|
|
239
455
|
|
|
240
456
|
```
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
src/
|
|
244
|
-
├── controllers/
|
|
245
|
-
├──
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
457
|
+
Traditional (Layer-based) Package-based (Feature-based)
|
|
458
|
+
───────────────────────── ────────────────────────────
|
|
459
|
+
src/ packages/
|
|
460
|
+
├── controllers/ ├── authentication/
|
|
461
|
+
│ ├── userController.js │ ├── api/
|
|
462
|
+
│ └── orderController.js │ ├── domain/
|
|
463
|
+
├── services/ │ ├── infrastructure/
|
|
464
|
+
│ ├── userService.js │ └── index.ts
|
|
465
|
+
│ └── orderService.js ├── orders/
|
|
466
|
+
├── models/ │ ├── api/
|
|
467
|
+
│ ├── user.js │ ├── domain/
|
|
468
|
+
│ └── order.js │ ├── infrastructure/
|
|
469
|
+
└── repositories/ │ └── index.ts
|
|
470
|
+
├── userRepository.js └── shared/
|
|
471
|
+
└── orderRepository.js ├── database/
|
|
472
|
+
└── utils/
|
|
250
473
|
```
|
|
251
474
|
|
|
252
475
|
### 好处
|
|
253
476
|
|
|
254
477
|
| 好处 | 说明 |
|
|
255
|
-
|
|
478
|
+
|---------|-------------|
|
|
256
479
|
| **清晰边界** | 每个包有明确的公开 API |
|
|
257
480
|
| **独立测试** | 可隔离测试包 |
|
|
258
481
|
| **并行开发** | 团队可在不同包上工作 |
|
|
259
482
|
| **选择性部署** | 只部署变更的包 |
|
|
483
|
+
| **代码所有权** | 每个包具有明确的所有权 |
|
|
484
|
+
|
|
485
|
+
### 包结构模板
|
|
486
|
+
|
|
487
|
+
```
|
|
488
|
+
packages/feature-name/
|
|
489
|
+
├── package.json # Package metadata
|
|
490
|
+
├── tsconfig.json # TypeScript config (if applicable)
|
|
491
|
+
├── src/
|
|
492
|
+
│ ├── index.ts # Public API exports
|
|
493
|
+
│ ├── api/ # External interfaces (REST, GraphQL, etc.)
|
|
494
|
+
│ ├── domain/ # Business logic
|
|
495
|
+
│ │ ├── entities/
|
|
496
|
+
│ │ ├── services/
|
|
497
|
+
│ │ └── events/
|
|
498
|
+
│ └── infrastructure/ # External integrations
|
|
499
|
+
│ ├── database/
|
|
500
|
+
│ └── external-services/
|
|
501
|
+
├── tests/
|
|
502
|
+
│ ├── unit/
|
|
503
|
+
│ └── integration/
|
|
504
|
+
└── README.md # Package documentation
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### 公开 API 设计
|
|
508
|
+
|
|
509
|
+
```typescript
|
|
510
|
+
// packages/authentication/src/index.ts
|
|
511
|
+
// Only export what other packages need
|
|
512
|
+
|
|
513
|
+
// Domain types
|
|
514
|
+
export type { User, AuthToken, AuthResult } from './domain/types';
|
|
515
|
+
|
|
516
|
+
// Service interfaces
|
|
517
|
+
export { AuthService } from './domain/services/auth-service';
|
|
518
|
+
|
|
519
|
+
// API handlers (if needed by other packages)
|
|
520
|
+
export { createAuthRouter } from './api/routes';
|
|
521
|
+
|
|
522
|
+
// Do NOT export internal implementation details
|
|
523
|
+
// ❌ export { hashPassword } from './infrastructure/crypto';
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
### 包间依赖
|
|
527
|
+
|
|
528
|
+
```json
|
|
529
|
+
// packages/orders/package.json
|
|
530
|
+
{
|
|
531
|
+
"name": "@myorg/orders",
|
|
532
|
+
"version": "1.0.0",
|
|
533
|
+
"dependencies": {
|
|
534
|
+
"@myorg/authentication": "workspace:*",
|
|
535
|
+
"@myorg/shared": "workspace:*"
|
|
536
|
+
}
|
|
537
|
+
}
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
---
|
|
541
|
+
|
|
542
|
+
## IDE 与编辑器产物
|
|
543
|
+
|
|
544
|
+
### 应加入 Gitignore 的常见产物
|
|
545
|
+
|
|
546
|
+
```gitignore
|
|
547
|
+
# IDE - JetBrains (IntelliJ, Rider, WebStorm)
|
|
548
|
+
.idea/
|
|
549
|
+
*.iml
|
|
550
|
+
|
|
551
|
+
# IDE - Visual Studio
|
|
552
|
+
.vs/
|
|
553
|
+
*.user
|
|
554
|
+
*.suo
|
|
555
|
+
|
|
556
|
+
# IDE - VS Code (optional, some teams commit .vscode/)
|
|
557
|
+
.vscode/
|
|
558
|
+
!.vscode/settings.json # May commit shared settings
|
|
559
|
+
!.vscode/extensions.json # May commit recommended extensions
|
|
560
|
+
|
|
561
|
+
# IDE - Eclipse
|
|
562
|
+
.project
|
|
563
|
+
.classpath
|
|
564
|
+
.settings/
|
|
565
|
+
|
|
566
|
+
# macOS
|
|
567
|
+
.DS_Store
|
|
568
|
+
|
|
569
|
+
# Windows
|
|
570
|
+
Thumbs.db
|
|
571
|
+
desktop.ini
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
### 检测未提交的产物
|
|
575
|
+
|
|
576
|
+
在提交之前,确认未跟踪任何 IDE 产物:
|
|
577
|
+
|
|
578
|
+
```bash
|
|
579
|
+
# Check for common IDE artifacts in git
|
|
580
|
+
git ls-files | grep -E '^\$|^\.idea|^\.vs/|\.user$|\.suo$'
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
**已知问题**:VSCode 变量展开错误可能会创建类似 `${workspaceFolder}/` 的目录。如果发现,请将其删除:
|
|
584
|
+
|
|
585
|
+
```bash
|
|
586
|
+
# Remove if exists and not tracked
|
|
587
|
+
rm -rf '${workspaceFolder}'
|
|
588
|
+
```
|
|
260
589
|
|
|
261
590
|
---
|
|
262
591
|
|
|
@@ -264,47 +593,47 @@ src/ packages/
|
|
|
264
593
|
|
|
265
594
|
### 目录用途指南
|
|
266
595
|
|
|
267
|
-
|
|
596
|
+
组织源代码时,这些目录具有不同的用途:
|
|
268
597
|
|
|
269
|
-
| 目录 | 用途 | 何时使用 | 无状态? |
|
|
598
|
+
| 目录 | 用途 | 何时使用 | 无状态? | 可复用范围 |
|
|
270
599
|
|------|------|---------|----------|-----------|
|
|
271
|
-
| `utils/` | 纯工具函数 |
|
|
272
|
-
| `helpers/` |
|
|
273
|
-
| `shared/` |
|
|
274
|
-
| `common/` | shared/ 的别名 | 较不推荐;建议使用 `shared/` | 不一定 | 跨模块 |
|
|
275
|
-
| `lib/` |
|
|
276
|
-
| `internal/` |
|
|
600
|
+
| `utils/` | 纯工具函数 | 无状态、无业务逻辑、跨模块可复用 | 是 | 全局 |
|
|
601
|
+
| `helpers/` | 上下文特定辅助 | 绑定到特定层级(测试、视图、控制器) | 不一定 | 层级特定 |
|
|
602
|
+
| `shared/` | 跨模块共享代码 | 供 2 个以上模块使用,可能有包边界 | 不一定 | 跨模块 |
|
|
603
|
+
| `common/` | shared/ 的别名 | 较不推荐;建议使用 `shared/` 代替 | 不一定 | 跨模块 |
|
|
604
|
+
| `lib/` | 封装/vendored 库 | 封装第三方依赖、内部库 | 不一定 | 项目级别 |
|
|
605
|
+
| `internal/` | 私有模块代码(Go 惯例) | 模块/包内部,不对外暴露给使用者 | 不一定 | 包内部 |
|
|
277
606
|
|
|
278
607
|
### 决策流程
|
|
279
608
|
|
|
280
609
|
```
|
|
281
|
-
|
|
282
|
-
├──
|
|
283
|
-
│ ├──
|
|
284
|
-
│ └──
|
|
285
|
-
│ ├──
|
|
286
|
-
│ └──
|
|
287
|
-
└──
|
|
288
|
-
├──
|
|
289
|
-
└──
|
|
290
|
-
├──
|
|
291
|
-
└──
|
|
610
|
+
Is it stateless and has no business logic?
|
|
611
|
+
├── YES: Is it reusable across the entire project?
|
|
612
|
+
│ ├── YES → utils/
|
|
613
|
+
│ └── NO: Is it tied to a specific layer (tests, views)?
|
|
614
|
+
│ ├── YES → helpers/ (e.g., tests/helpers/, views/helpers/)
|
|
615
|
+
│ └── NO → Place in the module that uses it
|
|
616
|
+
└── NO: Is it used by 2+ modules?
|
|
617
|
+
├── YES → shared/
|
|
618
|
+
└── NO: Is it wrapping a third-party dependency?
|
|
619
|
+
├── YES → lib/
|
|
620
|
+
└── NO → Place in the owning module
|
|
292
621
|
```
|
|
293
622
|
|
|
294
623
|
### 示例
|
|
295
624
|
|
|
296
625
|
```
|
|
297
626
|
src/
|
|
298
|
-
├── utils/ # formatDate()
|
|
299
|
-
├── helpers/ #
|
|
627
|
+
├── utils/ # formatDate(), slugify(), deepClone()
|
|
628
|
+
├── helpers/ # (uncommon at src/ level; prefer layer-specific)
|
|
300
629
|
├── shared/
|
|
301
|
-
│ ├── types/ #
|
|
302
|
-
│ └── constants/ #
|
|
630
|
+
│ ├── types/ # Cross-module TypeScript types
|
|
631
|
+
│ └── constants/ # Shared constants
|
|
303
632
|
├── lib/
|
|
304
|
-
│ └── http-client/ #
|
|
633
|
+
│ └── http-client/ # Wrapped axios with project defaults
|
|
305
634
|
└── modules/
|
|
306
635
|
└── auth/
|
|
307
|
-
└── helpers/ # Auth
|
|
636
|
+
└── helpers/ # Auth-specific helper functions
|
|
308
637
|
```
|
|
309
638
|
|
|
310
639
|
---
|
|
@@ -315,12 +644,12 @@ src/
|
|
|
315
644
|
|
|
316
645
|
| 分类 | 位置 | 示例 |
|
|
317
646
|
|------|------|------|
|
|
318
|
-
| **根目录配置** | 项目根目录 `/` | `package.json
|
|
319
|
-
| **应用程序配置** | `config/` 或 `src/config/` |
|
|
320
|
-
| **环境变量** | `.env` 文件(gitignored) | `.env
|
|
647
|
+
| **根目录配置** | 项目根目录 `/` | `package.json`, `tsconfig.json`, `pyproject.toml`, `.eslintrc.json` |
|
|
648
|
+
| **应用程序配置** | `config/` 或 `src/config/` | 数据库配置、特性标志、应用程序设置 |
|
|
649
|
+
| **环境变量** | `.env` 文件(gitignored) | `.env`, `.env.local`, `.env.production` |
|
|
321
650
|
| **CI/CD** | `.github/workflows/` 或 `.gitlab-ci.yml` | CI 管线定义 |
|
|
322
651
|
| **基础设施** | `infra/` 或 `deploy/` | Terraform、Kubernetes manifests、Docker Compose |
|
|
323
|
-
| **IDE/编辑器** | 根目录(多数 gitignored) | `.vscode
|
|
652
|
+
| **IDE/编辑器** | 根目录(多数 gitignored) | `.vscode/`, `.idea/`, `.editorconfig` |
|
|
324
653
|
|
|
325
654
|
### 决策规则
|
|
326
655
|
|
|
@@ -340,25 +669,76 @@ src/
|
|
|
340
669
|
|------|------|------------|
|
|
341
670
|
| **API 客户端 stubs** | `src/generated/` | 视工作流程而定 |
|
|
342
671
|
| **Protobuf/gRPC** | `src/generated/proto/` | 是(从 .proto 重新生成) |
|
|
343
|
-
|
|
|
672
|
+
| **数据库类型** (ORM) | `src/generated/db/` | 视 ORM 而定 |
|
|
344
673
|
| **OpenAPI 类型** | `src/generated/api/` | 视工作流程而定 |
|
|
345
|
-
| **构建产物** | `dist
|
|
346
|
-
| **编译资源** | `out
|
|
674
|
+
| **构建产物** | `dist/`, `build/` | 是 |
|
|
675
|
+
| **编译资源** | `out/`, `bin/` | 是 |
|
|
347
676
|
|
|
348
677
|
### 规则
|
|
349
678
|
|
|
350
679
|
1. **永远分离**生成代码与手写代码
|
|
351
680
|
2. **使用 `src/generated/`** 作为标准父目录
|
|
352
|
-
3. **可重现则 gitignore** —
|
|
353
|
-
4. **关键则提交** — 如果生成工具不在 CI
|
|
354
|
-
5. **永远不编辑生成文件** —
|
|
681
|
+
3. **可重现则 gitignore** — 如果代码可从源文件(`.proto`、`.graphql`、schema)重新生成,则 gitignore 它
|
|
682
|
+
4. **关键则提交** — 如果生成工具不在 CI 中或生成具有非确定性,则提交输出
|
|
683
|
+
5. **永远不编辑生成文件** — 添加头部注释:`// DO NOT EDIT — generated by [tool]`
|
|
684
|
+
|
|
685
|
+
---
|
|
686
|
+
|
|
687
|
+
## 反模式
|
|
688
|
+
|
|
689
|
+
### ❌ 避免这些模式
|
|
690
|
+
|
|
691
|
+
1. **无目的的嵌套 src 目录**
|
|
692
|
+
```
|
|
693
|
+
❌ project/src/src/main/...
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
2. **将构建输出与源代码混合**
|
|
697
|
+
```
|
|
698
|
+
❌ src/
|
|
699
|
+
├── app.ts
|
|
700
|
+
└── app.js # Compiled file mixed with source
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
3. **在没有 monorepo 结构的情况下,在一个代码仓库中放置多个无关项目**
|
|
704
|
+
```
|
|
705
|
+
❌ project/
|
|
706
|
+
├── backend/ # Unrelated project
|
|
707
|
+
└── frontend/ # Another unrelated project
|
|
708
|
+
# No shared tooling, no workspace config
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
4. **提交生成的文件**
|
|
712
|
+
```
|
|
713
|
+
❌ dist/ tracked in git
|
|
714
|
+
❌ node_modules/ tracked in git
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
5. **代码仓库中包含机密信息**
|
|
718
|
+
```
|
|
719
|
+
❌ config/secrets.json committed
|
|
720
|
+
❌ .env with real credentials committed
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
---
|
|
724
|
+
|
|
725
|
+
## 验证检查清单
|
|
726
|
+
|
|
727
|
+
在提交之前,请验证:
|
|
728
|
+
|
|
729
|
+
- [ ] 构建输出(`dist/`、`build/`、`bin/`、`obj/`)已 gitignore
|
|
730
|
+
- [ ] 依赖项(`node_modules/`、`.venv/`、`vendor/`)已 gitignore
|
|
731
|
+
- [ ] IDE 产物(`.idea/`、`.vs/`)已 gitignore
|
|
732
|
+
- [ ] 提交的文件中没有机密信息
|
|
733
|
+
- [ ] 源码结构遵循语言规范
|
|
734
|
+
- [ ] 没有异常目录(例如 `${workspaceFolder}/`)
|
|
355
735
|
|
|
356
736
|
---
|
|
357
737
|
|
|
358
738
|
## 相关标准
|
|
359
739
|
|
|
360
|
-
- [文档结构标准](documentation-structure.md)
|
|
361
|
-
- [代码签入标准](checkin-standards.md)
|
|
740
|
+
- [文档结构标准](documentation-structure.md)
|
|
741
|
+
- [代码签入标准](checkin-standards.md)
|
|
362
742
|
|
|
363
743
|
---
|
|
364
744
|
|
|
@@ -367,7 +747,7 @@ src/
|
|
|
367
747
|
| 版本 | 日期 | 变更 |
|
|
368
748
|
|------|------|------|
|
|
369
749
|
| 1.2.0 | 2026-03-04 | 新增:源代码组织术语(utils/helpers/shared/lib)、配置文件归属、生成代码归属 |
|
|
370
|
-
| 1.1.0 | 2026-01-24 | 新增:Monorepo vs Polyrepo 决策指南、Monorepo
|
|
750
|
+
| 1.1.0 | 2026-01-24 | 新增:Monorepo vs Polyrepo 决策指南、Monorepo 工具比较(Turborepo、Nx、Lerna、Rush)、Workspace 配置示例、基于包的架构 |
|
|
371
751
|
| 1.0.1 | 2025-12-24 | 新增:相关标准章节 |
|
|
372
752
|
| 1.0.0 | 2025-12-11 | 初始项目结构标准 |
|
|
373
753
|
|
|
@@ -381,8 +761,8 @@ src/
|
|
|
381
761
|
- [Standard Go Project Layout](https://github.com/golang-standards/project-layout)
|
|
382
762
|
- [Maven Standard Directory Layout](https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html)
|
|
383
763
|
- [Turborepo 文档](https://turbo.build/repo/docs) - 现代 JavaScript/TypeScript monorepo 构建系统
|
|
384
|
-
- [Nx 文档](https://nx.dev/getting-started/intro) -
|
|
385
|
-
- [pnpm Workspaces](https://pnpm.io/workspaces) -
|
|
764
|
+
- [Nx 文档](https://nx.dev/getting-started/intro) - 具备高级特性的智能 monorepo 工具
|
|
765
|
+
- [pnpm Workspaces](https://pnpm.io/workspaces) - 快速、高效节省磁盘空间的包管理器 workspaces
|
|
386
766
|
- [Monorepo Explained](https://monorepo.tools/) - Monorepo 工具全面指南
|
|
387
767
|
|
|
388
768
|
---
|