@ohos-cpf/3rdloop 0.0.2 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +290 -244
- package/bin/3rdloop.mjs +46 -46
- package/lib/cli.js +781 -781
- package/lib/config-cmd.js +451 -451
- package/lib/config.js +318 -318
- package/lib/doctor.js +113 -113
- package/lib/exit-codes.js +30 -30
- package/lib/opencode.js +155 -155
- package/lib/orch.js +426 -426
- package/lib/queries.js +263 -263
- package/lib/step.js +325 -325
- package/lib/ui.js +222 -222
- package/lib/update.js +279 -279
- package/lib/workflow.js +308 -308
- package/lib/workflows.js +131 -131
- package/package.json +50 -50
- package/vendor/Server/Agent/SkillSelector/README.md +343 -343
- package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -207
- package/vendor/Server/Agent/SkillSelector/index.js +14 -14
- package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -313
- package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -161
- package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -144
- package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -433
- package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -382
- package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +59 -59
- package/vendor/Server/Brain/AnalysisStrategies.js +422 -422
- package/vendor/Server/Brain/Brain.js +686 -686
- package/vendor/Server/Brain/DecompositionStrategies.js +621 -621
- package/vendor/Server/Brain/PlanPersistence.js +196 -196
- package/vendor/Server/Brain/SkillExecutor.js +251 -251
- package/vendor/Server/Brain/index.js +11 -11
- package/vendor/Server/CLI/cli.js +275 -275
- package/vendor/Server/CLI/deveco-code/index.js +71 -71
- package/vendor/Server/CLI/deveco-code.js +5 -5
- package/vendor/Server/CLI/opencode/index.js +817 -818
- package/vendor/Server/CLI/opencode.js +5 -5
- package/vendor/Server/DbUse/MessageArchive.js +61 -61
- package/vendor/Server/DbUse/StorageManager.js +107 -107
- package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -94
- package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -114
- package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -157
- package/vendor/Server/DbUse/index.js +160 -160
- package/vendor/Server/DbUse/stores/SessionStore.js +279 -279
- package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -133
- package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -262
- package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -279
- package/vendor/Server/FlexRunner/FlexRunner.js +1759 -1759
- package/vendor/Server/FlexRunner/index.js +12 -12
- package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -523
- package/vendor/Server/Knowledge/KnowledgeManager.js +341 -341
- package/vendor/Server/Knowledge/index.js +33 -33
- package/vendor/Server/LoopEngine/LoopEngine.js +1133 -1133
- package/vendor/Server/LoopEngine/index.js +11 -11
- package/vendor/Server/Orchestrator/Orchestrator.js +0 -3
- package/vendor/Server/Orchestrator/StepNode.js +312 -312
- package/vendor/Server/Orchestrator/index.js +13 -13
- package/vendor/Server/Routes/controllers/BrainController.js +241 -241
- package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -1125
- package/vendor/Server/Routes/controllers/HealthController.js +44 -44
- package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -355
- package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -788
- package/vendor/Server/Routes/controllers/StatsController.js +57 -57
- package/vendor/Server/Routes/controllers/StreamController.js +67 -67
- package/vendor/Server/Routes/library/logger.js +179 -179
- package/vendor/Server/Routes/library/zipArchive.js +172 -172
- package/vendor/Server/Routes/router/Router.js +204 -204
- package/vendor/Server/Routes/routes/brain.js +47 -47
- package/vendor/Server/Routes/routes/flexrunner.js +72 -72
- package/vendor/Server/Routes/routes/health.js +28 -28
- package/vendor/Server/Routes/routes/index.js +57 -57
- package/vendor/Server/Routes/routes/knowledge.js +55 -55
- package/vendor/Server/Routes/routes/loopengine.js +58 -58
- package/vendor/Server/Routes/routes/orchestrator.js +61 -61
- package/vendor/Server/Routes/routes/registry.js +97 -97
- package/vendor/Server/Routes/routes/stats.js +23 -23
- package/vendor/Server/Routes/routes/stream.js +30 -30
- package/vendor/Server/Routes/server.js +203 -203
- package/vendor/Server/Routes/sse/SseHub.js +308 -308
- package/vendor/Server/Skills/acceptance-check/SKILL.md +191 -191
- package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -52
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -77
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_EVIDENCE_VERIFICATION.md +70 -70
- package/vendor/Server/Skills/arkts-code-check/SKILL.md +320 -320
- package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +210 -210
- package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +28 -28
- package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +233 -233
- package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +328 -328
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -291
- package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -68
- package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -184
- package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -337
- package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -400
- package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +98 -98
- package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -544
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -174
- package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -321
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -100
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -185
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +233 -233
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +102 -102
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -89
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -62
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +107 -107
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -124
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -90
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -57
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +391 -391
- package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -113
- package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +312 -312
- package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -154
- package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +165 -165
- package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +308 -308
- package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -90
- package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -282
- package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +360 -360
- package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +145 -145
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +252 -252
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +114 -114
- package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +262 -262
- package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -455
- package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -60
- package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -76
- package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -200
- package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +518 -518
- package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -276
- package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +92 -92
- package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -767
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -221
- package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +228 -228
- package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -194
- package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +575 -575
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +574 -574
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -182
- package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +490 -490
- package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -217
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -299
- package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -190
- package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +133 -133
- package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/flutter-interface/README.md +75 -75
- package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -291
- package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -336
- package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -190
- package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -258
- package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -254
- package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +517 -517
- package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +381 -381
- package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +341 -341
- package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -71
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +518 -518
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +406 -406
- package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +652 -652
- package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +396 -396
- package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +744 -744
- package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +720 -720
- package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -414
- package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -150
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -304
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -265
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -286
- package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -383
- package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -165
- package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -91
- package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +453 -301
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_CHECKLIST.md +151 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +257 -105
- package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +191 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +317 -208
- package/vendor/Server/Skills/rn-code-check/SKILL.md +320 -320
- package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +234 -234
- package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +188 -188
- package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +246 -246
- package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -198
- package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -40
- package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -78
- package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -70
- package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -47
- package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -252
- package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -176
- package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -5
- package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -35
- package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -137
- package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -33
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -40
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -429
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -105
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -90
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -213
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -73
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -258
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -341
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -67
- package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -299
- package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -293
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -857
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -856
- package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -157
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -801
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +683 -683
- package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -233
- package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -1373
- package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -220
- package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -245
- package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -414
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -413
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -355
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -115
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -139
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -586
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -57
- package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -259
- package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -301
- package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -148
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -118
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -168
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -176
- package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -274
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -45
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -25
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -61
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -165
- package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -239
- package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -96
- package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +57 -57
- package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -99
- package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -64
- package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +74 -74
- package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -164
- package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +356 -339
- package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +85 -83
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +905 -859
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +124 -122
- package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +287 -279
- package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -273
- package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -129
- package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -581
- package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -138
- package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -168
- package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +526 -506
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +321 -280
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -221
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +220 -209
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -325
- package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -279
- package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -404
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -185
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -265
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -189
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -203
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -147
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -148
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -165
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -195
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -249
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -161
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -413
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -245
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -282
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -251
- package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -469
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -310
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -303
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -421
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -358
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -114
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -274
- package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -185
- package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -191
- package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -216
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -107
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -120
- package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -108
- package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -237
- package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -261
- package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -112
- package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +497 -497
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -270
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -164
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -556
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -459
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -65
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -512
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -132
- package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -424
- package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -137
- package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -306
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -485
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -172
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -422
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -95
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -169
- package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -554
- package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -106
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -216
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -413
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -98
- package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -337
- package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -722
- package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -173
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -267
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -174
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -111
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -186
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -150
- package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -296
- package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -371
- package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -212
- package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -223
- package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -1053
- package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +295 -255
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +82 -77
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -224
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +175 -174
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -967
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -1798
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -5
- package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +180 -137
- package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -145
- package/vendor/Server/Skills/skill-generator/SKILL.md +365 -365
- package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -183
- package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -82
- package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -110
- package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -122
- package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -121
- package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/task-analysis/SKILL.md +234 -234
- package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -160
- package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -190
- package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -224
- package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -162
- package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -55
- package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -126
- package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -256
- package/vendor/Server/Skills/task-decomposition/SKILL.md +528 -528
- package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -451
- package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -179
- package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -152
- package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -175
- package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -195
- package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -226
- package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -263
- package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -29
- package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -376
- package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -259
- package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -216
- package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +424 -424
- package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -427
- package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -214
- package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -235
- package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -250
- package/vendor/Server/TestCheck/TestCheck.js +775 -775
- package/vendor/Server/TestCheck/index.js +11 -11
- package/vendor/Server/library/McpToolGuide.js +280 -280
- package/vendor/Server/library/StatsService.js +126 -126
- package/vendor/Server/library/cstTime.js +16 -16
- package/vendor/VERSION +3 -3
- package/workflows/pr-check.mjs +105 -105
- package/workflows/pr-push.mjs +192 -192
- package/vendor/Server/Agent/SkillSelector/types.js +0 -63
|
@@ -1,337 +1,337 @@
|
|
|
1
|
-
# Demo 代码生成规范速查
|
|
2
|
-
|
|
3
|
-
本文档为 `arkts-library-demo-code` 技能的 ArkTS Demo 代码生成提供规范速查,涵盖命名规则、ArkTS 禁止项、日志规范、权限申请模式、国际化资源规范等。
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## 一、文件命名规范
|
|
8
|
-
|
|
9
|
-
### Demo 页面文件命名
|
|
10
|
-
|
|
11
|
-
格式:`{三位序号}_{PascalCase功能描述}Page.ets`
|
|
12
|
-
|
|
13
|
-
所有 Demo 页面文件统一**平铺**在 `pages/` 目录,**严禁**创建子目录。
|
|
14
|
-
|
|
15
|
-
| 规则 | 说明 | 示例 |
|
|
16
|
-
|------|------|------|
|
|
17
|
-
| 三位序号 | 用零补齐,保证文件排序与 Demo 序号一致 | `001`、`012`、`100` |
|
|
18
|
-
| PascalCase 描述 | 大驼峰,体现 Demo 核心功能,单词首字母大写 | `CheckSupportAndConfig`、`BlurManagerLifecycle` |
|
|
19
|
-
| 完整文件名 | `{序号}_{PascalCase描述}Page.ets` | `001_CheckSupportAndConfigPage.ets` |
|
|
20
|
-
|
|
21
|
-
**示例映射**:
|
|
22
|
-
|
|
23
|
-
| Demo 中文名 | 文件路径(相对于 `entry/src/main/ets/`) |
|
|
24
|
-
|-----------|---------------------------------------|
|
|
25
|
-
| 环境检测与配置创建 Demo | `pages/001_CheckSupportAndConfigPage.ets` |
|
|
26
|
-
| 生命周期管理 Demo | `pages/002_BlurManagerLifecyclePage.ets` |
|
|
27
|
-
| 同步图像处理 Demo | `pages/003_SyncImageProcessPage.ets` |
|
|
28
|
-
| 异步网络请求 Demo | `pages/004_AsyncNetworkRequestPage.ets` |
|
|
29
|
-
|
|
30
|
-
> ⚠️ 路由注册(`main_pages.json`)和 `router.pushUrl` 中的 URL 路径格式为 `pages/{序号}_{PascalCaseName}Page`(**不含子目录**),如 `pages/001_CheckSupportAndConfigPage`。
|
|
31
|
-
|
|
32
|
-
### 模型文件命名(可选)
|
|
33
|
-
|
|
34
|
-
若 Demo 需要数据模型类,在 `pages/` 目录下与页面文件同级创建:`{PascalCase名}Model.ets`
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## 二、ArkTS 编译禁止项(必查)
|
|
39
|
-
|
|
40
|
-
生成的所有代码必须规避以下 ArkTS 严格模式编译报错:
|
|
41
|
-
|
|
42
|
-
| 禁止项 | 错误标识 | 正确替代 |
|
|
43
|
-
|-------|---------|---------|
|
|
44
|
-
| `any` 类型 | `arkts-no-any` | 具体类型或泛型 `T` |
|
|
45
|
-
| `Object`/`ESObject` | `arkts-no-esobj` | 定义 `interface` 或具体类型 |
|
|
46
|
-
| 动态属性访问 `obj['key']` | `arkts-no-dynamic-property` | `obj.key` 类型安全访问 |
|
|
47
|
-
| 内联匿名对象类型 | `arkts-no-obj-literals-as-types` | 定义命名 `interface` |
|
|
48
|
-
| `prototype` 扩展 | `arkts-no-prototype-assignment` | 类继承或组合 |
|
|
49
|
-
| `delete` 操作符 | `arkts-no-delete` | 设为 `undefined` 或重构对象 |
|
|
50
|
-
| `arguments` 对象 | `arkts-no-arguments` | 展开参数 `...args: T[]` |
|
|
51
|
-
| 双重 `as unknown as T` | `arkts-no-unsafe-cast` | 正确定义类型,避免强转 |
|
|
52
|
-
| `for...in` | `arkts-no-for-in` | `Object.keys().forEach()` |
|
|
53
|
-
| `eval()` | `arkts-no-eval` | 禁止使用 |
|
|
54
|
-
| `catch(e)` 中直接 `throw e` | `arkts-limited-throw` | `e` 类型为 `unknown`,须用 `throw e instanceof Error ? e : new Error(String(e))` |
|
|
55
|
-
| `.then().catch()` 链式调用 | 可读性差 | 优先 `async/await + try/catch` |
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
## 三、日志规范
|
|
60
|
-
|
|
61
|
-
### 3.1 DOMAIN 与 TAG 分配
|
|
62
|
-
|
|
63
|
-
```typescript
|
|
64
|
-
// ✅ 正确:每个页面文件有独立 TAG,DOMAIN 在工程中统一范围
|
|
65
|
-
const DOMAIN: number = 0xD001; // 单个工程统一使用一个域值
|
|
66
|
-
const TAG: string = 'BlurKit_CheckSupportPage'; // {库名}_{页面/模块名}
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
**TAG 命名规则**:`{LibraryName}_{ComponentName}`,不超过 32 字符,只含字母数字下划线。
|
|
70
|
-
|
|
71
|
-
### 3.2 日志级别选择
|
|
72
|
-
|
|
73
|
-
| 级别 | 函数 | 使用场景 |
|
|
74
|
-
|------|------|---------|
|
|
75
|
-
| DEBUG | `hilog.debug(...)` | 方法入口、参数值、中间状态 |
|
|
76
|
-
| INFO | `hilog.info(...)` | 操作成功、状态变更、重要里程碑 |
|
|
77
|
-
| WARN | `hilog.warn(...)` | 输入非法但可处理、降级处理 |
|
|
78
|
-
| ERROR | `hilog.error(...)` | 捕获到异常、接口调用失败 |
|
|
79
|
-
| FATAL | `hilog.fatal(...)` | 不可恢复的致命错误(慎用) |
|
|
80
|
-
|
|
81
|
-
### 3.3 格式化参数
|
|
82
|
-
|
|
83
|
-
```typescript
|
|
84
|
-
// ✅ 公开数据用 %{public}s(会在日志中显示)
|
|
85
|
-
hilog.info(DOMAIN, TAG, 'Result count: %{public}d', count);
|
|
86
|
-
hilog.info(DOMAIN, TAG, 'File path: %{public}s', filePath);
|
|
87
|
-
|
|
88
|
-
// ✅ 敏感数据用 %{private}s(日志中显示为 <private>)
|
|
89
|
-
hilog.info(DOMAIN, TAG, 'User account: %{private}s', account);
|
|
90
|
-
hilog.info(DOMAIN, TAG, 'Token: %{private}s', token);
|
|
91
|
-
|
|
92
|
-
// ❌ 禁止:将密码、Token、手机号等用 %{public}s 输出
|
|
93
|
-
hilog.info(DOMAIN, TAG, 'Password: %{public}s', password); // 安全违规!
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
### 3.4 必须添加日志的位置
|
|
97
|
-
|
|
98
|
-
| 位置 | 日志级别 | 示例 |
|
|
99
|
-
|------|---------|------|
|
|
100
|
-
| `aboutToAppear()` | INFO | `hilog.info(..., 'XxxPage appeared')` |
|
|
101
|
-
| `aboutToDisappear()` | INFO | `hilog.info(..., 'XxxPage disappeared')` |
|
|
102
|
-
| 每个事件处理方法入口 | DEBUG | `hilog.debug(..., 'onButtonClick called')` |
|
|
103
|
-
| 接口调用成功 | INFO | `hilog.info(..., 'apiCall succeeded: ...')` |
|
|
104
|
-
| 捕获到异常 | ERROR | `hilog.error(..., 'apiCall failed: %{public}s', msg)` |
|
|
105
|
-
| 输入校验失败 | WARN | `hilog.warn(..., 'Invalid input: ...')` |
|
|
106
|
-
|
|
107
|
-
---
|
|
108
|
-
|
|
109
|
-
## 四、错误处理规范
|
|
110
|
-
|
|
111
|
-
### 4.1 异步接口标准模式
|
|
112
|
-
|
|
113
|
-
```typescript
|
|
114
|
-
private async callLibraryApi(param: string): Promise<void> {
|
|
115
|
-
hilog.debug(DOMAIN, TAG, 'callLibraryApi called, param: %{public}s', param);
|
|
116
|
-
this.isLoading = true;
|
|
117
|
-
try {
|
|
118
|
-
const result: ReturnType = await libraryApi(param);
|
|
119
|
-
hilog.info(DOMAIN, TAG, 'callLibraryApi succeeded');
|
|
120
|
-
this.resultText = `成功:${String(result)}`;
|
|
121
|
-
} catch (err) {
|
|
122
|
-
// ✅ 正确:使用 (err as Error).message,不使用 any
|
|
123
|
-
const msg: string = (err as Error).message ?? String(err);
|
|
124
|
-
hilog.error(DOMAIN, TAG, 'callLibraryApi failed: %{public}s', msg);
|
|
125
|
-
this.resultText = `错误:${msg}`;
|
|
126
|
-
} finally {
|
|
127
|
-
// ✅ 无论成功失败都要重置 Loading 状态
|
|
128
|
-
this.isLoading = false;
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### 4.2 同步接口标准模式
|
|
134
|
-
|
|
135
|
-
```typescript
|
|
136
|
-
private callSyncApi(): void {
|
|
137
|
-
hilog.debug(DOMAIN, TAG, 'callSyncApi called');
|
|
138
|
-
try {
|
|
139
|
-
const result: ReturnType = syncApi();
|
|
140
|
-
this.resultText = `结果:${String(result)}`;
|
|
141
|
-
hilog.info(DOMAIN, TAG, 'callSyncApi succeeded: %{public}s', String(result));
|
|
142
|
-
} catch (err) {
|
|
143
|
-
const msg: string = (err as Error).message ?? String(err);
|
|
144
|
-
hilog.error(DOMAIN, TAG, 'callSyncApi failed: %{public}s', msg);
|
|
145
|
-
this.resultText = `错误:${msg}`;
|
|
146
|
-
}
|
|
147
|
-
}
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
### 4.3 页面跳转错误处理
|
|
151
|
-
|
|
152
|
-
```typescript
|
|
153
|
-
// 组件方法内(推荐 getUIContext().getRouter(),路由路径无子目录)
|
|
154
|
-
this.getUIContext().getRouter().pushUrl({ url: 'pages/001_XxxPage' })
|
|
155
|
-
.catch((err: Error) => {
|
|
156
|
-
hilog.error(DOMAIN, TAG, 'Navigation failed: %{public}s', err.message);
|
|
157
|
-
});
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
---
|
|
161
|
-
|
|
162
|
-
## 五、资源生命周期管理
|
|
163
|
-
|
|
164
|
-
所有持有的资源必须在 `aboutToDisappear()` 中释放,防止内存泄露:
|
|
165
|
-
|
|
166
|
-
```typescript
|
|
167
|
-
// 持有的资源(非状态变量)
|
|
168
|
-
private blurManager: BlurManager | null = null;
|
|
169
|
-
private timerId: number = -1;
|
|
170
|
-
private httpRequest: http.HttpRequest | null = null;
|
|
171
|
-
|
|
172
|
-
aboutToDisappear(): void {
|
|
173
|
-
hilog.info(DOMAIN, TAG, 'XxxPage disappeared, releasing resources');
|
|
174
|
-
|
|
175
|
-
// 释放鸿蒙原生库实例
|
|
176
|
-
if (this.blurManager !== null) {
|
|
177
|
-
this.blurManager.release();
|
|
178
|
-
this.blurManager = null;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
// 清除定时器
|
|
182
|
-
if (this.timerId !== -1) {
|
|
183
|
-
clearInterval(this.timerId);
|
|
184
|
-
this.timerId = -1;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
// 销毁 HTTP 请求
|
|
188
|
-
if (this.httpRequest !== null) {
|
|
189
|
-
this.httpRequest.destroy();
|
|
190
|
-
this.httpRequest = null;
|
|
191
|
-
}
|
|
192
|
-
}
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
---
|
|
196
|
-
|
|
197
|
-
## 六、权限申请规范
|
|
198
|
-
|
|
199
|
-
### 6.1 常见权限速查
|
|
200
|
-
|
|
201
|
-
| 功能 | 权限名 | 授权类型 |
|
|
202
|
-
|------|-------|---------|
|
|
203
|
-
| 网络访问 | `ohos.permission.INTERNET` | 系统自动授权 |
|
|
204
|
-
| 读取媒体文件 | `ohos.permission.READ_MEDIA` | 用户授权 |
|
|
205
|
-
| 写入媒体文件 | `ohos.permission.WRITE_MEDIA` | 用户授权 |
|
|
206
|
-
| 相机 | `ohos.permission.CAMERA` | 用户授权 |
|
|
207
|
-
| 麦克风 | `ohos.permission.MICROPHONE` | 用户授权 |
|
|
208
|
-
| 位置(精确) | `ohos.permission.LOCATION` | 用户授权 |
|
|
209
|
-
| 位置(模糊) | `ohos.permission.APPROXIMATELY_LOCATION` | 用户授权 |
|
|
210
|
-
| 蓝牙 | `ohos.permission.USE_BLUETOOTH` | 系统自动授权 |
|
|
211
|
-
| 振动 | `ohos.permission.VIBRATE` | 系统自动授权 |
|
|
212
|
-
|
|
213
|
-
### 6.2 动态权限申请标准模式
|
|
214
|
-
|
|
215
|
-
```typescript
|
|
216
|
-
import abilityAccessCtrl, { Permissions } from '@ohos.abilityAccessCtrl';
|
|
217
|
-
import common from '@ohos.app.ability.common';
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* 申请运行时权限
|
|
221
|
-
* @param permissions 需要申请的权限列表
|
|
222
|
-
* @returns 所有权限均已授予返回 true,否则返回 false
|
|
223
|
-
*/
|
|
224
|
-
private async requestPermissions(permissions: Permissions[]): Promise<boolean> {
|
|
225
|
-
hilog.debug(DOMAIN, TAG, 'requestPermissions called, count: %{public}d', permissions.length);
|
|
226
|
-
const context = getContext(this) as common.UIAbilityContext;
|
|
227
|
-
const atManager = abilityAccessCtrl.createAtManager();
|
|
228
|
-
try {
|
|
229
|
-
const result = await atManager.requestPermissionsFromUser(context, permissions);
|
|
230
|
-
const allGranted: boolean = result.authResults.every((r: number) => r === 0);
|
|
231
|
-
hilog.info(DOMAIN, TAG, 'Permission request result: %{public}s',
|
|
232
|
-
allGranted ? 'all granted' : 'some denied');
|
|
233
|
-
return allGranted;
|
|
234
|
-
} catch (err) {
|
|
235
|
-
const msg: string = (err as Error).message ?? String(err);
|
|
236
|
-
hilog.error(DOMAIN, TAG, 'requestPermissions failed: %{public}s', msg);
|
|
237
|
-
return false;
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
---
|
|
243
|
-
|
|
244
|
-
## 七、UI 组件使用规范
|
|
245
|
-
|
|
246
|
-
### 7.1 状态显示模板
|
|
247
|
-
|
|
248
|
-
```typescript
|
|
249
|
-
// Loading 状态
|
|
250
|
-
if (this.isLoading) {
|
|
251
|
-
LoadingProgress().width(40).height(40).margin({ top: 8 })
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
// 错误/结果文本
|
|
255
|
-
if (this.resultText.length > 0) {
|
|
256
|
-
Text(this.resultText)
|
|
257
|
-
.fontSize(14)
|
|
258
|
-
.width('100%')
|
|
259
|
-
.padding(12)
|
|
260
|
-
.backgroundColor(this.isError ? '#FFEBEE' : '#F5F5F5')
|
|
261
|
-
.fontColor(this.isError ? '#C62828' : '#212121')
|
|
262
|
-
.borderRadius(8)
|
|
263
|
-
.margin({ top: 8 })
|
|
264
|
-
}
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
### 7.2 按钮禁用逻辑
|
|
268
|
-
|
|
269
|
-
```typescript
|
|
270
|
-
// 按钮文本必须通过 $r() 引用国际化字符串,禁止硬编码
|
|
271
|
-
Button($r('app.string.demo_001_action_btn'))
|
|
272
|
-
.width('100%')
|
|
273
|
-
.enabled(!this.isLoading) // 加载中禁用,防止重复触发
|
|
274
|
-
.onClick(() => this.doAction())
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### 7.3 列表渲染 key 要求
|
|
278
|
-
|
|
279
|
-
```typescript
|
|
280
|
-
// ✅ ForEach 第三个参数必须提供稳定唯一的 key
|
|
281
|
-
ForEach(this.items, (item: ItemType) => {
|
|
282
|
-
ListItem() { /* ... */ }
|
|
283
|
-
}, (item: ItemType) => item.id) // 使用唯一 id 作为 key
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
### 7.4 @Builder 动态数据禁用
|
|
287
|
-
|
|
288
|
-
**严禁**将 `@Builder` 方法用于展示需要动态更新的 `@State` 数据(耗时、计数器、状态标志等):
|
|
289
|
-
|
|
290
|
-
- 原因:`@Builder` 在调用时对参数进行 **by-value 快照复制**,ArkUI diff 算法在同一位置遇到同一 `@Builder` 调用时判断"结构未变"而**跳过重渲染**,即使外部 `@State` 已更新,`@Builder` 子作用域内的展示内容也**不会刷新**
|
|
291
|
-
- 正确做法:将涉及动态 `@State` 的 `Text`/`Image` 等节点**直接内联在 `build()` 方法中**,让 `@State` 变量直接出现在组件树属性表达式里,ArkUI 才能建立正确依赖并触发细粒度更新
|
|
292
|
-
- 合法用法:`@Builder` 仅适用于静态布局复用(不依赖 `@State` 的纯展示结构);`DemoIndex` 中的 `@Builder DemoCard(demo: DemoEntry)` 传入静态数据对象,属于合法用法
|
|
293
|
-
|
|
294
|
-
---
|
|
295
|
-
|
|
296
|
-
## 八、国际化资源规范
|
|
297
|
-
|
|
298
|
-
### 8.1 强制规则
|
|
299
|
-
|
|
300
|
-
- 所有出现在 UI `Text`/`Button` 组件中的静态字符串(页面标题、按钮文本、区块标签等)**必须**通过 `$r('app.string.xxx')` 引用,禁止在 ETS 代码中硬编码任何 UI 文本
|
|
301
|
-
- 主导航页面 `DemoEntry` 数组中,`title` 和 `description` 字段类型必须声明为 `Resource`,使用 `$r('app.string.demo_NNN_title')` 和 `$r('app.string.demo_NNN_index_desc')` 赋值
|
|
302
|
-
- 动态文本(运行时错误信息、接口返回结果等)不属于静态字符串,不需要资源键,在代码中直接赋值
|
|
303
|
-
|
|
304
|
-
### 8.2 三文件同步
|
|
305
|
-
|
|
306
|
-
每个 `$r('app.string.xxx')` 键必须**同时**在三个资源文件中添加同名条目:
|
|
307
|
-
|
|
308
|
-
| 文件 | 值的约定 |
|
|
309
|
-
|------|---------|
|
|
310
|
-
| `entry/src/main/resources/base/element/string.json` | 默认值(建议中文) |
|
|
311
|
-
| `entry/src/main/resources/zh_CN/element/string.json` | 中文,值用【序号】前缀标识 |
|
|
312
|
-
| `entry/src/main/resources/en_US/element/string.json` | 英文,值用 Title Case |
|
|
313
|
-
|
|
314
|
-
> 遗漏 base 会报 `Warning: the string of 'xxx' does not have a base resource.`(不阻塞编译,但影响资源回退与运行时定位)。
|
|
315
|
-
|
|
316
|
-
### 8.3 键名规则
|
|
317
|
-
|
|
318
|
-
- 格式:`demo_{三位序号}_{语义描述}`,如 `demo_001_title`、`demo_001_check_btn`
|
|
319
|
-
- 主导航专用键:每个 Demo 的 `demo_NNN_index_desc`(列表描述)、页面标题 `demo_index_title`
|
|
320
|
-
- 原始 Demo 入口:`demo_original_title`、`demo_original_index_desc`
|
|
321
|
-
- 键名以序号前缀隔离不同 Demo,避免冲突
|
|
322
|
-
|
|
323
|
-
---
|
|
324
|
-
|
|
325
|
-
## 九、验证点注释规范
|
|
326
|
-
|
|
327
|
-
在代码中为 Demo 描述文档中的每条"预期结果"添加验证点注释,帮助开发者对照验证:
|
|
328
|
-
|
|
329
|
-
```typescript
|
|
330
|
-
// ✅ 验证点 1: {第一条预期结果原文}
|
|
331
|
-
const result1 = await libraryApi();
|
|
332
|
-
|
|
333
|
-
// ✅ 验证点 2: {第二条预期结果原文}
|
|
334
|
-
this.displayResult = result1;
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
验证点注释应贴近产生该可观测结果的代码行或数据赋值语句。
|
|
1
|
+
# Demo 代码生成规范速查
|
|
2
|
+
|
|
3
|
+
本文档为 `arkts-library-demo-code` 技能的 ArkTS Demo 代码生成提供规范速查,涵盖命名规则、ArkTS 禁止项、日志规范、权限申请模式、国际化资源规范等。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 一、文件命名规范
|
|
8
|
+
|
|
9
|
+
### Demo 页面文件命名
|
|
10
|
+
|
|
11
|
+
格式:`{三位序号}_{PascalCase功能描述}Page.ets`
|
|
12
|
+
|
|
13
|
+
所有 Demo 页面文件统一**平铺**在 `pages/` 目录,**严禁**创建子目录。
|
|
14
|
+
|
|
15
|
+
| 规则 | 说明 | 示例 |
|
|
16
|
+
|------|------|------|
|
|
17
|
+
| 三位序号 | 用零补齐,保证文件排序与 Demo 序号一致 | `001`、`012`、`100` |
|
|
18
|
+
| PascalCase 描述 | 大驼峰,体现 Demo 核心功能,单词首字母大写 | `CheckSupportAndConfig`、`BlurManagerLifecycle` |
|
|
19
|
+
| 完整文件名 | `{序号}_{PascalCase描述}Page.ets` | `001_CheckSupportAndConfigPage.ets` |
|
|
20
|
+
|
|
21
|
+
**示例映射**:
|
|
22
|
+
|
|
23
|
+
| Demo 中文名 | 文件路径(相对于 `entry/src/main/ets/`) |
|
|
24
|
+
|-----------|---------------------------------------|
|
|
25
|
+
| 环境检测与配置创建 Demo | `pages/001_CheckSupportAndConfigPage.ets` |
|
|
26
|
+
| 生命周期管理 Demo | `pages/002_BlurManagerLifecyclePage.ets` |
|
|
27
|
+
| 同步图像处理 Demo | `pages/003_SyncImageProcessPage.ets` |
|
|
28
|
+
| 异步网络请求 Demo | `pages/004_AsyncNetworkRequestPage.ets` |
|
|
29
|
+
|
|
30
|
+
> ⚠️ 路由注册(`main_pages.json`)和 `router.pushUrl` 中的 URL 路径格式为 `pages/{序号}_{PascalCaseName}Page`(**不含子目录**),如 `pages/001_CheckSupportAndConfigPage`。
|
|
31
|
+
|
|
32
|
+
### 模型文件命名(可选)
|
|
33
|
+
|
|
34
|
+
若 Demo 需要数据模型类,在 `pages/` 目录下与页面文件同级创建:`{PascalCase名}Model.ets`
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 二、ArkTS 编译禁止项(必查)
|
|
39
|
+
|
|
40
|
+
生成的所有代码必须规避以下 ArkTS 严格模式编译报错:
|
|
41
|
+
|
|
42
|
+
| 禁止项 | 错误标识 | 正确替代 |
|
|
43
|
+
|-------|---------|---------|
|
|
44
|
+
| `any` 类型 | `arkts-no-any` | 具体类型或泛型 `T` |
|
|
45
|
+
| `Object`/`ESObject` | `arkts-no-esobj` | 定义 `interface` 或具体类型 |
|
|
46
|
+
| 动态属性访问 `obj['key']` | `arkts-no-dynamic-property` | `obj.key` 类型安全访问 |
|
|
47
|
+
| 内联匿名对象类型 | `arkts-no-obj-literals-as-types` | 定义命名 `interface` |
|
|
48
|
+
| `prototype` 扩展 | `arkts-no-prototype-assignment` | 类继承或组合 |
|
|
49
|
+
| `delete` 操作符 | `arkts-no-delete` | 设为 `undefined` 或重构对象 |
|
|
50
|
+
| `arguments` 对象 | `arkts-no-arguments` | 展开参数 `...args: T[]` |
|
|
51
|
+
| 双重 `as unknown as T` | `arkts-no-unsafe-cast` | 正确定义类型,避免强转 |
|
|
52
|
+
| `for...in` | `arkts-no-for-in` | `Object.keys().forEach()` |
|
|
53
|
+
| `eval()` | `arkts-no-eval` | 禁止使用 |
|
|
54
|
+
| `catch(e)` 中直接 `throw e` | `arkts-limited-throw` | `e` 类型为 `unknown`,须用 `throw e instanceof Error ? e : new Error(String(e))` |
|
|
55
|
+
| `.then().catch()` 链式调用 | 可读性差 | 优先 `async/await + try/catch` |
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 三、日志规范
|
|
60
|
+
|
|
61
|
+
### 3.1 DOMAIN 与 TAG 分配
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
// ✅ 正确:每个页面文件有独立 TAG,DOMAIN 在工程中统一范围
|
|
65
|
+
const DOMAIN: number = 0xD001; // 单个工程统一使用一个域值
|
|
66
|
+
const TAG: string = 'BlurKit_CheckSupportPage'; // {库名}_{页面/模块名}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**TAG 命名规则**:`{LibraryName}_{ComponentName}`,不超过 32 字符,只含字母数字下划线。
|
|
70
|
+
|
|
71
|
+
### 3.2 日志级别选择
|
|
72
|
+
|
|
73
|
+
| 级别 | 函数 | 使用场景 |
|
|
74
|
+
|------|------|---------|
|
|
75
|
+
| DEBUG | `hilog.debug(...)` | 方法入口、参数值、中间状态 |
|
|
76
|
+
| INFO | `hilog.info(...)` | 操作成功、状态变更、重要里程碑 |
|
|
77
|
+
| WARN | `hilog.warn(...)` | 输入非法但可处理、降级处理 |
|
|
78
|
+
| ERROR | `hilog.error(...)` | 捕获到异常、接口调用失败 |
|
|
79
|
+
| FATAL | `hilog.fatal(...)` | 不可恢复的致命错误(慎用) |
|
|
80
|
+
|
|
81
|
+
### 3.3 格式化参数
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
// ✅ 公开数据用 %{public}s(会在日志中显示)
|
|
85
|
+
hilog.info(DOMAIN, TAG, 'Result count: %{public}d', count);
|
|
86
|
+
hilog.info(DOMAIN, TAG, 'File path: %{public}s', filePath);
|
|
87
|
+
|
|
88
|
+
// ✅ 敏感数据用 %{private}s(日志中显示为 <private>)
|
|
89
|
+
hilog.info(DOMAIN, TAG, 'User account: %{private}s', account);
|
|
90
|
+
hilog.info(DOMAIN, TAG, 'Token: %{private}s', token);
|
|
91
|
+
|
|
92
|
+
// ❌ 禁止:将密码、Token、手机号等用 %{public}s 输出
|
|
93
|
+
hilog.info(DOMAIN, TAG, 'Password: %{public}s', password); // 安全违规!
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 3.4 必须添加日志的位置
|
|
97
|
+
|
|
98
|
+
| 位置 | 日志级别 | 示例 |
|
|
99
|
+
|------|---------|------|
|
|
100
|
+
| `aboutToAppear()` | INFO | `hilog.info(..., 'XxxPage appeared')` |
|
|
101
|
+
| `aboutToDisappear()` | INFO | `hilog.info(..., 'XxxPage disappeared')` |
|
|
102
|
+
| 每个事件处理方法入口 | DEBUG | `hilog.debug(..., 'onButtonClick called')` |
|
|
103
|
+
| 接口调用成功 | INFO | `hilog.info(..., 'apiCall succeeded: ...')` |
|
|
104
|
+
| 捕获到异常 | ERROR | `hilog.error(..., 'apiCall failed: %{public}s', msg)` |
|
|
105
|
+
| 输入校验失败 | WARN | `hilog.warn(..., 'Invalid input: ...')` |
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 四、错误处理规范
|
|
110
|
+
|
|
111
|
+
### 4.1 异步接口标准模式
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
private async callLibraryApi(param: string): Promise<void> {
|
|
115
|
+
hilog.debug(DOMAIN, TAG, 'callLibraryApi called, param: %{public}s', param);
|
|
116
|
+
this.isLoading = true;
|
|
117
|
+
try {
|
|
118
|
+
const result: ReturnType = await libraryApi(param);
|
|
119
|
+
hilog.info(DOMAIN, TAG, 'callLibraryApi succeeded');
|
|
120
|
+
this.resultText = `成功:${String(result)}`;
|
|
121
|
+
} catch (err) {
|
|
122
|
+
// ✅ 正确:使用 (err as Error).message,不使用 any
|
|
123
|
+
const msg: string = (err as Error).message ?? String(err);
|
|
124
|
+
hilog.error(DOMAIN, TAG, 'callLibraryApi failed: %{public}s', msg);
|
|
125
|
+
this.resultText = `错误:${msg}`;
|
|
126
|
+
} finally {
|
|
127
|
+
// ✅ 无论成功失败都要重置 Loading 状态
|
|
128
|
+
this.isLoading = false;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### 4.2 同步接口标准模式
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
private callSyncApi(): void {
|
|
137
|
+
hilog.debug(DOMAIN, TAG, 'callSyncApi called');
|
|
138
|
+
try {
|
|
139
|
+
const result: ReturnType = syncApi();
|
|
140
|
+
this.resultText = `结果:${String(result)}`;
|
|
141
|
+
hilog.info(DOMAIN, TAG, 'callSyncApi succeeded: %{public}s', String(result));
|
|
142
|
+
} catch (err) {
|
|
143
|
+
const msg: string = (err as Error).message ?? String(err);
|
|
144
|
+
hilog.error(DOMAIN, TAG, 'callSyncApi failed: %{public}s', msg);
|
|
145
|
+
this.resultText = `错误:${msg}`;
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### 4.3 页面跳转错误处理
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
// 组件方法内(推荐 getUIContext().getRouter(),路由路径无子目录)
|
|
154
|
+
this.getUIContext().getRouter().pushUrl({ url: 'pages/001_XxxPage' })
|
|
155
|
+
.catch((err: Error) => {
|
|
156
|
+
hilog.error(DOMAIN, TAG, 'Navigation failed: %{public}s', err.message);
|
|
157
|
+
});
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## 五、资源生命周期管理
|
|
163
|
+
|
|
164
|
+
所有持有的资源必须在 `aboutToDisappear()` 中释放,防止内存泄露:
|
|
165
|
+
|
|
166
|
+
```typescript
|
|
167
|
+
// 持有的资源(非状态变量)
|
|
168
|
+
private blurManager: BlurManager | null = null;
|
|
169
|
+
private timerId: number = -1;
|
|
170
|
+
private httpRequest: http.HttpRequest | null = null;
|
|
171
|
+
|
|
172
|
+
aboutToDisappear(): void {
|
|
173
|
+
hilog.info(DOMAIN, TAG, 'XxxPage disappeared, releasing resources');
|
|
174
|
+
|
|
175
|
+
// 释放鸿蒙原生库实例
|
|
176
|
+
if (this.blurManager !== null) {
|
|
177
|
+
this.blurManager.release();
|
|
178
|
+
this.blurManager = null;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
// 清除定时器
|
|
182
|
+
if (this.timerId !== -1) {
|
|
183
|
+
clearInterval(this.timerId);
|
|
184
|
+
this.timerId = -1;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// 销毁 HTTP 请求
|
|
188
|
+
if (this.httpRequest !== null) {
|
|
189
|
+
this.httpRequest.destroy();
|
|
190
|
+
this.httpRequest = null;
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## 六、权限申请规范
|
|
198
|
+
|
|
199
|
+
### 6.1 常见权限速查
|
|
200
|
+
|
|
201
|
+
| 功能 | 权限名 | 授权类型 |
|
|
202
|
+
|------|-------|---------|
|
|
203
|
+
| 网络访问 | `ohos.permission.INTERNET` | 系统自动授权 |
|
|
204
|
+
| 读取媒体文件 | `ohos.permission.READ_MEDIA` | 用户授权 |
|
|
205
|
+
| 写入媒体文件 | `ohos.permission.WRITE_MEDIA` | 用户授权 |
|
|
206
|
+
| 相机 | `ohos.permission.CAMERA` | 用户授权 |
|
|
207
|
+
| 麦克风 | `ohos.permission.MICROPHONE` | 用户授权 |
|
|
208
|
+
| 位置(精确) | `ohos.permission.LOCATION` | 用户授权 |
|
|
209
|
+
| 位置(模糊) | `ohos.permission.APPROXIMATELY_LOCATION` | 用户授权 |
|
|
210
|
+
| 蓝牙 | `ohos.permission.USE_BLUETOOTH` | 系统自动授权 |
|
|
211
|
+
| 振动 | `ohos.permission.VIBRATE` | 系统自动授权 |
|
|
212
|
+
|
|
213
|
+
### 6.2 动态权限申请标准模式
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
import abilityAccessCtrl, { Permissions } from '@ohos.abilityAccessCtrl';
|
|
217
|
+
import common from '@ohos.app.ability.common';
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* 申请运行时权限
|
|
221
|
+
* @param permissions 需要申请的权限列表
|
|
222
|
+
* @returns 所有权限均已授予返回 true,否则返回 false
|
|
223
|
+
*/
|
|
224
|
+
private async requestPermissions(permissions: Permissions[]): Promise<boolean> {
|
|
225
|
+
hilog.debug(DOMAIN, TAG, 'requestPermissions called, count: %{public}d', permissions.length);
|
|
226
|
+
const context = getContext(this) as common.UIAbilityContext;
|
|
227
|
+
const atManager = abilityAccessCtrl.createAtManager();
|
|
228
|
+
try {
|
|
229
|
+
const result = await atManager.requestPermissionsFromUser(context, permissions);
|
|
230
|
+
const allGranted: boolean = result.authResults.every((r: number) => r === 0);
|
|
231
|
+
hilog.info(DOMAIN, TAG, 'Permission request result: %{public}s',
|
|
232
|
+
allGranted ? 'all granted' : 'some denied');
|
|
233
|
+
return allGranted;
|
|
234
|
+
} catch (err) {
|
|
235
|
+
const msg: string = (err as Error).message ?? String(err);
|
|
236
|
+
hilog.error(DOMAIN, TAG, 'requestPermissions failed: %{public}s', msg);
|
|
237
|
+
return false;
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 七、UI 组件使用规范
|
|
245
|
+
|
|
246
|
+
### 7.1 状态显示模板
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
// Loading 状态
|
|
250
|
+
if (this.isLoading) {
|
|
251
|
+
LoadingProgress().width(40).height(40).margin({ top: 8 })
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
// 错误/结果文本
|
|
255
|
+
if (this.resultText.length > 0) {
|
|
256
|
+
Text(this.resultText)
|
|
257
|
+
.fontSize(14)
|
|
258
|
+
.width('100%')
|
|
259
|
+
.padding(12)
|
|
260
|
+
.backgroundColor(this.isError ? '#FFEBEE' : '#F5F5F5')
|
|
261
|
+
.fontColor(this.isError ? '#C62828' : '#212121')
|
|
262
|
+
.borderRadius(8)
|
|
263
|
+
.margin({ top: 8 })
|
|
264
|
+
}
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### 7.2 按钮禁用逻辑
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
// 按钮文本必须通过 $r() 引用国际化字符串,禁止硬编码
|
|
271
|
+
Button($r('app.string.demo_001_action_btn'))
|
|
272
|
+
.width('100%')
|
|
273
|
+
.enabled(!this.isLoading) // 加载中禁用,防止重复触发
|
|
274
|
+
.onClick(() => this.doAction())
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### 7.3 列表渲染 key 要求
|
|
278
|
+
|
|
279
|
+
```typescript
|
|
280
|
+
// ✅ ForEach 第三个参数必须提供稳定唯一的 key
|
|
281
|
+
ForEach(this.items, (item: ItemType) => {
|
|
282
|
+
ListItem() { /* ... */ }
|
|
283
|
+
}, (item: ItemType) => item.id) // 使用唯一 id 作为 key
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### 7.4 @Builder 动态数据禁用
|
|
287
|
+
|
|
288
|
+
**严禁**将 `@Builder` 方法用于展示需要动态更新的 `@State` 数据(耗时、计数器、状态标志等):
|
|
289
|
+
|
|
290
|
+
- 原因:`@Builder` 在调用时对参数进行 **by-value 快照复制**,ArkUI diff 算法在同一位置遇到同一 `@Builder` 调用时判断"结构未变"而**跳过重渲染**,即使外部 `@State` 已更新,`@Builder` 子作用域内的展示内容也**不会刷新**
|
|
291
|
+
- 正确做法:将涉及动态 `@State` 的 `Text`/`Image` 等节点**直接内联在 `build()` 方法中**,让 `@State` 变量直接出现在组件树属性表达式里,ArkUI 才能建立正确依赖并触发细粒度更新
|
|
292
|
+
- 合法用法:`@Builder` 仅适用于静态布局复用(不依赖 `@State` 的纯展示结构);`DemoIndex` 中的 `@Builder DemoCard(demo: DemoEntry)` 传入静态数据对象,属于合法用法
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## 八、国际化资源规范
|
|
297
|
+
|
|
298
|
+
### 8.1 强制规则
|
|
299
|
+
|
|
300
|
+
- 所有出现在 UI `Text`/`Button` 组件中的静态字符串(页面标题、按钮文本、区块标签等)**必须**通过 `$r('app.string.xxx')` 引用,禁止在 ETS 代码中硬编码任何 UI 文本
|
|
301
|
+
- 主导航页面 `DemoEntry` 数组中,`title` 和 `description` 字段类型必须声明为 `Resource`,使用 `$r('app.string.demo_NNN_title')` 和 `$r('app.string.demo_NNN_index_desc')` 赋值
|
|
302
|
+
- 动态文本(运行时错误信息、接口返回结果等)不属于静态字符串,不需要资源键,在代码中直接赋值
|
|
303
|
+
|
|
304
|
+
### 8.2 三文件同步
|
|
305
|
+
|
|
306
|
+
每个 `$r('app.string.xxx')` 键必须**同时**在三个资源文件中添加同名条目:
|
|
307
|
+
|
|
308
|
+
| 文件 | 值的约定 |
|
|
309
|
+
|------|---------|
|
|
310
|
+
| `entry/src/main/resources/base/element/string.json` | 默认值(建议中文) |
|
|
311
|
+
| `entry/src/main/resources/zh_CN/element/string.json` | 中文,值用【序号】前缀标识 |
|
|
312
|
+
| `entry/src/main/resources/en_US/element/string.json` | 英文,值用 Title Case |
|
|
313
|
+
|
|
314
|
+
> 遗漏 base 会报 `Warning: the string of 'xxx' does not have a base resource.`(不阻塞编译,但影响资源回退与运行时定位)。
|
|
315
|
+
|
|
316
|
+
### 8.3 键名规则
|
|
317
|
+
|
|
318
|
+
- 格式:`demo_{三位序号}_{语义描述}`,如 `demo_001_title`、`demo_001_check_btn`
|
|
319
|
+
- 主导航专用键:每个 Demo 的 `demo_NNN_index_desc`(列表描述)、页面标题 `demo_index_title`
|
|
320
|
+
- 原始 Demo 入口:`demo_original_title`、`demo_original_index_desc`
|
|
321
|
+
- 键名以序号前缀隔离不同 Demo,避免冲突
|
|
322
|
+
|
|
323
|
+
---
|
|
324
|
+
|
|
325
|
+
## 九、验证点注释规范
|
|
326
|
+
|
|
327
|
+
在代码中为 Demo 描述文档中的每条"预期结果"添加验证点注释,帮助开发者对照验证:
|
|
328
|
+
|
|
329
|
+
```typescript
|
|
330
|
+
// ✅ 验证点 1: {第一条预期结果原文}
|
|
331
|
+
const result1 = await libraryApi();
|
|
332
|
+
|
|
333
|
+
// ✅ 验证点 2: {第二条预期结果原文}
|
|
334
|
+
this.displayResult = result1;
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
验证点注释应贴近产生该可观测结果的代码行或数据赋值语句。
|