@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.
Files changed (393) hide show
  1. package/README.md +290 -244
  2. package/bin/3rdloop.mjs +46 -46
  3. package/lib/cli.js +781 -781
  4. package/lib/config-cmd.js +451 -451
  5. package/lib/config.js +318 -318
  6. package/lib/doctor.js +113 -113
  7. package/lib/exit-codes.js +30 -30
  8. package/lib/opencode.js +155 -155
  9. package/lib/orch.js +426 -426
  10. package/lib/queries.js +263 -263
  11. package/lib/step.js +325 -325
  12. package/lib/ui.js +222 -222
  13. package/lib/update.js +279 -279
  14. package/lib/workflow.js +308 -308
  15. package/lib/workflows.js +131 -131
  16. package/package.json +50 -50
  17. package/vendor/Server/Agent/SkillSelector/README.md +343 -343
  18. package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -207
  19. package/vendor/Server/Agent/SkillSelector/index.js +14 -14
  20. package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -313
  21. package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -161
  22. package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -144
  23. package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -433
  24. package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -382
  25. package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +59 -59
  26. package/vendor/Server/Brain/AnalysisStrategies.js +422 -422
  27. package/vendor/Server/Brain/Brain.js +686 -686
  28. package/vendor/Server/Brain/DecompositionStrategies.js +621 -621
  29. package/vendor/Server/Brain/PlanPersistence.js +196 -196
  30. package/vendor/Server/Brain/SkillExecutor.js +251 -251
  31. package/vendor/Server/Brain/index.js +11 -11
  32. package/vendor/Server/CLI/cli.js +275 -275
  33. package/vendor/Server/CLI/deveco-code/index.js +71 -71
  34. package/vendor/Server/CLI/deveco-code.js +5 -5
  35. package/vendor/Server/CLI/opencode/index.js +817 -818
  36. package/vendor/Server/CLI/opencode.js +5 -5
  37. package/vendor/Server/DbUse/MessageArchive.js +61 -61
  38. package/vendor/Server/DbUse/StorageManager.js +107 -107
  39. package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -94
  40. package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -138
  41. package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -138
  42. package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -114
  43. package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -157
  44. package/vendor/Server/DbUse/index.js +160 -160
  45. package/vendor/Server/DbUse/stores/SessionStore.js +279 -279
  46. package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -133
  47. package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -262
  48. package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -279
  49. package/vendor/Server/FlexRunner/FlexRunner.js +1759 -1759
  50. package/vendor/Server/FlexRunner/index.js +12 -12
  51. package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -523
  52. package/vendor/Server/Knowledge/KnowledgeManager.js +341 -341
  53. package/vendor/Server/Knowledge/index.js +33 -33
  54. package/vendor/Server/LoopEngine/LoopEngine.js +1133 -1133
  55. package/vendor/Server/LoopEngine/index.js +11 -11
  56. package/vendor/Server/Orchestrator/Orchestrator.js +0 -3
  57. package/vendor/Server/Orchestrator/StepNode.js +312 -312
  58. package/vendor/Server/Orchestrator/index.js +13 -13
  59. package/vendor/Server/Routes/controllers/BrainController.js +241 -241
  60. package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -1125
  61. package/vendor/Server/Routes/controllers/HealthController.js +44 -44
  62. package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -355
  63. package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -788
  64. package/vendor/Server/Routes/controllers/StatsController.js +57 -57
  65. package/vendor/Server/Routes/controllers/StreamController.js +67 -67
  66. package/vendor/Server/Routes/library/logger.js +179 -179
  67. package/vendor/Server/Routes/library/zipArchive.js +172 -172
  68. package/vendor/Server/Routes/router/Router.js +204 -204
  69. package/vendor/Server/Routes/routes/brain.js +47 -47
  70. package/vendor/Server/Routes/routes/flexrunner.js +72 -72
  71. package/vendor/Server/Routes/routes/health.js +28 -28
  72. package/vendor/Server/Routes/routes/index.js +57 -57
  73. package/vendor/Server/Routes/routes/knowledge.js +55 -55
  74. package/vendor/Server/Routes/routes/loopengine.js +58 -58
  75. package/vendor/Server/Routes/routes/orchestrator.js +61 -61
  76. package/vendor/Server/Routes/routes/registry.js +97 -97
  77. package/vendor/Server/Routes/routes/stats.js +23 -23
  78. package/vendor/Server/Routes/routes/stream.js +30 -30
  79. package/vendor/Server/Routes/server.js +203 -203
  80. package/vendor/Server/Routes/sse/SseHub.js +308 -308
  81. package/vendor/Server/Skills/acceptance-check/SKILL.md +191 -191
  82. package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -52
  83. package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -77
  84. package/vendor/Server/Skills/acceptance-check/references/PHASE2_EVIDENCE_VERIFICATION.md +70 -70
  85. package/vendor/Server/Skills/arkts-code-check/SKILL.md +320 -320
  86. package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +210 -210
  87. package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +28 -28
  88. package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +233 -233
  89. package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +219 -219
  90. package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +328 -328
  91. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -93
  92. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +432 -432
  93. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -851
  94. package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +788 -788
  95. package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -291
  96. package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -68
  97. package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -184
  98. package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -337
  99. package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -400
  100. package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +98 -98
  101. package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -544
  102. package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -93
  103. package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +432 -432
  104. package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -851
  105. package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +788 -788
  106. package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -174
  107. package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -321
  108. package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -100
  109. package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -185
  110. package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +233 -233
  111. package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +102 -102
  112. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -89
  113. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -62
  114. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +107 -107
  115. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -124
  116. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -90
  117. package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -57
  118. package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -259
  119. package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -97
  120. package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +391 -391
  121. package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -113
  122. package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +312 -312
  123. package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -154
  124. package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +165 -165
  125. package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +308 -308
  126. package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -90
  127. package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -282
  128. package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +360 -360
  129. package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +145 -145
  130. package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +252 -252
  131. package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +114 -114
  132. package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +262 -262
  133. package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -455
  134. package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -60
  135. package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -76
  136. package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -200
  137. package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +518 -518
  138. package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -276
  139. package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +92 -92
  140. package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -767
  141. package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -93
  142. package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +432 -432
  143. package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -851
  144. package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +788 -788
  145. package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -221
  146. package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +228 -228
  147. package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -97
  148. package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -194
  149. package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +575 -575
  150. package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +574 -574
  151. package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -182
  152. package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +490 -490
  153. package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -217
  154. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -93
  155. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +432 -432
  156. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -851
  157. package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +788 -788
  158. package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -299
  159. package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +311 -311
  160. package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -190
  161. package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +133 -133
  162. package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -259
  163. package/vendor/Server/Skills/flutter-interface/README.md +75 -75
  164. package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -291
  165. package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -336
  166. package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -190
  167. package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -258
  168. package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -254
  169. package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +517 -517
  170. package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +381 -381
  171. package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +341 -341
  172. package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -71
  173. package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +518 -518
  174. package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +406 -406
  175. package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +652 -652
  176. package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +396 -396
  177. package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +744 -744
  178. package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +720 -720
  179. package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -414
  180. package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -150
  181. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -304
  182. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -265
  183. package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -286
  184. package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -383
  185. package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -165
  186. package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -91
  187. package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -127
  188. package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +453 -301
  189. package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_CHECKLIST.md +151 -0
  190. package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +257 -105
  191. package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +191 -127
  192. package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +317 -208
  193. package/vendor/Server/Skills/rn-code-check/SKILL.md +320 -320
  194. package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +234 -234
  195. package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +188 -188
  196. package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +246 -246
  197. package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -198
  198. package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -40
  199. package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -78
  200. package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -70
  201. package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -47
  202. package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -252
  203. package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -176
  204. package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -5
  205. package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -35
  206. package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -137
  207. package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -33
  208. package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -40
  209. package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -429
  210. package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -105
  211. package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -90
  212. package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -213
  213. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -73
  214. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -258
  215. package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -341
  216. package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -67
  217. package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -299
  218. package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -293
  219. package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -857
  220. package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -856
  221. package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -157
  222. package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -801
  223. package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +683 -683
  224. package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -233
  225. package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -1373
  226. package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -220
  227. package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -245
  228. package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -263
  229. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -414
  230. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -413
  231. package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -311
  232. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -355
  233. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -115
  234. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -139
  235. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -586
  236. package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -57
  237. package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -259
  238. package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -301
  239. package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -148
  240. package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -118
  241. package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -168
  242. package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -176
  243. package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -274
  244. package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -45
  245. package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -25
  246. package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -61
  247. package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -165
  248. package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -239
  249. package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -263
  250. package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -96
  251. package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +57 -57
  252. package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -99
  253. package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -64
  254. package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +74 -74
  255. package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -164
  256. package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +356 -339
  257. package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +85 -83
  258. package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +905 -859
  259. package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +124 -122
  260. package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +287 -279
  261. package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -273
  262. package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -129
  263. package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -581
  264. package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -138
  265. package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -168
  266. package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +526 -506
  267. package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +321 -280
  268. package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -221
  269. package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +220 -209
  270. package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -325
  271. package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -279
  272. package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -404
  273. package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -185
  274. package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -265
  275. package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -189
  276. package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -203
  277. package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -147
  278. package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -148
  279. package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -165
  280. package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -195
  281. package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -249
  282. package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -235
  283. package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -161
  284. package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -413
  285. package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -235
  286. package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -245
  287. package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -282
  288. package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -251
  289. package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -469
  290. package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -310
  291. package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -303
  292. package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -421
  293. package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -358
  294. package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -114
  295. package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -274
  296. package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -185
  297. package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -191
  298. package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -216
  299. package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -107
  300. package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -120
  301. package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -108
  302. package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -237
  303. package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -261
  304. package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -112
  305. package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +497 -497
  306. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -270
  307. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -164
  308. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -556
  309. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -459
  310. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -65
  311. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -512
  312. package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -132
  313. package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -424
  314. package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -137
  315. package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -306
  316. package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -485
  317. package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -172
  318. package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -422
  319. package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -95
  320. package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -169
  321. package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -554
  322. package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -106
  323. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -216
  324. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -413
  325. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -269
  326. package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -98
  327. package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -337
  328. package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -722
  329. package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -219
  330. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -345
  331. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -269
  332. package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -173
  333. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -267
  334. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -174
  335. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -111
  336. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -186
  337. package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -150
  338. package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -296
  339. package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -371
  340. package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -212
  341. package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -345
  342. package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -223
  343. package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -1053
  344. package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +295 -255
  345. package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +82 -77
  346. package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -224
  347. package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +175 -174
  348. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -967
  349. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -1798
  350. package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -5
  351. package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +180 -137
  352. package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -145
  353. package/vendor/Server/Skills/skill-generator/SKILL.md +365 -365
  354. package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -183
  355. package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -82
  356. package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -110
  357. package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -122
  358. package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -121
  359. package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -259
  360. package/vendor/Server/Skills/task-analysis/SKILL.md +234 -234
  361. package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -160
  362. package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -190
  363. package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -224
  364. package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -162
  365. package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -55
  366. package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -126
  367. package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -256
  368. package/vendor/Server/Skills/task-decomposition/SKILL.md +528 -528
  369. package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -451
  370. package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -179
  371. package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -152
  372. package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -175
  373. package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -195
  374. package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -226
  375. package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -263
  376. package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -29
  377. package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -376
  378. package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -259
  379. package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -216
  380. package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +424 -424
  381. package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -427
  382. package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -214
  383. package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -235
  384. package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -250
  385. package/vendor/Server/TestCheck/TestCheck.js +775 -775
  386. package/vendor/Server/TestCheck/index.js +11 -11
  387. package/vendor/Server/library/McpToolGuide.js +280 -280
  388. package/vendor/Server/library/StatsService.js +126 -126
  389. package/vendor/Server/library/cstTime.js +16 -16
  390. package/vendor/VERSION +3 -3
  391. package/workflows/pr-check.mjs +105 -105
  392. package/workflows/pr-push.mjs +192 -192
  393. package/vendor/Server/Agent/SkillSelector/types.js +0 -63
