@dtt_siye/atool 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +235 -0
- package/VERSION +1 -0
- package/agents/code-reviewer.md +29 -0
- package/bin/atool.js +235 -0
- package/bin/postinstall.js +23 -0
- package/hooks/doc-sync-reminder +155 -0
- package/hooks/hooks-cursor.json +37 -0
- package/hooks/hooks.json +37 -0
- package/hooks/prompt-guard +135 -0
- package/hooks/session-start +286 -0
- package/install.sh +603 -0
- package/lib/analyze-source.sh +1265 -0
- package/lib/common.sh +1041 -0
- package/lib/compute-importance.sh +598 -0
- package/lib/detect-stack.sh +354 -0
- package/lib/generate-visualization.sh +266 -0
- package/lib/install-claude.sh +43 -0
- package/lib/install-cursor.sh +281 -0
- package/lib/install-hooks.sh +285 -0
- package/lib/install-kiro.sh +543 -0
- package/lib/install-mcp.sh +99 -0
- package/lib/install-skills.sh +129 -0
- package/lib/knowledge-graph.sh +1014 -0
- package/lib/multi-dimensional-analysis.sh +413 -0
- package/lib/pre-scan.sh +1045 -0
- package/lib/project-init.sh +552 -0
- package/lib/visualization-template.html +545 -0
- package/mcp/recommended.json +24 -0
- package/package.json +39 -0
- package/skills/_superpowers/.claude-plugin/marketplace.json +20 -0
- package/skills/_superpowers/.claude-plugin/plugin.json +20 -0
- package/skills/_superpowers/.codex/INSTALL.md +67 -0
- package/skills/_superpowers/.cursor-plugin/plugin.json +25 -0
- package/skills/_superpowers/.gitattributes +18 -0
- package/skills/_superpowers/.github/FUNDING.yml +3 -0
- package/skills/_superpowers/.github/ISSUE_TEMPLATE/bug_report.md +52 -0
- package/skills/_superpowers/.github/ISSUE_TEMPLATE/config.yml +5 -0
- package/skills/_superpowers/.github/ISSUE_TEMPLATE/feature_request.md +34 -0
- package/skills/_superpowers/.github/ISSUE_TEMPLATE/platform_support.md +23 -0
- package/skills/_superpowers/.github/PULL_REQUEST_TEMPLATE.md +87 -0
- package/skills/_superpowers/.opencode/INSTALL.md +83 -0
- package/skills/_superpowers/.opencode/plugins/superpowers.js +107 -0
- package/skills/_superpowers/CHANGELOG.md +13 -0
- package/skills/_superpowers/CODE_OF_CONDUCT.md +128 -0
- package/skills/_superpowers/GEMINI.md +2 -0
- package/skills/_superpowers/LICENSE +21 -0
- package/skills/_superpowers/README.md +187 -0
- package/skills/_superpowers/RELEASE-NOTES.md +1083 -0
- package/skills/_superpowers/agents/code-reviewer.md +48 -0
- package/skills/_superpowers/commands/brainstorm.md +5 -0
- package/skills/_superpowers/commands/execute-plan.md +5 -0
- package/skills/_superpowers/commands/write-plan.md +5 -0
- package/skills/_superpowers/docs/README.codex.md +126 -0
- package/skills/_superpowers/docs/README.opencode.md +130 -0
- package/skills/_superpowers/docs/plans/2025-11-22-opencode-support-design.md +294 -0
- package/skills/_superpowers/docs/plans/2025-11-22-opencode-support-implementation.md +1095 -0
- package/skills/_superpowers/docs/plans/2025-11-28-skills-improvements-from-user-feedback.md +711 -0
- package/skills/_superpowers/docs/plans/2026-01-17-visual-brainstorming.md +571 -0
- package/skills/_superpowers/docs/superpowers/plans/2026-01-22-document-review-system.md +301 -0
- package/skills/_superpowers/docs/superpowers/plans/2026-02-19-visual-brainstorming-refactor.md +523 -0
- package/skills/_superpowers/docs/superpowers/plans/2026-03-11-zero-dep-brainstorm-server.md +479 -0
- package/skills/_superpowers/docs/superpowers/plans/2026-03-23-codex-app-compatibility.md +564 -0
- package/skills/_superpowers/docs/superpowers/specs/2026-01-22-document-review-system-design.md +136 -0
- package/skills/_superpowers/docs/superpowers/specs/2026-02-19-visual-brainstorming-refactor-design.md +162 -0
- package/skills/_superpowers/docs/superpowers/specs/2026-03-11-zero-dep-brainstorm-server-design.md +118 -0
- package/skills/_superpowers/docs/superpowers/specs/2026-03-23-codex-app-compatibility-design.md +244 -0
- package/skills/_superpowers/docs/testing.md +303 -0
- package/skills/_superpowers/docs/windows/polyglot-hooks.md +212 -0
- package/skills/_superpowers/gemini-extension.json +6 -0
- package/skills/_superpowers/hooks/hooks-cursor.json +10 -0
- package/skills/_superpowers/hooks/hooks.json +16 -0
- package/skills/_superpowers/hooks/run-hook.cmd +46 -0
- package/skills/_superpowers/hooks/session-start +57 -0
- package/skills/_superpowers/package.json +6 -0
- package/skills/_superpowers/skills/brainstorming/SKILL.md +164 -0
- package/skills/_superpowers/skills/brainstorming/scripts/frame-template.html +214 -0
- package/skills/_superpowers/skills/brainstorming/scripts/helper.js +88 -0
- package/skills/_superpowers/skills/brainstorming/scripts/server.cjs +354 -0
- package/skills/_superpowers/skills/brainstorming/scripts/start-server.sh +148 -0
- package/skills/_superpowers/skills/brainstorming/scripts/stop-server.sh +56 -0
- package/skills/_superpowers/skills/brainstorming/spec-document-reviewer-prompt.md +49 -0
- package/skills/_superpowers/skills/brainstorming/visual-companion.md +287 -0
- package/skills/_superpowers/skills/dispatching-parallel-agents/SKILL.md +182 -0
- package/skills/_superpowers/skills/executing-plans/SKILL.md +70 -0
- package/skills/_superpowers/skills/finishing-a-development-branch/SKILL.md +200 -0
- package/skills/_superpowers/skills/receiving-code-review/SKILL.md +213 -0
- package/skills/_superpowers/skills/requesting-code-review/SKILL.md +105 -0
- package/skills/_superpowers/skills/requesting-code-review/code-reviewer.md +146 -0
- package/skills/_superpowers/skills/subagent-driven-development/SKILL.md +277 -0
- package/skills/_superpowers/skills/subagent-driven-development/code-quality-reviewer-prompt.md +26 -0
- package/skills/_superpowers/skills/subagent-driven-development/implementer-prompt.md +113 -0
- package/skills/_superpowers/skills/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/skills/_superpowers/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/skills/_superpowers/skills/systematic-debugging/SKILL.md +296 -0
- package/skills/_superpowers/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/skills/_superpowers/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/skills/_superpowers/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/skills/_superpowers/skills/systematic-debugging/find-polluter.sh +63 -0
- package/skills/_superpowers/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/skills/_superpowers/skills/systematic-debugging/test-academic.md +14 -0
- package/skills/_superpowers/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/skills/_superpowers/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/skills/_superpowers/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/skills/_superpowers/skills/test-driven-development/SKILL.md +371 -0
- package/skills/_superpowers/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/skills/_superpowers/skills/using-git-worktrees/SKILL.md +218 -0
- package/skills/_superpowers/skills/using-superpowers/SKILL.md +115 -0
- package/skills/_superpowers/skills/using-superpowers/references/codex-tools.md +100 -0
- package/skills/_superpowers/skills/using-superpowers/references/gemini-tools.md +33 -0
- package/skills/_superpowers/skills/verification-before-completion/SKILL.md +139 -0
- package/skills/_superpowers/skills/writing-plans/SKILL.md +152 -0
- package/skills/_superpowers/skills/writing-plans/plan-document-reviewer-prompt.md +49 -0
- package/skills/_superpowers/skills/writing-skills/SKILL.md +655 -0
- package/skills/_superpowers/skills/writing-skills/anthropic-best-practices.md +1150 -0
- package/skills/_superpowers/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/skills/_superpowers/skills/writing-skills/graphviz-conventions.dot +172 -0
- package/skills/_superpowers/skills/writing-skills/persuasion-principles.md +187 -0
- package/skills/_superpowers/skills/writing-skills/render-graphs.js +168 -0
- package/skills/_superpowers/skills/writing-skills/testing-skills-with-subagents.md +384 -0
- package/skills/_superpowers/tests/brainstorm-server/package-lock.json +36 -0
- package/skills/_superpowers/tests/brainstorm-server/package.json +10 -0
- package/skills/_superpowers/tests/brainstorm-server/server.test.js +427 -0
- package/skills/_superpowers/tests/brainstorm-server/windows-lifecycle.test.sh +351 -0
- package/skills/_superpowers/tests/brainstorm-server/ws-protocol.test.js +392 -0
- package/skills/_superpowers/tests/claude-code/README.md +158 -0
- package/skills/_superpowers/tests/claude-code/analyze-token-usage.py +168 -0
- package/skills/_superpowers/tests/claude-code/run-skill-tests.sh +187 -0
- package/skills/_superpowers/tests/claude-code/test-document-review-system.sh +177 -0
- package/skills/_superpowers/tests/claude-code/test-helpers.sh +202 -0
- package/skills/_superpowers/tests/claude-code/test-subagent-driven-development-integration.sh +314 -0
- package/skills/_superpowers/tests/claude-code/test-subagent-driven-development.sh +165 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/action-oriented.txt +3 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/after-planning-flow.txt +17 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/claude-suggested-it.txt +11 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/i-know-what-sdd-means.txt +8 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/mid-conversation-execute-plan.txt +3 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/please-use-brainstorming.txt +1 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/skip-formalities.txt +3 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/subagent-driven-development-please.txt +1 -0
- package/skills/_superpowers/tests/explicit-skill-requests/prompts/use-systematic-debugging.txt +1 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-all.sh +70 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-claude-describes-sdd.sh +100 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-extended-multiturn-test.sh +113 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-haiku-test.sh +144 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-multiturn-test.sh +143 -0
- package/skills/_superpowers/tests/explicit-skill-requests/run-test.sh +136 -0
- package/skills/_superpowers/tests/opencode/run-tests.sh +163 -0
- package/skills/_superpowers/tests/opencode/setup.sh +73 -0
- package/skills/_superpowers/tests/opencode/test-plugin-loading.sh +72 -0
- package/skills/_superpowers/tests/opencode/test-priority.sh +198 -0
- package/skills/_superpowers/tests/opencode/test-tools.sh +104 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/dispatching-parallel-agents.txt +8 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/executing-plans.txt +1 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/requesting-code-review.txt +3 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/systematic-debugging.txt +11 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/test-driven-development.txt +7 -0
- package/skills/_superpowers/tests/skill-triggering/prompts/writing-plans.txt +10 -0
- package/skills/_superpowers/tests/skill-triggering/run-all.sh +60 -0
- package/skills/_superpowers/tests/skill-triggering/run-test.sh +88 -0
- package/skills/_superpowers/tests/subagent-driven-dev/go-fractals/design.md +81 -0
- package/skills/_superpowers/tests/subagent-driven-dev/go-fractals/plan.md +172 -0
- package/skills/_superpowers/tests/subagent-driven-dev/go-fractals/scaffold.sh +45 -0
- package/skills/_superpowers/tests/subagent-driven-dev/run-test.sh +106 -0
- package/skills/_superpowers/tests/subagent-driven-dev/svelte-todo/design.md +70 -0
- package/skills/_superpowers/tests/subagent-driven-dev/svelte-todo/plan.md +222 -0
- package/skills/_superpowers/tests/subagent-driven-dev/svelte-todo/scaffold.sh +46 -0
- package/skills/ai-project-architecture/SKILL.md +632 -0
- package/skills/ai-project-architecture/reference/structure-rules.md +406 -0
- package/skills/ai-project-architecture/templates/compliance-report.md +300 -0
- package/skills/ai-project-architecture/templates/migration-plan.md +433 -0
- package/skills/ai-project-architecture/templates/verification-checklist.md +408 -0
- package/skills/android-conventions/SKILL.md +125 -0
- package/skills/atool-init/SKILL.md +141 -0
- package/skills/clarify-before-build/SKILL.md +107 -0
- package/skills/code-review/SKILL.md +406 -0
- package/skills/code-review/rules/architecture.md +285 -0
- package/skills/code-review/rules/coupling-cohesion.md +309 -0
- package/skills/code-review/rules/dead-code.md +115 -0
- package/skills/code-review/rules/deprecation-debt.md +279 -0
- package/skills/code-review/rules/duplication.md +104 -0
- package/skills/code-review/rules/error-security.md +143 -0
- package/skills/code-review/rules/maintainability.md +203 -0
- package/skills/code-review/rules/quality.md +158 -0
- package/skills/devops-conventions/SKILL.md +205 -0
- package/skills/doc-coauthoring/SKILL.md +392 -0
- package/skills/doc-standards-enforcer/SKILL.md +290 -0
- package/skills/doc-standards-enforcer/examples/valid-document-example.md +67 -0
- package/skills/doc-standards-enforcer/references/101-standards-summary.md +318 -0
- package/skills/doc-standards-enforcer/scripts/check_references.py +175 -0
- package/skills/doc-standards-enforcer/scripts/fix_common_issues.py +303 -0
- package/skills/doc-standards-enforcer/scripts/validate_doc_standards.py +332 -0
- package/skills/docx/LICENSE.txt +30 -0
- package/skills/docx/SKILL.md +200 -0
- package/skills/docx/docx-js.md +350 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
- package/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
- package/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
- package/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
- package/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
- package/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
- package/skills/docx/ooxml/schemas/mce/mc.xsd +75 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
- package/skills/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
- package/skills/docx/ooxml/scripts/pack.py +159 -0
- package/skills/docx/ooxml/scripts/unpack.py +29 -0
- package/skills/docx/ooxml/scripts/validate.py +69 -0
- package/skills/docx/ooxml/scripts/validation/__init__.py +15 -0
- package/skills/docx/ooxml/scripts/validation/base.py +951 -0
- package/skills/docx/ooxml/scripts/validation/docx.py +274 -0
- package/skills/docx/ooxml/scripts/validation/pptx.py +315 -0
- package/skills/docx/ooxml/scripts/validation/redlining.py +279 -0
- package/skills/docx/ooxml.md +610 -0
- package/skills/docx/scripts/__init__.py +1 -0
- package/skills/docx/scripts/document.py +1276 -0
- package/skills/docx/scripts/templates/comments.xml +3 -0
- package/skills/docx/scripts/templates/commentsExtended.xml +3 -0
- package/skills/docx/scripts/templates/commentsExtensible.xml +3 -0
- package/skills/docx/scripts/templates/commentsIds.xml +3 -0
- package/skills/docx/scripts/templates/people.xml +3 -0
- package/skills/docx/scripts/utilities.py +374 -0
- package/skills/flutter-conventions/SKILL.md +70 -0
- package/skills/go-conventions/SKILL.md +230 -0
- package/skills/harmony-conventions/SKILL.md +156 -0
- package/skills/java-conventions/SKILL.md +277 -0
- package/skills/pdf/LICENSE.txt +30 -0
- package/skills/pdf/SKILL.md +297 -0
- package/skills/pdf/forms.md +205 -0
- package/skills/pdf/reference.md +612 -0
- package/skills/pdf/scripts/check_bounding_boxes.py +70 -0
- package/skills/pdf/scripts/check_bounding_boxes_test.py +226 -0
- package/skills/pdf/scripts/check_fillable_fields.py +12 -0
- package/skills/pdf/scripts/convert_pdf_to_images.py +35 -0
- package/skills/pdf/scripts/create_validation_image.py +41 -0
- package/skills/pdf/scripts/extract_form_field_info.py +152 -0
- package/skills/pdf/scripts/fill_fillable_fields.py +114 -0
- package/skills/pdf/scripts/fill_pdf_form_with_annotations.py +108 -0
- package/skills/pptx/LICENSE.txt +30 -0
- package/skills/pptx/SKILL.md +487 -0
- package/skills/pptx/html2pptx.md +625 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
- package/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
- package/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
- package/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
- package/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
- package/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
- package/skills/pptx/ooxml/schemas/mce/mc.xsd +75 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
- package/skills/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
- package/skills/pptx/ooxml/scripts/pack.py +159 -0
- package/skills/pptx/ooxml/scripts/unpack.py +29 -0
- package/skills/pptx/ooxml/scripts/validate.py +69 -0
- package/skills/pptx/ooxml/scripts/validation/__init__.py +15 -0
- package/skills/pptx/ooxml/scripts/validation/base.py +951 -0
- package/skills/pptx/ooxml/scripts/validation/docx.py +274 -0
- package/skills/pptx/ooxml/scripts/validation/pptx.py +315 -0
- package/skills/pptx/ooxml/scripts/validation/redlining.py +279 -0
- package/skills/pptx/ooxml.md +427 -0
- package/skills/pptx/scripts/html2pptx.js +979 -0
- package/skills/pptx/scripts/inventory.py +1020 -0
- package/skills/pptx/scripts/rearrange.py +231 -0
- package/skills/pptx/scripts/replace.py +385 -0
- package/skills/pptx/scripts/thumbnail.py +450 -0
- package/skills/project-analyze/SKILL.md +270 -0
- package/skills/project-analyze/phases/phase0-discovery.md +278 -0
- package/skills/project-analyze/phases/phase0.5-prescan.md +139 -0
- package/skills/project-analyze/phases/phase1-inventory.md +94 -0
- package/skills/project-analyze/phases/phase2-deep-analysis.md +249 -0
- package/skills/project-analyze/phases/phase2a-l4-analysis.md +94 -0
- package/skills/project-analyze/phases/phase2b-l5-analysis.md +97 -0
- package/skills/project-analyze/phases/phase3-knowledge-graph.md +120 -0
- package/skills/project-analyze/phases/phase3a-multi-dimensional.md +61 -0
- package/skills/project-analyze/phases/phase4-code-quality.md +81 -0
- package/skills/project-analyze/phases/phase5-synthesis.md +284 -0
- package/skills/project-analyze/phases/phase6-validation.md +179 -0
- package/skills/project-analyze/prompts/code-review-agent.md +122 -0
- package/skills/project-analyze/prompts/deep-analysis-agent.md +107 -0
- package/skills/project-analyze/prompts/inventory-agent.md +67 -0
- package/skills/project-analyze/prompts/l4-analysis-agent.md +98 -0
- package/skills/project-analyze/rules/android.md +282 -0
- package/skills/project-analyze/rules/devops.md +443 -0
- package/skills/project-analyze/rules/generic.md +243 -0
- package/skills/project-analyze/rules/go.md +289 -0
- package/skills/project-analyze/rules/harmony.md +257 -0
- package/skills/project-analyze/rules/java.md +507 -0
- package/skills/project-analyze/rules/mobile-flutter.md +315 -0
- package/skills/project-analyze/rules/mobile-react-native.md +283 -0
- package/skills/project-analyze/rules/mobile-swift.md +323 -0
- package/skills/project-analyze/rules/python.md +317 -0
- package/skills/project-analyze/rules/rust-tauri.md +243 -0
- package/skills/project-analyze/rules/rust.md +296 -0
- package/skills/project-analyze/rules/web-nextjs.md +364 -0
- package/skills/project-analyze/rules/web-react.md +298 -0
- package/skills/project-analyze/rules/web-vue.md +378 -0
- package/skills/project-analyze/rules/web.md +390 -0
- package/skills/project-query/SKILL.md +224 -0
- package/skills/project-query/rules/query-templates.md +212 -0
- package/skills/python-conventions/SKILL.md +169 -0
- package/skills/react-native-conventions/SKILL.md +73 -0
- package/skills/requirements-writer/README.md +153 -0
- package/skills/requirements-writer/SKILL.md +341 -0
- package/skills/requirements-writer/examples/prd-outline-example.md +217 -0
- package/skills/requirements-writer/templates/module-prd-template.md +362 -0
- package/skills/requirements-writer/templates/prd-outline-template.md +185 -0
- package/skills/requirements-writer/templates/user-story-template.md +1125 -0
- package/skills/rust-conventions/SKILL.md +361 -0
- package/skills/smart-dispatch/SKILL.md +296 -0
- package/skills/smart-dispatch/implementer-prompt.md +146 -0
- package/skills/smart-dispatch/reviewer-prompt.md +199 -0
- package/skills/software-architecture/SKILL.md +278 -0
- package/skills/swift-conventions/SKILL.md +72 -0
- package/skills/ui-ux-pro/SKILL.md +140 -0
- package/skills/verification-before-completion/SKILL.md +119 -0
- package/skills/web-conventions/SKILL.md +259 -0
- package/skills/webapp-testing/LICENSE.txt +202 -0
- package/skills/webapp-testing/SKILL.md +97 -0
- package/skills/webapp-testing/examples/console_logging.py +35 -0
- package/skills/webapp-testing/examples/element_discovery.py +40 -0
- package/skills/webapp-testing/examples/static_html_automation.py +33 -0
- package/skills/webapp-testing/scripts/with_server.py +106 -0
- package/skills/writing-plans/SKILL.md +144 -0
- package/skills/xlsx/LICENSE.txt +30 -0
- package/skills/xlsx/SKILL.md +292 -0
- package/skills/xlsx/recalc.py +178 -0
- package/templates/CLAUDE.md.android +57 -0
- package/templates/CLAUDE.md.devops +50 -0
- package/templates/CLAUDE.md.generic +34 -0
- package/templates/CLAUDE.md.go +67 -0
- package/templates/CLAUDE.md.harmony +54 -0
- package/templates/CLAUDE.md.java +56 -0
- package/templates/CLAUDE.md.mobile-flutter +38 -0
- package/templates/CLAUDE.md.mobile-react-native +37 -0
- package/templates/CLAUDE.md.mobile-swift +40 -0
- package/templates/CLAUDE.md.python +65 -0
- package/templates/CLAUDE.md.rust +68 -0
- package/templates/CLAUDE.md.rust-tauri +120 -0
- package/templates/CLAUDE.md.web +63 -0
- package/templates/COMPONENT.md.android +58 -0
- package/templates/COMPONENT.md.devops +54 -0
- package/templates/COMPONENT.md.generic +35 -0
- package/templates/COMPONENT.md.go +59 -0
- package/templates/COMPONENT.md.harmony +63 -0
- package/templates/COMPONENT.md.java +69 -0
- package/templates/COMPONENT.md.mobile-flutter +56 -0
- package/templates/COMPONENT.md.mobile-react-native +55 -0
- package/templates/COMPONENT.md.mobile-swift +56 -0
- package/templates/COMPONENT.md.python +67 -0
- package/templates/COMPONENT.md.rust +57 -0
- package/templates/COMPONENT.md.rust-tauri +66 -0
- package/templates/COMPONENT.md.web +39 -0
- package/templates/README.md.android +71 -0
- package/templates/README.md.devops +68 -0
- package/templates/README.md.generic +39 -0
- package/templates/README.md.go +70 -0
- package/templates/README.md.harmony +72 -0
- package/templates/README.md.java +73 -0
- package/templates/README.md.mobile-flutter +69 -0
- package/templates/README.md.mobile-react-native +65 -0
- package/templates/README.md.mobile-swift +69 -0
- package/templates/README.md.monorepo +59 -0
- package/templates/README.md.python +66 -0
- package/templates/README.md.rust +69 -0
- package/templates/README.md.rust-tauri +149 -0
- package/templates/README.md.web +94 -0
- package/templates/UI_STYLE.md.android +74 -0
- package/templates/UI_STYLE.md.devops +50 -0
- package/templates/UI_STYLE.md.generic +31 -0
- package/templates/UI_STYLE.md.go +49 -0
- package/templates/UI_STYLE.md.harmony +71 -0
- package/templates/UI_STYLE.md.java +61 -0
- package/templates/UI_STYLE.md.mobile-flutter +70 -0
- package/templates/UI_STYLE.md.mobile-react-native +71 -0
- package/templates/UI_STYLE.md.mobile-swift +71 -0
- package/templates/UI_STYLE.md.python +58 -0
- package/templates/UI_STYLE.md.rust +52 -0
- package/templates/UI_STYLE.md.rust-tauri +102 -0
- package/templates/UI_STYLE.md.web +92 -0
- package/templates/cursor-rules.android.mdc +33 -0
- package/templates/cursor-rules.devops.mdc +32 -0
- package/templates/cursor-rules.generic.mdc +25 -0
- package/templates/cursor-rules.go.mdc +34 -0
- package/templates/cursor-rules.harmony.mdc +30 -0
- package/templates/cursor-rules.java.mdc +30 -0
- package/templates/cursor-rules.mobile-flutter.mdc +42 -0
- package/templates/cursor-rules.mobile-react-native.mdc +43 -0
- package/templates/cursor-rules.mobile-swift.mdc +42 -0
- package/templates/cursor-rules.python.mdc +33 -0
- package/templates/cursor-rules.rust-tauri.mdc +67 -0
- package/templates/cursor-rules.rust.mdc +30 -0
- package/templates/cursor-rules.web.mdc +30 -0
- package/templates/kiro-steering.android.md +39 -0
- package/templates/kiro-steering.devops.md +32 -0
- package/templates/kiro-steering.generic.md +28 -0
- package/templates/kiro-steering.go.md +41 -0
- package/templates/kiro-steering.harmony.md +36 -0
- package/templates/kiro-steering.java.md +37 -0
- package/templates/kiro-steering.mobile-flutter.md +73 -0
- package/templates/kiro-steering.mobile-react-native.md +71 -0
- package/templates/kiro-steering.mobile-swift.md +62 -0
- package/templates/kiro-steering.python.md +34 -0
- package/templates/kiro-steering.rust-tauri.md +50 -0
- package/templates/kiro-steering.rust.md +36 -0
- package/templates/kiro-steering.web.md +41 -0
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
# DevOps / Infrastructure 项目分析规则
|
|
2
|
+
|
|
3
|
+
## 分析粒度
|
|
4
|
+
|
|
5
|
+
按服务、环境和基础设施组件进行分析。
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Infrastructure as Code (IaC)
|
|
9
|
+
├── Docker(容器化)
|
|
10
|
+
│ ├── Dockerfile(镜像构建)
|
|
11
|
+
│ ├── docker-compose.yml(多服务编排)
|
|
12
|
+
│ └── .dockerignore(构建排除)
|
|
13
|
+
├── Kubernetes(容器编排)
|
|
14
|
+
│ ├── Deployment / StatefulSet / DaemonSet
|
|
15
|
+
│ ├── Service / Ingress / Gateway
|
|
16
|
+
│ ├── ConfigMap / Secret / PVC
|
|
17
|
+
│ ├── Helm Chart(模板化部署)
|
|
18
|
+
│ └── Kustomize(overlay 变体)
|
|
19
|
+
├── Terraform / OpenTofu(基础设施)
|
|
20
|
+
│ ├── resource / data / module
|
|
21
|
+
│ ├── provider / backend
|
|
22
|
+
│ └── variable / output / locals
|
|
23
|
+
└── CI/CD(自动化流水线)
|
|
24
|
+
├── GitHub Actions / GitLab CI / Jenkins
|
|
25
|
+
├── ArgoCD / Flux(GitOps)
|
|
26
|
+
└── Makefile / Taskfile(任务编排)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## 目录扫描策略
|
|
30
|
+
|
|
31
|
+
### 1. 识别基础设施类型
|
|
32
|
+
|
|
33
|
+
**信号文件检测:**
|
|
34
|
+
|
|
35
|
+
| 类型 | 信号文件 | 说明 |
|
|
36
|
+
|------|----------|------|
|
|
37
|
+
| Docker | `Dockerfile`, `Dockerfile.*`, `docker-compose.yml`, `docker-compose.yaml`, `.dockerignore` | 容器化配置 |
|
|
38
|
+
| Kubernetes | `k8s/`, `kubernetes/`, `manifests/`, `deploy/`, `kustomization.yaml`, `Chart.yaml`, `values.yaml` | K8s 部署配置 |
|
|
39
|
+
| Terraform | `*.tf`, `*.tfvars`, `terraform.tfstate`, `.terraform.lock.hcl` | IaC 配置 |
|
|
40
|
+
| Ansible | `playbook.yml`, `ansible.cfg`, `inventory/`, `roles/` | 配置管理 |
|
|
41
|
+
| CI/CD | `.github/workflows/`, `.gitlab-ci.yml`, `Jenkinsfile`, `.circleci/`, `tekton/`, `.argo/` | 流水线配置 |
|
|
42
|
+
| 监控 | `prometheus/`, `grafana/`, `alertmanager/`, `dashboards/`, `rules/*.yml` | 可观测性配置 |
|
|
43
|
+
| 安全 | `vault/`, `policy/`, `cert-manager/`, `istio/` | 安全策略配置 |
|
|
44
|
+
|
|
45
|
+
### 2. Docker 分析
|
|
46
|
+
|
|
47
|
+
**扫描文件**: `Dockerfile`, `Dockerfile.*`, `docker-compose.yml`, `docker-compose.yaml`, `.dockerignore`
|
|
48
|
+
|
|
49
|
+
**提取内容**:
|
|
50
|
+
- 基础镜像及版本(FROM 行)
|
|
51
|
+
- 多阶段构建结构(每个 FROM 为一个阶段)
|
|
52
|
+
- 暴露端口(EXPOSE)
|
|
53
|
+
- 环境变量(ENV)
|
|
54
|
+
- 卷挂载(VOLUME)
|
|
55
|
+
- 入口点(ENTRYPOINT / CMD)
|
|
56
|
+
- 构建参数(ARG)
|
|
57
|
+
- 健康检查(HEALTHCHECK)
|
|
58
|
+
- 用户/权限(USER, RUN chown)
|
|
59
|
+
- `.dockerignore` 排除规则
|
|
60
|
+
|
|
61
|
+
**输出示例**:
|
|
62
|
+
```
|
|
63
|
+
### api-gateway(Dockerfile)
|
|
64
|
+
- **路径**: `services/api-gateway/Dockerfile`
|
|
65
|
+
- **基础镜像**: `node:20-alpine AS builder` → `nginx:alpine AS production`
|
|
66
|
+
- **多阶段构建**:
|
|
67
|
+
| 阶段 | 基础镜像 | 用途 |
|
|
68
|
+
|------|----------|------|
|
|
69
|
+
| builder | node:20-alpine | 依赖安装 + 构建 |
|
|
70
|
+
| production | nginx:alpine | 运行时(Nginx 静态服务) |
|
|
71
|
+
- **暴露端口**: 8080
|
|
72
|
+
- **环境变量**: NODE_ENV=production, API_BASE_URL
|
|
73
|
+
- **健康检查**: `curl -f http://localhost:8080/health || exit 1`
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 3. Docker Compose 分析
|
|
77
|
+
|
|
78
|
+
**扫描文件**: `docker-compose.yml`, `docker-compose.yaml`, `docker-compose.*.yml`
|
|
79
|
+
|
|
80
|
+
**提取内容**:
|
|
81
|
+
- 服务列表(名称 + 镜像 + 构建上下文)
|
|
82
|
+
- 服务间依赖(depends_on)
|
|
83
|
+
- 网络配置(networks)
|
|
84
|
+
- 卷挂载(volumes)
|
|
85
|
+
- 环境变量(environment / env_file)
|
|
86
|
+
- 端口映射(ports)
|
|
87
|
+
- 健康检查(healthcheck)
|
|
88
|
+
- 扩展策略(deploy.replicas / scale)
|
|
89
|
+
- Compose 文件版本和 overlay 结构
|
|
90
|
+
|
|
91
|
+
**输出示例**:
|
|
92
|
+
```
|
|
93
|
+
### Docker Compose 服务编排
|
|
94
|
+
- **文件**: `docker-compose.yml` (version: '3.8')
|
|
95
|
+
- **服务列表**:
|
|
96
|
+
| 服务名 | 镜像 | 端口 | 依赖 | 说明 |
|
|
97
|
+
|--------|------|------|------|------|
|
|
98
|
+
| api | node:20-alpine (build) | 3000:3000 | postgres, redis | API 服务 |
|
|
99
|
+
| worker | node:20-alpine (build) | - | postgres, redis | 后台任务处理 |
|
|
100
|
+
| postgres | postgres:16-alpine | 5432:5432 | - | 数据库 |
|
|
101
|
+
| redis | redis:7-alpine | 6379:6379 | - | 缓存 |
|
|
102
|
+
- **网络**: app-network (bridge)
|
|
103
|
+
- **卷**: postgres-data, redis-data
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 4. Kubernetes 分析
|
|
107
|
+
|
|
108
|
+
**扫描文件**: `k8s/**/*.yaml`, `manifests/**/*.yaml`, `deploy/**/*.yaml`, `Chart.yaml`, `values.yaml`, `templates/**/*.yaml`
|
|
109
|
+
|
|
110
|
+
**提取内容**:
|
|
111
|
+
- 资源类型和数量(Deployment, Service, Ingress, ConfigMap, Secret, PVC, CronJob, Job, HPA)
|
|
112
|
+
- 每个 Deployment 的镜像、副本数、资源限制、探针配置
|
|
113
|
+
- Service 类型和端口映射(ClusterIP, NodePort, LoadBalancer)
|
|
114
|
+
- Ingress 规则(主机、路径、TLS)
|
|
115
|
+
- ConfigMap / Secret 数据结构(键名,不记录敏感值)
|
|
116
|
+
- PVC 存储类和大小
|
|
117
|
+
- Helm Chart 元数据(name, version, appVersion, dependencies)
|
|
118
|
+
- Helm values 结构(关键配置项及默认值)
|
|
119
|
+
- Kustomize overlay 结构(base + overlays/)
|
|
120
|
+
|
|
121
|
+
**输出示例**:
|
|
122
|
+
```
|
|
123
|
+
### Kubernetes 部署配置
|
|
124
|
+
#### Deployments
|
|
125
|
+
| 名称 | 命名空间 | 镜像 | 副本 | 资源限制 |
|
|
126
|
+
|------|----------|------|------|----------|
|
|
127
|
+
| api-server | production | myapp/api:v1.2.3 | 3 | cpu: 500m, mem: 512Mi |
|
|
128
|
+
| worker | production | myapp/worker:v1.2.3 | 2 | cpu: 250m, mem: 256Mi |
|
|
129
|
+
|
|
130
|
+
#### Services
|
|
131
|
+
| 名称 | 类型 | 端口 | 选择器 |
|
|
132
|
+
|------|------|------|--------|
|
|
133
|
+
| api-server-svc | ClusterIP | 8080:8080 | app=api-server |
|
|
134
|
+
| api-server-ingress | LoadBalancer | 80:80, 443:443 | app=api-server |
|
|
135
|
+
|
|
136
|
+
#### Ingress
|
|
137
|
+
| 主机 | 路径 | 后端 | TLS |
|
|
138
|
+
|------|------|------|-----|
|
|
139
|
+
| api.example.com | / | api-server-svc:8080 | api-tls |
|
|
140
|
+
|
|
141
|
+
#### ConfigMaps
|
|
142
|
+
| 名称 | 键 |
|
|
143
|
+
|------|-----|
|
|
144
|
+
| api-config | DATABASE_URL, REDIS_URL, LOG_LEVEL |
|
|
145
|
+
|
|
146
|
+
#### Helm Chart
|
|
147
|
+
- **名称**: myapp-chart
|
|
148
|
+
- **版本**: 0.3.0
|
|
149
|
+
- **AppVersion**: 1.2.3
|
|
150
|
+
- **依赖**: postgresql, redis
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### 5. Terraform 分析
|
|
154
|
+
|
|
155
|
+
**扫描文件**: `*.tf`, `*.tfvars`, `*.tf.json`
|
|
156
|
+
|
|
157
|
+
**提取内容**:
|
|
158
|
+
- Provider 列表及版本(aws, azurerm, google, kubernetes, helm 等)
|
|
159
|
+
- Backend 配置(s3, gcs, http 等)
|
|
160
|
+
- Resource 列表(类型 + 名称 + 关键参数)
|
|
161
|
+
- Data source 列表(类型 + 名称)
|
|
162
|
+
- Module 调用(源 + 版本 + 输入变量)
|
|
163
|
+
- Variable 定义(名称 + 类型 + 默认值 + 描述)
|
|
164
|
+
- Output 定义(名称 + 值 + 描述)
|
|
165
|
+
- Locals 定义(名称 + 值)
|
|
166
|
+
- 状态文件引用(remote state data source)
|
|
167
|
+
|
|
168
|
+
**输出示例**:
|
|
169
|
+
```
|
|
170
|
+
### Terraform 基础设施
|
|
171
|
+
#### Providers
|
|
172
|
+
| Provider | 版本 | 源 |
|
|
173
|
+
|----------|------|-----|
|
|
174
|
+
| aws | ~> 5.0 | hashicorp/aws |
|
|
175
|
+
| kubernetes | ~> 2.23 | hashicorp/kubernetes |
|
|
176
|
+
|
|
177
|
+
#### Resources(按类型分组)
|
|
178
|
+
**EC2**:
|
|
179
|
+
| 名称 | 实例类型 | 关键参数 |
|
|
180
|
+
|------|----------|----------|
|
|
181
|
+
| aws_instance.api | t3.medium | ami, vpc_security_group_ids, subnet_id |
|
|
182
|
+
|
|
183
|
+
**RDS**:
|
|
184
|
+
| 名称 | 引擎 | 存储大小 |
|
|
185
|
+
|------|------|----------|
|
|
186
|
+
| aws_db_instance.main | postgres 16 | 100 GB |
|
|
187
|
+
|
|
188
|
+
#### Modules
|
|
189
|
+
| 名称 | 源 | 版本 | 说明 |
|
|
190
|
+
|------|-----|------|------|
|
|
191
|
+
| vpc | terraform-aws-modules/vpc/aws | 5.1.0 | VPC 网络配置 |
|
|
192
|
+
| eks | terraform-aws-modules/eks/aws | 19.15.0 | EKS 集群 |
|
|
193
|
+
|
|
194
|
+
#### Variables
|
|
195
|
+
| 名称 | 类型 | 默认值 | 描述 |
|
|
196
|
+
|------|------|--------|------|
|
|
197
|
+
| environment | string | "production" | 部署环境 |
|
|
198
|
+
| instance_type | string | "t3.medium" | EC2 实例类型 |
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### 6. CI/CD 流水线分析
|
|
202
|
+
|
|
203
|
+
**扫描文件**: `.github/workflows/*.yml`, `.gitlab-ci.yml`, `Jenkinsfile`, `.circleci/config.yml`, `tekton/*.yaml`
|
|
204
|
+
|
|
205
|
+
**GitHub Actions 提取内容**:
|
|
206
|
+
- Workflow 名称和触发条件(push, pull_request, schedule, workflow_dispatch)
|
|
207
|
+
- 环境矩阵(matrix: os / node-version / etc.)
|
|
208
|
+
- Job 列表(名称 + 运行器 + 依赖关系)
|
|
209
|
+
- 每个 Job 的 Steps(动作名称 + 版本 + 关键参数)
|
|
210
|
+
- Secret 使用列表(名称,不记录值)
|
|
211
|
+
- Artifact 上传/下载
|
|
212
|
+
- 缓存策略(actions/cache)
|
|
213
|
+
- 环境部署(environment: production / staging)
|
|
214
|
+
|
|
215
|
+
**GitLab CI 提取内容**:
|
|
216
|
+
- Stage 列表和顺序
|
|
217
|
+
- Job 列表(stage + image + script + rules/only/except)
|
|
218
|
+
- 变量定义(variables)
|
|
219
|
+
- 缓存配置(cache)
|
|
220
|
+
- Artifact 定义
|
|
221
|
+
- 触发规则(rules / only / except)
|
|
222
|
+
|
|
223
|
+
**输出示例**:
|
|
224
|
+
```
|
|
225
|
+
### GitHub Actions CI/CD
|
|
226
|
+
#### Workflow: ci.yml
|
|
227
|
+
- **触发条件**: push (main, develop), pull_request
|
|
228
|
+
- **Jobs**:
|
|
229
|
+
| Job | 运行器 | 依赖 | 超时 | 说明 |
|
|
230
|
+
|-----|--------|------|------|------|
|
|
231
|
+
| lint | ubuntu-latest | - | 10m | 代码风格检查 |
|
|
232
|
+
| test | ubuntu-latest | lint | 20m | 单元测试 + 覆盖率 |
|
|
233
|
+
| build | ubuntu-latest | test | 15m | Docker 镜像构建 |
|
|
234
|
+
| deploy-staging | ubuntu-latest | build | 10m | 部署到 staging |
|
|
235
|
+
|
|
236
|
+
#### Workflow: deploy.yml
|
|
237
|
+
- **触发条件**: workflow_dispatch (inputs: environment)
|
|
238
|
+
- **环境**: production (需要审批), staging
|
|
239
|
+
- **Secrets**: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, KUBECONFIG
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### 7. 监控与可观测性分析
|
|
243
|
+
|
|
244
|
+
**扫描文件**: `prometheus/*.yml`, `grafana/**/*.json`, `alertmanager/*.yml`, `dashboards/**/*.json`
|
|
245
|
+
|
|
246
|
+
**提取内容**:
|
|
247
|
+
- Prometheus scrape 配置(targets, interval, labels)
|
|
248
|
+
- 自定义指标规则(recording rules)
|
|
249
|
+
- 告警规则(alert name, expr, severity, annotations)
|
|
250
|
+
- Grafana Dashboard 列表(标题 + 数据源 + 面板数)
|
|
251
|
+
- Alertmanager 路由配置(receiver, group_by, inhibit_rules)
|
|
252
|
+
- 日志聚合配置(如 ELK / Loki 的相关配置文件)
|
|
253
|
+
|
|
254
|
+
**输出示例**:
|
|
255
|
+
```
|
|
256
|
+
### 监控配置
|
|
257
|
+
#### Prometheus
|
|
258
|
+
- **Scrape 配置**:
|
|
259
|
+
| Job | Target | 间隔 | 标签 |
|
|
260
|
+
|-----|--------|------|------|
|
|
261
|
+
| api-server | http://api:8080/metrics | 15s | app=api, env=prod |
|
|
262
|
+
|
|
263
|
+
#### 告警规则
|
|
264
|
+
| 告警名 | 表达式 | 严重级别 | 说明 |
|
|
265
|
+
|--------|--------|----------|------|
|
|
266
|
+
| HighErrorRate | rate(http_errors_total[5m]) > 0.05 | warning | 错误率 > 5% |
|
|
267
|
+
| PodCrashLooping | kube_pod_container_status_restarts_total > 5 | critical | Pod 重启循环 |
|
|
268
|
+
|
|
269
|
+
#### Grafana Dashboards
|
|
270
|
+
| 名称 | 数据源 | 面板数 |
|
|
271
|
+
|------|--------|--------|
|
|
272
|
+
| API Overview | Prometheus | 12 |
|
|
273
|
+
| System Resources | Prometheus | 8 |
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
## 模块发现规则
|
|
277
|
+
|
|
278
|
+
- **Docker**: 每个 `Dockerfile` 或 `Dockerfile.*` 为一个分析单元
|
|
279
|
+
- **Compose**: 每个 compose 文件为一个分析单元,按 services 拆分子任务
|
|
280
|
+
- **Kubernetes**: 按 namespace / application 分组,每组内的资源类型为一个子任务
|
|
281
|
+
- **Helm**: Chart 为一个分析单元,`values.yaml` 和 `templates/` 分别分析
|
|
282
|
+
- **Terraform**: 每个 `*.tf` 文件为一个分析单元,按 resource type 分组
|
|
283
|
+
- **Ansible**: 每个 playbook 为一个分析单元
|
|
284
|
+
- **CI/CD**: 每个 workflow/job 文件为一个分析单元
|
|
285
|
+
- **监控**: 按工具(Prometheus / Grafana / Alertmanager)分组
|
|
286
|
+
|
|
287
|
+
## 依赖分析
|
|
288
|
+
|
|
289
|
+
从配置文件提取:
|
|
290
|
+
- Docker 基础镜像及版本(FROM 行,含 digest)
|
|
291
|
+
- K8s 部署的镜像标签(image: registry/...:tag)
|
|
292
|
+
- Terraform provider 及版本约束
|
|
293
|
+
- Terraform module 源和版本
|
|
294
|
+
- CI/CD 使用的 action / plugin 及版本
|
|
295
|
+
- Helm Chart 依赖(Chart.yaml dependencies)
|
|
296
|
+
- 服务间依赖(compose depends_on, K8s init containers, ArgoCD sync waves)
|
|
297
|
+
- Makefile / Taskfile 中的 target 依赖关系
|
|
298
|
+
|
|
299
|
+
## 环境管理分析
|
|
300
|
+
|
|
301
|
+
**扫描文件**: `envs/`, `environments/`, `*.env.example`, `terraform.tfvars`, `values-*.yaml`, `overlays/*/`
|
|
302
|
+
|
|
303
|
+
**提取内容**:
|
|
304
|
+
- 环境列表(development, staging, production)
|
|
305
|
+
- 每个环境的差异配置(副本数、资源限制、域名、数据库实例等)
|
|
306
|
+
- 环境变量管理方式(ConfigMap / Secret / .env / Vault)
|
|
307
|
+
- 配置覆盖策略(Kustomize overlay / Helm values / Terraform workspaces)
|
|
308
|
+
|
|
309
|
+
## 安全配置分析
|
|
310
|
+
|
|
311
|
+
**扫描文件**: `network-policy*.yaml`, `rbac*.yaml`, `pod-security*.yaml`, `vault/*.hcl`, `cert-manager/*.yaml`
|
|
312
|
+
|
|
313
|
+
**提取内容**:
|
|
314
|
+
- RBAC 角色(Role / ClusterRole + 绑定关系)
|
|
315
|
+
- Network Policy(入站/出站规则)
|
|
316
|
+
- Pod 安全标准(PSS / PSP)
|
|
317
|
+
- Secret 管理方式(K8s Secret / Vault / External Secrets Operator)
|
|
318
|
+
- TLS 配置(证书来源、过期策略)
|
|
319
|
+
|
|
320
|
+
## 输出模板
|
|
321
|
+
|
|
322
|
+
### README.md
|
|
323
|
+
|
|
324
|
+
```markdown
|
|
325
|
+
# {项目名称}
|
|
326
|
+
|
|
327
|
+
## 项目概述
|
|
328
|
+
基础设施项目描述、管理范围、覆盖的环境
|
|
329
|
+
|
|
330
|
+
## 架构总览
|
|
331
|
+
### 基础设施拓扑图(ASCII art)
|
|
332
|
+
展示 VPC → K8s Cluster → Services → Pods 的完整拓扑
|
|
333
|
+
|
|
334
|
+
### 环境架构图
|
|
335
|
+
development / staging / production 三环境的差异
|
|
336
|
+
|
|
337
|
+
## 目录结构
|
|
338
|
+
带注释的目录树
|
|
339
|
+
|
|
340
|
+
## 服务清单
|
|
341
|
+
| 服务名 | 类型 | 端口 | 健康检查 | 说明 |
|
|
342
|
+
|--------|------|------|----------|------|
|
|
343
|
+
|
|
344
|
+
## 环境变量
|
|
345
|
+
| 变量名 | 说明 | 示例值 | 必需 |
|
|
346
|
+
|--------|------|--------|------|
|
|
347
|
+
|
|
348
|
+
## 部署流程
|
|
349
|
+
从代码提交到生产部署的完整流程图
|
|
350
|
+
|
|
351
|
+
## 监控与告警
|
|
352
|
+
告警规则摘要 + Dashboard 链接
|
|
353
|
+
|
|
354
|
+
## 常用运维命令
|
|
355
|
+
部署、回滚、扩缩容、日志查看等命令
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### COMPONENT.md
|
|
359
|
+
|
|
360
|
+
```markdown
|
|
361
|
+
# 基础设施组件文档
|
|
362
|
+
|
|
363
|
+
## Docker 服务
|
|
364
|
+
### {服务名}
|
|
365
|
+
- **镜像**: ...
|
|
366
|
+
- **端口映射**: ...
|
|
367
|
+
- **环境变量**: ...
|
|
368
|
+
- **健康检查**: ...
|
|
369
|
+
- **构建参数**: ...
|
|
370
|
+
|
|
371
|
+
## Kubernetes 资源
|
|
372
|
+
### Deployments
|
|
373
|
+
### Services
|
|
374
|
+
### Ingress
|
|
375
|
+
### ConfigMaps / Secrets
|
|
376
|
+
|
|
377
|
+
## Terraform 资源
|
|
378
|
+
### {资源类型}
|
|
379
|
+
| 名称 | 关键参数 | 依赖 |
|
|
380
|
+
|------|----------|------|
|
|
381
|
+
|
|
382
|
+
## CI/CD Pipelines
|
|
383
|
+
### {流水线名}
|
|
384
|
+
- **触发条件**: ...
|
|
385
|
+
- **阶段**: ...
|
|
386
|
+
- **Secret 使用**: ...
|
|
387
|
+
|
|
388
|
+
## 监控配置
|
|
389
|
+
### Prometheus
|
|
390
|
+
### 告警规则
|
|
391
|
+
### Grafana Dashboards
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### UI_STYLE.md
|
|
395
|
+
|
|
396
|
+
对于 DevOps 项目,此文件记录运维可视化规范:
|
|
397
|
+
|
|
398
|
+
```markdown
|
|
399
|
+
# 运维可视化规范
|
|
400
|
+
|
|
401
|
+
## 监控 Dashboard 规范
|
|
402
|
+
- 图表类型选择标准
|
|
403
|
+
- 颜色编码(健康/警告/危险)
|
|
404
|
+
- 时间范围选择器默认值
|
|
405
|
+
|
|
406
|
+
## 告警通知规范
|
|
407
|
+
- 告警级别与通知渠道映射
|
|
408
|
+
- 告警消息格式模板
|
|
409
|
+
- 告警分组和抑制规则
|
|
410
|
+
|
|
411
|
+
## 日志规范
|
|
412
|
+
- 日志级别使用标准
|
|
413
|
+
- 结构化日志格式
|
|
414
|
+
- 日志保留策略
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
## 模块边界识别
|
|
418
|
+
|
|
419
|
+
以下目录模式下的每个子目录视为独立模块(L2+ 分析时生成 MODULE-DOC.md):
|
|
420
|
+
|
|
421
|
+
| 层 | 扫描路径 | 模块判定规则 | MODULE-DOC slug 来源 |
|
|
422
|
+
|----|----------|-------------|---------------------|
|
|
423
|
+
| Manifests 层 | `manifests/` | 每个子目录 | 目录名 kebab-case |
|
|
424
|
+
| Terraform 模块 | `terraform/modules/` | 每个子目录 | 目录名 kebab-case |
|
|
425
|
+
| CI/CD 层 | `.github/workflows/` | 每个文件 | 文件名去后缀 kebab-case |
|
|
426
|
+
| Helm Charts | `helm/` | 每个 chart | chart 名 kebab-case |
|
|
427
|
+
| 脚本层 | `scripts/` | 每个子目录或文件 | 名称 kebab-case |
|
|
428
|
+
|
|
429
|
+
**不视为独立模块的情况**:
|
|
430
|
+
- 单文件入口(如 `Makefile`, `docker-compose.yml`)
|
|
431
|
+
- 纯配置文件(`.env.example`, `*.tfvars.example`)
|
|
432
|
+
- Secret 文件(只记录键名,不记录值)
|
|
433
|
+
- `.tf.json` 与 `*.tf` 合并分析
|
|
434
|
+
|
|
435
|
+
## Token 管理
|
|
436
|
+
|
|
437
|
+
- 大型 YAML 文件(K8s manifest、Helm values)单独分析
|
|
438
|
+
- 每个子任务分析 <=10 个文件
|
|
439
|
+
- `values.yaml`(Helm)和 `*.tfvars`(Terraform)单独作为一个子任务
|
|
440
|
+
- 生成的清单文件(`helm template` 输出、`terraform plan` 输出)跳过
|
|
441
|
+
- `terraform.tfstate` 不分析(含敏感信息,仅记录 backend 类型)
|
|
442
|
+
- Secret 文件只记录键名,不记录值
|
|
443
|
+
- `.tf.json` 与 `*.tf` 合并分析
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# 通用项目分析规则
|
|
2
|
+
|
|
3
|
+
当无法识别具体技术栈或项目结构不遵循常见框架模式时使用此规则。作为所有规则文件的兜底。
|
|
4
|
+
|
|
5
|
+
## 分析粒度
|
|
6
|
+
|
|
7
|
+
按目录结构、文件类型和模块边界进行通用分析。
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
项目根目录
|
|
11
|
+
├── 配置文件(package.json, Makefile, Cargo.toml 等)
|
|
12
|
+
├── src/ 或 lib/(源码目录)
|
|
13
|
+
│ ├── 模块 A
|
|
14
|
+
│ ├── 模块 B
|
|
15
|
+
│ └── 公共代码
|
|
16
|
+
├── tests/ 或 test/(测试目录)
|
|
17
|
+
├── docs/(文档目录)
|
|
18
|
+
└── scripts/(脚本目录)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 目录扫描策略
|
|
22
|
+
|
|
23
|
+
### 1. 识别项目类型
|
|
24
|
+
|
|
25
|
+
**信号文件检测(按优先级):**
|
|
26
|
+
- `package.json` → Node.js / JavaScript 项目
|
|
27
|
+
- `pyproject.toml` / `requirements.txt` → Python 项目
|
|
28
|
+
- `go.mod` → Go 项目
|
|
29
|
+
- `Cargo.toml` → Rust 项目
|
|
30
|
+
- `pom.xml` / `build.gradle` → Java 项目
|
|
31
|
+
- `Gemfile` → Ruby 项目
|
|
32
|
+
- `composer.json` → PHP 项目
|
|
33
|
+
- `Makefile` / `CMakeLists.txt` → C/C++ 项目
|
|
34
|
+
- `build.gradle.kts` → Kotlin 项目
|
|
35
|
+
- `pubspec.yaml` → Dart/Flutter 项目
|
|
36
|
+
- 无信号文件 → 按目录结构推断
|
|
37
|
+
|
|
38
|
+
### 2. 排除非源码目录
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
node_modules/ vendor/ build/ dist/
|
|
42
|
+
.git/ __pycache__/ .cache/ target/
|
|
43
|
+
.idea/ .vscode/ .settings/ .DS_Store
|
|
44
|
+
.venv/ venv/ env/ oh_modules/
|
|
45
|
+
*.egg-info/ .eggs/ coverage/ .next/
|
|
46
|
+
out/ bin/ obj/ .gradle/
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 3. 按层扫描路径
|
|
50
|
+
|
|
51
|
+
- **入口**: `src/main.*`, `src/index.*`, `index.*`, `main.*`, `app.*`
|
|
52
|
+
- **公共代码**: `src/common/`, `src/shared/`, `src/core/`, `src/base/`
|
|
53
|
+
- **业务模块**: `src/modules/`, `src/features/`, `src/domain/`
|
|
54
|
+
- **工具**: `src/utils/`, `src/helpers/`, `src/lib/`, `src/internal/`
|
|
55
|
+
- **类型**: `src/types/`, `src/interfaces/`, `src/schemas/`
|
|
56
|
+
- **配置**: `src/config/`, `config/`, `conf/`
|
|
57
|
+
- **测试**: `tests/`, `test/`, `__tests__/`, `src/test/`
|
|
58
|
+
|
|
59
|
+
## 各层提取规则
|
|
60
|
+
|
|
61
|
+
### 层 1: 入口分析
|
|
62
|
+
|
|
63
|
+
**扫描文件**: 项目根目录下的入口文件
|
|
64
|
+
|
|
65
|
+
**提取内容**:
|
|
66
|
+
- 入口文件路径和语言
|
|
67
|
+
- 导入的模块列表
|
|
68
|
+
- 初始化逻辑摘要
|
|
69
|
+
- 暴露的公开 API
|
|
70
|
+
|
|
71
|
+
**输出示例**:
|
|
72
|
+
```
|
|
73
|
+
### 入口文件
|
|
74
|
+
- **文件**: `src/index.ts`
|
|
75
|
+
- **语言**: TypeScript
|
|
76
|
+
- **导入模块**: ./config, ./core/App, ./routes
|
|
77
|
+
- **公开 API**:
|
|
78
|
+
| 名称 | 类型 | 说明 |
|
|
79
|
+
|------|------|------|
|
|
80
|
+
| createApp | (config: AppConfig) => App | 创建应用实例 |
|
|
81
|
+
| version | string | 版本号 |
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 层 2: 模块发现
|
|
85
|
+
|
|
86
|
+
**扫描规则**:
|
|
87
|
+
- 递归扫描源码目录(最大深度 3 层)
|
|
88
|
+
- 每个包含 3+ 源码文件的目录视为一个功能模块
|
|
89
|
+
- `src/` 下的每个一级子目录为一个模块
|
|
90
|
+
- 单文件项目作为一个整体模块
|
|
91
|
+
|
|
92
|
+
**输出示例**:
|
|
93
|
+
```
|
|
94
|
+
### 模块列表
|
|
95
|
+
| 模块 | 路径 | 文件数 | 主要语言 | 职责描述 |
|
|
96
|
+
|------|------|--------|----------|----------|
|
|
97
|
+
| core | src/core/ | 12 | TypeScript | 核心逻辑和框架 |
|
|
98
|
+
| utils | src/utils/ | 8 | TypeScript | 工具函数集合 |
|
|
99
|
+
| api | src/api/ | 6 | TypeScript | 外部 API 封装 |
|
|
100
|
+
| models | src/models/ | 4 | TypeScript | 数据模型定义 |
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### 层 3: 核心类/函数分析
|
|
104
|
+
|
|
105
|
+
**扫描文件**: 每个模块内的主要源码文件
|
|
106
|
+
|
|
107
|
+
**提取内容**:
|
|
108
|
+
- 类/函数/接口名称
|
|
109
|
+
- 签名(参数 + 返回类型)
|
|
110
|
+
- 职责描述
|
|
111
|
+
- 依赖的其他模块
|
|
112
|
+
|
|
113
|
+
**输出示例**:
|
|
114
|
+
```
|
|
115
|
+
### 核心导出
|
|
116
|
+
- **文件**: `src/core/engine.ts`
|
|
117
|
+
- **导出**:
|
|
118
|
+
| 名称 | 类型 | 签名 | 说明 |
|
|
119
|
+
|------|------|------|------|
|
|
120
|
+
| Engine | Class | constructor(config: Config) | 核心引擎类 |
|
|
121
|
+
| process | Method | (input: Data): Promise<Result> | 处理数据 |
|
|
122
|
+
| validate | Function | (data: unknown): data is ValidData | 数据校验 |
|
|
123
|
+
- **依赖**: `src/config`, `src/utils/logger`, `src/models`
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 层 4: 依赖分析
|
|
127
|
+
|
|
128
|
+
**扫描文件**: 各种包管理器的依赖文件
|
|
129
|
+
|
|
130
|
+
**提取内容**:
|
|
131
|
+
- 依赖管理器类型和版本
|
|
132
|
+
- 运行时依赖列表(名称 + 版本)
|
|
133
|
+
- 开发依赖列表
|
|
134
|
+
- 对等依赖(peerDependencies)
|
|
135
|
+
|
|
136
|
+
**输出示例**:
|
|
137
|
+
```
|
|
138
|
+
### 依赖信息
|
|
139
|
+
- **管理器**: npm (package.json)
|
|
140
|
+
- **运行时依赖**:
|
|
141
|
+
| 包名 | 版本 | 用途 |
|
|
142
|
+
|------|------|------|
|
|
143
|
+
| express | 4.18.2 | Web 框架 |
|
|
144
|
+
| zod | 3.22.4 | 数据验证 |
|
|
145
|
+
| dayjs | 1.11.9 | 日期处理 |
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### 层 5: 构建与配置分析
|
|
149
|
+
|
|
150
|
+
**扫描文件**: 配置文件、构建脚本
|
|
151
|
+
|
|
152
|
+
**提取内容**:
|
|
153
|
+
- 构建命令(build、test、lint、dev)
|
|
154
|
+
- 环境变量配置
|
|
155
|
+
- 关键配置项
|
|
156
|
+
|
|
157
|
+
**输出示例**:
|
|
158
|
+
```
|
|
159
|
+
### 构建配置
|
|
160
|
+
- **构建工具**: TypeScript + tsx
|
|
161
|
+
- **脚本命令**:
|
|
162
|
+
| 命令 | 执行内容 | 说明 |
|
|
163
|
+
|------|----------|------|
|
|
164
|
+
| npm run dev | tsx watch src/index.ts | 开发模式 |
|
|
165
|
+
| npm run build | tsc && node build.js | 生产构建 |
|
|
166
|
+
| npm run test | vitest run | 运行测试 |
|
|
167
|
+
| npm run lint | eslint src/ --ext .ts | 代码检查 |
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## 输出模板
|
|
171
|
+
|
|
172
|
+
### README.md 章节结构
|
|
173
|
+
|
|
174
|
+
```markdown
|
|
175
|
+
# {项目名}
|
|
176
|
+
|
|
177
|
+
## 项目概述
|
|
178
|
+
项目功能描述(从 README 或配置文件 description 提取)
|
|
179
|
+
|
|
180
|
+
## 技术栈
|
|
181
|
+
| 技术 | 版本 | 用途 |
|
|
182
|
+
|------|------|------|
|
|
183
|
+
|
|
184
|
+
## 架构设计
|
|
185
|
+
### 架构图(ASCII)
|
|
186
|
+
展示模块关系的 ASCII 图
|
|
187
|
+
|
|
188
|
+
### 目录结构
|
|
189
|
+
带注释的文件树
|
|
190
|
+
|
|
191
|
+
## 模块说明
|
|
192
|
+
每个模块的职责、核心 API、依赖关系
|
|
193
|
+
|
|
194
|
+
## 构建 & 运行
|
|
195
|
+
构建命令、环境变量、运行方式
|
|
196
|
+
|
|
197
|
+
## 开发指南
|
|
198
|
+
如何修改/扩展项目
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### COMPONENT.md 章节结构
|
|
202
|
+
|
|
203
|
+
```markdown
|
|
204
|
+
# 模块文档
|
|
205
|
+
|
|
206
|
+
## 模块索引
|
|
207
|
+
按功能分组的模块列表
|
|
208
|
+
|
|
209
|
+
## 各模块详情
|
|
210
|
+
### {模块名}
|
|
211
|
+
- 路径 + 语言
|
|
212
|
+
- 公开 API 表格
|
|
213
|
+
- 依赖关系
|
|
214
|
+
- 使用示例
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## 模块边界识别
|
|
218
|
+
|
|
219
|
+
以下目录模式下的每个子目录视为独立模块(L2+ 分析时生成 MODULE-DOC.md):
|
|
220
|
+
|
|
221
|
+
| 层 | 扫描路径 | 模块判定规则 | MODULE-DOC slug 来源 |
|
|
222
|
+
|----|----------|-------------|---------------------|
|
|
223
|
+
| 源码层 | `src/` 一级子目录 | 3+ 文件的子目录 | 目录名 kebab-case |
|
|
224
|
+
| API/服务层 | `src/api/`, `src/services/` | 每个子目录 | 目录名 kebab-case |
|
|
225
|
+
| 状态管理层 | `src/store/`, `src/state/` | 每个子目录 | 目录名 kebab-case |
|
|
226
|
+
| 组件层 | `src/components/` | 3+ 文件的子目录 | 目录名 kebab-case |
|
|
227
|
+
| 自动推断 | 其他目录 | 3+ 源码文件 | 目录名 kebab-case |
|
|
228
|
+
|
|
229
|
+
**不视为独立模块的情况**:
|
|
230
|
+
- 单文件入口(如 `main.ts`, `index.js`, `app.py`)
|
|
231
|
+
- 纯导出桶文件(仅有 re-export)
|
|
232
|
+
- 工具函数目录(`utils/`, `helpers/`, `lib/`)— 合并为一个模块
|
|
233
|
+
- 生成文件(`*.generated.*`, `*.min.*`)跳过
|
|
234
|
+
|
|
235
|
+
## Token 管理
|
|
236
|
+
|
|
237
|
+
- 大目录(>20 文件)拆分为子任务
|
|
238
|
+
- 每个子任务分析 ≤10 文件
|
|
239
|
+
- 二进制文件、图片、压缩包跳过
|
|
240
|
+
- 超大文件(>100KB)跳过内容分析,只记录文件名和大小
|
|
241
|
+
- 生成文件(`*.generated.*`, `*.min.*`)跳过
|
|
242
|
+
- 测试文件单独分组分析
|
|
243
|
+
- 配置文件(JSON/YAML/TOML)单独分析
|