@ohos-cpf/3rdloop 0.0.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/README.md +425 -0
- package/bin/3rdloop.mjs +48 -0
- package/lib/cli.js +741 -0
- package/lib/config.js +318 -0
- package/lib/doctor.js +114 -0
- package/lib/exit-codes.js +31 -0
- package/lib/opencode.js +156 -0
- package/lib/orch.js +427 -0
- package/lib/queries.js +264 -0
- package/lib/runner.js +979 -0
- package/lib/step.js +326 -0
- package/lib/ui.js +223 -0
- package/lib/workflow.js +291 -0
- package/lib/workflows.js +132 -0
- package/package.json +50 -0
- package/vendor/Server/Agent/SkillSelector/README.md +344 -0
- package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -0
- package/vendor/Server/Agent/SkillSelector/index.js +14 -0
- package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -0
- package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -0
- package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -0
- package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -0
- package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -0
- package/vendor/Server/Agent/SkillSelector/types.js +63 -0
- package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +60 -0
- package/vendor/Server/Brain/AnalysisStrategies.js +422 -0
- package/vendor/Server/Brain/Brain.js +686 -0
- package/vendor/Server/Brain/DecompositionStrategies.js +621 -0
- package/vendor/Server/Brain/PlanPersistence.js +196 -0
- package/vendor/Server/Brain/SkillExecutor.js +251 -0
- package/vendor/Server/Brain/index.js +11 -0
- package/vendor/Server/CLI/cli.js +243 -0
- package/vendor/Server/CLI/opencode/index.js +804 -0
- package/vendor/Server/CLI/opencode.js +5 -0
- package/vendor/Server/DbUse/MessageArchive.js +61 -0
- package/vendor/Server/DbUse/StorageManager.js +107 -0
- package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -0
- package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -0
- package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -0
- package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -0
- package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -0
- package/vendor/Server/DbUse/index.js +160 -0
- package/vendor/Server/DbUse/stores/SessionStore.js +279 -0
- package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -0
- package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -0
- package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -0
- package/vendor/Server/FlexRunner/FlexRunner.js +1759 -0
- package/vendor/Server/FlexRunner/index.js +12 -0
- package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -0
- package/vendor/Server/Knowledge/KnowledgeManager.js +341 -0
- package/vendor/Server/Knowledge/index.js +33 -0
- package/vendor/Server/LoopEngine/LoopEngine.js +1133 -0
- package/vendor/Server/LoopEngine/index.js +11 -0
- package/vendor/Server/Orchestrator/Orchestrator.js +1425 -0
- package/vendor/Server/Orchestrator/StepNode.js +312 -0
- package/vendor/Server/Orchestrator/index.js +13 -0
- package/vendor/Server/Routes/controllers/BrainController.js +241 -0
- package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -0
- package/vendor/Server/Routes/controllers/HealthController.js +44 -0
- package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -0
- package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -0
- package/vendor/Server/Routes/controllers/OrchestratorController.js +911 -0
- package/vendor/Server/Routes/controllers/StatsController.js +57 -0
- package/vendor/Server/Routes/controllers/StreamController.js +67 -0
- package/vendor/Server/Routes/library/logger.js +179 -0
- package/vendor/Server/Routes/library/zipArchive.js +172 -0
- package/vendor/Server/Routes/router/Router.js +204 -0
- package/vendor/Server/Routes/routes/brain.js +47 -0
- package/vendor/Server/Routes/routes/flexrunner.js +72 -0
- package/vendor/Server/Routes/routes/health.js +28 -0
- package/vendor/Server/Routes/routes/index.js +57 -0
- package/vendor/Server/Routes/routes/knowledge.js +55 -0
- package/vendor/Server/Routes/routes/loopengine.js +58 -0
- package/vendor/Server/Routes/routes/orchestrator.js +61 -0
- package/vendor/Server/Routes/routes/registry.js +98 -0
- package/vendor/Server/Routes/routes/stats.js +23 -0
- package/vendor/Server/Routes/routes/stream.js +30 -0
- package/vendor/Server/Routes/server.js +202 -0
- package/vendor/Server/Routes/sse/SseHub.js +308 -0
- package/vendor/Server/Skills/acceptance-check/SKILL.md +174 -0
- package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -0
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -0
- package/vendor/Server/Skills/arkts-code-check/SKILL.md +314 -0
- package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +160 -0
- package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +29 -0
- package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +222 -0
- package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +220 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +329 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +99 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +234 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +103 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +108 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -0
- package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +392 -0
- package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -0
- package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +313 -0
- package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +166 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +309 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -0
- package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +361 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +146 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +253 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +115 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +263 -0
- package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -0
- package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +519 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +93 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -0
- package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +229 -0
- package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +576 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +575 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +491 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -0
- package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +312 -0
- package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -0
- package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +134 -0
- package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/flutter-interface/README.md +75 -0
- package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -0
- package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -0
- package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -0
- package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -0
- package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +518 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +382 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +342 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -0
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +519 -0
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +407 -0
- package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +653 -0
- package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +397 -0
- package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +745 -0
- package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +721 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -0
- package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -0
- package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -0
- package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -0
- package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +301 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +105 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +127 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +208 -0
- package/vendor/Server/Skills/rn-code-check/SKILL.md +321 -0
- package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +235 -0
- package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +189 -0
- package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +247 -0
- package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -0
- package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -0
- package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -0
- package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -0
- package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -0
- package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +684 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -0
- package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +58 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +75 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +339 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +83 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +859 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +122 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +279 -0
- package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -0
- package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -0
- package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -0
- package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -0
- package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +506 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +280 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +209 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +498 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -0
- package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -0
- package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +255 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +77 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +174 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +137 -0
- package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -0
- package/vendor/Server/Skills/skill-generator/SKILL.md +365 -0
- package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -0
- package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -0
- package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -0
- package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -0
- package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -0
- package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/task-analysis/SKILL.md +234 -0
- package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -0
- package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -0
- package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -0
- package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -0
- package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -0
- package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -0
- package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -0
- package/vendor/Server/Skills/task-decomposition/SKILL.md +529 -0
- package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -0
- package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -0
- package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -0
- package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -0
- package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -0
- package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -0
- package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -0
- package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +425 -0
- package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -0
- package/vendor/Server/TestCheck/TestCheck.js +775 -0
- package/vendor/Server/TestCheck/index.js +11 -0
- package/vendor/Server/library/McpToolGuide.js +280 -0
- package/vendor/Server/library/StatsService.js +127 -0
- package/vendor/Server/library/cstTime.js +16 -0
- package/vendor/Server/package.json +17 -0
- package/vendor/VERSION +3 -0
- package/workflows/pr-check.mjs +106 -0
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# Git Clone 指南
|
|
2
|
+
|
|
3
|
+
本文档详细说明从远程 Git 仓库克隆代码的 URL 解析规则和操作步骤。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## URL 格式解析规则
|
|
8
|
+
|
|
9
|
+
支持从 Web 页面 URL 直接复制使用,自动解析以下格式:
|
|
10
|
+
|
|
11
|
+
### 格式 1:仅分支
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
https://gitcode.com/openharmony-sig/flutter_inappwebview/tree/br_v6.1.5_ohos_dev
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
解析为:
|
|
18
|
+
- 仓库地址:`https://gitcode.com/openharmony-sig/flutter_inappwebview.git`
|
|
19
|
+
- 分支:`br_v6.1.5_ohos_dev`
|
|
20
|
+
- 子路径:无(分析整个仓库)
|
|
21
|
+
|
|
22
|
+
### 格式 2:分支 + 子路径
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
https://gitcode.com/openharmony-sig/kmptpc_compose_sample/tree/cmp192_for_ohos/harmonyApp
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
解析为:
|
|
29
|
+
- 仓库地址:`https://gitcode.com/openharmony-sig/kmptpc_compose_sample.git`
|
|
30
|
+
- 分支:`cmp192_for_ohos`
|
|
31
|
+
- 子路径:`harmonyApp`(只分析这个文件夹)
|
|
32
|
+
|
|
33
|
+
### 格式 3:标准 Git URL(支持扩展参数)
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
https://github.com/org/repo.git#branch=develop
|
|
37
|
+
https://github.com/org/repo.git#subpath=packages/core
|
|
38
|
+
https://github.com/org/repo.git#branch=develop&subpath=packages/core
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 解析步骤
|
|
44
|
+
|
|
45
|
+
### 1. 提取仓库基础 URL
|
|
46
|
+
|
|
47
|
+
- 如果 URL 包含 `/tree/`,提取 `https://域名/组织/仓库` 部分
|
|
48
|
+
- 添加 `.git` 后缀(如果尚未包含)
|
|
49
|
+
|
|
50
|
+
示例:
|
|
51
|
+
- `https://gitcode.com/org/repo/tree/branch` → `https://gitcode.com/org/repo.git`
|
|
52
|
+
- `https://gitcode.com/org/repo/tree/branch/subpath` → `https://gitcode.com/org/repo.git`
|
|
53
|
+
|
|
54
|
+
### 2. 提取分支名称
|
|
55
|
+
|
|
56
|
+
从 `/tree/` 后的第一个路径段提取分支名:
|
|
57
|
+
- `/tree/br_v6.1.5_ohos_dev` → 分支:`br_v6.1.5_ohos_dev`
|
|
58
|
+
- `/tree/cmp192_for_ohos/harmonyApp` → 分支:`cmp192_for_ohos`
|
|
59
|
+
|
|
60
|
+
### 3. 提取子路径
|
|
61
|
+
|
|
62
|
+
从分支名称后的路径段提取子路径(如果有):
|
|
63
|
+
- `/tree/cmp192_for_ohos/harmonyApp` → 子路径:`harmonyApp`
|
|
64
|
+
- `/tree/main/packages/core` → 子路径:`packages/core`
|
|
65
|
+
|
|
66
|
+
### 4. 解析标准 Git URL 参数
|
|
67
|
+
|
|
68
|
+
如果 URL 包含 `#branch=` 或 `#subpath=` 参数,提取对应值:
|
|
69
|
+
- `repo.git#branch=develop` → 分支:`develop`
|
|
70
|
+
- `repo.git#branch=develop&subpath=packages/core` → 分支:`develop`,子路径:`packages/core`
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 克隆操作
|
|
75
|
+
|
|
76
|
+
### 检查 Git 环境
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
git --version
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
确认 Git 已安装且版本 ≥ 2.25.0(支持 Sparse Checkout)。
|
|
83
|
+
|
|
84
|
+
### 情况 A:无子路径(完整克隆)
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# 克隆整个仓库
|
|
88
|
+
git clone <baseUrl> <outputDir>/source
|
|
89
|
+
|
|
90
|
+
# 切换到指定分支(如果有)
|
|
91
|
+
cd <outputDir>/source
|
|
92
|
+
git checkout <branch>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### 情况 B:有子路径(稀疏检出 - Sparse Checkout)
|
|
96
|
+
|
|
97
|
+
> 优势:只下载指定文件夹,节省时间和磁盘空间
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
# 1. 初始化空仓库
|
|
101
|
+
mkdir -p <outputDir>/source
|
|
102
|
+
cd <outputDir>/source
|
|
103
|
+
git init
|
|
104
|
+
|
|
105
|
+
# 2. 启用稀疏检出
|
|
106
|
+
git sparse-checkout init --cone
|
|
107
|
+
|
|
108
|
+
# 3. 设置远程仓库
|
|
109
|
+
git remote add origin <baseUrl>
|
|
110
|
+
|
|
111
|
+
# 4. 指定要检出的子路径
|
|
112
|
+
git sparse-checkout set <subpath>
|
|
113
|
+
|
|
114
|
+
# 5. 拉取指定分支的代码
|
|
115
|
+
git fetch origin <branch> --depth=1
|
|
116
|
+
|
|
117
|
+
# 6. 检出代码
|
|
118
|
+
git checkout <branch>
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 示例
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# 示例:只克隆 harmonyApp 文件夹
|
|
125
|
+
mkdir -p /tmp/analysis/kmptpc/source
|
|
126
|
+
cd /tmp/analysis/kmptpc/source
|
|
127
|
+
git init
|
|
128
|
+
git sparse-checkout init --cone
|
|
129
|
+
git remote add origin https://gitcode.com/openharmony-sig/kmptpc_compose_sample.git
|
|
130
|
+
git sparse-checkout set harmonyApp
|
|
131
|
+
git fetch origin cmp192_for_ohos --depth=1
|
|
132
|
+
git checkout cmp192_for_ohos
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## 验证克隆结果
|
|
138
|
+
|
|
139
|
+
检查 `<outputDir>/source` 目录:
|
|
140
|
+
- 如果有子路径,检查 `<outputDir>/source/<subpath>` 是否存在
|
|
141
|
+
- 确认目录包含源代码文件(`.dart`、`.ets`、`.ts`、`.js` 等)
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 记录克隆信息
|
|
146
|
+
|
|
147
|
+
将以下信息写入 `<outputDir>/clone-info.json`:
|
|
148
|
+
|
|
149
|
+
```json
|
|
150
|
+
{
|
|
151
|
+
"baseUrl": "https://gitcode.com/openharmony-sig/kmptpc_compose_sample.git",
|
|
152
|
+
"branch": "cmp192_for_ohos",
|
|
153
|
+
"subpath": "harmonyApp",
|
|
154
|
+
"sparseCheckout": true,
|
|
155
|
+
"cloneTime": "2026-05-09T10:30:00Z",
|
|
156
|
+
"commitHash": "abc123def456",
|
|
157
|
+
"originalUrl": "https://gitcode.com/openharmony-sig/kmptpc_compose_sample/tree/cmp192_for_ohos/harmonyApp"
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 确定最终分析路径
|
|
164
|
+
|
|
165
|
+
- 如果有子路径:`analysisRoot = <outputDir>/source/<subpath>`
|
|
166
|
+
- 如果无子路径:`analysisRoot = <outputDir>/source`
|
|
167
|
+
|
|
168
|
+
后续 Phase 2 的脚本提取基于 `analysisRoot` 目录进行。
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## 克隆失败处理
|
|
173
|
+
|
|
174
|
+
| 错误类型 | 可能原因 | 解决方案 |
|
|
175
|
+
|----------|----------|----------|
|
|
176
|
+
| 认证失败 | 私有仓库或权限不足 | 提示用户配置 SSH 密钥或 HTTPS Token |
|
|
177
|
+
| 分支不存在 | 分支名称错误 | 列出远程分支:`git branch -r`,提示用户选择正确分支 |
|
|
178
|
+
| 子路径不存在 | 路径错误或分支中无此目录 | 列出仓库根目录内容,提示用户确认路径 |
|
|
179
|
+
| 网络超时 | 网络问题 | 提示用户检查网络或使用镜像站点 |
|
|
180
|
+
| Sparse Checkout 失败 | Git 版本过低 | 提示升级 Git 到 2.25+ 或使用完整克隆 |
|
|
181
|
+
|
|
182
|
+
### 旧版本 Git 替代方案
|
|
183
|
+
|
|
184
|
+
如果 Git 版本 < 2.25,使用以下替代方案:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
git config core.sparseCheckout true
|
|
188
|
+
echo "<subpath>/*" >> .git/info/sparse-checkout
|
|
189
|
+
git pull origin <branch>
|
|
190
|
+
```
|
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
# 脚本使用参考
|
|
2
|
+
|
|
3
|
+
本文档详细说明 `flutter-extract-interfaces.cjs` 和 `flutter-render-spec-doc.cjs` 两个共享脚本(位于仓库 `MCP/scripts/` 目录,本 SKILL 通过相对路径 `{{skillDir}}/../../../MCP/scripts/` 引用,不保存副本)的参数、输出格式和故障排查。
|
|
4
|
+
|
|
5
|
+
> `{{skillDir}}` = 本 SKILL 的 SKILL.md 所在目录(任务 prompt 中“SKILL 目录”下发的绝对路径)。
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## flutter-extract-interfaces.cjs
|
|
10
|
+
|
|
11
|
+
### 功能
|
|
12
|
+
|
|
13
|
+
从 Flutter 三方库源码目录提取接口规格。基于 Dart 正则解析,提取类/枚举/mixin/extension/函数/变量的公开接口,输出 JSON。
|
|
14
|
+
|
|
15
|
+
### 脚本核心策略
|
|
16
|
+
|
|
17
|
+
1. `pubspec.yaml` → 包名 → `lib/<package>.dart` 入口定位
|
|
18
|
+
2. export 链递归追踪(`src/` 相对路径 + `package:` 跨包路径)
|
|
19
|
+
3. export hide/show 过滤
|
|
20
|
+
4. 预处理移除字符串/注释(保留行号),大括号块匹配提取类体
|
|
21
|
+
5. 正则解析类/枚举/mixin/extension 成员 + 顶层函数/变量/typedef
|
|
22
|
+
6. `///` 文档注释提取
|
|
23
|
+
7. `_` 前缀私有成员过滤
|
|
24
|
+
8. monorepo 多子包支持
|
|
25
|
+
|
|
26
|
+
### 用法
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# CLI 模式
|
|
30
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir <库源码目录> --output <interface-spec.json>
|
|
31
|
+
|
|
32
|
+
# 不指定 output 则输出 JSON 到 stdout
|
|
33
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir /path/to/flutter_lib
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 参数
|
|
37
|
+
|
|
38
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
39
|
+
|------|------|------|------|
|
|
40
|
+
| `--repoDir` | string | ✅ | 库源码根目录路径(包含 `lib/` 子目录和 `pubspec.yaml`) |
|
|
41
|
+
| `--output` | string | ❌ | 输出 JSON 文件路径(不指定则输出到 stdout) |
|
|
42
|
+
|
|
43
|
+
> `--libroot` 是 `--repoDir` 的别名,两者等价。
|
|
44
|
+
|
|
45
|
+
### 库源码目录结构约定
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
/path/to/lib/
|
|
49
|
+
├── <package>.dart ← 入口文件
|
|
50
|
+
├── src/ ← 库源码
|
|
51
|
+
└── constants.dart
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**monorepo(如 flutter_inappwebview)**:
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
/path/to/flutter_inappwebview/
|
|
58
|
+
├── flutter_inappwebview/ ← 主包
|
|
59
|
+
│ ├── lib/
|
|
60
|
+
│ └── pubspec.yaml
|
|
61
|
+
└── flutter_inappwebview_platform_interface/
|
|
62
|
+
└── lib/
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
脚本自动检测 monorepo 结构并定位主包。
|
|
66
|
+
|
|
67
|
+
### 输出 JSON 结构
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"libraryName": "包名",
|
|
72
|
+
"entryFile": "./lib/xxx.dart",
|
|
73
|
+
"nativeDPath": null,
|
|
74
|
+
"extractedAt": "2026-08-15T12:00:00.000Z",
|
|
75
|
+
"summary": {
|
|
76
|
+
"S": 10, // 类/接口/枚举总数
|
|
77
|
+
"N": 50, // 方法/属性/字段总数
|
|
78
|
+
"M": 0,
|
|
79
|
+
"methods": 30,
|
|
80
|
+
"properties": 10,
|
|
81
|
+
"fields": 5,
|
|
82
|
+
"constants": 5
|
|
83
|
+
},
|
|
84
|
+
"sources": [
|
|
85
|
+
"./lib/xxx.dart",
|
|
86
|
+
"./lib/src/yyy.dart"
|
|
87
|
+
],
|
|
88
|
+
"interfaces": [
|
|
89
|
+
{
|
|
90
|
+
"className": "ClassName",
|
|
91
|
+
"memberName": "methodName",
|
|
92
|
+
"fullName": "ClassName.methodName",
|
|
93
|
+
"kind": "method",
|
|
94
|
+
"isStatic": false,
|
|
95
|
+
"isReadonly": false,
|
|
96
|
+
"isOptional": false,
|
|
97
|
+
"isEvent": false,
|
|
98
|
+
"type": "class",
|
|
99
|
+
"signature": "ReturnType methodName(params)",
|
|
100
|
+
"params": [
|
|
101
|
+
{
|
|
102
|
+
"name": "paramName",
|
|
103
|
+
"type": "String",
|
|
104
|
+
"optional": false,
|
|
105
|
+
"description": "-"
|
|
106
|
+
}
|
|
107
|
+
],
|
|
108
|
+
"returnType": "void",
|
|
109
|
+
"description": "/// 文档注释内容",
|
|
110
|
+
"source": "./lib/src/xxx.dart",
|
|
111
|
+
"startLine": 42
|
|
112
|
+
}
|
|
113
|
+
]
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### 接口 kind 分类
|
|
118
|
+
|
|
119
|
+
| kind | 说明 | 对应 Dart 语法 |
|
|
120
|
+
|------|------|----------------|
|
|
121
|
+
| `method` | 类方法 | `ReturnType methodName(params) { }` |
|
|
122
|
+
| `property` | getter 属性 | `ReturnType get name` |
|
|
123
|
+
| `field` | 类字段 | `final Type field` 或 `Type field` |
|
|
124
|
+
| `constant` | 常量 | `const Type name` |
|
|
125
|
+
| `constructor` | 构造函数 | `ClassName(params)` 或 `factory ClassName.name(params)` |
|
|
126
|
+
| `enumValue` | 枚举值 | `enum Name { value1, value2 }` |
|
|
127
|
+
| `function` | 顶层函数 | `ReturnType functionName(params)` |
|
|
128
|
+
| `variable` | 顶层变量 | `var name = value` |
|
|
129
|
+
| `type` | 类型别名 | `typedef Name = Type` |
|
|
130
|
+
|
|
131
|
+
### 接口 type 分类(声明类型)
|
|
132
|
+
|
|
133
|
+
| type | 说明 |
|
|
134
|
+
|------|------|
|
|
135
|
+
| `class` | 普通类 |
|
|
136
|
+
| `abstract_class` | 抽象类 |
|
|
137
|
+
| `mixin` | mixin 声明 |
|
|
138
|
+
| `mixin_class` | mixin class(Dart 3) |
|
|
139
|
+
| `enum` | 枚举 |
|
|
140
|
+
| `extension` | 扩展 |
|
|
141
|
+
| `function` | 顶层函数 |
|
|
142
|
+
| `variable` | 顶层变量 |
|
|
143
|
+
| `typedef` | 类型别名 |
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## flutter-render-spec-doc.cjs
|
|
148
|
+
|
|
149
|
+
### 功能
|
|
150
|
+
|
|
151
|
+
将接口规格 JSON 渲染为 Markdown 格式的接口规格说明书文档。
|
|
152
|
+
|
|
153
|
+
### 用法
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
# 方式一:读 JSON 中间件(推荐,可复用 JSON)
|
|
157
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec <interface-spec.json> --output <spec.md>
|
|
158
|
+
|
|
159
|
+
# 方式二:直接从源码提取并渲染(一步到位)
|
|
160
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --libroot <库源码目录> --output <spec.md>
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### 参数
|
|
164
|
+
|
|
165
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
166
|
+
|------|------|------|------|
|
|
167
|
+
| `--spec` | string | 二选一 | 已有的 `interface-spec.json` 路径 |
|
|
168
|
+
| `--libroot` | string | 二选一 | 库源码根目录路径(直接从源码提取) |
|
|
169
|
+
| `--output` | string | ❌ | 输出 Markdown 文件路径(不指定则输出到 stdout) |
|
|
170
|
+
|
|
171
|
+
> `--repoDir` 是 `--libroot` 的别名,两者等价。
|
|
172
|
+
|
|
173
|
+
### 生成的文档结构
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
# [库名] 接口规格说明书
|
|
177
|
+
|
|
178
|
+
## 基本信息(库名、入口文件、生成时间、源文件数)
|
|
179
|
+
## 接口统计(类数、方法数、属性数等)
|
|
180
|
+
## 1. [类名](每个类/枚举/mixin 一个章节)
|
|
181
|
+
### 构造函数(表格)
|
|
182
|
+
### 方法(表格:方法名、事件、静态、参数、返回类型、说明)
|
|
183
|
+
### 属性(表格)
|
|
184
|
+
### 字段(表格)
|
|
185
|
+
### 常量(表格)
|
|
186
|
+
### 枚举值(表格)
|
|
187
|
+
### 函数(表格)
|
|
188
|
+
### 变量/常量(表格)
|
|
189
|
+
### 类型别名(表格)
|
|
190
|
+
### 事件方法汇总(表格)
|
|
191
|
+
## 2. [下一个类名]
|
|
192
|
+
...
|
|
193
|
+
## 源文件列表
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## 模块化调用(编程方式)
|
|
199
|
+
|
|
200
|
+
两个脚本也可作为 Node.js 模块 `require` 使用:
|
|
201
|
+
|
|
202
|
+
```javascript
|
|
203
|
+
// 提取接口
|
|
204
|
+
const { generateSpec } = require('./flutter-extract-interfaces.cjs');
|
|
205
|
+
const spec = generateSpec('/path/to/flutter_lib');
|
|
206
|
+
// spec 是 JSON 对象,可直接使用或写入文件
|
|
207
|
+
|
|
208
|
+
// 渲染文档需要通过 CLI 调用
|
|
209
|
+
// 或自行实现渲染逻辑
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## 故障排查
|
|
215
|
+
|
|
216
|
+
### 提取结果为空(interfaces 数组为空)
|
|
217
|
+
|
|
218
|
+
| 可能原因 | 排查方法 | 解决方案 |
|
|
219
|
+
|----------|----------|----------|
|
|
220
|
+
| 入口文件未找到 | 检查 `lib/<package>.dart` 是否存在 | 确认 `pubspec.yaml` 的 `name` 字段与入口文件名匹配 |
|
|
221
|
+
| 源文件无 export | 检查入口文件是否使用 `export` 语句导出 | 脚本同时收集 `lib/` 下所有 `.dart` 文件作为 fallback |
|
|
222
|
+
| 所有成员都是私有 | 检查成员是否以 `_` 开头 | 私有成员被自动过滤,属于正常行为 |
|
|
223
|
+
| 目录结构异常 | 检查 `analysisRoot` 是否正确 | 确认路径指向包含 `lib/` 的目录 |
|
|
224
|
+
|
|
225
|
+
### monorepo 主包定位错误
|
|
226
|
+
|
|
227
|
+
脚本自动检测 monorepo 主包,优先级:
|
|
228
|
+
1. 与根目录名完全匹配的子目录
|
|
229
|
+
2. 去掉 `fluttertpc_` 前缀后匹配的子目录
|
|
230
|
+
3. 排除 `platform_interface`/`_android`/`_ios` 等辅助包后按名称排序的第一个
|
|
231
|
+
|
|
232
|
+
如果定位错误,可手动指定主包路径直接传入:
|
|
233
|
+
```bash
|
|
234
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir /path/to/monorepo/main_package
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### export 链追踪不完整
|
|
238
|
+
|
|
239
|
+
脚本递归追踪 `export` 语句,但以下情况可能遗漏:
|
|
240
|
+
- 动态 export(条件 export)
|
|
241
|
+
- 通过 `part`/`part of` 拆分的文件(已支持但可能有边缘情况)
|
|
242
|
+
|
|
243
|
+
排查方法:检查输出 JSON 的 `sources` 数组,确认关键源文件是否被包含。
|
|
244
|
+
|
|
245
|
+
### 文档注释未提取
|
|
246
|
+
|
|
247
|
+
脚本提取 `///` 格式的文档注释。以下格式不被提取:
|
|
248
|
+
- `//` 单行注释(非文档注释)
|
|
249
|
+
- `/* */` 块注释(非文档注释)
|
|
250
|
+
- `/** */` JSDoc 风格(仅提取紧邻声明上方的 `*` 行)
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
## 性能说明
|
|
255
|
+
|
|
256
|
+
- 脚本基于正则解析,不依赖 Dart SDK 或 analyzer,适合 CI/CD 环境
|
|
257
|
+
- 大型库(如 `flutter_inappwebview`,数百个源文件)提取时间通常 < 5 秒
|
|
258
|
+
- 内存占用与源文件总大小成正比,无特殊内存优化需求
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
# Library Interface Analyzer - 文档模板
|
|
2
|
+
|
|
3
|
+
本模板可用于手动创建接口规格说明文档。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# [库名]接口规格说明
|
|
8
|
+
|
|
9
|
+
## 1. 三方库概述
|
|
10
|
+
|
|
11
|
+
[在此填写库的功能介绍,包括主要特性、适用场景等,3-5 句话即可]
|
|
12
|
+
|
|
13
|
+
示例:
|
|
14
|
+
> XXX 是一个轻量级的 JavaScript 工具库,提供了常用的字符串、数组和对象操作函数。它支持 ES6+ 语法,可在浏览器和 Node.js 环境中使用。主要特性包括:链式调用、按需引入、零依赖。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 2. 对外导出的类
|
|
19
|
+
|
|
20
|
+
> 如果没有导出类,可以省略此章节
|
|
21
|
+
|
|
22
|
+
### 2.1 [类名1]
|
|
23
|
+
|
|
24
|
+
| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
|
|
25
|
+
|------|-----------|-----------|----------|
|
|
26
|
+
| 1 | [类名1] | constructor([参数列表]) | [构造函数的功能描述] |
|
|
27
|
+
| 2 | | [方法名1]([参数列表]): [返回值类型] | [方法的功能描述] |
|
|
28
|
+
| 3 | | [方法名2]([参数列表]): [返回值类型] | [方法的功能描述] |
|
|
29
|
+
| 4 | | [属性名1]: [属性类型] | [属性的功能描述] |
|
|
30
|
+
| 5 | | [属性名2]: [属性类型] | [属性的功能描述] |
|
|
31
|
+
|
|
32
|
+
### 2.2 [类名2]
|
|
33
|
+
|
|
34
|
+
| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
|
|
35
|
+
|------|-----------|-----------|----------|
|
|
36
|
+
| 1 | [类名2] | constructor([参数列表]) | [构造函数的功能描述] |
|
|
37
|
+
| ... | ... | ... | ... |
|
|
38
|
+
|
|
39
|
+
> 如果有更多类,继续添加表格
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 3. 对外导出的接口/类型(TypeScript)
|
|
44
|
+
|
|
45
|
+
> 仅 TypeScript 库适用;如果没有导出接口/类型,可以省略此章节
|
|
46
|
+
|
|
47
|
+
### 3.1 [接口名1]
|
|
48
|
+
|
|
49
|
+
| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
|
|
50
|
+
|------|------------|------|------|------|------|
|
|
51
|
+
| 1 | [接口名1] | [字段名1] | [类型] | 是 | [字段描述] |
|
|
52
|
+
| 2 | | [字段名2?] | [类型] | 否 | [可选字段描述] |
|
|
53
|
+
| ... | ... | ... | ... | ... | ... |
|
|
54
|
+
|
|
55
|
+
### 3.2 [类型别名1]
|
|
56
|
+
|
|
57
|
+
> `type` 别名可直接描述其等价类型
|
|
58
|
+
|
|
59
|
+
| 序号 | 类型名 | 等价类型 | 功能描述 |
|
|
60
|
+
|------|--------|----------|----------|
|
|
61
|
+
| 1 | [类型名1] | [等价类型] | [类型的功能描述] |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 4. 对外导出的枚举
|
|
66
|
+
|
|
67
|
+
> 如果没有导出枚举,可以省略此章节
|
|
68
|
+
|
|
69
|
+
| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
|
|
70
|
+
|------|----------|--------|-----|----------|
|
|
71
|
+
| 1 | [枚举名1] | [成员名1] | [值] | [枚举整体描述] |
|
|
72
|
+
| 2 | | [成员名2] | [值] | [成员描述] |
|
|
73
|
+
| 3 | [枚举名2] | [成员名1] | [值] | [枚举整体描述] |
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 5. 对外导出的函数
|
|
78
|
+
|
|
79
|
+
> 如果没有导出函数,可以省略此章节
|
|
80
|
+
|
|
81
|
+
| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
|
|
82
|
+
|------|----------|--------|----------|----------|
|
|
83
|
+
| 1 | [函数名1] | [返回值类型] | [参数1: 类型1, 参数2: 类型2, ...] | [函数的功能描述] |
|
|
84
|
+
| 2 | [函数名2] | [返回值类型] | [参数列表] | [函数的功能描述] |
|
|
85
|
+
| 3 | [函数名3] | [返回值类型] | [参数列表] | [函数的功能描述] |
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 6. 对外导出的变量
|
|
90
|
+
|
|
91
|
+
> 如果没有导出变量,可以省略此章节
|
|
92
|
+
|
|
93
|
+
| 序号 | 变量名称 | 变量类型 | 功能描述 |
|
|
94
|
+
|------|----------|----------|----------|
|
|
95
|
+
| 1 | [变量名1] | [变量类型] | [变量的功能描述] |
|
|
96
|
+
| 2 | [变量名2] | [变量类型] | [变量的功能描述] |
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 7. 注意事项
|
|
101
|
+
|
|
102
|
+
> 如果没有特殊注意事项,可以省略此章节
|
|
103
|
+
|
|
104
|
+
- [注意事项1:例如使用限制、兼容性问题等]
|
|
105
|
+
- [注意事项2:例如依赖的环境、需要的配置等]
|
|
106
|
+
- [注意事项3:例如性能考虑、已知问题等]
|
|
107
|
+
|
|
108
|
+
示例:
|
|
109
|
+
- 本库依赖 ES6+ 环境,不支持 IE11 及更早版本
|
|
110
|
+
- 部分函数使用了 Node.js 内置模块,不能在浏览器环境中使用
|
|
111
|
+
- 深拷贝函数不支持循环引用的对象
|
|
112
|
+
- 异步函数均返回 Promise,需要注意错误处理
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## 填写说明
|
|
117
|
+
|
|
118
|
+
### 类(Classes)
|
|
119
|
+
每个类一个表格,包含:
|
|
120
|
+
- **构造函数**: 第一行,展示如何创建实例
|
|
121
|
+
- **方法**: 按重要性排序,包含参数和返回值类型;**静态方法需标注 `static`**
|
|
122
|
+
- **属性**: 公开可访问的属性;`private`/`protected` 成员不包含
|
|
123
|
+
|
|
124
|
+
**示例**:
|
|
125
|
+
```
|
|
126
|
+
| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
|
|
127
|
+
|------|-----------|-----------|----------|
|
|
128
|
+
| 1 | HttpClient | constructor(baseURL: string, timeout?: number) | 创建 HTTP 客户端实例 |
|
|
129
|
+
| 2 | | get(url: string, options?: RequestOptions): Promise<Response> | 发送 GET 请求 |
|
|
130
|
+
| 3 | | static create(baseURL: string): HttpClient | 静态工厂方法 |
|
|
131
|
+
| 4 | | timeout: number | 请求超时时间(毫秒) |
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 接口/类型(Interfaces/Types)
|
|
135
|
+
导出的 `interface` 或 `type` 别名:
|
|
136
|
+
- **必填字段**: 无 `?` 修饰符
|
|
137
|
+
- **可选字段**: 字段名带 `?`,展示为 `field?`
|
|
138
|
+
- **注意**: TypeScript 库的 `.d.ts` 文件是最权威的来源
|
|
139
|
+
|
|
140
|
+
**示例**:
|
|
141
|
+
```
|
|
142
|
+
| 序号 | 接口/类型名 | 字段 | 类型 | 必填 | 描述 |
|
|
143
|
+
|------|------------|------|------|------|------|
|
|
144
|
+
| 1 | RequestOptions | timeout? | number | 否 | 请求超时时间 |
|
|
145
|
+
| 2 | | headers? | Record<string, string> | 否 | 自定义请求头 |
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### 枚举(Enums)
|
|
149
|
+
导出的枚举应列出所有成员及对应值:
|
|
150
|
+
- 同一枚举的所有成员在表格中共用一个枚举名单元格,其余为空
|
|
151
|
+
|
|
152
|
+
**示例**:
|
|
153
|
+
```
|
|
154
|
+
| 序号 | 枚举名称 | 成员名 | 值 | 功能描述 |
|
|
155
|
+
|------|----------|--------|-----|----------|
|
|
156
|
+
| 1 | HttpMethod | GET | 'get' | HTTP GET 方法 |
|
|
157
|
+
| 2 | | POST | 'post' | HTTP POST 方法 |
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### 函数(Functions)
|
|
161
|
+
所有导出的独立函数:
|
|
162
|
+
- **函数名称**: 准确的函数名
|
|
163
|
+
- **返回值**: 返回值的类型
|
|
164
|
+
- **参数列表**: 包含参数名和类型,可选参数用 `?` 标记
|
|
165
|
+
- **功能描述**: 简短的功能说明
|
|
166
|
+
|
|
167
|
+
**示例**:
|
|
168
|
+
```
|
|
169
|
+
| 序号 | 函数名称 | 返回值 | 参数列表 | 功能描述 |
|
|
170
|
+
|------|----------|--------|----------|----------|
|
|
171
|
+
| 1 | debounce | Function | fn: Function, delay: number | 函数防抖,延迟执行 |
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### 变量(Variables)
|
|
175
|
+
导出的常量或配置对象:
|
|
176
|
+
- **变量名称**: 通常使用大写和下划线
|
|
177
|
+
- **变量类型**: 基本类型或对象类型
|
|
178
|
+
- **功能描述**: 变量的用途
|
|
179
|
+
|
|
180
|
+
**示例**:
|
|
181
|
+
```
|
|
182
|
+
| 序号 | 变量名称 | 变量类型 | 功能描述 |
|
|
183
|
+
|------|----------|----------|----------|
|
|
184
|
+
| 1 | VERSION | string | 库的版本号 |
|
|
185
|
+
| 2 | DEFAULT_CONFIG | object | 默认配置对象 |
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### 注意事项
|
|
189
|
+
包括但不限于:
|
|
190
|
+
- 环境要求(浏览器、Node.js 版本等)
|
|
191
|
+
- 使用限制(不支持的特性、边界情况等)
|
|
192
|
+
- 依赖关系(需要的外部库或工具)
|
|
193
|
+
- 性能考虑(大数据量的处理、内存占用等)
|
|
194
|
+
- 已知问题(bug、待完善的功能等)
|
|
195
|
+
- 最佳实践(推荐的使用方式)
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## 参数表示法
|
|
200
|
+
|
|
201
|
+
### TypeScript 风格
|
|
202
|
+
```
|
|
203
|
+
参数名: 类型
|
|
204
|
+
可选参数?: 类型
|
|
205
|
+
默认参数: 类型 = 默认值
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
示例:
|
|
209
|
+
- `url: string`
|
|
210
|
+
- `timeout?: number`
|
|
211
|
+
- `method: 'GET' | 'POST' = 'GET'`
|
|
212
|
+
|
|
213
|
+
### JavaScript 风格(JSDoc)
|
|
214
|
+
```
|
|
215
|
+
参数名: 类型
|
|
216
|
+
可选参数 (可选)
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
示例:
|
|
220
|
+
- `url: String`
|
|
221
|
+
- `timeout: Number (可选)`
|
|
222
|
+
|
|
223
|
+
### Python 风格
|
|
224
|
+
```
|
|
225
|
+
参数名: 类型
|
|
226
|
+
可选参数: 类型 = 默认值
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
示例:
|
|
230
|
+
- `text: str`
|
|
231
|
+
- `encoding: str = 'utf-8'`
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## 类型表示法
|
|
236
|
+
|
|
237
|
+
常见类型:
|
|
238
|
+
- **基本类型**: string, number, boolean, null, undefined
|
|
239
|
+
- **对象类型**: object, Object, any
|
|
240
|
+
- **数组类型**: Array, Array<T>, T[]
|
|
241
|
+
- **函数类型**: Function, (args) => returnType
|
|
242
|
+
- **联合类型**: string | number
|
|
243
|
+
- **泛型**: T, <T>
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
|
|
247
|
+
## 保存文件
|
|
248
|
+
|
|
249
|
+
文件名格式: `[库名]接口规格说明.md`
|
|
250
|
+
|
|
251
|
+
例如:
|
|
252
|
+
- `lodash接口规格说明.md`
|
|
253
|
+
- `axios接口规格说明.md`
|
|
254
|
+
- `react接口规格说明.md`
|