@@ -1,103 +1,103 @@
1
- # 文档质量检视报告模板(输出产物)
2
-
3
- > 生成 `文档质量检视报告.md` 时使用的标准模板。所有 `{占位符}` 替换为实际检视结果。
4
-
5
- ---
6
-
7
- ## 报告结构
8
-
9
- ```markdown
10
- # {repoName} 文档质量检视报告
11
-
12
- ## 一、检视概览
13
-
14
- | 字段 | 内容 |
15
- |------|------|
16
- | **仓库名称** | {repoName} |
17
- | **检视类型** | ArkTS 文档质量检视 |
18
- | **检视时间** | {timestamp} |
19
- | **扫描文档数** | {docCount} |
20
- | **扫描源码文件数** | {sourceFileCount} |
21
-
22
- ## 二、综合评分
23
-
24
- **综合评分:{score}/100**
25
-
26
- > 评分等级:{grade}({gradeDescription})
27
-
28
- ## 三、维度评分明细
29
-
30
- | 维度 | 子评分 | 权重 | 加权贡献 | Critical数 | Major数 | Minor数 |
31
- |------|--------|------|----------|-----------|---------|---------|
32
- | 文档完整性 | {完整性子评分}/100 | 30% | {完整性贡献} | {c1} | {m1} | {n1} |
33
- | 文档准确性 | {准确性子评分}/100 | 25% | {准确性贡献} | {c2} | {m2} | {n2} |
34
- | 文档易读性 | {易读性子评分}/100 | 15% | {易读性贡献} | {c3} | {m3} | {n3} |
35
- | 代码级文档质量 | {代码级子评分}/100 | 10% | {代码级贡献} | {c4} | {m4} | {n4} |
36
- | 鸿蒙化文档专项 | {鸿蒙化子评分}/100 | 20% | {鸿蒙化贡献} | {c5} | {m5} | {n5} |
37
-
38
- ## 四、检视维度详情
39
-
40
- ### 4.1 文档完整性(权重 30%)
41
-
42
- | 检查项 | 严重度 | 发现数量 | 详情 |
43
- |--------|--------|----------|------|
44
-
45
- > 完整性子评分:{完整性子评分}/100
46
-
47
- ### 4.2 文档准确性(权重 25%)
48
-
49
- > 准确性子评分:{准确性子评分}/100
50
-
51
- ### 4.3 文档易读性(权重 15%)
52
-
53
- > 易读性子评分:{易读性子评分}/100
54
-
55
- ### 4.4 代码级文档质量(权重 10%)
56
-
57
- > 代码级文档子评分:{代码级子评分}/100
58
-
59
- ### 4.5 鸿蒙化文档专项(权重 20%)
60
-
61
- > 鸿蒙化专项子评分:{鸿蒙化子评分}/100
62
-
63
- ## 五、问题清单
64
-
65
- | # | 文档/文件 | 严重度 | 维度 | 描述 | 修复建议 |
66
- |---|-----------|--------|------|------|----------|
67
-
68
- ## 六、改进建议
69
-
70
- ……
71
-
72
- ---
73
-
74
- **报告生成时间**:{timestamp}
75
- ```
76
-
77
- ---
78
-
79
- ## 关键格式要求
80
-
81
- > ⚠️ 以下格式要求必须严格遵守,后端 `_parseArktsLibraryScore` 依赖自动解析。
82
-
83
- 1. **综合评分行格式**:`**综合评分:数字/100**`
84
- - 数字为 0-100 的整数
85
- - 冒号使用**中文全角冒号** `:`
86
- - 必须出现在"二、综合评分"章节的首行
87
-
88
- 2. **维度评分明细表**:必须在综合评分之后紧邻展示
89
-
90
- 3. **各维度子评分标注**:每个维度详情末尾必须标注 `> {维度}子评分:{分数}/100`
91
-
92
- ---
93
-
94
- ## 评分等级参考
95
-
96
- | 评分区间 | 等级 | 含义 |
97
- |----------|------|------|
98
- | 90-100 | 优秀 | 文档完善、准确、易读,鸿蒙化说明充分 |
99
- | 80-89 | 良好 | 存在少量 Minor 问题,不影响使用 |
100
- | 70-79 | 一般 | 存在 Major 级别文档缺失,需补充 |
101
- | 60-69 | 较差 | 关键文档缺失或不准确,严重影响使用 |
102
- | 50-59 | 不合格 | Critical 级别文档缺失,用户无法正常使用 |
1
+ # 文档质量检视报告模板(输出产物)
2
+
3
+ > 生成 `文档质量检视报告.md` 时使用的标准模板。所有 `{占位符}` 替换为实际检视结果。
4
+
5
+ ---
6
+
7
+ ## 报告结构
8
+
9
+ ```markdown
10
+ # {repoName} 文档质量检视报告
11
+
12
+ ## 一、检视概览
13
+
14
+ | 字段 | 内容 |
15
+ |------|------|
16
+ | **仓库名称** | {repoName} |
17
+ | **检视类型** | ArkTS 文档质量检视 |
18
+ | **检视时间** | {timestamp} |
19
+ | **扫描文档数** | {docCount} |
20
+ | **扫描源码文件数** | {sourceFileCount} |
21
+
22
+ ## 二、综合评分
23
+
24
+ **综合评分:{score}/100**
25
+
26
+ > 评分等级:{grade}({gradeDescription})
27
+
28
+ ## 三、维度评分明细
29
+
30
+ | 维度 | 子评分 | 权重 | 加权贡献 | Critical数 | Major数 | Minor数 |
31
+ |------|--------|------|----------|-----------|---------|---------|
32
+ | 文档完整性 | {完整性子评分}/100 | 30% | {完整性贡献} | {c1} | {m1} | {n1} |
33
+ | 文档准确性 | {准确性子评分}/100 | 25% | {准确性贡献} | {c2} | {m2} | {n2} |
34
+ | 文档易读性 | {易读性子评分}/100 | 15% | {易读性贡献} | {c3} | {m3} | {n3} |
35
+ | 代码级文档质量 | {代码级子评分}/100 | 10% | {代码级贡献} | {c4} | {m4} | {n4} |
36
+ | 鸿蒙化文档专项 | {鸿蒙化子评分}/100 | 20% | {鸿蒙化贡献} | {c5} | {m5} | {n5} |
37
+
38
+ ## 四、检视维度详情
39
+
40
+ ### 4.1 文档完整性(权重 30%)
41
+
42
+ | 检查项 | 严重度 | 发现数量 | 详情 |
43
+ |--------|--------|----------|------|
44
+
45
+ > 完整性子评分:{完整性子评分}/100
46
+
47
+ ### 4.2 文档准确性(权重 25%)
48
+
49
+ > 准确性子评分:{准确性子评分}/100
50
+
51
+ ### 4.3 文档易读性(权重 15%)
52
+
53
+ > 易读性子评分:{易读性子评分}/100
54
+
55
+ ### 4.4 代码级文档质量(权重 10%)
56
+
57
+ > 代码级文档子评分:{代码级子评分}/100
58
+
59
+ ### 4.5 鸿蒙化文档专项(权重 20%)
60
+
61
+ > 鸿蒙化专项子评分:{鸿蒙化子评分}/100
62
+
63
+ ## 五、问题清单
64
+
65
+ | # | 文档/文件 | 严重度 | 维度 | 描述 | 修复建议 |
66
+ |---|-----------|--------|------|------|----------|
67
+
68
+ ## 六、改进建议
69
+
70
+ ……
71
+
72
+ ---
73
+
74
+ **报告生成时间**:{timestamp}
75
+ ```
76
+
77
+ ---
78
+
79
+ ## 关键格式要求
80
+
81
+ > ⚠️ 以下格式要求必须严格遵守,后端 `_parseArktsLibraryScore` 依赖自动解析。
82
+
83
+ 1. **综合评分行格式**:`**综合评分:数字/100**`
84
+ - 数字为 0-100 的整数
85
+ - 冒号使用**中文全角冒号** `:`
86
+ - 必须出现在"二、综合评分"章节的首行
87
+
88
+ 2. **维度评分明细表**:必须在综合评分之后紧邻展示
89
+
90
+ 3. **各维度子评分标注**:每个维度详情末尾必须标注 `> {维度}子评分:{分数}/100`
91
+
92
+ ---
93
+
94
+ ## 评分等级参考
95
+
96
+ | 评分区间 | 等级 | 含义 |
97
+ |----------|------|------|
98
+ | 90-100 | 优秀 | 文档完善、准确、易读,鸿蒙化说明充分 |
99
+ | 80-89 | 良好 | 存在少量 Minor 问题,不影响使用 |
100
+ | 70-79 | 一般 | 存在 Major 级别文档缺失,需补充 |
101
+ | 60-69 | 较差 | 关键文档缺失或不准确,严重影响使用 |
102
+ | 50-59 | 不合格 | Critical 级别文档缺失,用户无法正常使用 |
103
103
  | <50 | 严重不足 | 多维度 Critical 问题,文档基本不可用 |
