@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,263 +1,263 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: rn-library-documentation-quality-check
|
|
3
|
-
description: 对 RN 三方库的鸿蒙化代码进行文档质量检视,聚焦 source/ohos/ 下的 API 注释完整性、鸿蒙化适配说明、README/CHANGELOG 规范、代码示例质量、类型声明文档、国际化等维度,生成严苛评分报告(0-100分)。作为 RN 仓库检视流程的第六阶段。Use when 需要对 RN 鸿蒙化库进行文档质量评估、API 文档审查、适配说明完整性检查。
|
|
4
|
-
license: Apache-2.0
|
|
5
|
-
compatibility: 需要访问源码目录、分析文档和注释,读取 README/CHANGELOG/.d.ts 等文件;可选调用 MCP Gateway 的 gitcode_get_raw_file 获取外部文档
|
|
6
|
-
metadata:
|
|
7
|
-
version: "1.0.0"
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# RN 鸿蒙化库文档质量检视
|
|
11
|
-
|
|
12
|
-
对 RN 三方库的**鸿蒙化实现代码**进行文档质量检视,评估 API 文档完整性、鸿蒙化适配说明、README/CHANGELOG 规范、代码示例质量、类型声明文档、国际化等关键文档指标。
|
|
13
|
-
|
|
14
|
-
> ⚠️ **核心原则:不凭空捏造。** 所有检视结果必须基于实际读取到的文档和源码,禁止输出推测性结论。
|
|
15
|
-
|
|
16
|
-
> ⚠️ **核心定位**:本 SKILL **仅检视鸿蒙化版本的文档质量**,检视范围:源码 API 注释(TSDoc/JSDoc)、`.d.ts` 类型声明注释、README/CHANGELOG 文档、鸿蒙化适配说明、使用示例和集成指南、`module.json5` 权限与配置说明。
|
|
17
|
-
|
|
18
|
-
> ⚠️ **排除范围**:上游 RN 原库文档不在检视范围内,仅评估鸿蒙化新增/修改的文档内容。
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 任务参数
|
|
23
|
-
|
|
24
|
-
| 参数 | 类型 | 必填 | 说明 |
|
|
25
|
-
|------|------|------|------|
|
|
26
|
-
| `repoUrl` | string | ✅ | 鸿蒙化仓库地址 |
|
|
27
|
-
| `outputDir` | string | ✅ | 输出目录绝对路径 |
|
|
28
|
-
| `interfaceDocPath` | string | ✅ | 接口规格说明文档路径(通常为 `{outputDir}/接口规格说明.md`,由前置 `rn-library-interface-analyzer` 生成) |
|
|
29
|
-
| `repoName` | string | ✅ | 仓库名称 |
|
|
30
|
-
| `rndocUrl` | string | ❌ | 外部文档地址。当识别到跳转文档模式时,如果传入了 rndocUrl,优先使用 rndocUrl 下载文档,而非从 README 链接提取或构造标准 URL |
|
|
31
|
-
|
|
32
|
-
---
|
|
33
|
-
|
|
34
|
-
## 输入依赖
|
|
35
|
-
|
|
36
|
-
本 SKILL 是 RN 仓库检视流程的**第六阶段**,依赖:
|
|
37
|
-
|
|
38
|
-
- **前置 SKILL**: `rn-library-interface-analyzer`(第一阶段已生成接口规格说明文档)
|
|
39
|
-
- **前置 SKILL**: `rn-library-memory-leak-check`(内存泄露检视已完成)
|
|
40
|
-
- **输入文件**: `接口规格说明.md`、`内存泄露检视报告.md`(位于 outputDir)
|
|
41
|
-
- **仓库源码**: `{outputDir}/source/ohos/`
|
|
42
|
-
- **接口规格说明文档**(`{outputDir}/接口规格说明.md`):包含完整的 API 列表、参数签名、鸿蒙化差异(缺失/新增/变更),是交叉验证的权威基准
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## 工作流程概览
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
Phase 1: 文档文件定位与收集(识别内嵌/跳转模式,收集本地+外部文档)
|
|
50
|
-
↓
|
|
51
|
-
Phase 2: 逐维度文档质量检视(7大维度,按检查项清单逐一检视)
|
|
52
|
-
↓
|
|
53
|
-
Phase 2.5: 文档与接口规格交叉验证(强制环节,以接口规格说明为权威基准)
|
|
54
|
-
↓
|
|
55
|
-
Phase 3: 文档质量评分计算(维度加权扣分制,0-100分)
|
|
56
|
-
↓
|
|
57
|
-
Phase 4: 报告生成(六章节结构化报告)
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## 检视维度与评分标准
|
|
63
|
-
|
|
64
|
-
### 维度权重分配
|
|
65
|
-
|
|
66
|
-
| 维度 | 权重 | 扣分上限 | 说明 |
|
|
67
|
-
|------|------|----------|------|
|
|
68
|
-
| API 文档完整性 | 20% | -20 | TSDoc/JSDoc 注释、参数/返回值/异常说明 |
|
|
69
|
-
| 鸿蒙化适配说明 | 20% | -20 | 适配说明文档、差异说明、平台限制 |
|
|
70
|
-
| 代码仓基础信息 | 15% | -15 | package.json 元数据、README 结构、LICENSE、发布配置 |
|
|
71
|
-
| 代码示例质量 | 10% | -10 | 示例可编译性、集成步骤、Demo |
|
|
72
|
-
| 变更记录与版本规范 | 10% | -10 | CHANGELOG、版本号、鸿蒙化变更 |
|
|
73
|
-
| 文档与代码交叉验证 | 15% | -15 | 文档接口与代码实现双向一致性、接口规格对齐 |
|
|
74
|
-
| 文档准确性与国际化 | 10% | -10 | 文档代码一致性、国际化支持 |
|
|
75
|
-
|
|
76
|
-
### 严重度定义
|
|
77
|
-
|
|
78
|
-
| 严重度 | 单项扣分 | 说明 |
|
|
79
|
-
|--------|----------|------|
|
|
80
|
-
| Critical | -8 | 文档严重缺失导致用户无法使用核心功能 |
|
|
81
|
-
| Major | -4 | 文档缺失或不规范,影响用户理解和使用 |
|
|
82
|
-
| Minor | -1 | 文档轻微不规范,不影响功能使用 |
|
|
83
|
-
|
|
84
|
-
### 归零规则
|
|
85
|
-
|
|
86
|
-
- 文档完全空白(无 README、无 API 注释、无任何示例)→ 评分直接 **0 分**
|
|
87
|
-
- 核心 TurboModule/NAPI 接口无任何文档说明 → 评分直接 **0 分**
|
|
88
|
-
|
|
89
|
-
> 各维度的详细检查项清单(编号 AD/DT/NP/NC/CE/TG/HA/RM/CF/EX/CL/AC/XC-xxx)参考 [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md)(按需加载)。
|
|
90
|
-
|
|
91
|
-
---
|
|
92
|
-
|
|
93
|
-
## Phase 1:文档文件定位与收集
|
|
94
|
-
|
|
95
|
-
RN 三方库的文档存在**两种分布模式**,必须先识别模式再进行收集:
|
|
96
|
-
|
|
97
|
-
| 模式 | 特征 | 典型库 |
|
|
98
|
-
|------|------|--------|
|
|
99
|
-
| **内嵌文档** | README.md / README_zh.md 包含完整的安装、链接、接口说明、约束与限制 | `react-native-svg`、`react-native-linear-gradient` |
|
|
100
|
-
| **跳转文档** | README.md 极简(仅含包名+许可证),"文档"章节指向外部集中式文档仓库 | `react-native-network-info`、`react-native-device-info` |
|
|
101
|
-
|
|
102
|
-
### 步骤 1.1:识别文档模式
|
|
103
|
-
|
|
104
|
-
读取仓库根目录的 `README.md`,检查是否包含跳转特征(`OpenHarmony-RN/usage-docs` 链接等)。
|
|
105
|
-
|
|
106
|
-
### 步骤 1.2:收集本地文档文件
|
|
107
|
-
|
|
108
|
-
收集 `*.md`、`*.d.ts`、`*.json5`、`*.txt` 等文档文件。确认关键文件清单存在性。
|
|
109
|
-
|
|
110
|
-
### 步骤 1.3:收集外部跳转文档(跳转模式专属)
|
|
111
|
-
|
|
112
|
-
若识别为跳转模式,**必须**获取外部文档内容作为检视依据。获取优先级:**rndocUrl > README 链接提取 > 标准 URL 构造**。
|
|
113
|
-
|
|
114
|
-
> **MCP 工具可选**:若 MCP Gateway 可用,可调用 `gitcode_get_raw_file` 工具获取 GitCode 上的外部 usage-docs,比 curl 更可靠。
|
|
115
|
-
|
|
116
|
-
> 完整的文档收集流程、识别信号、文件分类规则、边界场景处理参见 [references/DOC_COLLECTION_GUIDE.md](references/DOC_COLLECTION_GUIDE.md)。
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Phase 2:逐维度文档质量检视
|
|
121
|
-
|
|
122
|
-
按维度 1-7 逐一检视,对每个发现的问题记录:
|
|
123
|
-
|
|
124
|
-
1. **严重度**:Critical / Major / Minor
|
|
125
|
-
2. **文件路径**:问题所在文件
|
|
126
|
-
3. **行号/位置**:问题在文件中的位置
|
|
127
|
-
4. **检查项编号**:AD/DT/NP/NC/CE/TG/HA/RM/CF/EX/CL/AC/XC-xxx
|
|
128
|
-
5. **问题描述**:缺少什么或存在什么问题
|
|
129
|
-
6. **修复建议**:具体的改进方案
|
|
130
|
-
|
|
131
|
-
**检视顺序建议**:README → .d.ts 文件 → 配置文件 → CHANGELOG 和示例
|
|
132
|
-
|
|
133
|
-
> 完整检查项清单参考 [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md)。检视示例参考 [references/EXAMPLES.md](references/EXAMPLES.md)。
|
|
134
|
-
|
|
135
|
-
---
|
|
136
|
-
|
|
137
|
-
## Phase 2.5:文档与接口规格交叉验证(强制环节)
|
|
138
|
-
|
|
139
|
-
> ⚠️ **本环节为强制执行**,不可跳过。
|
|
140
|
-
|
|
141
|
-
以**前置 SKILL `RNLibraryInterfaceAnalyzer` 生成的接口规格说明文档**为权威基准,与用户文档(README/外部 usage-docs)中的 API 描述进行比对。
|
|
142
|
-
|
|
143
|
-
**核心步骤**:
|
|
144
|
-
1. **加载接口规格说明文档** — 从 `{outputDir}/接口规格说明.md` 提取 API 清单、签名、鸿蒙化差异
|
|
145
|
-
2. **从用户文档提取 API 清单** — 从 README/外部 usage-docs 提取文档声称的接口信息
|
|
146
|
-
3. **双向比对** — 规格→文档、文档→规格、签名与类型、鸿蒙化差异
|
|
147
|
-
4. **权限与配置比对** — module.json5 权限声明 vs 文档说明
|
|
148
|
-
5. **生成交叉验证差异报告** — 结构化表格输出
|
|
149
|
-
|
|
150
|
-
> 若接口规格说明文档不存在,记录 XC-001 Critical,跳过交叉验证,在报告中注明。
|
|
151
|
-
|
|
152
|
-
> 完整交叉验证流程、比对逻辑、差异分类参见 [references/CROSS_VALIDATION_GUIDE.md](references/CROSS_VALIDATION_GUIDE.md)。
|
|
153
|
-
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
## Phase 3:文档质量评分计算
|
|
157
|
-
|
|
158
|
-
基于检视结果进行**严苛评分**(0-100分),采用维度加权扣分制:
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
基础分 = 100
|
|
162
|
-
|
|
163
|
-
每个维度内扣分规则:
|
|
164
|
-
- Critical: 每项 -8 分
|
|
165
|
-
- Major: 每项 -4 分
|
|
166
|
-
- Minor: 每项 -1 分
|
|
167
|
-
|
|
168
|
-
维度实际扣分 = min(扣分上限, Critical扣分 + Major扣分 + Minor扣分)
|
|
169
|
-
|
|
170
|
-
归零检查:
|
|
171
|
-
- 文档完全空白 → 最终分 = 0
|
|
172
|
-
- 核心 TurboModule/NAPI 接口无任何文档说明 → 最终分 = 0
|
|
173
|
-
|
|
174
|
-
最终分 = max(0, 100 - 各维度实际扣分之和)
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**评分等级**:90-100 优秀 | 80-89 良好 | 70-79 一般 | 60-69 较差 | 50-59 严重不足 | <50 极差
|
|
178
|
-
|
|
179
|
-
---
|
|
180
|
-
|
|
181
|
-
## Phase 4:报告生成
|
|
182
|
-
|
|
183
|
-
在 `{outputDir}` 下生成 `文档质量检视报告.md`,包含六个章节:检视概览、综合评分、各维度评分明细、检视维度详情、问题清单、改进建议。
|
|
184
|
-
|
|
185
|
-
> 完整报告模板和评分计算示例参考 [assets/REPORT_TEMPLATE.md](assets/REPORT_TEMPLATE.md)。
|
|
186
|
-
|
|
187
|
-
**关键格式要求**:
|
|
188
|
-
- 报告必须包含 `**综合评分:XX/100**` 格式,位于"二、综合评分"章节
|
|
189
|
-
- 确保可被 `_parseRNLibraryScore` 函数正确解析
|
|
190
|
-
- 评分正则匹配优先级为 `综合评分` > `总体评分/评分` > `得分`
|
|
191
|
-
|
|
192
|
-
---
|
|
193
|
-
|
|
194
|
-
## 输出产物
|
|
195
|
-
|
|
196
|
-
| 产物 | 文件名 | 说明 |
|
|
197
|
-
|------|--------|------|
|
|
198
|
-
| 文档质量检视报告 | `文档质量检视报告.md` | 各维度评分明细 + 问题清单 + 修复建议 |
|
|
199
|
-
|
|
200
|
-
所有产物写入 `{outputDir}` 目录。
|
|
201
|
-
|
|
202
|
-
> ⚠️ **输出文件自检**:写入结果文件前,先确认 `文档质量检视报告.md` 已存在且内容完整(**独立文件,禁止只写入 result 执行结果文件**)。若报告内容仅在草稿中,必须先将其保存为上述独立文件。
|
|
203
|
-
|
|
204
|
-
### 结构化指标输出(必须执行)
|
|
205
|
-
|
|
206
|
-
执行环境会在任务 prompt 中下发一个**结构化指标文件输出路径**(`stepId{X}_loop{L}_meta_{N}.json`)。
|
|
207
|
-
检视完成后,**必须**将最终评分以下述 JSON 对象写入该路径:
|
|
208
|
-
|
|
209
|
-
```json
|
|
210
|
-
{
|
|
211
|
-
"documentationScore": 85,
|
|
212
|
-
"scoreReason": "API注释缺失率40%-8等(一句话判定依据,≤50字;触发一票否决时必须注明)"
|
|
213
|
-
}
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
| 字段 | 类型 | 说明 |
|
|
217
|
-
|------|------|------|
|
|
218
|
-
| `documentationScore` | number | 文档质量评分(0-100 整数,与报告中 `**综合评分:XX/100**` 的数值一致) |
|
|
219
|
-
| `scoreReason` | string | 评分判定依据摘要(可选,前端悬浮提示展示;0 分时强烈建议写明触发规则,如"核心接口无任何文档说明触发归零") |
|
|
220
|
-
|
|
221
|
-
**说明**:该文件由执行框架自动收割入库(前端/历史列表直接读取评分,无需解析报告文本)。若 prompt 未下发该路径则跳过本节。
|
|
222
|
-
|
|
223
|
-
---
|
|
224
|
-
|
|
225
|
-
## 评分权重
|
|
226
|
-
|
|
227
|
-
本 SKILL 在 RN 仓库检视综合评分中权重为 **10%**。
|
|
228
|
-
|
|
229
|
-
---
|
|
230
|
-
|
|
231
|
-
## 常见陷阱(Gotchas)
|
|
232
|
-
|
|
233
|
-
以下为检视中最高频的 5 个陷阱,完整列表参见 [references/GOTCHAS.md](references/GOTCHAS.md)。
|
|
234
|
-
|
|
235
|
-
- **跳转文档模式误判为"文档缺失"**:跳转模式的 README 极简是设计选择,不应扣分为 RM-002/RM-004,应转而检视外部 usage-docs
|
|
236
|
-
- **async/Promise 返回类型遗漏**:文档写 `getConfig(): Config` 但代码为 `getConfig(): Promise<Config>`,是最常见的签名不一致
|
|
237
|
-
- **命名导出 vs 默认导出**:`export { lottie }` 是命名导出,示例必须用 `import { lottie }` 而非 `import lottie`
|
|
238
|
-
- **CHANGELOG 未记录鸿蒙化变更**:CHANGELOG 存在但仅含原库版本历史,无鸿蒙化适配条目
|
|
239
|
-
- **接口规格说明文档是权威基准**:交叉验证时直接使用,无需再从源码逐条提取
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
## 与前置/后置 SKILL 的衔接
|
|
244
|
-
|
|
245
|
-
- **前置依赖**:`rn-library-interface-analyzer`(第1阶段)输出的 `接口规格说明.md` — **交叉验证的权威基准**
|
|
246
|
-
- **前置依赖**:`rn-library-memory-leak-check`(第5阶段)输出的 `内存泄露检视报告.md`
|
|
247
|
-
- **后置输入**:本 SKILL 输出的 `文档质量检视报告.md` 将作为 `rn-library-test-coverage-check`(第7阶段)的输入依赖
|
|
248
|
-
- 确保报告中的问题清单包含足够的定位信息(文件路径+行号+检查项编号),便于后续 SKILL 参考和综合报告汇总
|
|
249
|
-
|
|
250
|
-
---
|
|
251
|
-
|
|
252
|
-
## 参考文件
|
|
253
|
-
|
|
254
|
-
| 文件 | 用途 | 加载时机 |
|
|
255
|
-
|------|------|----------|
|
|
256
|
-
| [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md) | 各维度详细检查项清单与编号 | Phase 2 检视时按需加载 |
|
|
257
|
-
| [references/DOC_COLLECTION_GUIDE.md](references/DOC_COLLECTION_GUIDE.md) | 文档模式识别与收集完整流程 | Phase 1 文档收集时按需加载 |
|
|
258
|
-
| [references/CROSS_VALIDATION_GUIDE.md](references/CROSS_VALIDATION_GUIDE.md) | 交叉验证完整流程与比对方法 | Phase 2.5 交叉验证时按需加载 |
|
|
259
|
-
| [references/EXAMPLES.md](references/EXAMPLES.md) | 检视示例与常见场景 | 理解检视流程时按需加载 |
|
|
260
|
-
| [references/GOTCHAS.md](references/GOTCHAS.md) | 完整常见陷阱列表 | 检视过程中按需加载 |
|
|
261
|
-
| [assets/REPORT_TEMPLATE.md](assets/REPORT_TEMPLATE.md) | 报告模板与评分计算示例 | Phase 4 报告生成时按需加载 |
|
|
262
|
-
| [assets/MODEL.md](assets/MODEL.md) | 中文文档模板规范 | 检视文档规范性时按需加载 |
|
|
263
|
-
| [assets/MODEL_en.md](assets/MODEL_en.md) | 英文文档模板规范 | 检视英文文档规范性时按需加载 |
|
|
1
|
+
---
|
|
2
|
+
name: rn-library-documentation-quality-check
|
|
3
|
+
description: 对 RN 三方库的鸿蒙化代码进行文档质量检视,聚焦 source/ohos/ 下的 API 注释完整性、鸿蒙化适配说明、README/CHANGELOG 规范、代码示例质量、类型声明文档、国际化等维度,生成严苛评分报告(0-100分)。作为 RN 仓库检视流程的第六阶段。Use when 需要对 RN 鸿蒙化库进行文档质量评估、API 文档审查、适配说明完整性检查。
|
|
4
|
+
license: Apache-2.0
|
|
5
|
+
compatibility: 需要访问源码目录、分析文档和注释,读取 README/CHANGELOG/.d.ts 等文件;可选调用 MCP Gateway 的 gitcode_get_raw_file 获取外部文档
|
|
6
|
+
metadata:
|
|
7
|
+
version: "1.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# RN 鸿蒙化库文档质量检视
|
|
11
|
+
|
|
12
|
+
对 RN 三方库的**鸿蒙化实现代码**进行文档质量检视,评估 API 文档完整性、鸿蒙化适配说明、README/CHANGELOG 规范、代码示例质量、类型声明文档、国际化等关键文档指标。
|
|
13
|
+
|
|
14
|
+
> ⚠️ **核心原则:不凭空捏造。** 所有检视结果必须基于实际读取到的文档和源码,禁止输出推测性结论。
|
|
15
|
+
|
|
16
|
+
> ⚠️ **核心定位**:本 SKILL **仅检视鸿蒙化版本的文档质量**,检视范围:源码 API 注释(TSDoc/JSDoc)、`.d.ts` 类型声明注释、README/CHANGELOG 文档、鸿蒙化适配说明、使用示例和集成指南、`module.json5` 权限与配置说明。
|
|
17
|
+
|
|
18
|
+
> ⚠️ **排除范围**:上游 RN 原库文档不在检视范围内,仅评估鸿蒙化新增/修改的文档内容。
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 任务参数
|
|
23
|
+
|
|
24
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
25
|
+
|------|------|------|------|
|
|
26
|
+
| `repoUrl` | string | ✅ | 鸿蒙化仓库地址 |
|
|
27
|
+
| `outputDir` | string | ✅ | 输出目录绝对路径 |
|
|
28
|
+
| `interfaceDocPath` | string | ✅ | 接口规格说明文档路径(通常为 `{outputDir}/接口规格说明.md`,由前置 `rn-library-interface-analyzer` 生成) |
|
|
29
|
+
| `repoName` | string | ✅ | 仓库名称 |
|
|
30
|
+
| `rndocUrl` | string | ❌ | 外部文档地址。当识别到跳转文档模式时,如果传入了 rndocUrl,优先使用 rndocUrl 下载文档,而非从 README 链接提取或构造标准 URL |
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 输入依赖
|
|
35
|
+
|
|
36
|
+
本 SKILL 是 RN 仓库检视流程的**第六阶段**,依赖:
|
|
37
|
+
|
|
38
|
+
- **前置 SKILL**: `rn-library-interface-analyzer`(第一阶段已生成接口规格说明文档)
|
|
39
|
+
- **前置 SKILL**: `rn-library-memory-leak-check`(内存泄露检视已完成)
|
|
40
|
+
- **输入文件**: `接口规格说明.md`、`内存泄露检视报告.md`(位于 outputDir)
|
|
41
|
+
- **仓库源码**: `{outputDir}/source/ohos/`
|
|
42
|
+
- **接口规格说明文档**(`{outputDir}/接口规格说明.md`):包含完整的 API 列表、参数签名、鸿蒙化差异(缺失/新增/变更),是交叉验证的权威基准
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 工作流程概览
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
Phase 1: 文档文件定位与收集(识别内嵌/跳转模式,收集本地+外部文档)
|
|
50
|
+
↓
|
|
51
|
+
Phase 2: 逐维度文档质量检视(7大维度,按检查项清单逐一检视)
|
|
52
|
+
↓
|
|
53
|
+
Phase 2.5: 文档与接口规格交叉验证(强制环节,以接口规格说明为权威基准)
|
|
54
|
+
↓
|
|
55
|
+
Phase 3: 文档质量评分计算(维度加权扣分制,0-100分)
|
|
56
|
+
↓
|
|
57
|
+
Phase 4: 报告生成(六章节结构化报告)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 检视维度与评分标准
|
|
63
|
+
|
|
64
|
+
### 维度权重分配
|
|
65
|
+
|
|
66
|
+
| 维度 | 权重 | 扣分上限 | 说明 |
|
|
67
|
+
|------|------|----------|------|
|
|
68
|
+
| API 文档完整性 | 20% | -20 | TSDoc/JSDoc 注释、参数/返回值/异常说明 |
|
|
69
|
+
| 鸿蒙化适配说明 | 20% | -20 | 适配说明文档、差异说明、平台限制 |
|
|
70
|
+
| 代码仓基础信息 | 15% | -15 | package.json 元数据、README 结构、LICENSE、发布配置 |
|
|
71
|
+
| 代码示例质量 | 10% | -10 | 示例可编译性、集成步骤、Demo |
|
|
72
|
+
| 变更记录与版本规范 | 10% | -10 | CHANGELOG、版本号、鸿蒙化变更 |
|
|
73
|
+
| 文档与代码交叉验证 | 15% | -15 | 文档接口与代码实现双向一致性、接口规格对齐 |
|
|
74
|
+
| 文档准确性与国际化 | 10% | -10 | 文档代码一致性、国际化支持 |
|
|
75
|
+
|
|
76
|
+
### 严重度定义
|
|
77
|
+
|
|
78
|
+
| 严重度 | 单项扣分 | 说明 |
|
|
79
|
+
|--------|----------|------|
|
|
80
|
+
| Critical | -8 | 文档严重缺失导致用户无法使用核心功能 |
|
|
81
|
+
| Major | -4 | 文档缺失或不规范,影响用户理解和使用 |
|
|
82
|
+
| Minor | -1 | 文档轻微不规范,不影响功能使用 |
|
|
83
|
+
|
|
84
|
+
### 归零规则
|
|
85
|
+
|
|
86
|
+
- 文档完全空白(无 README、无 API 注释、无任何示例)→ 评分直接 **0 分**
|
|
87
|
+
- 核心 TurboModule/NAPI 接口无任何文档说明 → 评分直接 **0 分**
|
|
88
|
+
|
|
89
|
+
> 各维度的详细检查项清单(编号 AD/DT/NP/NC/CE/TG/HA/RM/CF/EX/CL/AC/XC-xxx)参考 [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md)(按需加载)。
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Phase 1:文档文件定位与收集
|
|
94
|
+
|
|
95
|
+
RN 三方库的文档存在**两种分布模式**,必须先识别模式再进行收集:
|
|
96
|
+
|
|
97
|
+
| 模式 | 特征 | 典型库 |
|
|
98
|
+
|------|------|--------|
|
|
99
|
+
| **内嵌文档** | README.md / README_zh.md 包含完整的安装、链接、接口说明、约束与限制 | `react-native-svg`、`react-native-linear-gradient` |
|
|
100
|
+
| **跳转文档** | README.md 极简(仅含包名+许可证),"文档"章节指向外部集中式文档仓库 | `react-native-network-info`、`react-native-device-info` |
|
|
101
|
+
|
|
102
|
+
### 步骤 1.1:识别文档模式
|
|
103
|
+
|
|
104
|
+
读取仓库根目录的 `README.md`,检查是否包含跳转特征(`OpenHarmony-RN/usage-docs` 链接等)。
|
|
105
|
+
|
|
106
|
+
### 步骤 1.2:收集本地文档文件
|
|
107
|
+
|
|
108
|
+
收集 `*.md`、`*.d.ts`、`*.json5`、`*.txt` 等文档文件。确认关键文件清单存在性。
|
|
109
|
+
|
|
110
|
+
### 步骤 1.3:收集外部跳转文档(跳转模式专属)
|
|
111
|
+
|
|
112
|
+
若识别为跳转模式,**必须**获取外部文档内容作为检视依据。获取优先级:**rndocUrl > README 链接提取 > 标准 URL 构造**。
|
|
113
|
+
|
|
114
|
+
> **MCP 工具可选**:若 MCP Gateway 可用,可调用 `gitcode_get_raw_file` 工具获取 GitCode 上的外部 usage-docs,比 curl 更可靠。
|
|
115
|
+
|
|
116
|
+
> 完整的文档收集流程、识别信号、文件分类规则、边界场景处理参见 [references/DOC_COLLECTION_GUIDE.md](references/DOC_COLLECTION_GUIDE.md)。
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Phase 2:逐维度文档质量检视
|
|
121
|
+
|
|
122
|
+
按维度 1-7 逐一检视,对每个发现的问题记录:
|
|
123
|
+
|
|
124
|
+
1. **严重度**:Critical / Major / Minor
|
|
125
|
+
2. **文件路径**:问题所在文件
|
|
126
|
+
3. **行号/位置**:问题在文件中的位置
|
|
127
|
+
4. **检查项编号**:AD/DT/NP/NC/CE/TG/HA/RM/CF/EX/CL/AC/XC-xxx
|
|
128
|
+
5. **问题描述**:缺少什么或存在什么问题
|
|
129
|
+
6. **修复建议**:具体的改进方案
|
|
130
|
+
|
|
131
|
+
**检视顺序建议**:README → .d.ts 文件 → 配置文件 → CHANGELOG 和示例
|
|
132
|
+
|
|
133
|
+
> 完整检查项清单参考 [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md)。检视示例参考 [references/EXAMPLES.md](references/EXAMPLES.md)。
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Phase 2.5:文档与接口规格交叉验证(强制环节)
|
|
138
|
+
|
|
139
|
+
> ⚠️ **本环节为强制执行**,不可跳过。
|
|
140
|
+
|
|
141
|
+
以**前置 SKILL `RNLibraryInterfaceAnalyzer` 生成的接口规格说明文档**为权威基准,与用户文档(README/外部 usage-docs)中的 API 描述进行比对。
|
|
142
|
+
|
|
143
|
+
**核心步骤**:
|
|
144
|
+
1. **加载接口规格说明文档** — 从 `{outputDir}/接口规格说明.md` 提取 API 清单、签名、鸿蒙化差异
|
|
145
|
+
2. **从用户文档提取 API 清单** — 从 README/外部 usage-docs 提取文档声称的接口信息
|
|
146
|
+
3. **双向比对** — 规格→文档、文档→规格、签名与类型、鸿蒙化差异
|
|
147
|
+
4. **权限与配置比对** — module.json5 权限声明 vs 文档说明
|
|
148
|
+
5. **生成交叉验证差异报告** — 结构化表格输出
|
|
149
|
+
|
|
150
|
+
> 若接口规格说明文档不存在,记录 XC-001 Critical,跳过交叉验证,在报告中注明。
|
|
151
|
+
|
|
152
|
+
> 完整交叉验证流程、比对逻辑、差异分类参见 [references/CROSS_VALIDATION_GUIDE.md](references/CROSS_VALIDATION_GUIDE.md)。
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Phase 3:文档质量评分计算
|
|
157
|
+
|
|
158
|
+
基于检视结果进行**严苛评分**(0-100分),采用维度加权扣分制:
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
基础分 = 100
|
|
162
|
+
|
|
163
|
+
每个维度内扣分规则:
|
|
164
|
+
- Critical: 每项 -8 分
|
|
165
|
+
- Major: 每项 -4 分
|
|
166
|
+
- Minor: 每项 -1 分
|
|
167
|
+
|
|
168
|
+
维度实际扣分 = min(扣分上限, Critical扣分 + Major扣分 + Minor扣分)
|
|
169
|
+
|
|
170
|
+
归零检查:
|
|
171
|
+
- 文档完全空白 → 最终分 = 0
|
|
172
|
+
- 核心 TurboModule/NAPI 接口无任何文档说明 → 最终分 = 0
|
|
173
|
+
|
|
174
|
+
最终分 = max(0, 100 - 各维度实际扣分之和)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**评分等级**:90-100 优秀 | 80-89 良好 | 70-79 一般 | 60-69 较差 | 50-59 严重不足 | <50 极差
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Phase 4:报告生成
|
|
182
|
+
|
|
183
|
+
在 `{outputDir}` 下生成 `文档质量检视报告.md`,包含六个章节:检视概览、综合评分、各维度评分明细、检视维度详情、问题清单、改进建议。
|
|
184
|
+
|
|
185
|
+
> 完整报告模板和评分计算示例参考 [assets/REPORT_TEMPLATE.md](assets/REPORT_TEMPLATE.md)。
|
|
186
|
+
|
|
187
|
+
**关键格式要求**:
|
|
188
|
+
- 报告必须包含 `**综合评分:XX/100**` 格式,位于"二、综合评分"章节
|
|
189
|
+
- 确保可被 `_parseRNLibraryScore` 函数正确解析
|
|
190
|
+
- 评分正则匹配优先级为 `综合评分` > `总体评分/评分` > `得分`
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## 输出产物
|
|
195
|
+
|
|
196
|
+
| 产物 | 文件名 | 说明 |
|
|
197
|
+
|------|--------|------|
|
|
198
|
+
| 文档质量检视报告 | `文档质量检视报告.md` | 各维度评分明细 + 问题清单 + 修复建议 |
|
|
199
|
+
|
|
200
|
+
所有产物写入 `{outputDir}` 目录。
|
|
201
|
+
|
|
202
|
+
> ⚠️ **输出文件自检**:写入结果文件前,先确认 `文档质量检视报告.md` 已存在且内容完整(**独立文件,禁止只写入 result 执行结果文件**)。若报告内容仅在草稿中,必须先将其保存为上述独立文件。
|
|
203
|
+
|
|
204
|
+
### 结构化指标输出(必须执行)
|
|
205
|
+
|
|
206
|
+
执行环境会在任务 prompt 中下发一个**结构化指标文件输出路径**(`stepId{X}_loop{L}_meta_{N}.json`)。
|
|
207
|
+
检视完成后,**必须**将最终评分以下述 JSON 对象写入该路径:
|
|
208
|
+
|
|
209
|
+
```json
|
|
210
|
+
{
|
|
211
|
+
"documentationScore": 85,
|
|
212
|
+
"scoreReason": "API注释缺失率40%-8等(一句话判定依据,≤50字;触发一票否决时必须注明)"
|
|
213
|
+
}
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
| 字段 | 类型 | 说明 |
|
|
217
|
+
|------|------|------|
|
|
218
|
+
| `documentationScore` | number | 文档质量评分(0-100 整数,与报告中 `**综合评分:XX/100**` 的数值一致) |
|
|
219
|
+
| `scoreReason` | string | 评分判定依据摘要(可选,前端悬浮提示展示;0 分时强烈建议写明触发规则,如"核心接口无任何文档说明触发归零") |
|
|
220
|
+
|
|
221
|
+
**说明**:该文件由执行框架自动收割入库(前端/历史列表直接读取评分,无需解析报告文本)。若 prompt 未下发该路径则跳过本节。
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## 评分权重
|
|
226
|
+
|
|
227
|
+
本 SKILL 在 RN 仓库检视综合评分中权重为 **10%**。
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 常见陷阱(Gotchas)
|
|
232
|
+
|
|
233
|
+
以下为检视中最高频的 5 个陷阱,完整列表参见 [references/GOTCHAS.md](references/GOTCHAS.md)。
|
|
234
|
+
|
|
235
|
+
- **跳转文档模式误判为"文档缺失"**:跳转模式的 README 极简是设计选择,不应扣分为 RM-002/RM-004,应转而检视外部 usage-docs
|
|
236
|
+
- **async/Promise 返回类型遗漏**:文档写 `getConfig(): Config` 但代码为 `getConfig(): Promise<Config>`,是最常见的签名不一致
|
|
237
|
+
- **命名导出 vs 默认导出**:`export { lottie }` 是命名导出,示例必须用 `import { lottie }` 而非 `import lottie`
|
|
238
|
+
- **CHANGELOG 未记录鸿蒙化变更**:CHANGELOG 存在但仅含原库版本历史,无鸿蒙化适配条目
|
|
239
|
+
- **接口规格说明文档是权威基准**:交叉验证时直接使用,无需再从源码逐条提取
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## 与前置/后置 SKILL 的衔接
|
|
244
|
+
|
|
245
|
+
- **前置依赖**:`rn-library-interface-analyzer`(第1阶段)输出的 `接口规格说明.md` — **交叉验证的权威基准**
|
|
246
|
+
- **前置依赖**:`rn-library-memory-leak-check`(第5阶段)输出的 `内存泄露检视报告.md`
|
|
247
|
+
- **后置输入**:本 SKILL 输出的 `文档质量检视报告.md` 将作为 `rn-library-test-coverage-check`(第7阶段)的输入依赖
|
|
248
|
+
- 确保报告中的问题清单包含足够的定位信息(文件路径+行号+检查项编号),便于后续 SKILL 参考和综合报告汇总
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## 参考文件
|
|
253
|
+
|
|
254
|
+
| 文件 | 用途 | 加载时机 |
|
|
255
|
+
|------|------|----------|
|
|
256
|
+
| [references/CHECK_CHECKLIST.md](references/CHECK_CHECKLIST.md) | 各维度详细检查项清单与编号 | Phase 2 检视时按需加载 |
|
|
257
|
+
| [references/DOC_COLLECTION_GUIDE.md](references/DOC_COLLECTION_GUIDE.md) | 文档模式识别与收集完整流程 | Phase 1 文档收集时按需加载 |
|
|
258
|
+
| [references/CROSS_VALIDATION_GUIDE.md](references/CROSS_VALIDATION_GUIDE.md) | 交叉验证完整流程与比对方法 | Phase 2.5 交叉验证时按需加载 |
|
|
259
|
+
| [references/EXAMPLES.md](references/EXAMPLES.md) | 检视示例与常见场景 | 理解检视流程时按需加载 |
|
|
260
|
+
| [references/GOTCHAS.md](references/GOTCHAS.md) | 完整常见陷阱列表 | 检视过程中按需加载 |
|
|
261
|
+
| [assets/REPORT_TEMPLATE.md](assets/REPORT_TEMPLATE.md) | 报告模板与评分计算示例 | Phase 4 报告生成时按需加载 |
|
|
262
|
+
| [assets/MODEL.md](assets/MODEL.md) | 中文文档模板规范 | 检视文档规范性时按需加载 |
|
|
263
|
+
| [assets/MODEL_en.md](assets/MODEL_en.md) | 英文文档模板规范 | 检视英文文档规范性时按需加载 |
|