@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,57 +1,57 @@
|
|
|
1
|
-
# 常见陷阱(Gotchas)
|
|
2
|
-
|
|
3
|
-
> 本文件记录 `rn-library-documentation-quality-check` 技能在检视过程中容易踩坑的场景和注意事项。
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## 一、接口与命名陷阱
|
|
8
|
-
|
|
9
|
-
| 陷阱 | 说明 | 影响 |
|
|
10
|
-
|------|------|------|
|
|
11
|
-
| **TurboModule Spec 接口归零判定** | `.d.ts` 中 `Spec extends TurboModule` 接口完全无注释时触发归零,但若 README 有该 API 的用法说明则不触发——需同时检查源码注释和 README 描述 | 归零规则误判 |
|
|
12
|
-
| **`delete` 是 JS 保留字** | 源码 `export { delete }` 合法,README 可能写作 `axios.delete()` 或 `axios.del()` | 方法名比对误报 |
|
|
13
|
-
| **命名导出 vs 默认导出** | `export { lottie }` 是命名导出,示例必须用 `import { lottie }` 而非 `import lottie`,这是最常见的示例 Blocker | 示例质量误判 |
|
|
14
|
-
| **`@react-native-ohos/` 前缀** | 鸿蒙化包名通常以 `@react-native-ohos/` 开头,README 示例可能使用原库名导致 import 路径错误 | 示例 import 检查 |
|
|
15
|
-
|
|
16
|
-
## 二、ArkTS 与鸿蒙特有陷阱
|
|
17
|
-
|
|
18
|
-
| 陷阱 | 说明 | 影响 |
|
|
19
|
-
|------|------|------|
|
|
20
|
-
| **ArkTS 严格模式** | ArkTS 比 TS 更严格(不允许 `any`、强制类型标注),示例代码需以 ArkTS 规范为准 | 示例质量评估偏差 |
|
|
21
|
-
| **Codegen 配置** | TurboModule 库需在 `react-native.config.js` 中配置 Codegen,该文件无说明是常见遗漏 | 适配说明遗漏 |
|
|
22
|
-
| **module.json5 不是 JSON** | 允许注释和尾逗号,不能按严格 JSON 解析 | 解析报错 |
|
|
23
|
-
|
|
24
|
-
## 三、版本与变更陷阱
|
|
25
|
-
|
|
26
|
-
| 陷阱 | 说明 | 影响 |
|
|
27
|
-
|------|------|------|
|
|
28
|
-
| **版本号多处不一致** | package.json、oh-package.json5、README、CHANGELOG 中的版本号可能不一致,需交叉对比 | 版本规范误判 |
|
|
29
|
-
| **CHANGELOG 未记录鸿蒙化变更** | CHANGELOG 存在但仅含原库版本历史,无鸿蒙化适配条目是常见遗漏 | 变更记录遗漏 |
|
|
30
|
-
| **文档描述的 API 可能是旧版签名** | 代码重构后 API 签名变更但文档未同步更新,这是最常见的准确性问题,必须通过交叉验证环节发现 | 交叉验证遗漏 |
|
|
31
|
-
|
|
32
|
-
## 四、异步与类型陷阱
|
|
33
|
-
|
|
34
|
-
| 陷阱 | 说明 | 影响 |
|
|
35
|
-
|------|------|------|
|
|
36
|
-
| **async/Promise 返回类型遗漏** | 文档写 `getConfig(): Config` 但代码实际为 `getConfig(): Promise<Config>`,这是最常见的签名不一致模式 | 签名比对误报 |
|
|
37
|
-
| **示例代码未处理异步** | TurboModule 方法多为 Promise 返回,示例未 await 是常见 Major 问题 | 示例质量扣分 |
|
|
38
|
-
| **可选参数差异** | 文档写 `callback: Function` 但代码签名 `callback?: Function`(可选性未标注),或反向文档标注可选但代码实际必选 | 参数比对误报 |
|
|
39
|
-
|
|
40
|
-
## 五、跳转文档模式陷阱
|
|
41
|
-
|
|
42
|
-
| 陷阱 | 说明 | 影响 |
|
|
43
|
-
|------|------|------|
|
|
44
|
-
| **跳转文档模式误判为"文档缺失"** | 跳转模式的 README 极简是设计选择,不应直接扣分为 RM-002/RM-004,应转而检视外部 usage-docs 内容完整性 | 评分严重偏差 |
|
|
45
|
-
| **跳转文档链接指向统一仓库** | `OpenHarmony-RN/usage-docs` 是集中式文档仓库,一个库的文档对应 `zh-cn/{库名}.md` 和 `en/{库名}.md`,需分别获取中英文版本 | 文档获取遗漏 |
|
|
46
|
-
| **跳转文档可能未同步更新** | usage-docs 仓库的文档可能滞后于代码仓库更新,需通过 Phase 2.5 交叉验证环节强制比对(XC-001/XC-006) | 文档过时未发现 |
|
|
47
|
-
| **跳转文档的库名映射** | URL 中的库名是原库名(如 `react-native-network-info`),不是鸿蒙化包名(如 `@react-native-ohos/react-native-network-info`),提取时需去掉 `@org/` 前缀和版本号 | URL 构造错误 |
|
|
48
|
-
| **跳转文档接口支持矩阵过时** | 外部 usage-docs 的 Yes/No/Partial 标记可能基于旧版代码,需与接口规格说明文档中的鸿蒙化差异(第 5 章)逐项比对 | 支持矩阵不准 |
|
|
49
|
-
| **rndocUrl 优先使用** | 当任务参数传入 rndocUrl 时,跳转模式下应优先使用 rndocUrl 下载文档,而非从 README 提取链接或构造标准 URL。rndocUrl 通常是用户确认过的正确文档地址,可靠性最高 | 文档获取失败 |
|
|
50
|
-
|
|
51
|
-
## 六、交叉验证陷阱
|
|
52
|
-
|
|
53
|
-
| 陷阱 | 说明 | 影响 |
|
|
54
|
-
|------|------|------|
|
|
55
|
-
| **接口规格说明文档是权威基准** | 由 `RNLibraryInterfaceAnalyzer` 从上游原库和鸿蒙化仓库双仓库提取生成,已包含完整 API 清单和鸿蒙化差异,交叉验证时直接使用,无需再从源码逐条提取 | 重复工作 |
|
|
56
|
-
| **接口规格说明文档缺失时无法交叉验证** | 若 `{outputDir}/接口规格说明.md` 不存在(前置 SKILL 未执行),记录为 XC-001 Critical,跳过交叉验证环节,在报告中注明 | 交叉验证跳过 |
|
|
57
|
-
| **内嵌文档模板版本** | 内嵌模式的 README 通常遵循模板格式(如 `模板版本:v0.4.1`),可通过模板版本判断文档规范性 | 文档规范性判断 |
|
|
1
|
+
# 常见陷阱(Gotchas)
|
|
2
|
+
|
|
3
|
+
> 本文件记录 `rn-library-documentation-quality-check` 技能在检视过程中容易踩坑的场景和注意事项。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 一、接口与命名陷阱
|
|
8
|
+
|
|
9
|
+
| 陷阱 | 说明 | 影响 |
|
|
10
|
+
|------|------|------|
|
|
11
|
+
| **TurboModule Spec 接口归零判定** | `.d.ts` 中 `Spec extends TurboModule` 接口完全无注释时触发归零,但若 README 有该 API 的用法说明则不触发——需同时检查源码注释和 README 描述 | 归零规则误判 |
|
|
12
|
+
| **`delete` 是 JS 保留字** | 源码 `export { delete }` 合法,README 可能写作 `axios.delete()` 或 `axios.del()` | 方法名比对误报 |
|
|
13
|
+
| **命名导出 vs 默认导出** | `export { lottie }` 是命名导出,示例必须用 `import { lottie }` 而非 `import lottie`,这是最常见的示例 Blocker | 示例质量误判 |
|
|
14
|
+
| **`@react-native-ohos/` 前缀** | 鸿蒙化包名通常以 `@react-native-ohos/` 开头,README 示例可能使用原库名导致 import 路径错误 | 示例 import 检查 |
|
|
15
|
+
|
|
16
|
+
## 二、ArkTS 与鸿蒙特有陷阱
|
|
17
|
+
|
|
18
|
+
| 陷阱 | 说明 | 影响 |
|
|
19
|
+
|------|------|------|
|
|
20
|
+
| **ArkTS 严格模式** | ArkTS 比 TS 更严格(不允许 `any`、强制类型标注),示例代码需以 ArkTS 规范为准 | 示例质量评估偏差 |
|
|
21
|
+
| **Codegen 配置** | TurboModule 库需在 `react-native.config.js` 中配置 Codegen,该文件无说明是常见遗漏 | 适配说明遗漏 |
|
|
22
|
+
| **module.json5 不是 JSON** | 允许注释和尾逗号,不能按严格 JSON 解析 | 解析报错 |
|
|
23
|
+
|
|
24
|
+
## 三、版本与变更陷阱
|
|
25
|
+
|
|
26
|
+
| 陷阱 | 说明 | 影响 |
|
|
27
|
+
|------|------|------|
|
|
28
|
+
| **版本号多处不一致** | package.json、oh-package.json5、README、CHANGELOG 中的版本号可能不一致,需交叉对比 | 版本规范误判 |
|
|
29
|
+
| **CHANGELOG 未记录鸿蒙化变更** | CHANGELOG 存在但仅含原库版本历史,无鸿蒙化适配条目是常见遗漏 | 变更记录遗漏 |
|
|
30
|
+
| **文档描述的 API 可能是旧版签名** | 代码重构后 API 签名变更但文档未同步更新,这是最常见的准确性问题,必须通过交叉验证环节发现 | 交叉验证遗漏 |
|
|
31
|
+
|
|
32
|
+
## 四、异步与类型陷阱
|
|
33
|
+
|
|
34
|
+
| 陷阱 | 说明 | 影响 |
|
|
35
|
+
|------|------|------|
|
|
36
|
+
| **async/Promise 返回类型遗漏** | 文档写 `getConfig(): Config` 但代码实际为 `getConfig(): Promise<Config>`,这是最常见的签名不一致模式 | 签名比对误报 |
|
|
37
|
+
| **示例代码未处理异步** | TurboModule 方法多为 Promise 返回,示例未 await 是常见 Major 问题 | 示例质量扣分 |
|
|
38
|
+
| **可选参数差异** | 文档写 `callback: Function` 但代码签名 `callback?: Function`(可选性未标注),或反向文档标注可选但代码实际必选 | 参数比对误报 |
|
|
39
|
+
|
|
40
|
+
## 五、跳转文档模式陷阱
|
|
41
|
+
|
|
42
|
+
| 陷阱 | 说明 | 影响 |
|
|
43
|
+
|------|------|------|
|
|
44
|
+
| **跳转文档模式误判为"文档缺失"** | 跳转模式的 README 极简是设计选择,不应直接扣分为 RM-002/RM-004,应转而检视外部 usage-docs 内容完整性 | 评分严重偏差 |
|
|
45
|
+
| **跳转文档链接指向统一仓库** | `OpenHarmony-RN/usage-docs` 是集中式文档仓库,一个库的文档对应 `zh-cn/{库名}.md` 和 `en/{库名}.md`,需分别获取中英文版本 | 文档获取遗漏 |
|
|
46
|
+
| **跳转文档可能未同步更新** | usage-docs 仓库的文档可能滞后于代码仓库更新,需通过 Phase 2.5 交叉验证环节强制比对(XC-001/XC-006) | 文档过时未发现 |
|
|
47
|
+
| **跳转文档的库名映射** | URL 中的库名是原库名(如 `react-native-network-info`),不是鸿蒙化包名(如 `@react-native-ohos/react-native-network-info`),提取时需去掉 `@org/` 前缀和版本号 | URL 构造错误 |
|
|
48
|
+
| **跳转文档接口支持矩阵过时** | 外部 usage-docs 的 Yes/No/Partial 标记可能基于旧版代码,需与接口规格说明文档中的鸿蒙化差异(第 5 章)逐项比对 | 支持矩阵不准 |
|
|
49
|
+
| **rndocUrl 优先使用** | 当任务参数传入 rndocUrl 时,跳转模式下应优先使用 rndocUrl 下载文档,而非从 README 提取链接或构造标准 URL。rndocUrl 通常是用户确认过的正确文档地址,可靠性最高 | 文档获取失败 |
|
|
50
|
+
|
|
51
|
+
## 六、交叉验证陷阱
|
|
52
|
+
|
|
53
|
+
| 陷阱 | 说明 | 影响 |
|
|
54
|
+
|------|------|------|
|
|
55
|
+
| **接口规格说明文档是权威基准** | 由 `RNLibraryInterfaceAnalyzer` 从上游原库和鸿蒙化仓库双仓库提取生成,已包含完整 API 清单和鸿蒙化差异,交叉验证时直接使用,无需再从源码逐条提取 | 重复工作 |
|
|
56
|
+
| **接口规格说明文档缺失时无法交叉验证** | 若 `{outputDir}/接口规格说明.md` 不存在(前置 SKILL 未执行),记录为 XC-001 Critical,跳过交叉验证环节,在报告中注明 | 交叉验证跳过 |
|
|
57
|
+
| **内嵌文档模板版本** | 内嵌模式的 README 通常遵循模板格式(如 `模板版本:v0.4.1`),可通过模板版本判断文档规范性 | 文档规范性判断 |
|
package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py
CHANGED
|
@@ -1,259 +1,259 @@
|
|
|
1
|
-
#!/usr/bin/env python3
|
|
2
|
-
# @tool validate-skill
|
|
3
|
-
# @description 校验SKILL目录是否符合Agent Skills规范,检查frontmatter、结构、渐进式披露
|
|
4
|
-
# @param skillDir: string - SKILL目录绝对路径
|
|
5
|
-
|
|
6
|
-
import sys
|
|
7
|
-
import json
|
|
8
|
-
import os
|
|
9
|
-
import re
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
def main():
|
|
13
|
-
# 解析参数:支持 JSON 字符串(MCP Gateway 调用)或直接命令行参数
|
|
14
|
-
if len(sys.argv) > 1:
|
|
15
|
-
arg = sys.argv[1]
|
|
16
|
-
if arg.startswith('{'):
|
|
17
|
-
skill_dir = json.loads(arg).get('skillDir', '')
|
|
18
|
-
else:
|
|
19
|
-
skill_dir = arg
|
|
20
|
-
else:
|
|
21
|
-
print("Usage: validate-skill.py <skillDir>")
|
|
22
|
-
print("Error: skillDir parameter is required")
|
|
23
|
-
sys.exit(1)
|
|
24
|
-
|
|
25
|
-
if not skill_dir:
|
|
26
|
-
print("Usage: validate-skill.py <skillDir>")
|
|
27
|
-
print("Error: skillDir parameter is required")
|
|
28
|
-
sys.exit(1)
|
|
29
|
-
|
|
30
|
-
if not os.path.isdir(skill_dir):
|
|
31
|
-
print(f"Error: Directory does not exist: {skill_dir}")
|
|
32
|
-
sys.exit(1)
|
|
33
|
-
|
|
34
|
-
passed = 0
|
|
35
|
-
failed = 0
|
|
36
|
-
warnings = 0
|
|
37
|
-
|
|
38
|
-
def check_pass(msg):
|
|
39
|
-
nonlocal passed
|
|
40
|
-
print(f" PASS {msg}")
|
|
41
|
-
passed += 1
|
|
42
|
-
|
|
43
|
-
def check_fail(msg):
|
|
44
|
-
nonlocal failed
|
|
45
|
-
print(f" FAIL {msg}")
|
|
46
|
-
failed += 1
|
|
47
|
-
|
|
48
|
-
def check_warn(msg):
|
|
49
|
-
nonlocal warnings
|
|
50
|
-
print(f" WARN {msg}")
|
|
51
|
-
warnings += 1
|
|
52
|
-
|
|
53
|
-
print("=== SKILL spec validation ===")
|
|
54
|
-
print(f"Directory: {skill_dir}")
|
|
55
|
-
print()
|
|
56
|
-
|
|
57
|
-
# --- 1. SKILL.md existence ---
|
|
58
|
-
print("--- 1. File structure ---")
|
|
59
|
-
skill_file = os.path.join(skill_dir, "SKILL.md")
|
|
60
|
-
if os.path.isfile(skill_file):
|
|
61
|
-
check_pass("SKILL.md exists")
|
|
62
|
-
else:
|
|
63
|
-
check_fail("SKILL.md does not exist")
|
|
64
|
-
print("Cannot continue validation, SKILL.md is required")
|
|
65
|
-
sys.exit(1)
|
|
66
|
-
|
|
67
|
-
with open(skill_file, 'r', encoding='utf-8') as f:
|
|
68
|
-
content = f.read()
|
|
69
|
-
lines = content.splitlines()
|
|
70
|
-
|
|
71
|
-
# --- 2. Frontmatter ---
|
|
72
|
-
print()
|
|
73
|
-
print("--- 2. Frontmatter ---")
|
|
74
|
-
|
|
75
|
-
if lines and lines[0].strip() == '---':
|
|
76
|
-
check_pass("YAML frontmatter exists")
|
|
77
|
-
else:
|
|
78
|
-
check_fail("Missing YAML frontmatter (file should start with ---)")
|
|
79
|
-
|
|
80
|
-
# Extract name
|
|
81
|
-
name_match = re.search(r'^name:\s*(.+)$', content, re.MULTILINE)
|
|
82
|
-
name_field = name_match.group(1).strip() if name_match else ''
|
|
83
|
-
|
|
84
|
-
if name_field:
|
|
85
|
-
check_pass(f"name field exists: {name_field}")
|
|
86
|
-
|
|
87
|
-
if re.match(r'^[a-z0-9]+(-[a-z0-9]+)*$', name_field):
|
|
88
|
-
check_pass("name charset valid (lowercase letters/digits/hyphens only)")
|
|
89
|
-
else:
|
|
90
|
-
check_fail("name charset invalid: should only contain a-z/0-9/-, no leading/trailing or consecutive hyphens")
|
|
91
|
-
|
|
92
|
-
name_len = len(name_field)
|
|
93
|
-
if 1 <= name_len <= 64:
|
|
94
|
-
check_pass(f"name length valid ({name_len} chars)")
|
|
95
|
-
else:
|
|
96
|
-
check_fail(f"name length invalid: should be 1-64 chars (current {name_len})")
|
|
97
|
-
|
|
98
|
-
dir_name = os.path.basename(skill_dir.rstrip(os.sep))
|
|
99
|
-
if name_field == dir_name:
|
|
100
|
-
check_pass(f"name matches parent directory ({dir_name})")
|
|
101
|
-
else:
|
|
102
|
-
check_warn(f"name does not exactly match parent directory: name='{name_field}' vs dir='{dir_name}' (PascalCase dir convention exempted)")
|
|
103
|
-
else:
|
|
104
|
-
check_fail("name field is missing")
|
|
105
|
-
|
|
106
|
-
# Extract description
|
|
107
|
-
desc_match = re.search(r'^description:\s*(.+?)(?=\n[a-z]|\n---|\Z)', content, re.MULTILINE | re.DOTALL)
|
|
108
|
-
desc_field = desc_match.group(1).strip() if desc_match else ''
|
|
109
|
-
|
|
110
|
-
if desc_field:
|
|
111
|
-
desc_len = len(desc_field)
|
|
112
|
-
if desc_len <= 1024:
|
|
113
|
-
check_pass(f"description length valid ({desc_len} chars)")
|
|
114
|
-
else:
|
|
115
|
-
check_fail(f"description too long: should be <=1024 chars (current {desc_len})")
|
|
116
|
-
else:
|
|
117
|
-
check_fail("description field is missing or empty")
|
|
118
|
-
|
|
119
|
-
# Check license
|
|
120
|
-
if re.search(r'^license:', content, re.MULTILINE):
|
|
121
|
-
check_pass("license field exists")
|
|
122
|
-
else:
|
|
123
|
-
check_warn("license field missing (recommended)")
|
|
124
|
-
warnings += 1
|
|
125
|
-
|
|
126
|
-
# Check metadata
|
|
127
|
-
if re.search(r'^metadata:', content, re.MULTILINE):
|
|
128
|
-
check_pass("metadata field exists")
|
|
129
|
-
else:
|
|
130
|
-
check_warn("metadata field missing (recommended author/version)")
|
|
131
|
-
warnings += 1
|
|
132
|
-
|
|
133
|
-
# --- 3. Body ---
|
|
134
|
-
print()
|
|
135
|
-
print("--- 3. Body content ---")
|
|
136
|
-
|
|
137
|
-
# Count body lines (after frontmatter)
|
|
138
|
-
start = 0
|
|
139
|
-
end_idx = 0
|
|
140
|
-
for i, line in enumerate(lines):
|
|
141
|
-
if line.strip() == '---':
|
|
142
|
-
if start == 0:
|
|
143
|
-
start = i + 1
|
|
144
|
-
else:
|
|
145
|
-
end_idx = i + 1
|
|
146
|
-
break
|
|
147
|
-
if end_idx == 0:
|
|
148
|
-
end_idx = start
|
|
149
|
-
body_lines = lines[end_idx:]
|
|
150
|
-
body_count = len(body_lines)
|
|
151
|
-
|
|
152
|
-
if body_count <= 500:
|
|
153
|
-
check_pass(f"body line count valid ({body_count} lines, <=500)")
|
|
154
|
-
else:
|
|
155
|
-
check_warn(f"body line count high ({body_count} lines, recommended <500, consider splitting to references/)")
|
|
156
|
-
warnings += 1
|
|
157
|
-
|
|
158
|
-
# Check task parameters table
|
|
159
|
-
if re.search(r'(task param|param|\| .*param)', content, re.IGNORECASE) or 'param' in content.lower():
|
|
160
|
-
check_pass("contains task parameters table")
|
|
161
|
-
else:
|
|
162
|
-
check_warn("no task parameters table found (recommended)")
|
|
163
|
-
warnings += 1
|
|
164
|
-
|
|
165
|
-
# Check workflow
|
|
166
|
-
if re.search(r'(workflow|Phase)', content):
|
|
167
|
-
check_pass("contains workflow overview")
|
|
168
|
-
else:
|
|
169
|
-
check_warn("no workflow overview found (recommended)")
|
|
170
|
-
warnings += 1
|
|
171
|
-
|
|
172
|
-
# --- 4. Progressive disclosure ---
|
|
173
|
-
print()
|
|
174
|
-
print("--- 4. Progressive disclosure ---")
|
|
175
|
-
|
|
176
|
-
# Check references directory
|
|
177
|
-
refs_dir = os.path.join(skill_dir, "references")
|
|
178
|
-
if os.path.isdir(refs_dir):
|
|
179
|
-
ref_files = [f for f in os.listdir(refs_dir) if f.endswith('.md') and os.path.isfile(os.path.join(refs_dir, f))]
|
|
180
|
-
check_pass(f"references/ directory exists ({len(ref_files)} docs)")
|
|
181
|
-
|
|
182
|
-
# Check nesting depth (one level)
|
|
183
|
-
nested = False
|
|
184
|
-
for root, dirs, files in os.walk(refs_dir):
|
|
185
|
-
if root != refs_dir and dirs:
|
|
186
|
-
nested = True
|
|
187
|
-
break
|
|
188
|
-
if not nested:
|
|
189
|
-
check_pass("references maintain one-level depth")
|
|
190
|
-
else:
|
|
191
|
-
check_fail("references contains nested subdirectories, should maintain one-level depth")
|
|
192
|
-
else:
|
|
193
|
-
check_warn("no references/ directory (consider splitting detailed content here)")
|
|
194
|
-
warnings += 1
|
|
195
|
-
|
|
196
|
-
# Check assets directory
|
|
197
|
-
assets_dir = os.path.join(skill_dir, "assets")
|
|
198
|
-
if os.path.isdir(assets_dir):
|
|
199
|
-
asset_files = [f for f in os.listdir(assets_dir) if os.path.isfile(os.path.join(assets_dir, f))]
|
|
200
|
-
check_pass(f"assets/ directory exists ({len(asset_files)} files)")
|
|
201
|
-
else:
|
|
202
|
-
check_warn("no assets/ directory (add if templates/resources needed)")
|
|
203
|
-
warnings += 1
|
|
204
|
-
|
|
205
|
-
# Check scripts directory
|
|
206
|
-
scripts_dir = os.path.join(skill_dir, "scripts")
|
|
207
|
-
if os.path.isdir(scripts_dir):
|
|
208
|
-
script_files = [f for f in os.listdir(scripts_dir) if os.path.isfile(os.path.join(scripts_dir, f))]
|
|
209
|
-
check_pass(f"scripts/ directory exists ({len(script_files)} scripts)")
|
|
210
|
-
else:
|
|
211
|
-
check_warn("no scripts/ directory (add if executable scripts needed)")
|
|
212
|
-
warnings += 1
|
|
213
|
-
|
|
214
|
-
# Check relative paths (no absolute path references like ](/...)
|
|
215
|
-
abs_refs = re.findall(r'\]\(/[^)]+\)', content)
|
|
216
|
-
if len(abs_refs) == 0:
|
|
217
|
-
check_pass("file references use relative paths")
|
|
218
|
-
else:
|
|
219
|
-
check_fail(f"found {len(abs_refs)} absolute path references, should use relative paths")
|
|
220
|
-
|
|
221
|
-
# --- 5. Referenced file existence ---
|
|
222
|
-
print()
|
|
223
|
-
print("--- 5. Referenced file existence ---")
|
|
224
|
-
|
|
225
|
-
ref_paths = set(re.findall(r'\]\((references/[^)]+)\)', content))
|
|
226
|
-
asset_paths = set(re.findall(r'\]\((assets/[^)]+)\)', content))
|
|
227
|
-
|
|
228
|
-
for ref in sorted(ref_paths):
|
|
229
|
-
fullpath = os.path.join(skill_dir, ref)
|
|
230
|
-
if os.path.isfile(fullpath):
|
|
231
|
-
check_pass(f"referenced file exists: {ref}")
|
|
232
|
-
else:
|
|
233
|
-
check_fail(f"referenced file does not exist: {ref}")
|
|
234
|
-
|
|
235
|
-
for asset in sorted(asset_paths):
|
|
236
|
-
fullpath = os.path.join(skill_dir, asset)
|
|
237
|
-
if os.path.isfile(fullpath):
|
|
238
|
-
check_pass(f"referenced file exists: {asset}")
|
|
239
|
-
else:
|
|
240
|
-
check_fail(f"referenced file does not exist: {asset}")
|
|
241
|
-
|
|
242
|
-
# --- 6. Summary ---
|
|
243
|
-
print()
|
|
244
|
-
print("=== Validation summary ===")
|
|
245
|
-
print(f" PASS: {passed}")
|
|
246
|
-
print(f" FAIL: {failed}")
|
|
247
|
-
print(f" WARN: {warnings}")
|
|
248
|
-
print()
|
|
249
|
-
|
|
250
|
-
if failed == 0:
|
|
251
|
-
print("ALL CHECKS PASSED")
|
|
252
|
-
sys.exit(0)
|
|
253
|
-
else:
|
|
254
|
-
print(f"VALIDATION FAILED: {failed} issue(s) must be fixed")
|
|
255
|
-
sys.exit(1)
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
if __name__ == '__main__':
|
|
259
|
-
main()
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
# @tool validate-skill
|
|
3
|
+
# @description 校验SKILL目录是否符合Agent Skills规范,检查frontmatter、结构、渐进式披露
|
|
4
|
+
# @param skillDir: string - SKILL目录绝对路径
|
|
5
|
+
|
|
6
|
+
import sys
|
|
7
|
+
import json
|
|
8
|
+
import os
|
|
9
|
+
import re
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def main():
|
|
13
|
+
# 解析参数:支持 JSON 字符串(MCP Gateway 调用)或直接命令行参数
|
|
14
|
+
if len(sys.argv) > 1:
|
|
15
|
+
arg = sys.argv[1]
|
|
16
|
+
if arg.startswith('{'):
|
|
17
|
+
skill_dir = json.loads(arg).get('skillDir', '')
|
|
18
|
+
else:
|
|
19
|
+
skill_dir = arg
|
|
20
|
+
else:
|
|
21
|
+
print("Usage: validate-skill.py <skillDir>")
|
|
22
|
+
print("Error: skillDir parameter is required")
|
|
23
|
+
sys.exit(1)
|
|
24
|
+
|
|
25
|
+
if not skill_dir:
|
|
26
|
+
print("Usage: validate-skill.py <skillDir>")
|
|
27
|
+
print("Error: skillDir parameter is required")
|
|
28
|
+
sys.exit(1)
|
|
29
|
+
|
|
30
|
+
if not os.path.isdir(skill_dir):
|
|
31
|
+
print(f"Error: Directory does not exist: {skill_dir}")
|
|
32
|
+
sys.exit(1)
|
|
33
|
+
|
|
34
|
+
passed = 0
|
|
35
|
+
failed = 0
|
|
36
|
+
warnings = 0
|
|
37
|
+
|
|
38
|
+
def check_pass(msg):
|
|
39
|
+
nonlocal passed
|
|
40
|
+
print(f" PASS {msg}")
|
|
41
|
+
passed += 1
|
|
42
|
+
|
|
43
|
+
def check_fail(msg):
|
|
44
|
+
nonlocal failed
|
|
45
|
+
print(f" FAIL {msg}")
|
|
46
|
+
failed += 1
|
|
47
|
+
|
|
48
|
+
def check_warn(msg):
|
|
49
|
+
nonlocal warnings
|
|
50
|
+
print(f" WARN {msg}")
|
|
51
|
+
warnings += 1
|
|
52
|
+
|
|
53
|
+
print("=== SKILL spec validation ===")
|
|
54
|
+
print(f"Directory: {skill_dir}")
|
|
55
|
+
print()
|
|
56
|
+
|
|
57
|
+
# --- 1. SKILL.md existence ---
|
|
58
|
+
print("--- 1. File structure ---")
|
|
59
|
+
skill_file = os.path.join(skill_dir, "SKILL.md")
|
|
60
|
+
if os.path.isfile(skill_file):
|
|
61
|
+
check_pass("SKILL.md exists")
|
|
62
|
+
else:
|
|
63
|
+
check_fail("SKILL.md does not exist")
|
|
64
|
+
print("Cannot continue validation, SKILL.md is required")
|
|
65
|
+
sys.exit(1)
|
|
66
|
+
|
|
67
|
+
with open(skill_file, 'r', encoding='utf-8') as f:
|
|
68
|
+
content = f.read()
|
|
69
|
+
lines = content.splitlines()
|
|
70
|
+
|
|
71
|
+
# --- 2. Frontmatter ---
|
|
72
|
+
print()
|
|
73
|
+
print("--- 2. Frontmatter ---")
|
|
74
|
+
|
|
75
|
+
if lines and lines[0].strip() == '---':
|
|
76
|
+
check_pass("YAML frontmatter exists")
|
|
77
|
+
else:
|
|
78
|
+
check_fail("Missing YAML frontmatter (file should start with ---)")
|
|
79
|
+
|
|
80
|
+
# Extract name
|
|
81
|
+
name_match = re.search(r'^name:\s*(.+)$', content, re.MULTILINE)
|
|
82
|
+
name_field = name_match.group(1).strip() if name_match else ''
|
|
83
|
+
|
|
84
|
+
if name_field:
|
|
85
|
+
check_pass(f"name field exists: {name_field}")
|
|
86
|
+
|
|
87
|
+
if re.match(r'^[a-z0-9]+(-[a-z0-9]+)*$', name_field):
|
|
88
|
+
check_pass("name charset valid (lowercase letters/digits/hyphens only)")
|
|
89
|
+
else:
|
|
90
|
+
check_fail("name charset invalid: should only contain a-z/0-9/-, no leading/trailing or consecutive hyphens")
|
|
91
|
+
|
|
92
|
+
name_len = len(name_field)
|
|
93
|
+
if 1 <= name_len <= 64:
|
|
94
|
+
check_pass(f"name length valid ({name_len} chars)")
|
|
95
|
+
else:
|
|
96
|
+
check_fail(f"name length invalid: should be 1-64 chars (current {name_len})")
|
|
97
|
+
|
|
98
|
+
dir_name = os.path.basename(skill_dir.rstrip(os.sep))
|
|
99
|
+
if name_field == dir_name:
|
|
100
|
+
check_pass(f"name matches parent directory ({dir_name})")
|
|
101
|
+
else:
|
|
102
|
+
check_warn(f"name does not exactly match parent directory: name='{name_field}' vs dir='{dir_name}' (PascalCase dir convention exempted)")
|
|
103
|
+
else:
|
|
104
|
+
check_fail("name field is missing")
|
|
105
|
+
|
|
106
|
+
# Extract description
|
|
107
|
+
desc_match = re.search(r'^description:\s*(.+?)(?=\n[a-z]|\n---|\Z)', content, re.MULTILINE | re.DOTALL)
|
|
108
|
+
desc_field = desc_match.group(1).strip() if desc_match else ''
|
|
109
|
+
|
|
110
|
+
if desc_field:
|
|
111
|
+
desc_len = len(desc_field)
|
|
112
|
+
if desc_len <= 1024:
|
|
113
|
+
check_pass(f"description length valid ({desc_len} chars)")
|
|
114
|
+
else:
|
|
115
|
+
check_fail(f"description too long: should be <=1024 chars (current {desc_len})")
|
|
116
|
+
else:
|
|
117
|
+
check_fail("description field is missing or empty")
|
|
118
|
+
|
|
119
|
+
# Check license
|
|
120
|
+
if re.search(r'^license:', content, re.MULTILINE):
|
|
121
|
+
check_pass("license field exists")
|
|
122
|
+
else:
|
|
123
|
+
check_warn("license field missing (recommended)")
|
|
124
|
+
warnings += 1
|
|
125
|
+
|
|
126
|
+
# Check metadata
|
|
127
|
+
if re.search(r'^metadata:', content, re.MULTILINE):
|
|
128
|
+
check_pass("metadata field exists")
|
|
129
|
+
else:
|
|
130
|
+
check_warn("metadata field missing (recommended author/version)")
|
|
131
|
+
warnings += 1
|
|
132
|
+
|
|
133
|
+
# --- 3. Body ---
|
|
134
|
+
print()
|
|
135
|
+
print("--- 3. Body content ---")
|
|
136
|
+
|
|
137
|
+
# Count body lines (after frontmatter)
|
|
138
|
+
start = 0
|
|
139
|
+
end_idx = 0
|
|
140
|
+
for i, line in enumerate(lines):
|
|
141
|
+
if line.strip() == '---':
|
|
142
|
+
if start == 0:
|
|
143
|
+
start = i + 1
|
|
144
|
+
else:
|
|
145
|
+
end_idx = i + 1
|
|
146
|
+
break
|
|
147
|
+
if end_idx == 0:
|
|
148
|
+
end_idx = start
|
|
149
|
+
body_lines = lines[end_idx:]
|
|
150
|
+
body_count = len(body_lines)
|
|
151
|
+
|
|
152
|
+
if body_count <= 500:
|
|
153
|
+
check_pass(f"body line count valid ({body_count} lines, <=500)")
|
|
154
|
+
else:
|
|
155
|
+
check_warn(f"body line count high ({body_count} lines, recommended <500, consider splitting to references/)")
|
|
156
|
+
warnings += 1
|
|
157
|
+
|
|
158
|
+
# Check task parameters table
|
|
159
|
+
if re.search(r'(task param|param|\| .*param)', content, re.IGNORECASE) or 'param' in content.lower():
|
|
160
|
+
check_pass("contains task parameters table")
|
|
161
|
+
else:
|
|
162
|
+
check_warn("no task parameters table found (recommended)")
|
|
163
|
+
warnings += 1
|
|
164
|
+
|
|
165
|
+
# Check workflow
|
|
166
|
+
if re.search(r'(workflow|Phase)', content):
|
|
167
|
+
check_pass("contains workflow overview")
|
|
168
|
+
else:
|
|
169
|
+
check_warn("no workflow overview found (recommended)")
|
|
170
|
+
warnings += 1
|
|
171
|
+
|
|
172
|
+
# --- 4. Progressive disclosure ---
|
|
173
|
+
print()
|
|
174
|
+
print("--- 4. Progressive disclosure ---")
|
|
175
|
+
|
|
176
|
+
# Check references directory
|
|
177
|
+
refs_dir = os.path.join(skill_dir, "references")
|
|
178
|
+
if os.path.isdir(refs_dir):
|
|
179
|
+
ref_files = [f for f in os.listdir(refs_dir) if f.endswith('.md') and os.path.isfile(os.path.join(refs_dir, f))]
|
|
180
|
+
check_pass(f"references/ directory exists ({len(ref_files)} docs)")
|
|
181
|
+
|
|
182
|
+
# Check nesting depth (one level)
|
|
183
|
+
nested = False
|
|
184
|
+
for root, dirs, files in os.walk(refs_dir):
|
|
185
|
+
if root != refs_dir and dirs:
|
|
186
|
+
nested = True
|
|
187
|
+
break
|
|
188
|
+
if not nested:
|
|
189
|
+
check_pass("references maintain one-level depth")
|
|
190
|
+
else:
|
|
191
|
+
check_fail("references contains nested subdirectories, should maintain one-level depth")
|
|
192
|
+
else:
|
|
193
|
+
check_warn("no references/ directory (consider splitting detailed content here)")
|
|
194
|
+
warnings += 1
|
|
195
|
+
|
|
196
|
+
# Check assets directory
|
|
197
|
+
assets_dir = os.path.join(skill_dir, "assets")
|
|
198
|
+
if os.path.isdir(assets_dir):
|
|
199
|
+
asset_files = [f for f in os.listdir(assets_dir) if os.path.isfile(os.path.join(assets_dir, f))]
|
|
200
|
+
check_pass(f"assets/ directory exists ({len(asset_files)} files)")
|
|
201
|
+
else:
|
|
202
|
+
check_warn("no assets/ directory (add if templates/resources needed)")
|
|
203
|
+
warnings += 1
|
|
204
|
+
|
|
205
|
+
# Check scripts directory
|
|
206
|
+
scripts_dir = os.path.join(skill_dir, "scripts")
|
|
207
|
+
if os.path.isdir(scripts_dir):
|
|
208
|
+
script_files = [f for f in os.listdir(scripts_dir) if os.path.isfile(os.path.join(scripts_dir, f))]
|
|
209
|
+
check_pass(f"scripts/ directory exists ({len(script_files)} scripts)")
|
|
210
|
+
else:
|
|
211
|
+
check_warn("no scripts/ directory (add if executable scripts needed)")
|
|
212
|
+
warnings += 1
|
|
213
|
+
|
|
214
|
+
# Check relative paths (no absolute path references like ](/...)
|
|
215
|
+
abs_refs = re.findall(r'\]\(/[^)]+\)', content)
|
|
216
|
+
if len(abs_refs) == 0:
|
|
217
|
+
check_pass("file references use relative paths")
|
|
218
|
+
else:
|
|
219
|
+
check_fail(f"found {len(abs_refs)} absolute path references, should use relative paths")
|
|
220
|
+
|
|
221
|
+
# --- 5. Referenced file existence ---
|
|
222
|
+
print()
|
|
223
|
+
print("--- 5. Referenced file existence ---")
|
|
224
|
+
|
|
225
|
+
ref_paths = set(re.findall(r'\]\((references/[^)]+)\)', content))
|
|
226
|
+
asset_paths = set(re.findall(r'\]\((assets/[^)]+)\)', content))
|
|
227
|
+
|
|
228
|
+
for ref in sorted(ref_paths):
|
|
229
|
+
fullpath = os.path.join(skill_dir, ref)
|
|
230
|
+
if os.path.isfile(fullpath):
|
|
231
|
+
check_pass(f"referenced file exists: {ref}")
|
|
232
|
+
else:
|
|
233
|
+
check_fail(f"referenced file does not exist: {ref}")
|
|
234
|
+
|
|
235
|
+
for asset in sorted(asset_paths):
|
|
236
|
+
fullpath = os.path.join(skill_dir, asset)
|
|
237
|
+
if os.path.isfile(fullpath):
|
|
238
|
+
check_pass(f"referenced file exists: {asset}")
|
|
239
|
+
else:
|
|
240
|
+
check_fail(f"referenced file does not exist: {asset}")
|
|
241
|
+
|
|
242
|
+
# --- 6. Summary ---
|
|
243
|
+
print()
|
|
244
|
+
print("=== Validation summary ===")
|
|
245
|
+
print(f" PASS: {passed}")
|
|
246
|
+
print(f" FAIL: {failed}")
|
|
247
|
+
print(f" WARN: {warnings}")
|
|
248
|
+
print()
|
|
249
|
+
|
|
250
|
+
if failed == 0:
|
|
251
|
+
print("ALL CHECKS PASSED")
|
|
252
|
+
sys.exit(0)
|
|
253
|
+
else:
|
|
254
|
+
print(f"VALIDATION FAILED: {failed} issue(s) must be fixed")
|
|
255
|
+
sys.exit(1)
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
if __name__ == '__main__':
|
|
259
|
+
main()
|