@ohos-cpf/3rdloop 0.0.1
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 +425 -0
- package/bin/3rdloop.mjs +48 -0
- package/lib/cli.js +741 -0
- package/lib/config.js +318 -0
- package/lib/doctor.js +114 -0
- package/lib/exit-codes.js +31 -0
- package/lib/opencode.js +156 -0
- package/lib/orch.js +427 -0
- package/lib/queries.js +264 -0
- package/lib/runner.js +979 -0
- package/lib/step.js +326 -0
- package/lib/ui.js +223 -0
- package/lib/workflow.js +291 -0
- package/lib/workflows.js +132 -0
- package/package.json +50 -0
- package/vendor/Server/Agent/SkillSelector/README.md +344 -0
- package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -0
- package/vendor/Server/Agent/SkillSelector/index.js +14 -0
- package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -0
- package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -0
- package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -0
- package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -0
- package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -0
- package/vendor/Server/Agent/SkillSelector/types.js +63 -0
- package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +60 -0
- package/vendor/Server/Brain/AnalysisStrategies.js +422 -0
- package/vendor/Server/Brain/Brain.js +686 -0
- package/vendor/Server/Brain/DecompositionStrategies.js +621 -0
- package/vendor/Server/Brain/PlanPersistence.js +196 -0
- package/vendor/Server/Brain/SkillExecutor.js +251 -0
- package/vendor/Server/Brain/index.js +11 -0
- package/vendor/Server/CLI/cli.js +243 -0
- package/vendor/Server/CLI/opencode/index.js +804 -0
- package/vendor/Server/CLI/opencode.js +5 -0
- package/vendor/Server/DbUse/MessageArchive.js +61 -0
- package/vendor/Server/DbUse/StorageManager.js +107 -0
- package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -0
- package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -0
- package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -0
- package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -0
- package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -0
- package/vendor/Server/DbUse/index.js +160 -0
- package/vendor/Server/DbUse/stores/SessionStore.js +279 -0
- package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -0
- package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -0
- package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -0
- package/vendor/Server/FlexRunner/FlexRunner.js +1759 -0
- package/vendor/Server/FlexRunner/index.js +12 -0
- package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -0
- package/vendor/Server/Knowledge/KnowledgeManager.js +341 -0
- package/vendor/Server/Knowledge/index.js +33 -0
- package/vendor/Server/LoopEngine/LoopEngine.js +1133 -0
- package/vendor/Server/LoopEngine/index.js +11 -0
- package/vendor/Server/Orchestrator/Orchestrator.js +1425 -0
- package/vendor/Server/Orchestrator/StepNode.js +312 -0
- package/vendor/Server/Orchestrator/index.js +13 -0
- package/vendor/Server/Routes/controllers/BrainController.js +241 -0
- package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -0
- package/vendor/Server/Routes/controllers/HealthController.js +44 -0
- package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -0
- package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -0
- package/vendor/Server/Routes/controllers/OrchestratorController.js +911 -0
- package/vendor/Server/Routes/controllers/StatsController.js +57 -0
- package/vendor/Server/Routes/controllers/StreamController.js +67 -0
- package/vendor/Server/Routes/library/logger.js +179 -0
- package/vendor/Server/Routes/library/zipArchive.js +172 -0
- package/vendor/Server/Routes/router/Router.js +204 -0
- package/vendor/Server/Routes/routes/brain.js +47 -0
- package/vendor/Server/Routes/routes/flexrunner.js +72 -0
- package/vendor/Server/Routes/routes/health.js +28 -0
- package/vendor/Server/Routes/routes/index.js +57 -0
- package/vendor/Server/Routes/routes/knowledge.js +55 -0
- package/vendor/Server/Routes/routes/loopengine.js +58 -0
- package/vendor/Server/Routes/routes/orchestrator.js +61 -0
- package/vendor/Server/Routes/routes/registry.js +98 -0
- package/vendor/Server/Routes/routes/stats.js +23 -0
- package/vendor/Server/Routes/routes/stream.js +30 -0
- package/vendor/Server/Routes/server.js +202 -0
- package/vendor/Server/Routes/sse/SseHub.js +308 -0
- package/vendor/Server/Skills/acceptance-check/SKILL.md +174 -0
- package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -0
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -0
- package/vendor/Server/Skills/arkts-code-check/SKILL.md +314 -0
- package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +160 -0
- package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +29 -0
- package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +222 -0
- package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +220 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +329 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +99 -0
- package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -0
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +234 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +103 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +108 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -0
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -0
- package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +392 -0
- package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -0
- package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +313 -0
- package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +166 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +309 -0
- package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -0
- package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +361 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +146 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +253 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +115 -0
- package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +263 -0
- package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -0
- package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +519 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +93 -0
- package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -0
- package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +229 -0
- package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +576 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +575 -0
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +491 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +433 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -0
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +789 -0
- package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -0
- package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +312 -0
- package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -0
- package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +134 -0
- package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/flutter-interface/README.md +75 -0
- package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -0
- package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -0
- package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -0
- package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -0
- package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +518 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +382 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +342 -0
- package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -0
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +519 -0
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +407 -0
- package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +653 -0
- package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +397 -0
- package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +745 -0
- package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +721 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -0
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -0
- package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -0
- package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -0
- package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -0
- package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +301 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +105 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +127 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +208 -0
- package/vendor/Server/Skills/rn-code-check/SKILL.md +321 -0
- package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +235 -0
- package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +189 -0
- package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +247 -0
- package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -0
- package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -0
- package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -0
- package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -0
- package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -0
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -0
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -0
- package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -0
- package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +684 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -0
- package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -0
- package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -0
- package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -0
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -0
- package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +58 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +75 -0
- package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +339 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +83 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +859 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +122 -0
- package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +279 -0
- package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -0
- package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -0
- package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -0
- package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -0
- package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +506 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +280 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +209 -0
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -0
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -0
- package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -0
- package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -0
- package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +498 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -0
- package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -0
- package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -0
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -0
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -0
- package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -0
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -0
- package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +255 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +77 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +174 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -0
- package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +137 -0
- package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -0
- package/vendor/Server/Skills/skill-generator/SKILL.md +365 -0
- package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -0
- package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -0
- package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -0
- package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -0
- package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -0
- package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -0
- package/vendor/Server/Skills/task-analysis/SKILL.md +234 -0
- package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -0
- package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -0
- package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -0
- package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -0
- package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -0
- package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -0
- package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -0
- package/vendor/Server/Skills/task-decomposition/SKILL.md +529 -0
- package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -0
- package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -0
- package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -0
- package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -0
- package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -0
- package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -0
- package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -0
- package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -0
- package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +425 -0
- package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -0
- package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -0
- package/vendor/Server/TestCheck/TestCheck.js +775 -0
- package/vendor/Server/TestCheck/index.js +11 -0
- package/vendor/Server/library/McpToolGuide.js +280 -0
- package/vendor/Server/library/StatsService.js +127 -0
- package/vendor/Server/library/cstTime.js +16 -0
- package/vendor/Server/package.json +17 -0
- package/vendor/VERSION +3 -0
- package/workflows/pr-check.mjs +106 -0
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# Flutter 代码检视清单
|
|
2
|
+
|
|
3
|
+
本文档包含 Flutter 三方库 PR 代码检视的完整检查项。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. 非兼容变更(Breaking Changes)
|
|
8
|
+
|
|
9
|
+
- [ ] 是否删除或重命名了公开 Plugin API / MethodChannel 方法名
|
|
10
|
+
- [ ] 是否修改了 Dart 侧 `MethodChannel.invokeMethod` 的方法名或参数结构
|
|
11
|
+
- [ ] 是否修改了 `result.success()` 的返回数据格式(影响 Dart 侧解析)
|
|
12
|
+
- [ ] 是否修改了 `oh-package.json5` 中影响依赖解析的字段
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 2. Flutter Plugin 协议合规性(ohos/ ArkTS 实现)
|
|
17
|
+
|
|
18
|
+
- [ ] Plugin 入口类是否继承并正确实现了 `FlutterPlugin` 接口
|
|
19
|
+
- [ ] `onAttachedToEngine(binding: FlutterPluginBinding)` 中完成了 Channel 注册和资源初始化
|
|
20
|
+
- [ ] `onDetachedFromEngine(binding: FlutterPluginBinding)` 中释放了所有 Channel 和监听器
|
|
21
|
+
- [ ] `MethodCallHandler.onMethodCall` 覆盖了所有 Dart 侧声明的方法
|
|
22
|
+
- [ ] `onMethodCall` 含 `else` 分支调用 `result.notImplemented()`
|
|
23
|
+
- [ ] `result.success()` / `result.error()` / `result.notImplemented()` 调用后有 `return`,防止重复回调
|
|
24
|
+
- [ ] EventChannel(如有)的 `StreamHandler.onListen` / `onCancel` 对称实现
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 3. ArkTS 语言约束
|
|
29
|
+
|
|
30
|
+
- [ ] 无 `any` 类型使用(禁止 `as any`、隐式 any)
|
|
31
|
+
- [ ] 无 `eval()`、`Function()` 动态代码执行
|
|
32
|
+
- [ ] 无 `prototype` 动态修改
|
|
33
|
+
- [ ] 装饰器使用正确(`@Component`、`@State`、`@Observed` 等)
|
|
34
|
+
- [ ] 是否使用已废弃的 OHOS API(`@deprecated` 标注的接口)
|
|
35
|
+
- [ ] 泛型类型参数明确,避免推导歧义
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 4. OpenHarmony API 兼容性
|
|
40
|
+
|
|
41
|
+
- [ ] 新增 API 使用是否超出工程 `minAPIVersion`
|
|
42
|
+
- [ ] 是否使用了 OHOS 专有 API 但未做平台判断
|
|
43
|
+
- [ ] 权限申请是否正确(`requestPermissionsFromUser`)
|
|
44
|
+
- [ ] `OH_*` C API 的返回值是否有检查(Native 模块场景)
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 5. 异步处理
|
|
49
|
+
|
|
50
|
+
- [ ] 所有异步 OHOS API 调用均有 `await` 或 `.then()` 处理
|
|
51
|
+
- [ ] `try/catch` 覆盖所有 `await` 调用,catch 块有实质性错误处理
|
|
52
|
+
- [ ] 未处理的 Promise rejection(`.catch()` 或 `try/catch` 必须存在)
|
|
53
|
+
- [ ] 大量数据处理是否使用 Worker/TaskPool 而非主线程执行
|
|
54
|
+
- [ ] 并行异步操作使用 `Promise.all`,避免不必要的顺序 await
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 6. 事件监听器管理(on/off 对称性)
|
|
59
|
+
|
|
60
|
+
- [ ] 每个 `on('eventName', handler)` 有对应 `off('eventName', handler)`
|
|
61
|
+
- [ ] 监听器在 `onDetachedFromEngine` 或设备销毁时被移除
|
|
62
|
+
- [ ] 重连场景中同一事件多次调用 `on` 不会造成监听器堆积
|
|
63
|
+
- [ ] EventChannel 的 `onCancel` 中清理了所有底层事件订阅
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 7. C++ Native 实现
|
|
68
|
+
|
|
69
|
+
- [ ] NAPI 导出函数命名与 ArkTS 侧调用一致
|
|
70
|
+
- [ ] `napi_create_*` 创建的对象在不需要时正确释放
|
|
71
|
+
- [ ] `napi_ref` 在不需要时调用 `napi_delete_reference`
|
|
72
|
+
- [ ] 跨线程回调使用 `napi_threadsafe_function` 或 `uv_async_send`
|
|
73
|
+
- [ ] 共享数据结构有互斥锁保护
|
|
74
|
+
- [ ] C++ 异常捕获并转为 NAPI 错误
|
|
75
|
+
- [ ] `malloc`/`new` 有对应 `free`/`delete`
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 8. 错误处理
|
|
80
|
+
|
|
81
|
+
- [ ] `result.error()` 调用后有 `return`,避免后续代码继续执行
|
|
82
|
+
- [ ] 错误信息包含错误码(`e.code`)和错误描述(`e.message`)
|
|
83
|
+
- [ ] switch-case 中每个 case 末尾有 `break`(避免 fall-through)
|
|
84
|
+
- [ ] 提前 `return` 不会跳过必要的资源清理
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 9. 内存与资源管理
|
|
89
|
+
|
|
90
|
+
- [ ] `onDetachedFromEngine` 中清理了 MethodChannel、EventChannel 的 handler
|
|
91
|
+
- [ ] 定时器(`setInterval`/`setTimeout`)有对应 `clearInterval`/`clearTimeout`
|
|
92
|
+
- [ ] `ArrayBuffer` / `Uint8Array` 大数据用完后无强引用持有
|
|
93
|
+
- [ ] Map / Set 数据结构在不再需要时及时 `delete` / `clear`
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 10. 跨平台一致性对比(ohos vs android/iOS)
|
|
98
|
+
|
|
99
|
+
> PR 中仅包含鸿蒙代码提交,需从克隆的仓库中读取 `android/` 和 `ios/` 的已有实现进行对比。
|
|
100
|
+
|
|
101
|
+
- [ ] ohos `onMethodCall` 的 case 分支与 android `onMethodCall` 完全对应,无缺失方法
|
|
102
|
+
- [ ] 同一 MethodChannel 方法名在 ohos 注册与 android 注册一致(Dart 侧共用同一 Channel)
|
|
103
|
+
- [ ] 同一方法中,ohos 解析 `call.argument` 的类型与 android 一致(如 `bool` vs `string` 的致命错误)
|
|
104
|
+
- [ ] `result.success()` 返回值的数据结构与 android 对齐(字段名、类型、嵌套层级)
|
|
105
|
+
- [ ] `result.error()` 的 code 和 message 与 android 对齐,确保 Dart 侧异常处理逻辑一致
|
|
106
|
+
- [ ] android 有实现但 ohos 为 Stub(返回固定值无实际操作)的方法已标记并记录
|
|
107
|
+
- [ ] EventChannel(如有)的事件名和事件数据格式与 android 一致
|
|
108
|
+
- [ ] 新增的 ohos 方法在 android 中是否也存在对应实现,避免鸿蒙侧单方面新增
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 11. Dart 接口层(lib/ 目录)
|
|
113
|
+
|
|
114
|
+
> **核心原则**:鸿蒙适配 PR 中 Dart 代码不应修改。以下检查项用于验证现有 Dart 代码的正确性,若发现 PR 修改了 Dart 代码,必须转入第 15 节进行必要性审查。
|
|
115
|
+
|
|
116
|
+
- [ ] Platform Interface 方法签名与鸿蒙侧 `onMethodCall` 实现一致
|
|
117
|
+
- [ ] 是否有鸿蒙平台判断:`Platform.isOHOS` 或 `defaultTargetPlatform == TargetPlatform.ohos`
|
|
118
|
+
- [ ] 公共 API 有完整的文档注释(Dart doc)
|
|
119
|
+
- [ ] 异步方法返回 `Future<T>`,同步方法有明确说明
|
|
120
|
+
- [ ] Dart 侧 `MethodChannel` 注册名与 ohos 侧注册名一致
|
|
121
|
+
- [ ] Dart 侧 `invokeMethod` 调用的方法名在 ohos `onMethodCall` 中均有对应 case 分支
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 12. 安全性
|
|
126
|
+
|
|
127
|
+
- [ ] 无硬编码的密钥、Token、密码等敏感信息
|
|
128
|
+
- [ ] 网络请求是否校验 HTTPS 证书(禁止忽略证书错误)
|
|
129
|
+
- [ ] 用户输入是否有校验和过滤(防注入)
|
|
130
|
+
- [ ] 文件路径是否有安全校验(防路径穿越)
|
|
131
|
+
- [ ] 敏感数据不在日志中输出
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 13. 构建配置
|
|
136
|
+
|
|
137
|
+
- [ ] `oh-package.json5` 新增依赖合理,来源可信,无 `*` 通配版本
|
|
138
|
+
- [ ] `CMakeLists.txt` 链接的系统库均为必要依赖
|
|
139
|
+
- [ ] `minAPIVersion` / `targetAPIVersion` 变更合理
|
|
140
|
+
- [ ] 不存在不必要的依赖或版本锁定过死
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## 14. 代码规范
|
|
145
|
+
|
|
146
|
+
- [ ] 命名遵循驼峰规则(变量/方法小驼峰,类/接口大驼峰)
|
|
147
|
+
- [ ] 无冗余的 `console.log` 调试代码遗留
|
|
148
|
+
- [ ] 公共 API 有完整 JSDoc / Dart doc 注释
|
|
149
|
+
- [ ] 文件头版权声明完整
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 15. Dart 改动必要性审查(lib/ 目录变更)
|
|
154
|
+
|
|
155
|
+
> **前提**:鸿蒙适配 PR 的本质是为已有库增加 ohos 平台实现,Dart 代码理论上不应修改。若 PR 包含 `lib/` 目录的变更,必须逐项进行必要性审查。
|
|
156
|
+
|
|
157
|
+
### 15.1 变更识别
|
|
158
|
+
|
|
159
|
+
- [ ] 已完整列出 PR 中所有 `lib/**/*.dart` 文件的变更点
|
|
160
|
+
- [ ] 已区分每处变更是「新增代码」还是「修改/删除已有代码」
|
|
161
|
+
- [ ] 已记录每处变更涉及的文件、行号、变更类型
|
|
162
|
+
|
|
163
|
+
### 15.2 必要性判定
|
|
164
|
+
|
|
165
|
+
- [ ] 每处 Dart 变更是否为鸿蒙适配的**唯一实现方式**(无法在 ohos 侧单独完成)
|
|
166
|
+
- [ ] 新增 `Platform.isOHOS` / `TargetPlatform.ohos` 条件分支 — ✅ 通常必要
|
|
167
|
+
- [ ] 新增 ohos 平台注册逻辑 — ✅ 通常必要
|
|
168
|
+
- [ ] 修改 `MethodChannel` 名称 — ❌ 应在 ohos 侧注册相同 Channel 名
|
|
169
|
+
- [ ] 修改 `invokeMethod` 的参数结构 — ❌ 应在 ohos 侧适配参数解析
|
|
170
|
+
- [ ] 修改 `result` 返回值的解析/类型 — ❌ 应在 ohos 侧返回与 android 相同格式
|
|
171
|
+
- [ ] 修改 Platform Interface 方法签名 — ❌ 应通过 ohos Plugin 实现适配
|
|
172
|
+
- [ ] 删除或注释已有功能代码 — ❌ 鸿蒙适配不应删除已有功能
|
|
173
|
+
- [ ] 新增 `import 'dart:io'`(原无此依赖) — ⚠️ 需评估是否影响 Web 平台编译
|
|
174
|
+
- [ ] 新增公共 API 方法 — ⚠️ 需评估是否为通用需求还是仅 ohos 使用
|
|
175
|
+
- [ ] 修改 `pubspec.yaml` 依赖 — ⚠️ 需评估新增依赖的必要性
|
|
176
|
+
|
|
177
|
+
### 15.3 跨平台影响评估
|
|
178
|
+
|
|
179
|
+
- [ ] Dart 变更是否在 `Platform.isOHOS` 条件分支内,确保不影响 android/iOS 运行时行为
|
|
180
|
+
- [ ] 修改后的 `MethodChannel.invokeMethod` 参数是否仍与 android 侧实现兼容
|
|
181
|
+
- [ ] 修改后的返回值解析逻辑是否仍与 android 侧 `result.success()` 返回格式兼容
|
|
182
|
+
- [ ] Platform Interface 的默认实现行为是否被改变(影响未注册平台的行为)
|
|
183
|
+
- [ ] 公共 API 签名若变更,`pubspec.yaml` 版本号是否对应升 major(语义化版本)
|
|
184
|
+
- [ ] 新增的 `import` 或依赖是否引入了 android/iOS/Web 平台的编译或运行时问题
|
|
185
|
+
|
|
186
|
+
### 15.4 替代方案建议
|
|
187
|
+
|
|
188
|
+
- [ ] 对于「不应修改」的变更,已给出 ohos 侧的替代实现方案
|
|
189
|
+
- [ ] 对于「需评估」的变更,已分析替代方案并给出推荐
|
|
190
|
+
- [ ] 替代方案不引入新的跨平台兼容性问题
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# 平台 API 参考
|
|
2
|
+
|
|
3
|
+
本文档详细说明各代码托管平台的 API 调用方式和 patch 下载方法。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## GitCode 平台
|
|
8
|
+
|
|
9
|
+
### 1. PR 元数据 API
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
curl -s "https://api.gitcode.com/api/v5/repos/{owner}/{repo}/pulls/{prNumber}?access_token={accessToken}"
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
响应字段提取:
|
|
16
|
+
|
|
17
|
+
| 字段 | JSON 路径 | 说明 |
|
|
18
|
+
|------|-----------|------|
|
|
19
|
+
| PR 标题 | `title` | |
|
|
20
|
+
| 目标分支 | `base.ref` | 即 `targetBranch` |
|
|
21
|
+
| Head SHA | `head.sha` | PR 最新提交 hash |
|
|
22
|
+
| 作者 | `user.name` / `user.email` | |
|
|
23
|
+
| 创建时间 | `created_at` | |
|
|
24
|
+
| PR 状态 | `state` | open/merged/closed |
|
|
25
|
+
|
|
26
|
+
### 2. Commit Patch API(推荐)
|
|
27
|
+
|
|
28
|
+
> **核心接口**:直接获取 PR head commit 的 patch 文件。
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
curl -s "https://api.gitcode.com/api/v5/repos/{owner}/{repo}/commit/{head.sha}/patch?access_token={accessToken}" -o {outputDir}/pr.patch
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
**关键注意**:
|
|
35
|
+
- 路径使用 `commit`(单数),不是 `commits`(复数)
|
|
36
|
+
- `{head.sha}` 从 PR 元数据 API 获取
|
|
37
|
+
|
|
38
|
+
**Patch 文件格式**:
|
|
39
|
+
```
|
|
40
|
+
From <commit-hash> Mon Sep 17 00:00:00 2001
|
|
41
|
+
From: <author> <email>
|
|
42
|
+
Date: <date>
|
|
43
|
+
Subject: [PATCH] <commit message>
|
|
44
|
+
|
|
45
|
+
<file change statistics>
|
|
46
|
+
|
|
47
|
+
diff --git a/<file> b/<file>
|
|
48
|
+
...
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**从 Patch 提取信息**:
|
|
52
|
+
- Commit 作者、日期、message(头部元数据)
|
|
53
|
+
- 修改文件列表(扫描 `diff --git a/<file> b/<file>` 行)
|
|
54
|
+
- 文件变更统计(`<file> | <added> +, <removed> -` 行)
|
|
55
|
+
- 具体代码变更(diff hunks)
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## GitHub 平台
|
|
60
|
+
|
|
61
|
+
### 1. PR 元数据 API
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
curl -s "https://api.github.com/repos/{owner}/{repo}/pulls/{prNumber}"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 2. Patch URL
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
curl -L -o pr.patch "https://github.com/{owner}/{repo}/pull/{prNumber}.patch"
|
|
71
|
+
curl -L -o pr.diff "https://github.com/{owner}/{repo}/pull/{prNumber}.diff"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Gitee 平台
|
|
77
|
+
|
|
78
|
+
### 1. PR 元数据 API
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
curl -s "https://gitee.com/api/v5/repos/{owner}/{repo}/pulls/{prNumber}?access_token={accessToken}"
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 2. Patch URL
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
curl -L -o pr.patch "https://gitee.com/{owner}/{repo}/pulls/{prNumber}.patch"
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## GitLab 平台
|
|
93
|
+
|
|
94
|
+
### 1. Patch URL
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
curl -L -o pr.patch "https://gitlab.com/{owner}/{repo}/-/merge_requests/{prNumber}.patch"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 仓库克隆策略
|
|
103
|
+
|
|
104
|
+
### GitCode
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# 克隆目标分支
|
|
108
|
+
git clone --depth=50 --branch {targetBranch} https://gitcode.com/{owner}/{repo}.git {outputDir}/source/
|
|
109
|
+
|
|
110
|
+
# 拉取 PR HEAD
|
|
111
|
+
git ls-remote origin # 查找 refs/merge-requests/{prNumber}/head
|
|
112
|
+
git fetch origin refs/merge-requests/{prNumber}/head:pr{prNumber}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 其他平台
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
git clone --depth=50 --branch {targetBranch} https://{platform}/{owner}/{repo}.git {outputDir}/source/
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
若指定分支克隆失败,去掉 `--branch` 参数克隆默认分支。
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 文件类型识别
|
|
126
|
+
|
|
127
|
+
| 路径/扩展名 | 类型 | 检视优先级 |
|
|
128
|
+
|-------------|------|------------|
|
|
129
|
+
| `ohos/src/main/ets/**/*.ets` | ArkTS Plugin 实现 | **最高** |
|
|
130
|
+
| `ohos/src/main/cpp/**` | C++ Native | **高** |
|
|
131
|
+
| `ohos/CMakeLists.txt` / `*.cmake` | 构建系统 | 中 |
|
|
132
|
+
| `ohos/oh-package.json5` | 包依赖 | 中 |
|
|
133
|
+
| `lib/**/*.dart` | Dart 接口层 | 中 |
|
|
134
|
+
| `example/**` | 示例工程 | 低 |
|
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* @tool validate-skill
|
|
4
|
+
* @description 校验 SKILL 目录是否符合 Agent Skills 规范,检查 frontmatter、结构、渐进式披露。跨平台(Windows/macOS/Linux),仅需 Node.js。
|
|
5
|
+
* @param skillDir: string - SKILL 目录绝对路径
|
|
6
|
+
* @hidden
|
|
7
|
+
* validate-skill.cjs
|
|
8
|
+
*
|
|
9
|
+
* 用法:
|
|
10
|
+
* # CLI 模式
|
|
11
|
+
* node validate-skill.cjs /path/to/skill
|
|
12
|
+
*
|
|
13
|
+
* # MCP Gateway 模式(第一个参数为 JSON 字符串)
|
|
14
|
+
* node validate-skill.cjs '{"skillDir":"/path/to/skill"}'
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
'use strict';
|
|
18
|
+
|
|
19
|
+
const fs = require('node:fs');
|
|
20
|
+
const path = require('node:path');
|
|
21
|
+
|
|
22
|
+
// ── 参数解析(兼容 MCP Gateway JSON 模式与 CLI 模式) ──────
|
|
23
|
+
|
|
24
|
+
function parseArgs(argv) {
|
|
25
|
+
if (argv.length === 0) return {};
|
|
26
|
+
const first = argv[0];
|
|
27
|
+
if (typeof first === 'string' && first.startsWith('{')) {
|
|
28
|
+
try { return JSON.parse(first); } catch (e) { return {}; }
|
|
29
|
+
}
|
|
30
|
+
return { skillDir: first };
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
// ── 输出统计 ─────────────────────────────────────────────
|
|
34
|
+
|
|
35
|
+
let PASS = 0;
|
|
36
|
+
let FAIL = 0;
|
|
37
|
+
let WARNINGS = 0;
|
|
38
|
+
|
|
39
|
+
function checkPass(msg) { console.log(` ✅ ${msg}`); PASS += 1; }
|
|
40
|
+
function checkFail(msg) { console.log(` ❌ ${msg}`); FAIL += 1; }
|
|
41
|
+
function checkWarn(msg) { console.log(` ⚠️ ${msg}`); WARNINGS += 1; }
|
|
42
|
+
|
|
43
|
+
// ── Frontmatter 解析 ─────────────────────────────────────
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* 解析 SKILL.md 的 frontmatter 与 body。
|
|
47
|
+
* 返回 { frontmatter: object|null, bodyLines: string[] }
|
|
48
|
+
*/
|
|
49
|
+
function parseFrontmatter(content) {
|
|
50
|
+
const lines = content.split(/\r?\n/);
|
|
51
|
+
if (!lines[0] || lines[0].trim() !== '---') {
|
|
52
|
+
return { frontmatter: null, bodyLines: lines };
|
|
53
|
+
}
|
|
54
|
+
let end = -1;
|
|
55
|
+
for (let i = 1; i < lines.length; i++) {
|
|
56
|
+
if (lines[i].trim() === '---') { end = i; break; }
|
|
57
|
+
}
|
|
58
|
+
if (end === -1) {
|
|
59
|
+
return { frontmatter: null, bodyLines: lines };
|
|
60
|
+
}
|
|
61
|
+
const fmLines = lines.slice(1, end);
|
|
62
|
+
const fm = {};
|
|
63
|
+
let currentKey = null;
|
|
64
|
+
for (const line of fmLines) {
|
|
65
|
+
const m = line.match(/^([a-zA-Z_][\w-]*):\s*(.*)$/);
|
|
66
|
+
if (m) {
|
|
67
|
+
currentKey = m[1];
|
|
68
|
+
fm[currentKey] = m[2].trim();
|
|
69
|
+
} else if (currentKey && /^\s+\S/.test(line)) {
|
|
70
|
+
fm[currentKey] += '\n' + line.trim();
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
return { frontmatter: fm, bodyLines: lines.slice(end + 1) };
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// ── 主流程 ───────────────────────────────────────────────
|
|
77
|
+
|
|
78
|
+
function main() {
|
|
79
|
+
const args = parseArgs(process.argv.slice(2));
|
|
80
|
+
const skillDir = args.skillDir || '';
|
|
81
|
+
|
|
82
|
+
if (!skillDir) {
|
|
83
|
+
console.log('Usage: node validate-skill.cjs <skillDir>');
|
|
84
|
+
console.log('Error: skillDir parameter is required');
|
|
85
|
+
process.exit(1);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
if (!fs.existsSync(skillDir) || !fs.statSync(skillDir).isDirectory()) {
|
|
89
|
+
console.log(`Error: Directory does not exist: ${skillDir}`);
|
|
90
|
+
process.exit(1);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
console.log('=== SKILL 规范校验 ===');
|
|
94
|
+
console.log(`目录: ${skillDir}`);
|
|
95
|
+
console.log('');
|
|
96
|
+
|
|
97
|
+
// ─── 1. SKILL.md 存在性 ───
|
|
98
|
+
console.log('--- 1. 文件结构检查 ---');
|
|
99
|
+
const skillFile = path.join(skillDir, 'SKILL.md');
|
|
100
|
+
if (fs.existsSync(skillFile) && fs.statSync(skillFile).isFile()) {
|
|
101
|
+
checkPass('SKILL.md 存在');
|
|
102
|
+
} else {
|
|
103
|
+
checkFail('SKILL.md 不存在');
|
|
104
|
+
console.log('无法继续校验,SKILL.md 是必需文件');
|
|
105
|
+
process.exit(1);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const content = fs.readFileSync(skillFile, 'utf-8');
|
|
109
|
+
const { frontmatter, bodyLines } = parseFrontmatter(content);
|
|
110
|
+
|
|
111
|
+
// ─── 2. Frontmatter 检查 ───
|
|
112
|
+
console.log('');
|
|
113
|
+
console.log('--- 2. Frontmatter 检查 ---');
|
|
114
|
+
|
|
115
|
+
if (frontmatter) {
|
|
116
|
+
checkPass('YAML frontmatter 存在');
|
|
117
|
+
} else {
|
|
118
|
+
checkFail('缺少 YAML frontmatter(文件应以 --- 开头并以 --- 结束头部)');
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
const nameField = frontmatter ? String(frontmatter.name || '') : '';
|
|
122
|
+
if (nameField) {
|
|
123
|
+
checkPass(`name 字段存在: ${nameField}`);
|
|
124
|
+
|
|
125
|
+
// name 字符集校验
|
|
126
|
+
if (/^[a-z0-9]+(-[a-z0-9]+)*$/.test(nameField)) {
|
|
127
|
+
checkPass('name 字符集合规(仅小写字母/数字/连字符)');
|
|
128
|
+
} else {
|
|
129
|
+
checkFail('name 字符集不合规:应仅含 a-z/0-9/-,不能首尾连字符或连续连字符');
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
// name 长度校验
|
|
133
|
+
const nameLen = nameField.length;
|
|
134
|
+
if (nameLen >= 1 && nameLen <= 64) {
|
|
135
|
+
checkPass(`name 长度合规 (${nameLen} 字符)`);
|
|
136
|
+
} else {
|
|
137
|
+
checkFail(`name 长度不合规:应在 1-64 字符之间(当前 ${nameLen})`);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
// name 匹配目录名
|
|
141
|
+
const dirName = path.basename(path.resolve(skillDir));
|
|
142
|
+
if (nameField === dirName) {
|
|
143
|
+
checkPass(`name 匹配父目录名 (${dirName})`);
|
|
144
|
+
} else {
|
|
145
|
+
checkFail(`name 不匹配父目录名:name='${nameField}' vs 目录='${dirName}'`);
|
|
146
|
+
}
|
|
147
|
+
} else {
|
|
148
|
+
checkFail('name 字段缺失');
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
const descField = frontmatter ? String(frontmatter.description || '') : '';
|
|
152
|
+
if (descField) {
|
|
153
|
+
const descLen = descField.length;
|
|
154
|
+
if (descLen <= 1024) {
|
|
155
|
+
checkPass(`description 长度合规 (${descLen} 字符)`);
|
|
156
|
+
} else {
|
|
157
|
+
checkFail(`description 过长:应 ≤1024 字符(当前 ${descLen})`);
|
|
158
|
+
}
|
|
159
|
+
} else {
|
|
160
|
+
checkFail('description 字段缺失或为空');
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
if (frontmatter && frontmatter.license) {
|
|
164
|
+
checkPass('license 字段存在');
|
|
165
|
+
} else {
|
|
166
|
+
checkWarn('license 字段缺失(推荐添加)');
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (frontmatter && frontmatter.metadata) {
|
|
170
|
+
checkPass('metadata 字段存在');
|
|
171
|
+
} else {
|
|
172
|
+
checkWarn('metadata 字段缺失(推荐添加 author/version)');
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
// ─── 3. Body 检查 ───
|
|
176
|
+
console.log('');
|
|
177
|
+
console.log('--- 3. Body 内容检查 ---');
|
|
178
|
+
|
|
179
|
+
const bodyLineCount = bodyLines.length;
|
|
180
|
+
if (bodyLineCount <= 500) {
|
|
181
|
+
checkPass(`body 行数合规 (${bodyLineCount} 行, ≤500)`);
|
|
182
|
+
} else {
|
|
183
|
+
checkWarn(`body 行数较多 (${bodyLineCount} 行,推荐 < 500,考虑拆分到 references/)`);
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
if (/任务参数|## .*参数|\|\s*参数/.test(content)) {
|
|
187
|
+
checkPass('包含任务参数说明');
|
|
188
|
+
} else {
|
|
189
|
+
checkWarn('未找到任务参数表(推荐添加)');
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
if (/工作流程|Phase|## Phase/.test(content)) {
|
|
193
|
+
checkPass('包含工作流程概览');
|
|
194
|
+
} else {
|
|
195
|
+
checkWarn('未找到工作流程概览(推荐添加)');
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
// ─── 4. 渐进式披露检查 ───
|
|
199
|
+
console.log('');
|
|
200
|
+
console.log('--- 4. 渐进式披露检查 ---');
|
|
201
|
+
|
|
202
|
+
const refsDir = path.join(skillDir, 'references');
|
|
203
|
+
if (fs.existsSync(refsDir) && fs.statSync(refsDir).isDirectory()) {
|
|
204
|
+
const refFiles = fs.readdirSync(refsDir)
|
|
205
|
+
.filter((f) => f.endsWith('.md') && fs.statSync(path.join(refsDir, f)).isFile());
|
|
206
|
+
checkPass(`references/ 目录存在 (${refFiles.length} 个文档)`);
|
|
207
|
+
|
|
208
|
+
// 检查引用深度(一层)
|
|
209
|
+
const nestedDirs = fs.readdirSync(refsDir, { withFileTypes: true })
|
|
210
|
+
.filter((d) => d.isDirectory()).length;
|
|
211
|
+
if (nestedDirs === 0) {
|
|
212
|
+
checkPass('references 保持一层深度');
|
|
213
|
+
} else {
|
|
214
|
+
checkFail(`references 存在嵌套子目录 (${nestedDirs} 个),应保持一层深度`);
|
|
215
|
+
}
|
|
216
|
+
} else {
|
|
217
|
+
checkWarn('无 references/ 目录(详细内容建议拆分到此目录)');
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
const assetsDir = path.join(skillDir, 'assets');
|
|
221
|
+
if (fs.existsSync(assetsDir) && fs.statSync(assetsDir).isDirectory()) {
|
|
222
|
+
checkPass('assets/ 目录存在');
|
|
223
|
+
} else {
|
|
224
|
+
checkWarn('无 assets/ 目录(如需模板/资源可添加)');
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
const scriptsDir = path.join(skillDir, 'scripts');
|
|
228
|
+
if (fs.existsSync(scriptsDir) && fs.statSync(scriptsDir).isDirectory()) {
|
|
229
|
+
checkPass('scripts/ 目录存在');
|
|
230
|
+
} else {
|
|
231
|
+
checkWarn('无 scripts/ 目录(如需可执行脚本可添加)');
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
// 检查文件引用使用相对路径
|
|
235
|
+
const absRefs = (content.match(/\]\(\/[^)]+\)/g) || []).length;
|
|
236
|
+
if (absRefs === 0) {
|
|
237
|
+
checkPass('文件引用使用相对路径');
|
|
238
|
+
} else {
|
|
239
|
+
checkFail(`发现 ${absRefs} 个绝对路径引用,应使用相对路径`);
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
// ─── 5. 总结 ───
|
|
243
|
+
console.log('');
|
|
244
|
+
console.log('=== 校验总结 ===');
|
|
245
|
+
console.log(` ✅ 通过: ${PASS}`);
|
|
246
|
+
console.log(` ❌ 失败: ${FAIL}`);
|
|
247
|
+
console.log(` ⚠️ 警告: ${WARNINGS}`);
|
|
248
|
+
console.log('');
|
|
249
|
+
|
|
250
|
+
if (FAIL === 0) {
|
|
251
|
+
console.log('ALL CHECKS PASSED');
|
|
252
|
+
process.exit(0);
|
|
253
|
+
} else {
|
|
254
|
+
console.log(`VALIDATION FAILED: ${FAIL} 个必须修复的问题`);
|
|
255
|
+
process.exit(1);
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
main();
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Flutter Interface Analyzer
|
|
2
|
+
|
|
3
|
+
一个符合 [Agent Skills](https://agentskills.io) 规范的 skill,用于分析 Flutter 三方库的对外接口能力并生成标准化文档。
|
|
4
|
+
|
|
5
|
+
## 功能特性
|
|
6
|
+
|
|
7
|
+
- 基于脚本自动提取 Dart 源码接口(`flutter-extract-interfaces.cjs`)
|
|
8
|
+
- 自动渲染接口规格说明书 Markdown 文档(`flutter-render-spec-doc.cjs`)
|
|
9
|
+
- 支持 Git 仓库克隆(含 Sparse Checkout 稀疏检出)
|
|
10
|
+
- 支持 monorepo 多子包结构和 export 链追踪
|
|
11
|
+
- 自动过滤私有成员(`_` 前缀)和 export hide/show
|
|
12
|
+
- 提取 `///` 文档注释作为功能描述
|
|
13
|
+
- 输出 JSON 中间件,可供下游覆盖率分析复用
|
|
14
|
+
|
|
15
|
+
## 目录结构
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
flutter-interface/
|
|
19
|
+
├── SKILL.md # Skill 主文件(工作流指令)
|
|
20
|
+
├── README.md # 本文件
|
|
21
|
+
└── references/
|
|
22
|
+
├── GIT_CLONE_GUIDE.md # Git Clone 操作指南
|
|
23
|
+
├── SCRIPT_REFERENCE.md # 脚本参数与故障排查
|
|
24
|
+
├── EXAMPLES.md # 分析示例
|
|
25
|
+
└── TEMPLATE.md # 文档输出模板
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
> 脚本不保存在本 SKILL 内,统一位于仓库的 `MCP/scripts/` 目录(`flutter-extract-interfaces.cjs`、`flutter-render-spec-doc.cjs`),通过相对路径 `{{skillDir}}/../../../MCP/scripts/` 引用。
|
|
29
|
+
|
|
30
|
+
## 快速开始
|
|
31
|
+
|
|
32
|
+
### 脚本驱动分析(推荐)
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# 1. 提取接口到 JSON
|
|
36
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-extract-interfaces.cjs" --repoDir /path/to/flutter_lib --output spec.json
|
|
37
|
+
|
|
38
|
+
# 2. 渲染为 Markdown 文档
|
|
39
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --spec spec.json --output 接口规格说明.md
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 一步到位
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# 直接从源码生成文档(不保留 JSON 中间件)
|
|
46
|
+
node "{{skillDir}}/../../../MCP/scripts/flutter-render-spec-doc.cjs" --libroot /path/to/flutter_lib --output 接口规格说明.md
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 从 Git 仓库分析
|
|
50
|
+
|
|
51
|
+
按照 [SKILL.md](SKILL.md) 中的 Phase 1 执行 Git Clone,然后运行脚本提取接口。
|
|
52
|
+
|
|
53
|
+
详细的 Git Clone 操作参见 [GIT_CLONE_GUIDE.md](references/GIT_CLONE_GUIDE.md)。
|
|
54
|
+
|
|
55
|
+
## 核心脚本
|
|
56
|
+
|
|
57
|
+
| 脚本 | 用途 | 输入 | 输出 |
|
|
58
|
+
|------|------|------|------|
|
|
59
|
+
| `flutter-extract-interfaces.cjs` | 从 Dart 源码提取接口 | 库源码目录 | interface-spec.json |
|
|
60
|
+
| `flutter-render-spec-doc.cjs` | 渲染接口文档 | JSON 或源码目录 | Markdown 文档 |
|
|
61
|
+
|
|
62
|
+
> 脚本位于仓库的 `MCP/scripts/` 目录(本 SKILL 不保存副本),通过相对路径 `{{skillDir}}/../../../MCP/scripts/` 引用。
|
|
63
|
+
|
|
64
|
+
脚本详细参数和故障排查参见 [SCRIPT_REFERENCE.md](references/SCRIPT_REFERENCE.md)。
|
|
65
|
+
|
|
66
|
+
## 分析原则
|
|
67
|
+
|
|
68
|
+
- **脚本优先**:接口提取由脚本自动完成,AI 不手动逐文件读取源码
|
|
69
|
+
- **只分析公开接口**:脚本自动过滤 `_` 前缀私有成员和 export hide/show
|
|
70
|
+
- **忠实于源码**:所有接口信息来自脚本解析实际源码,不允许推断或捏造
|
|
71
|
+
- **JSON 中间件复用**:`interface-spec.json` 可供下游覆盖率分析复用
|
|
72
|
+
|
|
73
|
+
## 支持的语言
|
|
74
|
+
|
|
75
|
+
- **Dart/Flutter**(完整支持,基于 `flutter-extract-interfaces.cjs` 正则解析引擎)
|