@@ -1,89 +1,89 @@
1
- # 文档质量检视检查维度
2
-
3
- 本文件定义文档质量检视的五个维度、检查项和严重度判定标准。
4
-
5
- ---
6
-
7
- ## 维度一:文档完整性(权重 30%)
8
-
9
- | 检查项 | 严重度 | 说明 |
10
- |--------|--------|------|
11
- | README 缺失 | Critical | 无 README 或 README 为空,用户无法了解库的基本信息 |
12
- | 鸿蒙化说明缺失 | Critical | 缺少鸿蒙化适配说明文档(ohos/README 或等价文档) |
13
- | API 文档缺失 | Major | 公开接口无文档说明(对照接口规格说明.md) |
14
- | 安装指南缺失 | Major | 缺少鸿蒙化库的安装/引入说明(ohpm install 等) |
15
- | 使用示例缺失 | Major | 缺少使用示例代码或 Demo 工程 |
16
- | 中文文档缺失 | Major | 鸿蒙化库面向中文生态,缺少中文文档(README_zh.md 等) |
17
- | 导出声明文档缺失 | Major | index.ets 导出接口无文档说明 |
18
- | 版本说明缺失 | Minor | 无 CHANGELOG 或版本记录 |
19
- | oh-package.json5 说明缺失 | Minor | 依赖配置文件缺少注释/说明 |
20
- | Demo/示例工程缺失 | Minor | 无完整可运行的示例工程 |
21
-
22
- ---
23
-
24
- ## 维度二:文档准确性(权重 25%)
25
-
26
- | 检查项 | 严重度 | 说明 |
27
- |--------|--------|------|
28
- | 错误示例代码 | Critical | 示例代码无法运行或有明显错误(导入路径错、API 不存在等) |
29
- | API 签名不一致 | Major | 文档描述与实际代码接口签名不匹配(参数名、类型、返回值) |
30
- | 导出声明与文档不匹配 | Major | index.ets 导出的接口与文档描述不一致 |
31
- | 废弃 API 未标注 | Major | 文档中仍引用已废弃的 API 或已移除的鸿蒙 API |
32
- | 鸿蒙 API 说明与代码不一致 | Major | 文档声称使用某 @ohos.* API 但代码实际使用了不同 API |
33
- | 代码注释与文档矛盾 | Major | JSDoc 注释描述与 README/API 文档描述互相矛盾 |
34
- | 版本号不一致 | Minor | 文档版本号与 oh-package.json5 版本不匹配 |
35
- | 依赖说明与实际不匹配 | Minor | 文档描述的依赖与 oh-package.json5 不匹配 |
36
- | 链接失效 | Minor | 文档中的外部链接无法访问(404 等) |
37
-
38
- ---
39
-
40
- ## 维度三:文档易读性(权重 15%)
41
-
42
- | 检查项 | 严重度 | 说明 |
43
- |--------|--------|------|
44
- | 结构混乱 | Major | 文档缺少章节划分,内容杂乱无层次 |
45
- | 缺少目录导航 | Minor | 长文档(>500 行)无目录索引 |
46
- | 语言不通顺 | Minor | 表述模糊、语法错误或逻辑不连贯 |
47
- | 缺少图表 | Minor | 复杂流程/架构未用图表说明 |
48
- | 格式不规范 | Minor | Markdown 格式错误(未闭合标签、错误链接语法等) |
49
- | 中英文混杂无规范 | Minor | 同一文档中中英文混杂,未遵循统一语言规范 |
50
- | 术语不一致 | Minor | 同一概念在不同文档中使用不同术语 |
51
-
52
- ---
53
-
54
- ## 维度四:代码级文档质量(权重 10%)
55
-
56
- | 检查项 | 严重度 | 说明 |
57
- |--------|--------|------|
58
- | 公开接口无 JSDoc | Major | 导出的函数/类/接口缺少 JSDoc/TSDoc 注释 |
59
- | JSDoc 参数描述缺失 | Major | 函数注释中缺少参数说明或返回值说明 |
60
- | 鸿蒙特有 API 未注释 | Major | @ohos.* 调用缺少权限/版本等必要注释 |
61
- | 注释过时 | Minor | 代码变更后注释未同步更新 |
62
- | 注释格式不规范 | Minor | JSDoc 格式不符合 ArkTS 编程规范 |
63
-
64
- ---
65
-
66
- ## 维度五:鸿蒙化文档专项(权重 20%)
67
-
68
- | 检查项 | 严重度 | 说明 |
69
- |--------|--------|------|
70
- | 权限说明缺失 | Critical | 使用系统 API(如 sensor、network、geolocation)但未说明所需权限 |
71
- | 鸿蒙化构建配置说明缺失 | Major | build-profile.json5 / hvigorfile.ts 中的鸿蒙特有配置未说明 |
72
- | 鸿蒙特性行为说明缺失 | Major | 缺少鸿蒙平台特有行为/限制说明(如线程模型差异) |
73
- | 差异对比文档缺失 | Major | 缺少鸿蒙化与原库的差异说明(行为差异、接口差异) |
74
- | 鸿蒙化迁移指南缺失 | Major | 缺少从原库迁移到鸿蒙化版本的指南 |
75
- | 兼容性说明缺失 | Major | 缺少支持的鸿蒙版本/API 版本范围说明 |
76
- | 鸿蒙化已知限制说明缺失 | Major | 鸿蒙化后存在的已知功能限制未文档化 |
77
- | 性能限制说明缺失 | Minor | 缺少鸿蒙化后的性能差异/瓶颈说明 |
78
- | 鸿蒙化第三方依赖说明缺失 | Minor | oh-package.json5 中的鸿蒙特有依赖未说明用途 |
79
- | 鸿蒙化测试说明缺失 | Minor | 缺少鸿蒙化特有测试方法/环境说明 |
80
-
81
- ---
82
-
83
- ## 严重度判定标准
84
-
85
- | 严重度 | 扣分 | 判定依据 |
86
- |--------|------|----------|
87
- | Critical | -15 分/项 | 导致用户完全无法使用或严重误解库的功能 |
88
- | Major | -8 分/项 | 关键信息缺失或错误,显著影响用户使用体验 |
89
- | Minor | -3 分/项 | 描述不精确但不影响核心使用 |
1
+ # 文档质量检视检查维度
2
+
3
+ 本文件定义文档质量检视的五个维度、检查项和严重度判定标准。
4
+
5
+ ---
6
+
7
+ ## 维度一:文档完整性(权重 30%)
8
+
9
+ | 检查项 | 严重度 | 说明 |
10
+ |--------|--------|------|
11
+ | README 缺失 | Critical | 无 README 或 README 为空,用户无法了解库的基本信息 |
12
+ | 鸿蒙化说明缺失 | Critical | 缺少鸿蒙化适配说明文档(ohos/README 或等价文档) |
13
+ | API 文档缺失 | Major | 公开接口无文档说明(对照接口规格说明.md) |
14
+ | 安装指南缺失 | Major | 缺少鸿蒙化库的安装/引入说明(ohpm install 等) |
15
+ | 使用示例缺失 | Major | 缺少使用示例代码或 Demo 工程 |
16
+ | 中文文档缺失 | Major | 鸿蒙化库面向中文生态,缺少中文文档(README_zh.md 等) |
17
+ | 导出声明文档缺失 | Major | index.ets 导出接口无文档说明 |
18
+ | 版本说明缺失 | Minor | 无 CHANGELOG 或版本记录 |
19
+ | oh-package.json5 说明缺失 | Minor | 依赖配置文件缺少注释/说明 |
20
+ | Demo/示例工程缺失 | Minor | 无完整可运行的示例工程 |
21
+
22
+ ---
23
+
24
+ ## 维度二:文档准确性(权重 25%)
25
+
26
+ | 检查项 | 严重度 | 说明 |
27
+ |--------|--------|------|
28
+ | 错误示例代码 | Critical | 示例代码无法运行或有明显错误(导入路径错、API 不存在等) |
29
+ | API 签名不一致 | Major | 文档描述与实际代码接口签名不匹配(参数名、类型、返回值) |
30
+ | 导出声明与文档不匹配 | Major | index.ets 导出的接口与文档描述不一致 |
31
+ | 废弃 API 未标注 | Major | 文档中仍引用已废弃的 API 或已移除的鸿蒙 API |
32
+ | 鸿蒙 API 说明与代码不一致 | Major | 文档声称使用某 @ohos.* API 但代码实际使用了不同 API |
33
+ | 代码注释与文档矛盾 | Major | JSDoc 注释描述与 README/API 文档描述互相矛盾 |
34
+ | 版本号不一致 | Minor | 文档版本号与 oh-package.json5 版本不匹配 |
35
+ | 依赖说明与实际不匹配 | Minor | 文档描述的依赖与 oh-package.json5 不匹配 |
36
+ | 链接失效 | Minor | 文档中的外部链接无法访问(404 等) |
37
+
38
+ ---
39
+
40
+ ## 维度三:文档易读性(权重 15%)
41
+
42
+ | 检查项 | 严重度 | 说明 |
43
+ |--------|--------|------|
44
+ | 结构混乱 | Major | 文档缺少章节划分,内容杂乱无层次 |
45
+ | 缺少目录导航 | Minor | 长文档(>500 行)无目录索引 |
46
+ | 语言不通顺 | Minor | 表述模糊、语法错误或逻辑不连贯 |
47
+ | 缺少图表 | Minor | 复杂流程/架构未用图表说明 |
48
+ | 格式不规范 | Minor | Markdown 格式错误(未闭合标签、错误链接语法等) |
49
+ | 中英文混杂无规范 | Minor | 同一文档中中英文混杂,未遵循统一语言规范 |
50
+ | 术语不一致 | Minor | 同一概念在不同文档中使用不同术语 |
51
+
52
+ ---
53
+
54
+ ## 维度四:代码级文档质量(权重 10%)
55
+
56
+ | 检查项 | 严重度 | 说明 |
57
+ |--------|--------|------|
58
+ | 公开接口无 JSDoc | Major | 导出的函数/类/接口缺少 JSDoc/TSDoc 注释 |
59
+ | JSDoc 参数描述缺失 | Major | 函数注释中缺少参数说明或返回值说明 |
60
+ | 鸿蒙特有 API 未注释 | Major | @ohos.* 调用缺少权限/版本等必要注释 |
61
+ | 注释过时 | Minor | 代码变更后注释未同步更新 |
62
+ | 注释格式不规范 | Minor | JSDoc 格式不符合 ArkTS 编程规范 |
63
+
64
+ ---
65
+
66
+ ## 维度五:鸿蒙化文档专项(权重 20%)
67
+
68
+ | 检查项 | 严重度 | 说明 |
69
+ |--------|--------|------|
70
+ | 权限说明缺失 | Critical | 使用系统 API(如 sensor、network、geolocation)但未说明所需权限 |
71
+ | 鸿蒙化构建配置说明缺失 | Major | build-profile.json5 / hvigorfile.ts 中的鸿蒙特有配置未说明 |
72
+ | 鸿蒙特性行为说明缺失 | Major | 缺少鸿蒙平台特有行为/限制说明(如线程模型差异) |
73
+ | 差异对比文档缺失 | Major | 缺少鸿蒙化与原库的差异说明(行为差异、接口差异) |
74
+ | 鸿蒙化迁移指南缺失 | Major | 缺少从原库迁移到鸿蒙化版本的指南 |
75
+ | 兼容性说明缺失 | Major | 缺少支持的鸿蒙版本/API 版本范围说明 |
76
+ | 鸿蒙化已知限制说明缺失 | Major | 鸿蒙化后存在的已知功能限制未文档化 |
77
+ | 性能限制说明缺失 | Minor | 缺少鸿蒙化后的性能差异/瓶颈说明 |
78
+ | 鸿蒙化第三方依赖说明缺失 | Minor | oh-package.json5 中的鸿蒙特有依赖未说明用途 |
79
+ | 鸿蒙化测试说明缺失 | Minor | 缺少鸿蒙化特有测试方法/环境说明 |
80
+
81
+ ---
82
+
83
+ ## 严重度判定标准
84
+
85
+ | 严重度 | 扣分 | 判定依据 |
86
+ |--------|------|----------|
87
+ | Critical | -15 分/项 | 导致用户完全无法使用或严重误解库的功能 |
88
+ | Major | -8 分/项 | 关键信息缺失或错误,显著影响用户使用体验 |
89
+ | Minor | -3 分/项 | 描述不精确但不影响核心使用 |
@@ -1,62 +1,62 @@
1
- # 文档质量检视合规检查清单
2
-
3
- > 检视完成后,对照本清单确认报告完整性与格式合规性,确保后端可自动解析。
4
-
5
- ---
6
-
7
- ## 1. 检视范围检查
8
-
9
- | # | 检查项 | 通过条件 |
10
- |---|--------|----------|
11
- | 1.1 | 文档全量扫描 | 已扫描所有 README、.md、.txt、.rst、CHANGELOG、.json5 文件 |
12
- | 1.2 | 源码扫描 | 已扫描所有 .ets/.ts 文件(排除 node_modules) |
13
- | 1.3 | 鸿蒙化说明定位 | 已通过三级优先级搜索定位鸿蒙化说明文档 |
14
- | 1.4 | 接口规格对照 | 已读取 `接口规格说明.md` 并提取公开接口列表 |
15
- | 1.5 | 文档分类映射 | 已按类别归类(入口/API/鸿蒙化/构建配置/导出声明/示例/代码注释) |
16
-
17
- ---
18
-
19
- ## 2. 五维度检视检查
20
-
21
- | # | 维度 | 通过条件 |
22
- |---|------|----------|
23
- | 2.1 | 文档完整性 | 已检查 README、鸿蒙化说明、API 文档、安装指南、使用示例、中文文档 |
24
- | 2.2 | 文档准确性 | 已核对 API 签名、示例代码可运行性、导出声明一致性、废弃 API |
25
- | 2.3 | 文档易读性 | 已检查结构、目录导航、语言、图表、格式规范 |
26
- | 2.4 | 代码级文档质量 | 已检查 JSDoc/TSDoc 覆盖、参数/返回值描述、鸿蒙特有 API 注释 |
27
- | 2.5 | 鸿蒙化文档专项 | 已检查权限说明、构建配置、差异对比、迁移指南、兼容性说明 |
28
-
29
- ---
30
-
31
- ## 3. 评分计算检查
32
-
33
- | # | 检查项 | 通过条件 |
34
- |---|--------|----------|
35
- | 3.1 | 维度子评分 | 每个维度独立计算 `max(0, 100 - Critical×15 - Major×8 - Minor×3)` |
36
- | 3.2 | 综合评分 | 按权重加权:30/25/15/10/20 |
37
- | 3.3 | 严苛保障 | ≥3 Critical → 最高60分;≥1 Critical + ≥5 Major → 最高50分 |
38
- | 3.4 | 等级标注 | 已按 90-100/80-89/70-79/60-69/50-59/<50 标注等级 |
39
-
40
- ---
41
-
42
- ## 4. 报告格式检查(后端解析依赖)
43
-
44
- | # | 检查项 | 通过条件 |
45
- |---|--------|----------|
46
- | 4.1 | 综合评分行 | `**综合评分:数字/100**`,中文全角冒号 `:`,位于"二、综合评分"首行 |
47
- | 4.2 | 维度评分明细表 | 紧随综合评分之后展示 |
48
- | 4.3 | 维度子评分标注 | 每个维度详情末尾标注 `> {维度}子评分:{分数}/100` |
49
- | 4.4 | 问题清单 | 包含文档/文件、严重度、维度、描述、修复建议 |
50
- | 4.5 | 改进建议 | 提供可执行的改进建议 |
51
-
52
- ---
53
-
54
- ## 5. 常见遗漏检查
55
-
56
- | # | 检查项 | 说明 |
57
- |---|--------|------|
58
- | 5.1 | 示例代码可运行性 | 导入路径错误是最常见 Critical,务必逐个验证 |
59
- | 5.2 | 权限说明 | 使用 @ohos.network 等系统 API 必须检查权限说明 |
60
- | 5.3 | 双 README 同步 | README_zh.md 与 README.md 需双向检查 |
61
- | 5.4 | 隐含行为文档化 | 生命周期自动 API 调用(如 aboutToDisappear → destroy()) |
62
- | 5.5 | oh-package.json5 解析 | 允许注释和尾逗号,不能按严格 JSON 解析 |
1
+ # 文档质量检视合规检查清单
2
+
3
+ > 检视完成后,对照本清单确认报告完整性与格式合规性,确保后端可自动解析。
4
+
5
+ ---
6
+
7
+ ## 1. 检视范围检查
8
+
9
+ | # | 检查项 | 通过条件 |
10
+ |---|--------|----------|
11
+ | 1.1 | 文档全量扫描 | 已扫描所有 README、.md、.txt、.rst、CHANGELOG、.json5 文件 |
12
+ | 1.2 | 源码扫描 | 已扫描所有 .ets/.ts 文件(排除 node_modules) |
13
+ | 1.3 | 鸿蒙化说明定位 | 已通过三级优先级搜索定位鸿蒙化说明文档 |
14
+ | 1.4 | 接口规格对照 | 已读取 `接口规格说明.md` 并提取公开接口列表 |
15
+ | 1.5 | 文档分类映射 | 已按类别归类(入口/API/鸿蒙化/构建配置/导出声明/示例/代码注释) |
16
+
17
+ ---
18
+
19
+ ## 2. 五维度检视检查
20
+
21
+ | # | 维度 | 通过条件 |
22
+ |---|------|----------|
23
+ | 2.1 | 文档完整性 | 已检查 README、鸿蒙化说明、API 文档、安装指南、使用示例、中文文档 |
24
+ | 2.2 | 文档准确性 | 已核对 API 签名、示例代码可运行性、导出声明一致性、废弃 API |
25
+ | 2.3 | 文档易读性 | 已检查结构、目录导航、语言、图表、格式规范 |
26
+ | 2.4 | 代码级文档质量 | 已检查 JSDoc/TSDoc 覆盖、参数/返回值描述、鸿蒙特有 API 注释 |
27
+ | 2.5 | 鸿蒙化文档专项 | 已检查权限说明、构建配置、差异对比、迁移指南、兼容性说明 |
28
+
29
+ ---
30
+
31
+ ## 3. 评分计算检查
32
+
33
+ | # | 检查项 | 通过条件 |
34
+ |---|--------|----------|
35
+ | 3.1 | 维度子评分 | 每个维度独立计算 `max(0, 100 - Critical×15 - Major×8 - Minor×3)` |
36
+ | 3.2 | 综合评分 | 按权重加权:30/25/15/10/20 |
37
+ | 3.3 | 严苛保障 | ≥3 Critical → 最高60分;≥1 Critical + ≥5 Major → 最高50分 |
38
+ | 3.4 | 等级标注 | 已按 90-100/80-89/70-79/60-69/50-59/<50 标注等级 |
39
+
40
+ ---
41
+
42
+ ## 4. 报告格式检查(后端解析依赖)
43
+
44
+ | # | 检查项 | 通过条件 |
45
+ |---|--------|----------|
46
+ | 4.1 | 综合评分行 | `**综合评分:数字/100**`,中文全角冒号 `:`,位于"二、综合评分"首行 |
47
+ | 4.2 | 维度评分明细表 | 紧随综合评分之后展示 |
48
+ | 4.3 | 维度子评分标注 | 每个维度详情末尾标注 `> {维度}子评分:{分数}/100` |
49
+ | 4.4 | 问题清单 | 包含文档/文件、严重度、维度、描述、修复建议 |
50
+ | 4.5 | 改进建议 | 提供可执行的改进建议 |
51
+
52
+ ---
53
+
54
+ ## 5. 常见遗漏检查
55
+
56
+ | # | 检查项 | 说明 |
57
+ |---|--------|------|
58
+ | 5.1 | 示例代码可运行性 | 导入路径错误是最常见 Critical,务必逐个验证 |
59
+ | 5.2 | 权限说明 | 使用 @ohos.network 等系统 API 必须检查权限说明 |
60
+ | 5.3 | 双 README 同步 | README_zh.md 与 README.md 需双向检查 |
61
+ | 5.4 | 隐含行为文档化 | 生命周期自动 API 调用(如 aboutToDisappear → destroy()) |
62
+ | 5.5 | oh-package.json5 解析 | 允许注释和尾逗号,不能按严格 JSON 解析 |