@ohos-cpf/3rdloop 0.0.2 → 0.0.4
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 +290 -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,148 +1,148 @@
|
|
|
1
|
-
# 接口规格说明文档模板
|
|
2
|
-
|
|
3
|
-
本模板定义 RNLibraryInterfaceAnalyzer 最终输出的 `接口规格说明.md` 文档结构。
|
|
4
|
-
|
|
5
|
-
> 脚本 `rn-render-spec-doc.cjs` 生成基础接口规格部分(第 1~4 节),AI 在此基础上补充第 5 节(鸿蒙化接口差异)。
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 文档结构
|
|
10
|
-
|
|
11
|
-
```markdown
|
|
12
|
-
# {libraryName} 接口规格说明
|
|
13
|
-
|
|
14
|
-
## 1. 概述
|
|
15
|
-
- 上游原库地址:{upstreamRepoUrl}
|
|
16
|
-
- 鸿蒙化仓库地址:{ohosRepoUrl}
|
|
17
|
-
- 库功能描述:(从 README 提取)
|
|
18
|
-
|
|
19
|
-
## 2. 入口文件与分析范围
|
|
20
|
-
|
|
21
|
-
**上游原库入口文件:** `index.js`(或实际路径,由脚本自动检测)
|
|
22
|
-
|
|
23
|
-
**分析涉及的源文件:**
|
|
24
|
-
- `src/index.ts`
|
|
25
|
-
- `android/src/main/java/.../MyModule.java`
|
|
26
|
-
- `ios/MyModule.m`
|
|
27
|
-
- ...(脚本输出的 sources 列表)
|
|
28
|
-
|
|
29
|
-
**鸿蒙化仓库入口文件:** `Index.ets`(或实际路径)
|
|
30
|
-
|
|
31
|
-
## 3. JS/TS 层导出接口
|
|
32
|
-
|
|
33
|
-
> 以下由 `rn-render-spec-doc.cjs` 自动生成,按类/模块分组
|
|
34
|
-
|
|
35
|
-
### 3.1 类 (Classes)
|
|
36
|
-
|
|
37
|
-
#### ClassName
|
|
38
|
-
|
|
39
|
-
| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
|
|
40
|
-
|------|-----------|-----------|----------|
|
|
41
|
-
| 1 | ClassName | constructor(param1: type1) | 构造函数 |
|
|
42
|
-
| 2 | | methodName(param: type): returnType | 方法描述 |
|
|
43
|
-
| 3 | | static staticMethod(): returnType | 静态方法 |
|
|
44
|
-
| 4 | | propertyName: type | 公开属性 |
|
|
45
|
-
|
|
46
|
-
### 3.2 接口/类型 (Interfaces/Types)
|
|
47
|
-
|
|
48
|
-
#### InterfaceName
|
|
49
|
-
|
|
50
|
-
| 序号 | 字段名 | 类型 | 必填 | 描述 |
|
|
51
|
-
|------|--------|------|------|------|
|
|
52
|
-
| 1 | field1 | string | 是 | 字段描述 |
|
|
53
|
-
| 2 | field2? | number | 否 | 可选字段 |
|
|
54
|
-
|
|
55
|
-
### 3.3 枚举 (Enums)
|
|
56
|
-
|
|
57
|
-
#### EnumName
|
|
58
|
-
|
|
59
|
-
| 序号 | 成员名 | 值 | 描述 |
|
|
60
|
-
|------|--------|-----|------|
|
|
61
|
-
| 1 | MEMBER_A | 'A' | 描述 |
|
|
62
|
-
|
|
63
|
-
### 3.4 函数 (Functions)
|
|
64
|
-
|
|
65
|
-
| 序号 | 函数名 | 参数 | 返回值 | 描述 |
|
|
66
|
-
|------|--------|------|--------|------|
|
|
67
|
-
| 1 | funcName | (param: type) | returnType | 函数描述 |
|
|
68
|
-
|
|
69
|
-
### 3.5 变量/常量 (Variables)
|
|
70
|
-
|
|
71
|
-
| 序号 | 变量名 | 类型 | 描述 |
|
|
72
|
-
|------|--------|------|------|
|
|
73
|
-
| 1 | CONST_NAME | type | 常量描述 |
|
|
74
|
-
|
|
75
|
-
### 3.6 TurboModule Spec
|
|
76
|
-
|
|
77
|
-
> 如果库使用 TurboModule 架构,脚本会自动提取 Native*.ts 中的 Spec 接口
|
|
78
|
-
|
|
79
|
-
#### ModuleName
|
|
80
|
-
|
|
81
|
-
| 序号 | 方法名 | 参数 | 返回值 | 事件 | 说明 |
|
|
82
|
-
|------|--------|------|--------|------|------|
|
|
83
|
-
| 1 | nativeMethod | (param: type) | Promise<void> | 否 | 方法描述 |
|
|
84
|
-
|
|
85
|
-
## 4. 原生模块导出接口(AI 补充)
|
|
86
|
-
|
|
87
|
-
> 脚本仅提取 JS/TS 层和 TurboModule Spec。如果库包含旧式原生模块(iOS RCT_EXPORT_MODULE / Android ReactPackage),AI 需手动补充此节。
|
|
88
|
-
|
|
89
|
-
### 4.1 iOS 原生模块
|
|
90
|
-
|
|
91
|
-
#### ModuleName
|
|
92
|
-
|
|
93
|
-
| 序号 | 方法名 | 参数 | 返回值 | 描述 |
|
|
94
|
-
|------|--------|------|--------|------|
|
|
95
|
-
| 1 | nativeMethod | (param: type) | Promise<void> | 方法描述 |
|
|
96
|
-
|
|
97
|
-
### 4.2 Android 原生模块(与 iOS 差异)
|
|
98
|
-
|
|
99
|
-
> 以下仅列出与 iOS 端差异的接口
|
|
100
|
-
|
|
101
|
-
| 序号 | 方法名 | iOS 签名 | Android 签名 | 差异说明 |
|
|
102
|
-
|------|--------|----------|--------------|----------|
|
|
103
|
-
| 1 | methodName | (param: String) | (param: String, extra: String) | Android 端多一个参数 |
|
|
104
|
-
|
|
105
|
-
## 5. 鸿蒙化接口差异(AI 补充)
|
|
106
|
-
|
|
107
|
-
> 鸿蒙化库接口默认与原库一致,以下仅列出差异项
|
|
108
|
-
>
|
|
109
|
-
> **文档来源说明**:{说明文档来源}
|
|
110
|
-
|
|
111
|
-
### 5.1 缺失接口 ❌
|
|
112
|
-
|
|
113
|
-
| 序号 | 接口名 | 原库位置 | 文档是否标注 | 说明 |
|
|
114
|
-
|------|--------|----------|--------------|------|
|
|
115
|
-
| 1 | methodName | ClassName.methodName | ✅ 已标注 | 鸿蒙化版本未实现,文档标注为 No |
|
|
116
|
-
|
|
117
|
-
### 5.2 新增接口 🆕
|
|
118
|
-
|
|
119
|
-
| 序号 | 接口名 | 鸿蒙化位置 | 文档是否标注 | 说明 |
|
|
120
|
-
|------|--------|------------|--------------|------|
|
|
121
|
-
| 1 | ohosMethod | Index.ets | ✅ 已标注 | 鸿蒙平台特有 API |
|
|
122
|
-
|
|
123
|
-
### 5.3 签名变更 ⚠️
|
|
124
|
-
|
|
125
|
-
| 序号 | 接口名 | 原库签名 | 鸿蒙化签名 | 文档是否标注 | 变更说明 |
|
|
126
|
-
|------|--------|----------|------------|--------------|----------|
|
|
127
|
-
| 1 | methodName | (param: string): void | (param: number): void | ⚠️ 部分标注 | 参数类型变更 |
|
|
128
|
-
|
|
129
|
-
> 💡 **文档是否标注列取值**:
|
|
130
|
-
> - ✅ 已标注:文档已列出该接口,HarmonyOS Support 列为 `No`/`partially`
|
|
131
|
-
> - ⚠️ 部分标注:文档列出接口但未说明差异
|
|
132
|
-
> - ❌ 未标注:文档中完全未提及该接口
|
|
133
|
-
> - — 不适用:该库无使用文档文件
|
|
134
|
-
|
|
135
|
-
(若无差异,注明"鸿蒙化版本接口与上游原库完全一致")
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## 文档生成流程
|
|
139
|
-
|
|
140
|
-
```
|
|
141
|
-
rn-extract-interfaces.cjs → interface-spec.json
|
|
142
|
-
↓
|
|
143
|
-
rn-render-spec-doc.cjs → 接口规格说明_基础.md(第 1~3 节)
|
|
144
|
-
↓
|
|
145
|
-
AI 补充第 4 节(原生模块,如需) + 第 5 节(鸿蒙化差异)
|
|
146
|
-
↓
|
|
147
|
-
接口规格说明.md(最终文档)
|
|
148
|
-
```
|
|
1
|
+
# 接口规格说明文档模板
|
|
2
|
+
|
|
3
|
+
本模板定义 RNLibraryInterfaceAnalyzer 最终输出的 `接口规格说明.md` 文档结构。
|
|
4
|
+
|
|
5
|
+
> 脚本 `rn-render-spec-doc.cjs` 生成基础接口规格部分(第 1~4 节),AI 在此基础上补充第 5 节(鸿蒙化接口差异)。
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 文档结构
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# {libraryName} 接口规格说明
|
|
13
|
+
|
|
14
|
+
## 1. 概述
|
|
15
|
+
- 上游原库地址:{upstreamRepoUrl}
|
|
16
|
+
- 鸿蒙化仓库地址:{ohosRepoUrl}
|
|
17
|
+
- 库功能描述:(从 README 提取)
|
|
18
|
+
|
|
19
|
+
## 2. 入口文件与分析范围
|
|
20
|
+
|
|
21
|
+
**上游原库入口文件:** `index.js`(或实际路径,由脚本自动检测)
|
|
22
|
+
|
|
23
|
+
**分析涉及的源文件:**
|
|
24
|
+
- `src/index.ts`
|
|
25
|
+
- `android/src/main/java/.../MyModule.java`
|
|
26
|
+
- `ios/MyModule.m`
|
|
27
|
+
- ...(脚本输出的 sources 列表)
|
|
28
|
+
|
|
29
|
+
**鸿蒙化仓库入口文件:** `Index.ets`(或实际路径)
|
|
30
|
+
|
|
31
|
+
## 3. JS/TS 层导出接口
|
|
32
|
+
|
|
33
|
+
> 以下由 `rn-render-spec-doc.cjs` 自动生成,按类/模块分组
|
|
34
|
+
|
|
35
|
+
### 3.1 类 (Classes)
|
|
36
|
+
|
|
37
|
+
#### ClassName
|
|
38
|
+
|
|
39
|
+
| 序号 | 类名/成员 | 方法/属性 | 功能描述 |
|
|
40
|
+
|------|-----------|-----------|----------|
|
|
41
|
+
| 1 | ClassName | constructor(param1: type1) | 构造函数 |
|
|
42
|
+
| 2 | | methodName(param: type): returnType | 方法描述 |
|
|
43
|
+
| 3 | | static staticMethod(): returnType | 静态方法 |
|
|
44
|
+
| 4 | | propertyName: type | 公开属性 |
|
|
45
|
+
|
|
46
|
+
### 3.2 接口/类型 (Interfaces/Types)
|
|
47
|
+
|
|
48
|
+
#### InterfaceName
|
|
49
|
+
|
|
50
|
+
| 序号 | 字段名 | 类型 | 必填 | 描述 |
|
|
51
|
+
|------|--------|------|------|------|
|
|
52
|
+
| 1 | field1 | string | 是 | 字段描述 |
|
|
53
|
+
| 2 | field2? | number | 否 | 可选字段 |
|
|
54
|
+
|
|
55
|
+
### 3.3 枚举 (Enums)
|
|
56
|
+
|
|
57
|
+
#### EnumName
|
|
58
|
+
|
|
59
|
+
| 序号 | 成员名 | 值 | 描述 |
|
|
60
|
+
|------|--------|-----|------|
|
|
61
|
+
| 1 | MEMBER_A | 'A' | 描述 |
|
|
62
|
+
|
|
63
|
+
### 3.4 函数 (Functions)
|
|
64
|
+
|
|
65
|
+
| 序号 | 函数名 | 参数 | 返回值 | 描述 |
|
|
66
|
+
|------|--------|------|--------|------|
|
|
67
|
+
| 1 | funcName | (param: type) | returnType | 函数描述 |
|
|
68
|
+
|
|
69
|
+
### 3.5 变量/常量 (Variables)
|
|
70
|
+
|
|
71
|
+
| 序号 | 变量名 | 类型 | 描述 |
|
|
72
|
+
|------|--------|------|------|
|
|
73
|
+
| 1 | CONST_NAME | type | 常量描述 |
|
|
74
|
+
|
|
75
|
+
### 3.6 TurboModule Spec
|
|
76
|
+
|
|
77
|
+
> 如果库使用 TurboModule 架构,脚本会自动提取 Native*.ts 中的 Spec 接口
|
|
78
|
+
|
|
79
|
+
#### ModuleName
|
|
80
|
+
|
|
81
|
+
| 序号 | 方法名 | 参数 | 返回值 | 事件 | 说明 |
|
|
82
|
+
|------|--------|------|--------|------|------|
|
|
83
|
+
| 1 | nativeMethod | (param: type) | Promise<void> | 否 | 方法描述 |
|
|
84
|
+
|
|
85
|
+
## 4. 原生模块导出接口(AI 补充)
|
|
86
|
+
|
|
87
|
+
> 脚本仅提取 JS/TS 层和 TurboModule Spec。如果库包含旧式原生模块(iOS RCT_EXPORT_MODULE / Android ReactPackage),AI 需手动补充此节。
|
|
88
|
+
|
|
89
|
+
### 4.1 iOS 原生模块
|
|
90
|
+
|
|
91
|
+
#### ModuleName
|
|
92
|
+
|
|
93
|
+
| 序号 | 方法名 | 参数 | 返回值 | 描述 |
|
|
94
|
+
|------|--------|------|--------|------|
|
|
95
|
+
| 1 | nativeMethod | (param: type) | Promise<void> | 方法描述 |
|
|
96
|
+
|
|
97
|
+
### 4.2 Android 原生模块(与 iOS 差异)
|
|
98
|
+
|
|
99
|
+
> 以下仅列出与 iOS 端差异的接口
|
|
100
|
+
|
|
101
|
+
| 序号 | 方法名 | iOS 签名 | Android 签名 | 差异说明 |
|
|
102
|
+
|------|--------|----------|--------------|----------|
|
|
103
|
+
| 1 | methodName | (param: String) | (param: String, extra: String) | Android 端多一个参数 |
|
|
104
|
+
|
|
105
|
+
## 5. 鸿蒙化接口差异(AI 补充)
|
|
106
|
+
|
|
107
|
+
> 鸿蒙化库接口默认与原库一致,以下仅列出差异项
|
|
108
|
+
>
|
|
109
|
+
> **文档来源说明**:{说明文档来源}
|
|
110
|
+
|
|
111
|
+
### 5.1 缺失接口 ❌
|
|
112
|
+
|
|
113
|
+
| 序号 | 接口名 | 原库位置 | 文档是否标注 | 说明 |
|
|
114
|
+
|------|--------|----------|--------------|------|
|
|
115
|
+
| 1 | methodName | ClassName.methodName | ✅ 已标注 | 鸿蒙化版本未实现,文档标注为 No |
|
|
116
|
+
|
|
117
|
+
### 5.2 新增接口 🆕
|
|
118
|
+
|
|
119
|
+
| 序号 | 接口名 | 鸿蒙化位置 | 文档是否标注 | 说明 |
|
|
120
|
+
|------|--------|------------|--------------|------|
|
|
121
|
+
| 1 | ohosMethod | Index.ets | ✅ 已标注 | 鸿蒙平台特有 API |
|
|
122
|
+
|
|
123
|
+
### 5.3 签名变更 ⚠️
|
|
124
|
+
|
|
125
|
+
| 序号 | 接口名 | 原库签名 | 鸿蒙化签名 | 文档是否标注 | 变更说明 |
|
|
126
|
+
|------|--------|----------|------------|--------------|----------|
|
|
127
|
+
| 1 | methodName | (param: string): void | (param: number): void | ⚠️ 部分标注 | 参数类型变更 |
|
|
128
|
+
|
|
129
|
+
> 💡 **文档是否标注列取值**:
|
|
130
|
+
> - ✅ 已标注:文档已列出该接口,HarmonyOS Support 列为 `No`/`partially`
|
|
131
|
+
> - ⚠️ 部分标注:文档列出接口但未说明差异
|
|
132
|
+
> - ❌ 未标注:文档中完全未提及该接口
|
|
133
|
+
> - — 不适用:该库无使用文档文件
|
|
134
|
+
|
|
135
|
+
(若无差异,注明"鸿蒙化版本接口与上游原库完全一致")
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## 文档生成流程
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
rn-extract-interfaces.cjs → interface-spec.json
|
|
142
|
+
↓
|
|
143
|
+
rn-render-spec-doc.cjs → 接口规格说明_基础.md(第 1~3 节)
|
|
144
|
+
↓
|
|
145
|
+
AI 补充第 4 节(原生模块,如需) + 第 5 节(鸿蒙化差异)
|
|
146
|
+
↓
|
|
147
|
+
接口规格说明.md(最终文档)
|
|
148
|
+
```
|
package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md
CHANGED
|
@@ -1,118 +1,118 @@
|
|
|
1
|
-
# 文档标注查询指南
|
|
2
|
-
|
|
3
|
-
本文档详细说明如何对照鸿蒙 RN 三方库使用文档,标注差异接口的文档覆盖情况。
|
|
4
|
-
|
|
5
|
-
## 文档来源确定
|
|
6
|
-
|
|
7
|
-
**文档来源优先级**:
|
|
8
|
-
|
|
9
|
-
1. **用户传入 `rndocUrl`**:若 `rndocUrl` 不为 null/空,使用该地址作为文档来源
|
|
10
|
-
2. **鸿蒙化仓库 README.md**(默认回退):若 `rndocUrl` 未提供,直接使用 `{ohosAnalysisRoot}/README.md`
|
|
11
|
-
|
|
12
|
-
根据 `rndocUrl` 的输入类型,分别处理:
|
|
13
|
-
|
|
14
|
-
| rndocUrl 输入类型 | 判断规则 | 处理方式 | 文档读取路径 |
|
|
15
|
-
|----------|----------|----------|----------|
|
|
16
|
-
| Git URL | 以 `http://`、`https://`、`git://`、`ssh://` 开头,或以 `.git` 结尾 | 克隆到 `{outputDir}/tmp/rndoc`,按 URL 格式解析规则提取分支/commit/子路径后 checkout | `{outputDir}/tmp/rndoc/{subpath}/` 下的 `.md` 文件 |
|
|
17
|
-
| 本地路径 | 路径存在且非 Git URL | 直接读取目录文件 | `rndocUrl` 指向的目录下的 `.md` 文件 |
|
|
18
|
-
| Web URL | 以 `http://` 或 `https://` 开头但非 Git 仓库地址(不含 `.git`、`/tree/`、`/blob/`) | 使用 web fetch 获取页面内容 | web fetch 返回的 Markdown 内容 |
|
|
19
|
-
| 未提供(null/空) | — | 直接使用鸿蒙化仓库根目录 `README.md` | `{ohosAnalysisRoot}/README.md` |
|
|
20
|
-
|
|
21
|
-
> ⚠️ 当 `rndocUrl` 为 Git URL 时,克隆必须存放到 `{outputDir}/tmp/rndoc`,禁止克隆到系统临时目录或其他外部路径。
|
|
22
|
-
|
|
23
|
-
## 定位文档文件
|
|
24
|
-
|
|
25
|
-
根据文档来源类型,在对应路径中查找匹配的 `.md` 文件:
|
|
26
|
-
|
|
27
|
-
**rndocUrl 为 Git URL 或本地路径时**:
|
|
28
|
-
|
|
29
|
-
- 优先精确匹配:`{libraryName}.md`(如 `react-native-touch-id` → `react-native-touch-id.md`)
|
|
30
|
-
- 若未命中,尝试去除 `@scope/` 前缀后匹配
|
|
31
|
-
- 若仍未命中,列出目录下所有 `.md` 文件,按名称相似度选取最接近的文件
|
|
32
|
-
- 若无匹配的 `.md` 文件,列出目录下所有 `.md` 文件,选取最相关的(如 `README.md`)
|
|
33
|
-
|
|
34
|
-
**rndocUrl 为 Web URL 时**:直接使用 web fetch 获取的内容作为文档。
|
|
35
|
-
|
|
36
|
-
**rndocUrl 未提供时**:直接读取 `{ohosAnalysisRoot}/README.md`。
|
|
37
|
-
|
|
38
|
-
**无文档可用**:若以上所有方式均无法获取到文档内容,则所有差异项的"文档是否标注"列统一填 `—`(无文档),并在差异表上方注明"该库暂无使用文档",**跳过后续查询步骤**。
|
|
39
|
-
|
|
40
|
-
## 文档结构说明(必读)
|
|
41
|
-
|
|
42
|
-
文档的章节编号、标题用词、数量都因库而异,**不要假设固定结构**。所有判断都必须基于文档**实际内容**,而非预设的章节编号或关键词。
|
|
43
|
-
|
|
44
|
-
**定位接口标注的唯一可靠依据**:表格中是否存在 **"HarmonyOS Support" 列**。凡是包含该列的表格,都是接口标注表;不含该列的表格(如纯说明性表格)不携带标注信息。
|
|
45
|
-
|
|
46
|
-
- 文档中可能有一张或多张包含 "HarmonyOS Support" 列的表格(不同库的表格数量和划分方式不同,需逐张检查)。
|
|
47
|
-
- 该列通常为表格最后一列,取值为(大小写不统一):`yes` / `No` / `no` / `NO` / `partially`。
|
|
48
|
-
- 接口章节开头通常有一段固定说明文字,解释上述取值含义:
|
|
49
|
-
> "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。
|
|
50
|
-
- 除接口表格外,文档还可能包含"遗留问题"/"已知问题"类章节(通过 issue 链接补充提及某些接口的已知缺陷),编号和位置不固定,识别时同样以实际内容为准。
|
|
51
|
-
|
|
52
|
-
> ⚠️ **关键**:文档通过 **"HarmonyOS Support" 列** 标注每个接口在鸿蒙平台的支持情况:
|
|
53
|
-
> - `yes` —— 鸿蒙支持
|
|
54
|
-
> - `No` / `no` / `NO` —— **鸿蒙不支持**(这就是对"缺失接口"的标注!)
|
|
55
|
-
> - `partially` —— 部分支持(这就是对"签名变更/功能差异"的标注!)
|
|
56
|
-
>
|
|
57
|
-
> **该列的 `No` / `partially` 本身就是差异说明,等同于"已标注差异",不要再去寻找额外的"不支持"文字描述。**
|
|
58
|
-
|
|
59
|
-
> ⚠️ **无 "HarmonyOS Support" 列的文档处理**:若文档(如鸿蒙化仓库 README.md)中不包含 "HarmonyOS Support" 列表格,则无法通过表格列进行精确标注判定。此时应通读文档全文,检查文档是否以文字描述、已知问题列表、或其他形式提及差异接口。若文档以任意形式明确提及某接口的差异或不支持,记为 ⚠️ 部分标注;若完全未提及,记为 ❌ 未标注。
|
|
60
|
-
|
|
61
|
-
## 查询步骤
|
|
62
|
-
|
|
63
|
-
### 步骤 1:获取文档内容
|
|
64
|
-
|
|
65
|
-
- **rndocUrl 为 Git URL**:克隆到 `{outputDir}/tmp/rndoc` 后读取本地文件
|
|
66
|
-
- **rndocUrl 为本地路径**:直接读取本地文件
|
|
67
|
-
- **rndocUrl 为 Web URL**:使用 web fetch 获取内容
|
|
68
|
-
- **rndocUrl 未提供**:直接读取 `{ohosAnalysisRoot}/README.md`
|
|
69
|
-
|
|
70
|
-
> ⚠️ **优先使用本地文件读取**,避免 web fetch。gitcode.com 等平台网页通常只渲染页面框架而不返回 Markdown 原文,web fetch 可靠性低。
|
|
71
|
-
|
|
72
|
-
### 步骤 2:定位文档文件
|
|
73
|
-
|
|
74
|
-
按上述规则定位具体的 `.md` 文件。若定位到多个相关文件,合并阅读所有文件内容。
|
|
75
|
-
|
|
76
|
-
### 步骤 3:读取文档内容
|
|
77
|
-
|
|
78
|
-
**通读全部内容**,定位所有包含 "HarmonyOS Support" 列的表格行(按列名定位,不依赖章节标题或编号)。逐行判断每行的 "HarmonyOS Support" 列取值。
|
|
79
|
-
|
|
80
|
-
若文档不包含 "HarmonyOS Support" 列表格,则通读全文检查文字描述形式的差异标注。
|
|
81
|
-
|
|
82
|
-
### 步骤 4:逐项核对标注
|
|
83
|
-
|
|
84
|
-
**4a. 名称归一化匹配**
|
|
85
|
-
|
|
86
|
-
文档中的接口名与源码提取的接口名格式可能不同,匹配前需归一化:
|
|
87
|
-
- 方法名:文档写 `clearFormData()`,源码提取 `clearFormData` → 去除 `()` 后缀匹配
|
|
88
|
-
- 可选属性:文档写 `saveFormDataDisabled?`,源码提取 `saveFormDataDisabled` → 去除 `?` 后缀匹配
|
|
89
|
-
- 版本标记:文档写 `paymentRequestEnabled<sup>13.15.1+</sup>`,源码提取 `paymentRequestEnabled` → 去除 `<sup>...</sup>` 后匹配
|
|
90
|
-
- 匹配方式:在文档全文中搜索归一化后的接口名(子串匹配即可)
|
|
91
|
-
|
|
92
|
-
**4b. 判定规则**
|
|
93
|
-
|
|
94
|
-
**有 "HarmonyOS Support" 列的文档**:
|
|
95
|
-
|
|
96
|
-
| 差异类型 | HarmonyOS Support 列值 | 判定结果 |
|
|
97
|
-
|----------|----------------------|----------|
|
|
98
|
-
| 缺失接口 | `No` / `no` / `NO` | ✅ 已标注(文档明确标注不支持) |
|
|
99
|
-
| 缺失接口 | `partially` | ⚠️ 部分标注(文档标注部分支持,但未说明完全缺失) |
|
|
100
|
-
| 缺失接口 | `yes` | ⚠️ 部分标注(文档标注支持,与分析结论矛盾,可能文档过时) |
|
|
101
|
-
| 新增接口 | 文档中提及且标注为 Harmony 特有 / `yes` | ✅ 已标注 |
|
|
102
|
-
| 新增接口 | 文档中提及但未说明为 Harmony 特有 | ⚠️ 部分标注 |
|
|
103
|
-
| 签名变更 | `partially` | ✅ 已标注(文档标注部分支持,通常对应签名/功能差异) |
|
|
104
|
-
| 签名变更 | `yes` 且文档描述了鸿蒙侧行为差异 | ✅ 已标注 |
|
|
105
|
-
| 签名变更 | `yes` 但未描述差异 | ⚠️ 部分标注 |
|
|
106
|
-
| 任意类型 | 接口在文档中完全未出现 | ❌ 未标注 |
|
|
107
|
-
|
|
108
|
-
**无 "HarmonyOS Support" 列的文档(如 README.md)**:
|
|
109
|
-
|
|
110
|
-
| 差异类型 | 文档中是否提及 | 判定结果 |
|
|
111
|
-
|----------|--------------|----------|
|
|
112
|
-
| 任意类型 | 文档明确提及该接口在鸿蒙平台不支持/有差异 | ⚠️ 部分标注(文字描述不如表格列精确) |
|
|
113
|
-
| 任意类型 | 文档提及该接口但未说明鸿蒙差异 | ⚠️ 部分标注 |
|
|
114
|
-
| 任意类型 | 文档完全未提及该接口 | ❌ 未标注 |
|
|
115
|
-
|
|
116
|
-
**额外检查**:若接口在接口表格中未找到,还需检查标题含「遗留问题」/「已知问题」的章节是否通过 issue 链接提及该接口。若遗留问题中提及,记为 ⚠️ 部分标注。
|
|
117
|
-
|
|
118
|
-
> 💡 **示例**:`clearFormData` 是缺失接口,在文档「静态方法」章节的表格中找到行 `| clearFormData() | ... | function | No | Android | No |`,HarmonyOS Support 列为 `No` → 判定为 **✅ 已标注**。
|
|
1
|
+
# 文档标注查询指南
|
|
2
|
+
|
|
3
|
+
本文档详细说明如何对照鸿蒙 RN 三方库使用文档,标注差异接口的文档覆盖情况。
|
|
4
|
+
|
|
5
|
+
## 文档来源确定
|
|
6
|
+
|
|
7
|
+
**文档来源优先级**:
|
|
8
|
+
|
|
9
|
+
1. **用户传入 `rndocUrl`**:若 `rndocUrl` 不为 null/空,使用该地址作为文档来源
|
|
10
|
+
2. **鸿蒙化仓库 README.md**(默认回退):若 `rndocUrl` 未提供,直接使用 `{ohosAnalysisRoot}/README.md`
|
|
11
|
+
|
|
12
|
+
根据 `rndocUrl` 的输入类型,分别处理:
|
|
13
|
+
|
|
14
|
+
| rndocUrl 输入类型 | 判断规则 | 处理方式 | 文档读取路径 |
|
|
15
|
+
|----------|----------|----------|----------|
|
|
16
|
+
| Git URL | 以 `http://`、`https://`、`git://`、`ssh://` 开头,或以 `.git` 结尾 | 克隆到 `{outputDir}/tmp/rndoc`,按 URL 格式解析规则提取分支/commit/子路径后 checkout | `{outputDir}/tmp/rndoc/{subpath}/` 下的 `.md` 文件 |
|
|
17
|
+
| 本地路径 | 路径存在且非 Git URL | 直接读取目录文件 | `rndocUrl` 指向的目录下的 `.md` 文件 |
|
|
18
|
+
| Web URL | 以 `http://` 或 `https://` 开头但非 Git 仓库地址(不含 `.git`、`/tree/`、`/blob/`) | 使用 web fetch 获取页面内容 | web fetch 返回的 Markdown 内容 |
|
|
19
|
+
| 未提供(null/空) | — | 直接使用鸿蒙化仓库根目录 `README.md` | `{ohosAnalysisRoot}/README.md` |
|
|
20
|
+
|
|
21
|
+
> ⚠️ 当 `rndocUrl` 为 Git URL 时,克隆必须存放到 `{outputDir}/tmp/rndoc`,禁止克隆到系统临时目录或其他外部路径。
|
|
22
|
+
|
|
23
|
+
## 定位文档文件
|
|
24
|
+
|
|
25
|
+
根据文档来源类型,在对应路径中查找匹配的 `.md` 文件:
|
|
26
|
+
|
|
27
|
+
**rndocUrl 为 Git URL 或本地路径时**:
|
|
28
|
+
|
|
29
|
+
- 优先精确匹配:`{libraryName}.md`(如 `react-native-touch-id` → `react-native-touch-id.md`)
|
|
30
|
+
- 若未命中,尝试去除 `@scope/` 前缀后匹配
|
|
31
|
+
- 若仍未命中,列出目录下所有 `.md` 文件,按名称相似度选取最接近的文件
|
|
32
|
+
- 若无匹配的 `.md` 文件,列出目录下所有 `.md` 文件,选取最相关的(如 `README.md`)
|
|
33
|
+
|
|
34
|
+
**rndocUrl 为 Web URL 时**:直接使用 web fetch 获取的内容作为文档。
|
|
35
|
+
|
|
36
|
+
**rndocUrl 未提供时**:直接读取 `{ohosAnalysisRoot}/README.md`。
|
|
37
|
+
|
|
38
|
+
**无文档可用**:若以上所有方式均无法获取到文档内容,则所有差异项的"文档是否标注"列统一填 `—`(无文档),并在差异表上方注明"该库暂无使用文档",**跳过后续查询步骤**。
|
|
39
|
+
|
|
40
|
+
## 文档结构说明(必读)
|
|
41
|
+
|
|
42
|
+
文档的章节编号、标题用词、数量都因库而异,**不要假设固定结构**。所有判断都必须基于文档**实际内容**,而非预设的章节编号或关键词。
|
|
43
|
+
|
|
44
|
+
**定位接口标注的唯一可靠依据**:表格中是否存在 **"HarmonyOS Support" 列**。凡是包含该列的表格,都是接口标注表;不含该列的表格(如纯说明性表格)不携带标注信息。
|
|
45
|
+
|
|
46
|
+
- 文档中可能有一张或多张包含 "HarmonyOS Support" 列的表格(不同库的表格数量和划分方式不同,需逐张检查)。
|
|
47
|
+
- 该列通常为表格最后一列,取值为(大小写不统一):`yes` / `No` / `no` / `NO` / `partially`。
|
|
48
|
+
- 接口章节开头通常有一段固定说明文字,解释上述取值含义:
|
|
49
|
+
> "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。
|
|
50
|
+
- 除接口表格外,文档还可能包含"遗留问题"/"已知问题"类章节(通过 issue 链接补充提及某些接口的已知缺陷),编号和位置不固定,识别时同样以实际内容为准。
|
|
51
|
+
|
|
52
|
+
> ⚠️ **关键**:文档通过 **"HarmonyOS Support" 列** 标注每个接口在鸿蒙平台的支持情况:
|
|
53
|
+
> - `yes` —— 鸿蒙支持
|
|
54
|
+
> - `No` / `no` / `NO` —— **鸿蒙不支持**(这就是对"缺失接口"的标注!)
|
|
55
|
+
> - `partially` —— 部分支持(这就是对"签名变更/功能差异"的标注!)
|
|
56
|
+
>
|
|
57
|
+
> **该列的 `No` / `partially` 本身就是差异说明,等同于"已标注差异",不要再去寻找额外的"不支持"文字描述。**
|
|
58
|
+
|
|
59
|
+
> ⚠️ **无 "HarmonyOS Support" 列的文档处理**:若文档(如鸿蒙化仓库 README.md)中不包含 "HarmonyOS Support" 列表格,则无法通过表格列进行精确标注判定。此时应通读文档全文,检查文档是否以文字描述、已知问题列表、或其他形式提及差异接口。若文档以任意形式明确提及某接口的差异或不支持,记为 ⚠️ 部分标注;若完全未提及,记为 ❌ 未标注。
|
|
60
|
+
|
|
61
|
+
## 查询步骤
|
|
62
|
+
|
|
63
|
+
### 步骤 1:获取文档内容
|
|
64
|
+
|
|
65
|
+
- **rndocUrl 为 Git URL**:克隆到 `{outputDir}/tmp/rndoc` 后读取本地文件
|
|
66
|
+
- **rndocUrl 为本地路径**:直接读取本地文件
|
|
67
|
+
- **rndocUrl 为 Web URL**:使用 web fetch 获取内容
|
|
68
|
+
- **rndocUrl 未提供**:直接读取 `{ohosAnalysisRoot}/README.md`
|
|
69
|
+
|
|
70
|
+
> ⚠️ **优先使用本地文件读取**,避免 web fetch。gitcode.com 等平台网页通常只渲染页面框架而不返回 Markdown 原文,web fetch 可靠性低。
|
|
71
|
+
|
|
72
|
+
### 步骤 2:定位文档文件
|
|
73
|
+
|
|
74
|
+
按上述规则定位具体的 `.md` 文件。若定位到多个相关文件,合并阅读所有文件内容。
|
|
75
|
+
|
|
76
|
+
### 步骤 3:读取文档内容
|
|
77
|
+
|
|
78
|
+
**通读全部内容**,定位所有包含 "HarmonyOS Support" 列的表格行(按列名定位,不依赖章节标题或编号)。逐行判断每行的 "HarmonyOS Support" 列取值。
|
|
79
|
+
|
|
80
|
+
若文档不包含 "HarmonyOS Support" 列表格,则通读全文检查文字描述形式的差异标注。
|
|
81
|
+
|
|
82
|
+
### 步骤 4:逐项核对标注
|
|
83
|
+
|
|
84
|
+
**4a. 名称归一化匹配**
|
|
85
|
+
|
|
86
|
+
文档中的接口名与源码提取的接口名格式可能不同,匹配前需归一化:
|
|
87
|
+
- 方法名:文档写 `clearFormData()`,源码提取 `clearFormData` → 去除 `()` 后缀匹配
|
|
88
|
+
- 可选属性:文档写 `saveFormDataDisabled?`,源码提取 `saveFormDataDisabled` → 去除 `?` 后缀匹配
|
|
89
|
+
- 版本标记:文档写 `paymentRequestEnabled<sup>13.15.1+</sup>`,源码提取 `paymentRequestEnabled` → 去除 `<sup>...</sup>` 后匹配
|
|
90
|
+
- 匹配方式:在文档全文中搜索归一化后的接口名(子串匹配即可)
|
|
91
|
+
|
|
92
|
+
**4b. 判定规则**
|
|
93
|
+
|
|
94
|
+
**有 "HarmonyOS Support" 列的文档**:
|
|
95
|
+
|
|
96
|
+
| 差异类型 | HarmonyOS Support 列值 | 判定结果 |
|
|
97
|
+
|----------|----------------------|----------|
|
|
98
|
+
| 缺失接口 | `No` / `no` / `NO` | ✅ 已标注(文档明确标注不支持) |
|
|
99
|
+
| 缺失接口 | `partially` | ⚠️ 部分标注(文档标注部分支持,但未说明完全缺失) |
|
|
100
|
+
| 缺失接口 | `yes` | ⚠️ 部分标注(文档标注支持,与分析结论矛盾,可能文档过时) |
|
|
101
|
+
| 新增接口 | 文档中提及且标注为 Harmony 特有 / `yes` | ✅ 已标注 |
|
|
102
|
+
| 新增接口 | 文档中提及但未说明为 Harmony 特有 | ⚠️ 部分标注 |
|
|
103
|
+
| 签名变更 | `partially` | ✅ 已标注(文档标注部分支持,通常对应签名/功能差异) |
|
|
104
|
+
| 签名变更 | `yes` 且文档描述了鸿蒙侧行为差异 | ✅ 已标注 |
|
|
105
|
+
| 签名变更 | `yes` 但未描述差异 | ⚠️ 部分标注 |
|
|
106
|
+
| 任意类型 | 接口在文档中完全未出现 | ❌ 未标注 |
|
|
107
|
+
|
|
108
|
+
**无 "HarmonyOS Support" 列的文档(如 README.md)**:
|
|
109
|
+
|
|
110
|
+
| 差异类型 | 文档中是否提及 | 判定结果 |
|
|
111
|
+
|----------|--------------|----------|
|
|
112
|
+
| 任意类型 | 文档明确提及该接口在鸿蒙平台不支持/有差异 | ⚠️ 部分标注(文字描述不如表格列精确) |
|
|
113
|
+
| 任意类型 | 文档提及该接口但未说明鸿蒙差异 | ⚠️ 部分标注 |
|
|
114
|
+
| 任意类型 | 文档完全未提及该接口 | ❌ 未标注 |
|
|
115
|
+
|
|
116
|
+
**额外检查**:若接口在接口表格中未找到,还需检查标题含「遗留问题」/「已知问题」的章节是否通过 issue 链接提及该接口。若遗留问题中提及,记为 ⚠️ 部分标注。
|
|
117
|
+
|
|
118
|
+
> 💡 **示例**:`clearFormData` 是缺失接口,在文档「静态方法」章节的表格中找到行 `| clearFormData() | ... | function | No | Android | No |`,HarmonyOS Support 列为 `No` → 判定为 **✅ 已标注**。
|