@ohos-cpf/3rdloop 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +244 -244
- package/bin/3rdloop.mjs +46 -46
- package/lib/cli.js +781 -781
- package/lib/config-cmd.js +451 -451
- package/lib/config.js +318 -318
- package/lib/doctor.js +113 -113
- package/lib/exit-codes.js +30 -30
- package/lib/opencode.js +155 -155
- package/lib/orch.js +426 -426
- package/lib/queries.js +263 -263
- package/lib/step.js +325 -325
- package/lib/ui.js +222 -222
- package/lib/update.js +279 -279
- package/lib/workflow.js +308 -308
- package/lib/workflows.js +131 -131
- package/package.json +50 -50
- package/vendor/Server/Agent/SkillSelector/README.md +343 -343
- package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -207
- package/vendor/Server/Agent/SkillSelector/index.js +14 -14
- package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -313
- package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -161
- package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -144
- package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -433
- package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -382
- package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +59 -59
- package/vendor/Server/Brain/AnalysisStrategies.js +422 -422
- package/vendor/Server/Brain/Brain.js +686 -686
- package/vendor/Server/Brain/DecompositionStrategies.js +621 -621
- package/vendor/Server/Brain/PlanPersistence.js +196 -196
- package/vendor/Server/Brain/SkillExecutor.js +251 -251
- package/vendor/Server/Brain/index.js +11 -11
- package/vendor/Server/CLI/cli.js +275 -275
- package/vendor/Server/CLI/deveco-code/index.js +71 -71
- package/vendor/Server/CLI/deveco-code.js +5 -5
- package/vendor/Server/CLI/opencode/index.js +817 -818
- package/vendor/Server/CLI/opencode.js +5 -5
- package/vendor/Server/DbUse/MessageArchive.js +61 -61
- package/vendor/Server/DbUse/StorageManager.js +107 -107
- package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -94
- package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -114
- package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -157
- package/vendor/Server/DbUse/index.js +160 -160
- package/vendor/Server/DbUse/stores/SessionStore.js +279 -279
- package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -133
- package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -262
- package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -279
- package/vendor/Server/FlexRunner/FlexRunner.js +1759 -1759
- package/vendor/Server/FlexRunner/index.js +12 -12
- package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -523
- package/vendor/Server/Knowledge/KnowledgeManager.js +341 -341
- package/vendor/Server/Knowledge/index.js +33 -33
- package/vendor/Server/LoopEngine/LoopEngine.js +1133 -1133
- package/vendor/Server/LoopEngine/index.js +11 -11
- package/vendor/Server/Orchestrator/Orchestrator.js +0 -3
- package/vendor/Server/Orchestrator/StepNode.js +312 -312
- package/vendor/Server/Orchestrator/index.js +13 -13
- package/vendor/Server/Routes/controllers/BrainController.js +241 -241
- package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -1125
- package/vendor/Server/Routes/controllers/HealthController.js +44 -44
- package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -355
- package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -788
- package/vendor/Server/Routes/controllers/StatsController.js +57 -57
- package/vendor/Server/Routes/controllers/StreamController.js +67 -67
- package/vendor/Server/Routes/library/logger.js +179 -179
- package/vendor/Server/Routes/library/zipArchive.js +172 -172
- package/vendor/Server/Routes/router/Router.js +204 -204
- package/vendor/Server/Routes/routes/brain.js +47 -47
- package/vendor/Server/Routes/routes/flexrunner.js +72 -72
- package/vendor/Server/Routes/routes/health.js +28 -28
- package/vendor/Server/Routes/routes/index.js +57 -57
- package/vendor/Server/Routes/routes/knowledge.js +55 -55
- package/vendor/Server/Routes/routes/loopengine.js +58 -58
- package/vendor/Server/Routes/routes/orchestrator.js +61 -61
- package/vendor/Server/Routes/routes/registry.js +97 -97
- package/vendor/Server/Routes/routes/stats.js +23 -23
- package/vendor/Server/Routes/routes/stream.js +30 -30
- package/vendor/Server/Routes/server.js +203 -203
- package/vendor/Server/Routes/sse/SseHub.js +308 -308
- package/vendor/Server/Skills/acceptance-check/SKILL.md +191 -191
- package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -52
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -77
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_EVIDENCE_VERIFICATION.md +70 -70
- package/vendor/Server/Skills/arkts-code-check/SKILL.md +320 -320
- package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +210 -210
- package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +28 -28
- package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +233 -233
- package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +328 -328
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -291
- package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -68
- package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -184
- package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -337
- package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -400
- package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +98 -98
- package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -544
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -174
- package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -321
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -100
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -185
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +233 -233
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +102 -102
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -89
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -62
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +107 -107
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -124
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -90
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -57
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +391 -391
- package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -113
- package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +312 -312
- package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -154
- package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +165 -165
- package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +308 -308
- package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -90
- package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -282
- package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +360 -360
- package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +145 -145
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +252 -252
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +114 -114
- package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +262 -262
- package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -455
- package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -60
- package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -76
- package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -200
- package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +518 -518
- package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -276
- package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +92 -92
- package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -767
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -221
- package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +228 -228
- package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -194
- package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +575 -575
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +574 -574
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -182
- package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +490 -490
- package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -217
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -299
- package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -190
- package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +133 -133
- package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/flutter-interface/README.md +75 -75
- package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -291
- package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -336
- package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -190
- package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -258
- package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -254
- package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +517 -517
- package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +381 -381
- package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +341 -341
- package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -71
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +518 -518
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +406 -406
- package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +652 -652
- package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +396 -396
- package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +744 -744
- package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +720 -720
- package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -414
- package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -150
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -304
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -265
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -286
- package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -383
- package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -165
- package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -91
- package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +453 -301
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_CHECKLIST.md +151 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +257 -105
- package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +191 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +317 -208
- package/vendor/Server/Skills/rn-code-check/SKILL.md +320 -320
- package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +234 -234
- package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +188 -188
- package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +246 -246
- package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -198
- package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -40
- package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -78
- package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -70
- package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -47
- package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -252
- package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -176
- package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -5
- package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -35
- package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -137
- package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -33
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -40
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -429
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -105
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -90
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -213
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -73
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -258
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -341
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -67
- package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -299
- package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -293
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -857
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -856
- package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -157
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -801
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +683 -683
- package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -233
- package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -1373
- package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -220
- package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -245
- package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -414
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -413
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -355
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -115
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -139
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -586
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -57
- package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -259
- package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -301
- package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -148
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -118
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -168
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -176
- package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -274
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -45
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -25
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -61
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -165
- package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -239
- package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -96
- package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +57 -57
- package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -99
- package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -64
- package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +74 -74
- package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -164
- package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +356 -339
- package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +85 -83
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +905 -859
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +124 -122
- package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +287 -279
- package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -273
- package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -129
- package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -581
- package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -138
- package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -168
- package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +526 -506
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +321 -280
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -221
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +220 -209
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -325
- package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -279
- package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -404
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -185
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -265
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -189
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -203
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -147
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -148
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -165
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -195
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -249
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -161
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -413
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -245
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -282
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -251
- package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -469
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -310
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -303
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -421
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -358
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -114
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -274
- package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -185
- package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -191
- package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -216
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -107
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -120
- package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -108
- package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -237
- package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -261
- package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -112
- package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +497 -497
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -270
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -164
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -556
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -459
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -65
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -512
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -132
- package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -424
- package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -137
- package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -306
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -485
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -172
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -422
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -95
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -169
- package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -554
- package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -106
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -216
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -413
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -98
- package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -337
- package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -722
- package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -173
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -267
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -174
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -111
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -186
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -150
- package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -296
- package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -371
- package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -212
- package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -223
- package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -1053
- package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +295 -255
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +82 -77
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -224
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +175 -174
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -967
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -1798
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -5
- package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +180 -137
- package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -145
- package/vendor/Server/Skills/skill-generator/SKILL.md +365 -365
- package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -183
- package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -82
- package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -110
- package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -122
- package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -121
- package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/task-analysis/SKILL.md +234 -234
- package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -160
- package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -190
- package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -224
- package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -162
- package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -55
- package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -126
- package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -256
- package/vendor/Server/Skills/task-decomposition/SKILL.md +528 -528
- package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -451
- package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -179
- package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -152
- package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -175
- package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -195
- package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -226
- package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -263
- package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -29
- package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -376
- package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -259
- package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -216
- package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +424 -424
- package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -427
- package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -214
- package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -235
- package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -250
- package/vendor/Server/TestCheck/TestCheck.js +775 -775
- package/vendor/Server/TestCheck/index.js +11 -11
- package/vendor/Server/library/McpToolGuide.js +280 -280
- package/vendor/Server/library/StatsService.js +126 -126
- package/vendor/Server/library/cstTime.js +16 -16
- package/vendor/VERSION +3 -3
- package/workflows/pr-check.mjs +105 -105
- package/workflows/pr-push.mjs +192 -192
- package/vendor/Server/Agent/SkillSelector/types.js +0 -63
|
@@ -1,291 +1,291 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flutter-interface
|
|
3
|
-
description: 分析 Flutter 三方库的对外接口能力,使用 flutter-extract-interfaces.cjs 脚本自动提取 Dart 源码中的类/枚举/mixin/extension/函数/变量公开接口,生成结构化的接口规格说明文档。当需要理解 Flutter 三方库 API、生成接口规格文档、进行覆盖率分析前置提取时使用。支持 Git 仓库克隆、monorepo 多子包、export 链追踪。
|
|
4
|
-
license: MIT
|
|
5
|
-
compatibility: 需要 Node.js 运行环境(执行 .cjs 脚本),需要 git(克隆远程仓库时)
|
|
6
|
-
metadata:
|
|
7
|
-
version: "1.1.0"
|
|
8
|
-
category: interface-analysis
|
|
9
|
-
language-support: "Dart/Flutter(完整支持,基于正则解析引擎)"
|
|
10
|
-
script-powered: "flutter-extract-interfaces.cjs + flutter-render-spec-doc.cjs"
|
|
11
|
-
git-support: "支持 git clone 从远程仓库克隆代码,支持 Sparse Checkout 稀疏检出"
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
# Flutter Interface Analyzer
|
|
15
|
-
|
|
16
|
-
本技能用于**分析 Flutter 三方库的对外接口能力**,自动生成标准化的接口规格说明文档。核心接口提取由 `MCP/scripts/` 下的共享脚本 `flutter-extract-interfaces.cjs` 完成(本 SKILL 通过相对路径引用,不保存脚本副本),AI 负责审查补充和文档整合。
|
|
17
|
-
|
|
18
|
-
> ⚠️ **核心原则:只分析对外公开导出的接口,不关注内部实现细节。接口提取由脚本自动完成,AI 不手动逐文件读取源码提取接口。**
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 任务参数
|
|
23
|
-
|
|
24
|
-
| 参数 | 类型 | 必填 | 说明 |
|
|
25
|
-
|------|------|------|------|
|
|
26
|
-
| `input` | string | ✅ | Git 仓库 URL 或本地库源码目录路径 |
|
|
27
|
-
| `outputDir` | string | ✅ | 输出目录绝对路径 |
|
|
28
|
-
| `repoName` | string | ❌ | 仓库名称(从 URL 解析或用户提供) |
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## 输入依赖
|
|
33
|
-
|
|
34
|
-
无前置 SKILL。可作为独立任务调用。
|
|
35
|
-
|
|
36
|
-
## 脚本依赖
|
|
37
|
-
|
|
38
|
-
本 SKILL **不保存脚本副本**,直接调用 `MCP/scripts/` 目录下的两个共享 Node.js 脚本:
|
|
39
|
-
|
|
40
|
-
| 脚本 | 功能 | 输出 |
|
|
41
|
-
|------|------|------|
|
|
42
|
-
| `flutter-extract-interfaces.cjs` | 从 Dart 源码提取接口规格 JSON | `interface-spec.json` |
|
|
43
|
-
| `flutter-render-spec-doc.cjs` | 将 JSON 渲染为 Markdown 接口文档 | `接口规格说明.md` |
|
|
44
|
-
|
|
45
|
-
**派生变量**:
|
|
46
|
-
- `skillDir`:本 SKILL 所在目录(任务 prompt 中“SKILL 目录”下发的绝对路径)
|
|
47
|
-
- `mcpScriptsDir`:共享脚本目录 = `{{skillDir}}/../../../MCP/scripts`(即 `3rdLibraryLoop/MCP/scripts`)
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## 工作流程概览
|
|
52
|
-
|
|
53
|
-
```
|
|
54
|
-
Phase 1: 输入解析与代码获取(Git Clone / 本地路径)
|
|
55
|
-
↓
|
|
56
|
-
Phase 2: 脚本自动提取接口(核心 — flutter-extract-interfaces.cjs)
|
|
57
|
-
↓
|
|
58
|
-
Phase 3: 脚本渲染接口文档(flutter-render-spec-doc.cjs)
|
|
59
|
-
↓
|
|
60
|
-
Phase 4: AI 审查与补充(README 概述、注意事项等脚本无法提取的内容)
|
|
61
|
-
↓
|
|
62
|
-
Phase 5: 最终文档输出
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## Phase 1:输入解析与代码获取
|
|
68
|
-
|
|
69
|
-
### 1.1 判断输入类型
|
|
70
|
-
|
|
71
|
-
| 输入形式 | 判断依据 | 处理方式 |
|
|
72
|
-
|----------|----------|----------|
|
|
73
|
-
| Git 仓库 URL | 以 `http://`、`https://` 开头,含 `.git` 或 `/tree/` | 执行 Git Clone(步骤 1.2) |
|
|
74
|
-
| 本地路径 | 以 `/` 或 `~` 开头,目录存在 | 直接使用,跳到 Phase 2 |
|
|
75
|
-
|
|
76
|
-
### 1.2 Git Clone(仅远程仓库输入)
|
|
77
|
-
|
|
78
|
-
从 URL 解析仓库地址、分支、子路径,执行克隆:
|
|
79
|
-
|
|
80
|
-
- **无子路径**:完整克隆 `git clone <baseUrl> <outputDir>/source`
|
|
81
|
-
- **有子路径**:稀疏检出(Sparse Checkout),只下载指定文件夹
|
|
82
|
-
|
|
83
|
-
> **仓库迁移探测(按序尝试,避免浪费轮次)**:Gitee `openharmony-tpc` 组织下的 Flutter 仓库已大规模迁移到 GitCode。克隆 404 时按以下顺序快速探测,**不要**盲目尝试随机组织名:
|
|
84
|
-
> 1. `https://gitcode.com/CPF-Flutter/{原仓库名}`(鸿蒙化 Flutter 仓库主要迁移目的地,仓库名可能带 `fluttertpc_` 前缀)
|
|
85
|
-
> 2. `https://gitcode.com/openharmony-tpc/{原仓库名}`
|
|
86
|
-
> 3. GitCode 站内搜索仓库名(一次搜索定位实际组织)
|
|
87
|
-
>
|
|
88
|
-
> 找到迁移仓库后,在报告中标注原地址 → 实际地址的映射关系。
|
|
89
|
-
|
|
90
|
-
> 详细的 URL 解析规则和克隆命令参见 [Git Clone 指南](references/GIT_CLONE_GUIDE.md)
|
|
91
|
-
|
|
92
|
-
### 1.3 确定分析路径
|
|
93
|
-
|
|
94
|
-
克隆完成后确定 `analysisRoot`:
|
|
95
|
-
- 完整克隆(无子路径):`analysisRoot = <outputDir>/source`
|
|
96
|
-
- 稀疏检出(有子路径):`analysisRoot = <outputDir>/source/<subpath>`
|
|
97
|
-
- 本地路径输入:`analysisRoot = 用户提供的路径`
|
|
98
|
-
|
|
99
|
-
> 后续所有分析基于 `analysisRoot` 目录进行。
|
|
100
|
-
|
|
101
|
-
---
|
|
102
|
-
|
|
103
|
-
## Phase 2:脚本自动提取接口
|
|
104
|
-
|
|
105
|
-
> ⚠️ **这是本 SKILL 的核心优化点:接口提取由脚本自动完成,AI 不手动逐文件读取源码。**
|
|
106
|
-
|
|
107
|
-
### 2.1 运行提取脚本
|
|
108
|
-
|
|
109
|
-
使用共享脚本从 Dart 源码自动提取全部公开接口:
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir <analysisRoot> --output <outputDir>/interface-spec.json
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
**脚本自动完成的工作**:
|
|
116
|
-
1. 解析 `pubspec.yaml` 获取包名,定位 `lib/<package>.dart` 入口文件
|
|
117
|
-
2. 递归追踪 export 链(`export 'src/xxx.dart'`、`package:xxx/yyy.dart`),收集所有可达源文件
|
|
118
|
-
3. 支持 monorepo 多子包(如 `flutter_inappwebview` 含多个子包)
|
|
119
|
-
4. 预处理源码:移除字符串/注释(保留行号),保留 `///` 文档注释
|
|
120
|
-
5. 正则解析提取:类(含 abstract/mixin class)、枚举(含 Dart 3 增强枚举)、mixin、extension 的成员(方法/属性/字段/构造函数/常量)+ 顶层函数/变量/typedef
|
|
121
|
-
6. 过滤私有成员(`_` 前缀)、export hide/show 过滤
|
|
122
|
-
7. 提取 `///` 文档注释作为功能描述
|
|
123
|
-
8. 输出结构化 JSON(`interface-spec.json`)
|
|
124
|
-
|
|
125
|
-
> ⚠️ **monorepo 主包定位(重要)**:脚本对仓库根执行时,可能误把 `example` 子包(如 `packages/xxx_example`)识别为多子包一并提取,导致结果混入示例代码。**monorepo 仓库(含 `packages/` 目录)应把 `--repoDir` 指向主包目录**(如 `source/packages/flutter_blue_plus`),而不是仓库根目录。判断依据:`packages/` 下有多个子包时,选取含 `lib/<包名>.dart` 且 `pubspec.yaml` 与仓库名对应的主包。
|
|
126
|
-
|
|
127
|
-
**输出 JSON 结构**:
|
|
128
|
-
```json
|
|
129
|
-
{
|
|
130
|
-
"libraryName": "包名",
|
|
131
|
-
"entryFile": "./lib/xxx.dart",
|
|
132
|
-
"extractedAt": "ISO时间戳",
|
|
133
|
-
"summary": { "S": 类数, "N": 接口总数, "methods": N, "properties": N, "fields": N, "constants": N },
|
|
134
|
-
"sources": ["./lib/xxx.dart", ...],
|
|
135
|
-
"interfaces": [
|
|
136
|
-
{
|
|
137
|
-
"className": "ClassName",
|
|
138
|
-
"memberName": "methodName",
|
|
139
|
-
"fullName": "ClassName.methodName",
|
|
140
|
-
"kind": "method|property|field|constant|constructor|enumValue|function|variable|type",
|
|
141
|
-
"isStatic": false,
|
|
142
|
-
"signature": "ReturnType methodName(params)",
|
|
143
|
-
"params": [{ "name": "param", "type": "String", "optional": false }],
|
|
144
|
-
"returnType": "void",
|
|
145
|
-
"description": "/// 文档注释内容",
|
|
146
|
-
"source": "./lib/src/xxx.dart",
|
|
147
|
-
"startLine": 42
|
|
148
|
-
}
|
|
149
|
-
]
|
|
150
|
-
}
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
> 脚本的详细参数说明、输出字段含义、常见问题排查参见 [脚本使用参考](references/SCRIPT_REFERENCE.md)
|
|
154
|
-
|
|
155
|
-
### 2.2 验证提取结果
|
|
156
|
-
|
|
157
|
-
检查脚本输出的 JSON:
|
|
158
|
-
- 确认 `libraryName` 正确(来自 `pubspec.yaml` 的 `name` 字段)
|
|
159
|
-
- 确认 `sources` 列表非空(至少包含入口文件)
|
|
160
|
-
- 确认 `interfaces` 数组非空(至少有 1 个接口)
|
|
161
|
-
- 若 `interfaces` 为空,检查入口文件是否正确定位(参见 [脚本使用参考](references/SCRIPT_REFERENCE.md) 的故障排查章节)
|
|
162
|
-
|
|
163
|
-
---
|
|
164
|
-
|
|
165
|
-
## Phase 3:脚本渲染接口文档
|
|
166
|
-
|
|
167
|
-
### 3.1 运行渲染脚本
|
|
168
|
-
|
|
169
|
-
使用共享脚本将 JSON 渲染为 Markdown 文档:
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec <outputDir>/interface-spec.json --output <outputDir>/接口规格说明.md
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
**也可以一步到位**(跳过 Phase 2 的 JSON 输出,直接从源码生成文档):
|
|
176
|
-
|
|
177
|
-
```bash
|
|
178
|
-
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --libroot <analysisRoot> --output <outputDir>/接口规格说明.md
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
> 推荐使用两步方式(先提取 JSON 再渲染),JSON 中间件可复用于下游覆盖率分析。
|
|
182
|
-
|
|
183
|
-
### 3.2 渲染脚本生成的文档结构
|
|
184
|
-
|
|
185
|
-
脚本自动生成以下章节:
|
|
186
|
-
- **基本信息**:库名、入口文件、生成时间、源文件数
|
|
187
|
-
- **接口统计**:类/接口/枚举总数、方法/属性/字段/常量数量
|
|
188
|
-
- **按类分组的接口详情**:每个类/枚举/mixin/extension一个章节,含构造函数、方法、属性、字段、常量、枚举值、函数、变量、类型别名、事件方法汇总等子表格
|
|
189
|
-
- **源文件列表**:所有被分析的源文件路径
|
|
190
|
-
|
|
191
|
-
---
|
|
192
|
-
|
|
193
|
-
## Phase 4:AI 审查与补充
|
|
194
|
-
|
|
195
|
-
> 脚本已自动完成接口提取和文档渲染,AI 在此阶段负责补充脚本无法提取的内容。
|
|
196
|
-
|
|
197
|
-
### 4.1 读取 README 补充概述
|
|
198
|
-
|
|
199
|
-
读取库的 `README.md`,提取:
|
|
200
|
-
- 库的功能描述和主要特性
|
|
201
|
-
- 适用场景和使用限制
|
|
202
|
-
|
|
203
|
-
将概述信息补充到文档开头(脚本生成的"基本信息"表格之后)。
|
|
204
|
-
|
|
205
|
-
### 4.2 补充注意事项
|
|
206
|
-
|
|
207
|
-
从 README 和代码注释中提取:
|
|
208
|
-
- 使用限制和兼容性说明
|
|
209
|
-
- 已知问题和注意事项
|
|
210
|
-
- 平台支持情况(特别是鸿蒙 `ohos` 平台适配状态)
|
|
211
|
-
|
|
212
|
-
### 4.3 审查接口完整性
|
|
213
|
-
|
|
214
|
-
对比脚本输出的接口列表与 README 中提到的 API:
|
|
215
|
-
- 确认主要 API 均已被脚本提取
|
|
216
|
-
- 若发现遗漏(如脚本正则无法覆盖的特殊语法),手动补充到文档中
|
|
217
|
-
|
|
218
|
-
### 4.4 人工可读性优化
|
|
219
|
-
|
|
220
|
-
- 为缺少 `///` 文档注释的接口补充功能描述(根据方法名推断,标注"待确认")
|
|
221
|
-
- 合并或调整表格顺序,提升可读性
|
|
222
|
-
|
|
223
|
-
> 文档输出格式模板参见 [文档模板](references/TEMPLATE.md)
|
|
224
|
-
|
|
225
|
-
---
|
|
226
|
-
|
|
227
|
-
## Phase 5:最终文档输出
|
|
228
|
-
|
|
229
|
-
### 5.1 合并最终文档
|
|
230
|
-
|
|
231
|
-
将脚本生成的接口规格文档(Phase 3)与 AI 补充内容(Phase 4)合并为最终文档。
|
|
232
|
-
|
|
233
|
-
最终文档结构:
|
|
234
|
-
```markdown
|
|
235
|
-
# [库名] 接口规格说明书
|
|
236
|
-
|
|
237
|
-
## 基本信息 ← 脚本生成
|
|
238
|
-
## 三方库概述 ← AI 从 README 补充
|
|
239
|
-
## 接口统计 ← 脚本生成
|
|
240
|
-
## [类名] 接口详情 ← 脚本生成(每个类一个章节)
|
|
241
|
-
### 构造函数
|
|
242
|
-
### 方法
|
|
243
|
-
### 属性
|
|
244
|
-
### 字段
|
|
245
|
-
### 常量
|
|
246
|
-
### 枚举值
|
|
247
|
-
...
|
|
248
|
-
## 源文件列表 ← 脚本生成
|
|
249
|
-
## 注意事项 ← AI 补充
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
### 5.2 保存文档
|
|
253
|
-
|
|
254
|
-
将最终文档保存为:`<outputDir>/接口规格说明.md`
|
|
255
|
-
|
|
256
|
-
**禁止**将文档放置在 source 目录或其他子目录,必须放在输出目录根目录。
|
|
257
|
-
|
|
258
|
-
### 5.3 保留中间件
|
|
259
|
-
|
|
260
|
-
保留 `<outputDir>/interface-spec.json` 中间件,可供下游覆盖率分析(Demo 覆盖率、XTS 测试覆盖率)复用。
|
|
261
|
-
|
|
262
|
-
---
|
|
263
|
-
|
|
264
|
-
## 工具支持
|
|
265
|
-
|
|
266
|
-
### 核心脚本
|
|
267
|
-
|
|
268
|
-
| 脚本 | 用途 | 调用方式 |
|
|
269
|
-
|------|------|----------|
|
|
270
|
-
| `flutter-extract-interfaces.cjs` | 从 Dart 源码提取接口规格 JSON | `node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir <路径> --output <json路径>` |
|
|
271
|
-
| `flutter-render-spec-doc.cjs` | 将 JSON 渲染为 Markdown 文档 | `node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec <json路径> --output <md路径>` |
|
|
272
|
-
|
|
273
|
-
> 脚本位于 `MCP/scripts/`(本 SKILL 不保存副本),详细参数、输出格式、故障排查参见 [脚本使用参考](references/SCRIPT_REFERENCE.md)
|
|
274
|
-
|
|
275
|
-
---
|
|
276
|
-
|
|
277
|
-
## 分析示例
|
|
278
|
-
|
|
279
|
-
详细的分析示例(含脚本输出演示)请参考 [分析示例](references/EXAMPLES.md)。
|
|
280
|
-
|
|
281
|
-
---
|
|
282
|
-
|
|
283
|
-
## 注意事项
|
|
284
|
-
|
|
285
|
-
1. **脚本优先**:接口提取由 `flutter-extract-interfaces.cjs` 自动完成,AI 不手动逐文件读取源码提取接口
|
|
286
|
-
2. **只分析公开接口**:脚本自动过滤 `_` 前缀私有成员和 export hide/show,确保只输出对外公开的接口
|
|
287
|
-
3. **忠实于源码**:所有接口信息来自脚本解析实际源码,不允许推断或捏造;`description` 字段为空时使用 `-` 表示
|
|
288
|
-
4. **monorepo 支持**:脚本自动检测 monorepo 结构(如 `flutter_inappwebview` 含多个子包),无需手动指定主包
|
|
289
|
-
5. **export 链追踪**:脚本递归追踪 `export` 语句,支持 `src/` 相对路径和 `package:` 跨包路径,支持 hide/show 过滤
|
|
290
|
-
6. **JSON 中间件复用**:`interface-spec.json` 可供下游覆盖率分析脚本复用,避免重复解析源码
|
|
291
|
-
7. **文档输出位置**:最终文档必须保存在 `<outputDir>/接口规格说明.md`,不得放在 source 目录内
|
|
1
|
+
---
|
|
2
|
+
name: flutter-interface
|
|
3
|
+
description: 分析 Flutter 三方库的对外接口能力,使用 flutter-extract-interfaces.cjs 脚本自动提取 Dart 源码中的类/枚举/mixin/extension/函数/变量公开接口,生成结构化的接口规格说明文档。当需要理解 Flutter 三方库 API、生成接口规格文档、进行覆盖率分析前置提取时使用。支持 Git 仓库克隆、monorepo 多子包、export 链追踪。
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: 需要 Node.js 运行环境(执行 .cjs 脚本),需要 git(克隆远程仓库时)
|
|
6
|
+
metadata:
|
|
7
|
+
version: "1.1.0"
|
|
8
|
+
category: interface-analysis
|
|
9
|
+
language-support: "Dart/Flutter(完整支持,基于正则解析引擎)"
|
|
10
|
+
script-powered: "flutter-extract-interfaces.cjs + flutter-render-spec-doc.cjs"
|
|
11
|
+
git-support: "支持 git clone 从远程仓库克隆代码,支持 Sparse Checkout 稀疏检出"
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Flutter Interface Analyzer
|
|
15
|
+
|
|
16
|
+
本技能用于**分析 Flutter 三方库的对外接口能力**,自动生成标准化的接口规格说明文档。核心接口提取由 `MCP/scripts/` 下的共享脚本 `flutter-extract-interfaces.cjs` 完成(本 SKILL 通过相对路径引用,不保存脚本副本),AI 负责审查补充和文档整合。
|
|
17
|
+
|
|
18
|
+
> ⚠️ **核心原则:只分析对外公开导出的接口,不关注内部实现细节。接口提取由脚本自动完成,AI 不手动逐文件读取源码提取接口。**
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 任务参数
|
|
23
|
+
|
|
24
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
25
|
+
|------|------|------|------|
|
|
26
|
+
| `input` | string | ✅ | Git 仓库 URL 或本地库源码目录路径 |
|
|
27
|
+
| `outputDir` | string | ✅ | 输出目录绝对路径 |
|
|
28
|
+
| `repoName` | string | ❌ | 仓库名称(从 URL 解析或用户提供) |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 输入依赖
|
|
33
|
+
|
|
34
|
+
无前置 SKILL。可作为独立任务调用。
|
|
35
|
+
|
|
36
|
+
## 脚本依赖
|
|
37
|
+
|
|
38
|
+
本 SKILL **不保存脚本副本**,直接调用 `MCP/scripts/` 目录下的两个共享 Node.js 脚本:
|
|
39
|
+
|
|
40
|
+
| 脚本 | 功能 | 输出 |
|
|
41
|
+
|------|------|------|
|
|
42
|
+
| `flutter-extract-interfaces.cjs` | 从 Dart 源码提取接口规格 JSON | `interface-spec.json` |
|
|
43
|
+
| `flutter-render-spec-doc.cjs` | 将 JSON 渲染为 Markdown 接口文档 | `接口规格说明.md` |
|
|
44
|
+
|
|
45
|
+
**派生变量**:
|
|
46
|
+
- `skillDir`:本 SKILL 所在目录(任务 prompt 中“SKILL 目录”下发的绝对路径)
|
|
47
|
+
- `mcpScriptsDir`:共享脚本目录 = `{{skillDir}}/../../../MCP/scripts`(即 `3rdLibraryLoop/MCP/scripts`)
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## 工作流程概览
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
Phase 1: 输入解析与代码获取(Git Clone / 本地路径)
|
|
55
|
+
↓
|
|
56
|
+
Phase 2: 脚本自动提取接口(核心 — flutter-extract-interfaces.cjs)
|
|
57
|
+
↓
|
|
58
|
+
Phase 3: 脚本渲染接口文档(flutter-render-spec-doc.cjs)
|
|
59
|
+
↓
|
|
60
|
+
Phase 4: AI 审查与补充(README 概述、注意事项等脚本无法提取的内容)
|
|
61
|
+
↓
|
|
62
|
+
Phase 5: 最终文档输出
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Phase 1:输入解析与代码获取
|
|
68
|
+
|
|
69
|
+
### 1.1 判断输入类型
|
|
70
|
+
|
|
71
|
+
| 输入形式 | 判断依据 | 处理方式 |
|
|
72
|
+
|----------|----------|----------|
|
|
73
|
+
| Git 仓库 URL | 以 `http://`、`https://` 开头,含 `.git` 或 `/tree/` | 执行 Git Clone(步骤 1.2) |
|
|
74
|
+
| 本地路径 | 以 `/` 或 `~` 开头,目录存在 | 直接使用,跳到 Phase 2 |
|
|
75
|
+
|
|
76
|
+
### 1.2 Git Clone(仅远程仓库输入)
|
|
77
|
+
|
|
78
|
+
从 URL 解析仓库地址、分支、子路径,执行克隆:
|
|
79
|
+
|
|
80
|
+
- **无子路径**:完整克隆 `git clone <baseUrl> <outputDir>/source`
|
|
81
|
+
- **有子路径**:稀疏检出(Sparse Checkout),只下载指定文件夹
|
|
82
|
+
|
|
83
|
+
> **仓库迁移探测(按序尝试,避免浪费轮次)**:Gitee `openharmony-tpc` 组织下的 Flutter 仓库已大规模迁移到 GitCode。克隆 404 时按以下顺序快速探测,**不要**盲目尝试随机组织名:
|
|
84
|
+
> 1. `https://gitcode.com/CPF-Flutter/{原仓库名}`(鸿蒙化 Flutter 仓库主要迁移目的地,仓库名可能带 `fluttertpc_` 前缀)
|
|
85
|
+
> 2. `https://gitcode.com/openharmony-tpc/{原仓库名}`
|
|
86
|
+
> 3. GitCode 站内搜索仓库名(一次搜索定位实际组织)
|
|
87
|
+
>
|
|
88
|
+
> 找到迁移仓库后,在报告中标注原地址 → 实际地址的映射关系。
|
|
89
|
+
|
|
90
|
+
> 详细的 URL 解析规则和克隆命令参见 [Git Clone 指南](references/GIT_CLONE_GUIDE.md)
|
|
91
|
+
|
|
92
|
+
### 1.3 确定分析路径
|
|
93
|
+
|
|
94
|
+
克隆完成后确定 `analysisRoot`:
|
|
95
|
+
- 完整克隆(无子路径):`analysisRoot = <outputDir>/source`
|
|
96
|
+
- 稀疏检出(有子路径):`analysisRoot = <outputDir>/source/<subpath>`
|
|
97
|
+
- 本地路径输入:`analysisRoot = 用户提供的路径`
|
|
98
|
+
|
|
99
|
+
> 后续所有分析基于 `analysisRoot` 目录进行。
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Phase 2:脚本自动提取接口
|
|
104
|
+
|
|
105
|
+
> ⚠️ **这是本 SKILL 的核心优化点:接口提取由脚本自动完成,AI 不手动逐文件读取源码。**
|
|
106
|
+
|
|
107
|
+
### 2.1 运行提取脚本
|
|
108
|
+
|
|
109
|
+
使用共享脚本从 Dart 源码自动提取全部公开接口:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir <analysisRoot> --output <outputDir>/interface-spec.json
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**脚本自动完成的工作**:
|
|
116
|
+
1. 解析 `pubspec.yaml` 获取包名,定位 `lib/<package>.dart` 入口文件
|
|
117
|
+
2. 递归追踪 export 链(`export 'src/xxx.dart'`、`package:xxx/yyy.dart`),收集所有可达源文件
|
|
118
|
+
3. 支持 monorepo 多子包(如 `flutter_inappwebview` 含多个子包)
|
|
119
|
+
4. 预处理源码:移除字符串/注释(保留行号),保留 `///` 文档注释
|
|
120
|
+
5. 正则解析提取:类(含 abstract/mixin class)、枚举(含 Dart 3 增强枚举)、mixin、extension 的成员(方法/属性/字段/构造函数/常量)+ 顶层函数/变量/typedef
|
|
121
|
+
6. 过滤私有成员(`_` 前缀)、export hide/show 过滤
|
|
122
|
+
7. 提取 `///` 文档注释作为功能描述
|
|
123
|
+
8. 输出结构化 JSON(`interface-spec.json`)
|
|
124
|
+
|
|
125
|
+
> ⚠️ **monorepo 主包定位(重要)**:脚本对仓库根执行时,可能误把 `example` 子包(如 `packages/xxx_example`)识别为多子包一并提取,导致结果混入示例代码。**monorepo 仓库(含 `packages/` 目录)应把 `--repoDir` 指向主包目录**(如 `source/packages/flutter_blue_plus`),而不是仓库根目录。判断依据:`packages/` 下有多个子包时,选取含 `lib/<包名>.dart` 且 `pubspec.yaml` 与仓库名对应的主包。
|
|
126
|
+
|
|
127
|
+
**输出 JSON 结构**:
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"libraryName": "包名",
|
|
131
|
+
"entryFile": "./lib/xxx.dart",
|
|
132
|
+
"extractedAt": "ISO时间戳",
|
|
133
|
+
"summary": { "S": 类数, "N": 接口总数, "methods": N, "properties": N, "fields": N, "constants": N },
|
|
134
|
+
"sources": ["./lib/xxx.dart", ...],
|
|
135
|
+
"interfaces": [
|
|
136
|
+
{
|
|
137
|
+
"className": "ClassName",
|
|
138
|
+
"memberName": "methodName",
|
|
139
|
+
"fullName": "ClassName.methodName",
|
|
140
|
+
"kind": "method|property|field|constant|constructor|enumValue|function|variable|type",
|
|
141
|
+
"isStatic": false,
|
|
142
|
+
"signature": "ReturnType methodName(params)",
|
|
143
|
+
"params": [{ "name": "param", "type": "String", "optional": false }],
|
|
144
|
+
"returnType": "void",
|
|
145
|
+
"description": "/// 文档注释内容",
|
|
146
|
+
"source": "./lib/src/xxx.dart",
|
|
147
|
+
"startLine": 42
|
|
148
|
+
}
|
|
149
|
+
]
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
> 脚本的详细参数说明、输出字段含义、常见问题排查参见 [脚本使用参考](references/SCRIPT_REFERENCE.md)
|
|
154
|
+
|
|
155
|
+
### 2.2 验证提取结果
|
|
156
|
+
|
|
157
|
+
检查脚本输出的 JSON:
|
|
158
|
+
- 确认 `libraryName` 正确(来自 `pubspec.yaml` 的 `name` 字段)
|
|
159
|
+
- 确认 `sources` 列表非空(至少包含入口文件)
|
|
160
|
+
- 确认 `interfaces` 数组非空(至少有 1 个接口)
|
|
161
|
+
- 若 `interfaces` 为空,检查入口文件是否正确定位(参见 [脚本使用参考](references/SCRIPT_REFERENCE.md) 的故障排查章节)
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Phase 3:脚本渲染接口文档
|
|
166
|
+
|
|
167
|
+
### 3.1 运行渲染脚本
|
|
168
|
+
|
|
169
|
+
使用共享脚本将 JSON 渲染为 Markdown 文档:
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec <outputDir>/interface-spec.json --output <outputDir>/接口规格说明.md
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**也可以一步到位**(跳过 Phase 2 的 JSON 输出,直接从源码生成文档):
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --libroot <analysisRoot> --output <outputDir>/接口规格说明.md
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
> 推荐使用两步方式(先提取 JSON 再渲染),JSON 中间件可复用于下游覆盖率分析。
|
|
182
|
+
|
|
183
|
+
### 3.2 渲染脚本生成的文档结构
|
|
184
|
+
|
|
185
|
+
脚本自动生成以下章节:
|
|
186
|
+
- **基本信息**:库名、入口文件、生成时间、源文件数
|
|
187
|
+
- **接口统计**:类/接口/枚举总数、方法/属性/字段/常量数量
|
|
188
|
+
- **按类分组的接口详情**:每个类/枚举/mixin/extension一个章节,含构造函数、方法、属性、字段、常量、枚举值、函数、变量、类型别名、事件方法汇总等子表格
|
|
189
|
+
- **源文件列表**:所有被分析的源文件路径
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## Phase 4:AI 审查与补充
|
|
194
|
+
|
|
195
|
+
> 脚本已自动完成接口提取和文档渲染,AI 在此阶段负责补充脚本无法提取的内容。
|
|
196
|
+
|
|
197
|
+
### 4.1 读取 README 补充概述
|
|
198
|
+
|
|
199
|
+
读取库的 `README.md`,提取:
|
|
200
|
+
- 库的功能描述和主要特性
|
|
201
|
+
- 适用场景和使用限制
|
|
202
|
+
|
|
203
|
+
将概述信息补充到文档开头(脚本生成的"基本信息"表格之后)。
|
|
204
|
+
|
|
205
|
+
### 4.2 补充注意事项
|
|
206
|
+
|
|
207
|
+
从 README 和代码注释中提取:
|
|
208
|
+
- 使用限制和兼容性说明
|
|
209
|
+
- 已知问题和注意事项
|
|
210
|
+
- 平台支持情况(特别是鸿蒙 `ohos` 平台适配状态)
|
|
211
|
+
|
|
212
|
+
### 4.3 审查接口完整性
|
|
213
|
+
|
|
214
|
+
对比脚本输出的接口列表与 README 中提到的 API:
|
|
215
|
+
- 确认主要 API 均已被脚本提取
|
|
216
|
+
- 若发现遗漏(如脚本正则无法覆盖的特殊语法),手动补充到文档中
|
|
217
|
+
|
|
218
|
+
### 4.4 人工可读性优化
|
|
219
|
+
|
|
220
|
+
- 为缺少 `///` 文档注释的接口补充功能描述(根据方法名推断,标注"待确认")
|
|
221
|
+
- 合并或调整表格顺序,提升可读性
|
|
222
|
+
|
|
223
|
+
> 文档输出格式模板参见 [文档模板](references/TEMPLATE.md)
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## Phase 5:最终文档输出
|
|
228
|
+
|
|
229
|
+
### 5.1 合并最终文档
|
|
230
|
+
|
|
231
|
+
将脚本生成的接口规格文档(Phase 3)与 AI 补充内容(Phase 4)合并为最终文档。
|
|
232
|
+
|
|
233
|
+
最终文档结构:
|
|
234
|
+
```markdown
|
|
235
|
+
# [库名] 接口规格说明书
|
|
236
|
+
|
|
237
|
+
## 基本信息 ← 脚本生成
|
|
238
|
+
## 三方库概述 ← AI 从 README 补充
|
|
239
|
+
## 接口统计 ← 脚本生成
|
|
240
|
+
## [类名] 接口详情 ← 脚本生成(每个类一个章节)
|
|
241
|
+
### 构造函数
|
|
242
|
+
### 方法
|
|
243
|
+
### 属性
|
|
244
|
+
### 字段
|
|
245
|
+
### 常量
|
|
246
|
+
### 枚举值
|
|
247
|
+
...
|
|
248
|
+
## 源文件列表 ← 脚本生成
|
|
249
|
+
## 注意事项 ← AI 补充
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### 5.2 保存文档
|
|
253
|
+
|
|
254
|
+
将最终文档保存为:`<outputDir>/接口规格说明.md`
|
|
255
|
+
|
|
256
|
+
**禁止**将文档放置在 source 目录或其他子目录,必须放在输出目录根目录。
|
|
257
|
+
|
|
258
|
+
### 5.3 保留中间件
|
|
259
|
+
|
|
260
|
+
保留 `<outputDir>/interface-spec.json` 中间件,可供下游覆盖率分析(Demo 覆盖率、XTS 测试覆盖率)复用。
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
## 工具支持
|
|
265
|
+
|
|
266
|
+
### 核心脚本
|
|
267
|
+
|
|
268
|
+
| 脚本 | 用途 | 调用方式 |
|
|
269
|
+
|------|------|----------|
|
|
270
|
+
| `flutter-extract-interfaces.cjs` | 从 Dart 源码提取接口规格 JSON | `node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir <路径> --output <json路径>` |
|
|
271
|
+
| `flutter-render-spec-doc.cjs` | 将 JSON 渲染为 Markdown 文档 | `node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec <json路径> --output <md路径>` |
|
|
272
|
+
|
|
273
|
+
> 脚本位于 `MCP/scripts/`(本 SKILL 不保存副本),详细参数、输出格式、故障排查参见 [脚本使用参考](references/SCRIPT_REFERENCE.md)
|
|
274
|
+
|
|
275
|
+
---
|
|
276
|
+
|
|
277
|
+
## 分析示例
|
|
278
|
+
|
|
279
|
+
详细的分析示例(含脚本输出演示)请参考 [分析示例](references/EXAMPLES.md)。
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## 注意事项
|
|
284
|
+
|
|
285
|
+
1. **脚本优先**:接口提取由 `flutter-extract-interfaces.cjs` 自动完成,AI 不手动逐文件读取源码提取接口
|
|
286
|
+
2. **只分析公开接口**:脚本自动过滤 `_` 前缀私有成员和 export hide/show,确保只输出对外公开的接口
|
|
287
|
+
3. **忠实于源码**:所有接口信息来自脚本解析实际源码,不允许推断或捏造;`description` 字段为空时使用 `-` 表示
|
|
288
|
+
4. **monorepo 支持**:脚本自动检测 monorepo 结构(如 `flutter_inappwebview` 含多个子包),无需手动指定主包
|
|
289
|
+
5. **export 链追踪**:脚本递归追踪 `export` 语句,支持 `src/` 相对路径和 `package:` 跨包路径,支持 hide/show 过滤
|
|
290
|
+
6. **JSON 中间件复用**:`interface-spec.json` 可供下游覆盖率分析脚本复用,避免重复解析源码
|
|
291
|
+
7. **文档输出位置**:最终文档必须保存在 `<outputDir>/接口规格说明.md`,不得放在 source 目录内
|