android2harmony 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +407 -0
  2. package/agents/build-fixer.md +385 -0
  3. package/agents/code-reviewer.md +478 -0
  4. package/agents/logic-coder.md +212 -0
  5. package/agents/logic-context-builder.md +199 -0
  6. package/agents/scripts/hmos-precheck/arkts.mjs +534 -0
  7. package/agents/scripts/hmos-precheck/codelinter.mjs +362 -0
  8. package/agents/scripts/hmos-precheck/index.mjs +926 -0
  9. package/agents/scripts/platform_query.mjs +535 -0
  10. package/dist/index.js +179 -0
  11. package/dist/index.js.map +7 -0
  12. package/package.json +29 -0
  13. package/skills/hmos-batch-ui-align/SKILL.md +141 -0
  14. package/skills/hmos-batch-ui-align/references/conversion-procedure.md +217 -0
  15. package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-atomic-component-mapping-reference.md +2533 -0
  16. package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-interaction-mapping-reference.md +555 -0
  17. package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-layout-mapping-reference.md +117 -0
  18. package/skills/hmos-batch-ui-align/references/mvvm/@Link/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/217/214/345/220/221/345/220/214/346/255/245.md +648 -0
  19. package/skills/hmos-batch-ui-align/references/mvvm/@Observed/350/243/205/351/245/260/345/231/250/345/222/214@ObjectLink/350/243/205/351/245/260/345/231/250/357/274/232/345/265/214/345/245/227/347/261/273/345/257/271/350/261/241/345/261/236/346/200/247/345/217/230/345/214/226.md +2089 -0
  20. package/skills/hmos-batch-ui-align/references/mvvm/@Prop/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/215/225/345/220/221/345/220/214/346/255/245.md +1033 -0
  21. package/skills/hmos-batch-ui-align/references/mvvm/@Provide/350/243/205/351/245/260/345/231/250/345/222/214@Consume/350/243/205/351/245/260/345/231/250/357/274/232/344/270/216/345/220/216/344/273/243/347/273/204/344/273/266/345/217/214/345/220/221/345/220/214/346/255/245.md +1183 -0
  22. package/skills/hmos-batch-ui-align/references/mvvm/@State/350/243/205/351/245/260/345/231/250/357/274/232/347/273/204/344/273/266/345/206/205/347/212/266/346/200/201.md +576 -0
  23. package/skills/hmos-batch-ui-align/references/mvvm/@Track/350/243/205/351/245/260/345/231/250/357/274/232class/345/257/271/350/261/241/345/261/236/346/200/247/347/272/247/346/233/264/346/226/260.md +297 -0
  24. package/skills/hmos-batch-ui-align/references/mvvm/@Watch/350/243/205/351/245/260/345/231/250/357/274/232/347/212/266/346/200/201/345/217/230/351/207/217/346/233/264/346/224/271/351/200/232/347/237/245.md +395 -0
  25. package/skills/hmos-batch-ui-align/references/mvvm/AppStorage/357/274/232/345/272/224/347/224/250/345/205/250/345/261/200/347/232/204UI/347/212/266/346/200/201/345/255/230/345/202/250.md +903 -0
  26. package/skills/hmos-batch-ui-align/references/mvvm/Environment/357/274/232/350/256/276/345/244/207/347/216/257/345/242/203/346/237/245/350/257/242.md +106 -0
  27. package/skills/hmos-batch-ui-align/references/mvvm/LocalStorage/357/274/232/351/241/265/351/235/242/347/272/247UI/347/212/266/346/200/201/345/255/230/345/202/250.md +1178 -0
  28. package/skills/hmos-batch-ui-align/references/mvvm/MVVM/346/250/241/345/274/217/357/274/210V1/357/274/211.md +911 -0
  29. package/skills/hmos-batch-ui-align/references/mvvm/PersistentStorage/357/274/232/346/214/201/344/271/205/345/214/226/345/255/230/345/202/250UI/347/212/266/346/200/201.md +355 -0
  30. package/skills/hmos-batch-ui-align/references/mvvm//347/256/241/347/220/206/345/272/224/347/224/250/346/213/245/346/234/211/347/232/204/347/212/266/346/200/201/346/246/202/350/277/260.md +11 -0
  31. package/skills/hmos-batch-ui-align/scripts/android_parse_fast.ts +1750 -0
  32. package/skills/hmos-convert-pipeline/SKILL.md +446 -0
  33. package/skills/hmos-fix-build-errors/SKILL.md +281 -0
  34. package/skills/hmos-fix-build-errors/references/arkts-strict-patterns.md +219 -0
  35. package/skills/hmos-fix-build-errors/references/known-patterns.md +157 -0
  36. package/skills/hmos-fix-build-errors/references/rdb-entity-pattern.md +131 -0
  37. package/skills/hmos-resources-convert/SKILL.md +654 -0
  38. package/skills/hmos-resources-convert/references/conversion-rules.md +663 -0
  39. package/skills/hmos-resources-convert/references/dependency-analysis-rules.md +388 -0
  40. package/skills/hmos-resources-convert/references/resource-mapping-rules.md +457 -0
  41. package/skills/hmos-resources-convert/references/xml-drawable-to-svg-rules.md +513 -0
  42. package/skills/hmos-resources-convert/template/AppScope/app.json5 +10 -0
  43. package/skills/hmos-resources-convert/template/AppScope/resources/base/element/string.json +8 -0
  44. package/skills/hmos-resources-convert/template/AppScope/resources/base/media/background.png +0 -0
  45. package/skills/hmos-resources-convert/template/AppScope/resources/base/media/foreground.png +0 -0
  46. package/skills/hmos-resources-convert/template/AppScope/resources/base/media/layered_image.json +7 -0
  47. package/skills/hmos-resources-convert/template/build-profile.json5 +42 -0
  48. package/skills/hmos-resources-convert/template/code-linter.json5 +32 -0
  49. package/skills/hmos-resources-convert/template/entry/build-profile.json5 +33 -0
  50. package/skills/hmos-resources-convert/template/entry/hvigorfile.ts +6 -0
  51. package/skills/hmos-resources-convert/template/entry/obfuscation-rules.txt +23 -0
  52. package/skills/hmos-resources-convert/template/entry/oh-package.json5 +10 -0
  53. package/skills/hmos-resources-convert/template/entry/src/main/ets/entryability/EntryAbility.ets +48 -0
  54. package/skills/hmos-resources-convert/template/entry/src/main/ets/entrybackupability/EntryBackupAbility.ets +16 -0
  55. package/skills/hmos-resources-convert/template/entry/src/main/ets/pages/Index.ets +23 -0
  56. package/skills/hmos-resources-convert/template/entry/src/main/module.json5 +55 -0
  57. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/element/color.json +8 -0
  58. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/element/float.json +8 -0
  59. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/element/string.json +16 -0
  60. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/media/background.png +0 -0
  61. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/media/foreground.png +0 -0
  62. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/media/layered_image.json +7 -0
  63. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/media/startIcon.png +0 -0
  64. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/profile/backup_config.json +3 -0
  65. package/skills/hmos-resources-convert/template/entry/src/main/resources/base/profile/main_pages.json +5 -0
  66. package/skills/hmos-resources-convert/template/entry/src/main/resources/dark/element/color.json +8 -0
  67. package/skills/hmos-resources-convert/template/entry/src/mock/mock-config.json5 +2 -0
  68. package/skills/hmos-resources-convert/template/entry/src/ohosTest/ets/test/Ability.test.ets +35 -0
  69. package/skills/hmos-resources-convert/template/entry/src/ohosTest/ets/test/List.test.ets +5 -0
  70. package/skills/hmos-resources-convert/template/entry/src/ohosTest/module.json5 +16 -0
  71. package/skills/hmos-resources-convert/template/entry/src/test/List.test.ets +5 -0
  72. package/skills/hmos-resources-convert/template/entry/src/test/LocalUnit.test.ets +33 -0
  73. package/skills/hmos-resources-convert/template/hvigor/hvigor-config.json5 +23 -0
  74. package/skills/hmos-resources-convert/template/hvigorfile.ts +6 -0
  75. package/skills/hmos-resources-convert/template/oh-package-lock.json5 +28 -0
  76. package/skills/hmos-resources-convert/template/oh-package.json5 +10 -0
  77. package/skills/hmos-spec-generate/SKILL.md +413 -0
  78. package/skills/hmos-spec-generate/references/android-platform-tokens.md +105 -0
  79. package/skills/hmos-spec-generate/references/spec-sample-1.md +78 -0
  80. package/skills/hmos-spec-generate/references/spec-sample-2.md +58 -0
  81. package/skills/hmos-spec-generate/references/spec-sample-3.md +116 -0
  82. package/skills/hmos-spec-generate/references/step4-report-template.md +33 -0
@@ -0,0 +1,281 @@
1
+ ---
2
+ name: hmos-fix-build-errors
3
+ description: Build a HarmonyOS project via CLI and automatically fix compile errors in a loop until the build succeeds. Default unsigned HAP; pass --signed to build a signed HAP (signing config must already exist in the project's build-profile.json5).
4
+ argument-hint: <harmony_project_dir> [deveco-studio-path] [--signed]
5
+ allowed-tools: Agent, Read, Write, Edit, Glob, Grep, Bash
6
+ type: tool
7
+ domain: engineering
8
+ ---
9
+
10
+ # HarmonyOS Auto Build & Fix
11
+
12
+ Automatically build a HarmonyOS NEXT project from the command line, parse compile errors, fix them, and retry — repeating until the build succeeds.
13
+
14
+ ## Inputs
15
+
16
+ Declare all inputs up front as explicit `snake_case` variables, bound to the positional `$ARGUMENTS`:
17
+
18
+ | Variable | Positional | Required | Meaning |
19
+ |---|---|---|---|
20
+ | `harmony_project_dir` | `$ARGUMENTS[0]` | yes | HarmonyOS project root, e.g. `D:/MyHmosApp` |
21
+ | `deveco_studio_path` | `$ARGUMENTS[1]` | no | DevEco Studio installation root, e.g. `D:/DevEco Studio`. When omitted, resolved automatically (see Step 0.2) |
22
+ | `signed` | `--signed` flag | no | If any argument equals `--signed`, build a **signed HAP**; otherwise build an **unsigned HAP** (default) |
23
+
24
+ Note: `--signed` is a positional-order-independent flag — when `deveco_studio_path` is omitted it may appear as `$ARGUMENTS[1]`, and when provided it appears as `$ARGUMENTS[2]`.
25
+
26
+ ---
27
+
28
+ ## Step 0: Validate Inputs & Setup Environment
29
+
30
+ 1. **Verify project exists** — Check that `harmony_project_dir` contains a valid HarmonyOS project (look for `build-profile.json5`, `entry/src` directory, `oh-package.json5`).
31
+
32
+ 2. **Resolve `<deveco-path>`** — follow the standard config chain, stopping at the first source that yields a valid path:
33
+ 1. `deveco_studio_path` if provided (and not `--signed`).
34
+ 2. **OS environment variables** (`echo "$VAR"` on macOS/Linux; `$env:VAR` in PowerShell on Windows): `DEVECO_HOME` → parent of `DEVECO_SDK_HOME` → strip the trailing `/sdk/default/openharmony/ets` from `OHOS_SDK_PATH` (legacy).
35
+ 3. **`~/.hometrans/config.json`** — read `env.DEVECO_HOME`, else parent of `env.DEVECO_SDK_HOME` (written by `ht init`).
36
+ 4. **Ask the user** for the DevEco Studio install path (suggest running `ht init` to persist it as an environment variable).
37
+
38
+ **Verify the resolved `<deveco-path>`** contains:
39
+ - `tools/node/node.exe`
40
+ - `tools/hvigor/bin/hvigorw.js`
41
+ - `tools/ohpm/bin/ohpm`
42
+ - `sdk/` directory
43
+
44
+ If verification fails for an env-sourced path, treat that source as invalid and continue down the list; if it fails for a user-supplied path, report what is missing and ask again.
45
+
46
+ 3. **Set up `local.properties`** — Ensure the project root has `local.properties` with:
47
+ ```properties
48
+ hwsdk.dir=<deveco-path>/sdk
49
+ ```
50
+ Create it if missing. Use forward slashes in the path.
51
+
52
+ 4. **Run `ohpm install`** — Install dependencies before first build:
53
+ ```bash
54
+ cd "<project-dir>"
55
+ export PATH="<deveco-path>/tools/ohpm/bin:$PATH"
56
+ "<deveco-path>/tools/ohpm/bin/ohpm" install
57
+ ```
58
+
59
+ 5. **Determine Build Mode** — Check if any argument equals `--signed` (it may be `$ARGUMENTS[1]` when the DevEco path is omitted, or `$ARGUMENTS[2]` when it is provided):
60
+ - **If NOT `--signed`** → **Unsigned build mode**. Ensure `build-profile.json5` does NOT have `signingConfigs` or `signingConfig` references in products (remove them if present). Go to Step 1.
61
+ - **If `--signed`** → **Signed build mode**. Proceed to Step 0.5 to validate signing config.
62
+
63
+ ---
64
+
65
+ ## Step 0.5: Validate Signing Config (Only for --signed Builds)
66
+
67
+ This step is ONLY executed when `--signed` is specified.
68
+
69
+ Signing information is read directly from the project's own `build-profile.json5`. The user must have already configured signing in DevEco Studio before running this skill.
70
+
71
+ ### Steps:
72
+
73
+ 1. **Read `build-profile.json5`** in the project root.
74
+
75
+ 2. **Check for `signingConfigs`** — Look for `app.signingConfigs` array in the file.
76
+ - If `signingConfigs` exists and has at least one entry with valid `material` fields (`certpath`, `storeFile`, `profile`), proceed to step 3.
77
+ - If `signingConfigs` is missing or empty, **STOP and report to the user**:
78
+ > Signing configuration not found in `build-profile.json5`.
79
+ > Please open the project in DevEco Studio, go to **File → Project Structure → Signing Configs**, enable **Automatically generate signature**, then re-run this skill with `--signed`.
80
+
81
+ 3. **Validate signing material files exist** — For the first entry in `signingConfigs`, check that the files referenced by `material.certpath`, `material.storeFile`, and `material.profile` actually exist on disk.
82
+ - If any file is missing, **STOP and report** which files are missing. Suggest the user re-open DevEco Studio and re-generate the signing config.
83
+
84
+ 4. **Ensure product references signing** — Check that the product entry in `products` array has `"signingConfig": "default"` (or matching the signing config name). Add it if missing.
85
+
86
+ 5. Proceed to Step 1.
87
+
88
+ ---
89
+
90
+ ## Step 1: Build-Fix Loop
91
+
92
+ Execute the following loop. **Maximum 20 iterations** to prevent infinite loops.
93
+
94
+ ### 1.1 Run CLI Build
95
+
96
+ **IMPORTANT (Windows)**: On Windows, bash `export PATH` does NOT propagate to Windows native child processes. You **must** use a temporary `.bat` file to set `PATH` and `JAVA_HOME`.
97
+
98
+ 1. **Write a temporary batch file** (e.g. `<project-dir>/build_temp.bat`):
99
+
100
+ **For unsigned builds** (no `--signed`):
101
+ ```bat
102
+ @echo off
103
+ set "DEVECO_SDK_HOME=<deveco-path>\sdk"
104
+ cd /d "<project-dir>"
105
+ "<deveco-path>\tools\node\node.exe" "<deveco-path>\tools\hvigor\bin\hvigorw.js" assembleHap --mode module -p module=entry --no-daemon
106
+ ```
107
+
108
+ **For signed builds** (`--signed`):
109
+ ```bat
110
+ @echo off
111
+ set "PATH=<deveco-path>\jbr\bin;%PATH%"
112
+ set "JAVA_HOME=<deveco-path>\jbr"
113
+ set "DEVECO_SDK_HOME=<deveco-path>\sdk"
114
+ cd /d "<project-dir>"
115
+ "<deveco-path>\tools\node\node.exe" "<deveco-path>\tools\hvigor\bin\hvigorw.js" assembleHap --mode module -p module=entry --no-daemon
116
+ ```
117
+ Note: Signed builds need `JAVA_HOME` and `jbr\bin` in PATH because the `SignHap` step spawns `java` as a child process.
118
+
119
+ Use backslashes (`\`) in paths inside the `.bat` file (Windows convention).
120
+
121
+ 2. **Run the batch file** via `cmd.exe`:
122
+ ```bash
123
+ cmd.exe //c "<project-dir>/build_temp.bat" 2>&1
124
+ ```
125
+
126
+ 3. **Delete the batch file** after the build completes (success or failure).
127
+
128
+ - Capture the **full output** into a variable.
129
+ - The build command may take 1-3 minutes. Use a timeout of 300000ms (5 minutes).
130
+
131
+ ### 1.2 Check Build Result
132
+
133
+ - If output contains `BUILD SUCCESSFUL` → **Build succeeded!** Exit the loop, go to Step 2.
134
+ - If output contains `ERROR` or `BUILD FAILED` → Parse errors and continue to 1.3.
135
+
136
+ ### 1.3 Parse Errors
137
+
138
+ Extract error information from the build output. Errors typically appear in these formats:
139
+
140
+ ```
141
+ ERROR: <file-path>:<line>:<col> - <error-code>: <message>
142
+ ```
143
+
144
+ or
145
+
146
+ ```
147
+ ArkTS:ERROR File: <file-path>:<line>:<col>
148
+ <error message>
149
+ ```
150
+
151
+ Group errors by file. Focus on **actual errors**, not warnings.
152
+
153
+ ### 1.4 Fix Errors
154
+
155
+ Read each file that has errors and apply fixes. Use the error reference table below to identify and fix common issues:
156
+
157
+ | Error Code / Pattern | Message | Fix |
158
+ |---|---|---|
159
+ | `arkts-limited-throw` | "throw statements cannot accept values of arbitrary types" | Change `throw err` to `throw (err instanceof Error) ? err : new Error(String(err))` |
160
+ | `arkts-no-obj-literals-as-types` | "Object literals cannot be used as type declarations" | Define a named `interface` instead of inline `{ key: Type }` |
161
+ | `arkts-no-untyped-obj-literals` | "Object literal must correspond to some explicitly declared class or interface" | Assign to typed variable: `const r: MyInterface = {...}; return r;` |
162
+ | `arkts-no-any-type` / `any` type usage | "Use explicit types instead of any" | Replace `any` with the correct concrete type or `object` |
163
+ | `arkts-no-var` | "Use 'let' or 'const' instead of 'var'" | Replace `var` with `let` or `const` |
164
+ | `10903329` | "Unknown resource name 'xxx'" | Verify resource exists in `resources/base/media/` or `element/*.json`. Use `layered_image` as fallback for missing images. **Special case**: `$r('sys.media.ohos_ic_public_xxx')` references system icons by SDK-specific names that may not exist in the build SDK — replace with `$r('app.media.ic_public_xxx')` and add the icon file to `resources/base/media/` |
165
+ | `10505001` | "Resource[] is not assignable to ResourceColor" | Remove array brackets: `.fontColor($r('app.color.x'))` not `.fontColor([$r('app.color.x')])` |
166
+ | `00303221` | "permission must be a value that is predefined within the SDK" | Remove invalid permission from `module.json5`. See valid permissions list below |
167
+ | Missing import | "Cannot find name 'xxx'" | Add the correct import (see import reference below) |
168
+ | Missing `async` | "await expression requires async function" | Add `async` to the enclosing function |
169
+ | Missing `build()` | "@Component must have build() method" | Add a `build() {}` method to the @Component struct |
170
+ | Type mismatch | Various type errors | Fix the type annotation or cast appropriately |
171
+ | Duplicate identifier | "Duplicate identifier 'xxx'" | Remove or rename the duplicate declaration |
172
+
173
+ **For errors NOT in the table above**: Read the error message carefully, read the relevant source file, understand the context, and apply an appropriate fix. Use your knowledge of ArkTS/HarmonyOS to determine the correct solution.
174
+
175
+ ### 1.5 Log Progress
176
+
177
+ After each fix iteration, briefly report:
178
+ - Iteration number
179
+ - Number of errors found
180
+ - Summary of fixes applied
181
+ - Whether re-building
182
+
183
+ Then go back to **1.1** and rebuild.
184
+
185
+ ---
186
+
187
+ ## Step 2: Build Success Report
188
+
189
+ When the build succeeds, present a summary:
190
+
191
+ 1. **Build Status**: SUCCESS
192
+ 2. **Build Type**: Signed HAP or Unsigned HAP
193
+ 3. **Signing** (if signed): Confirm signing config from `build-profile.json5` was used
194
+ 4. **Iterations**: How many build-fix cycles were needed
195
+ 5. **Total Errors Fixed**: Count of errors fixed across all iterations
196
+ 6. **Summary of Changes**: List of files modified and what was fixed in each
197
+ 7. **Output HAP Path**:
198
+ - Signed: `<project>/entry/build/default/outputs/default/entry-default-signed.hap`
199
+ - Unsigned: `<project>/entry/build/default/outputs/default/entry-default-unsigned.hap`
200
+
201
+ ---
202
+
203
+ ## Reference: Common HarmonyOS Imports
204
+
205
+ ```typescript
206
+ // Network
207
+ import { http } from '@kit.NetworkKit';
208
+
209
+ // Data persistence
210
+ import { preferences } from '@kit.ArkData';
211
+ import { relationalStore } from '@kit.ArkData';
212
+
213
+ // UI utilities
214
+ import { router } from '@kit.ArkUI';
215
+ import { promptAction } from '@kit.ArkUI';
216
+
217
+ // Ability & Context
218
+ import { UIAbility, AbilityConstant, Want } from '@kit.AbilityKit';
219
+ import { common } from '@kit.AbilityKit';
220
+
221
+ // File I/O
222
+ import { fileIo } from '@kit.CoreFileKit';
223
+
224
+ // Logging
225
+ import { hilog } from '@kit.PerformanceAnalysisKit';
226
+
227
+ // JSON parsing — built-in, no import needed
228
+ // ArkUI built-in components (Text, Column, Row, List, Button, Image, etc.) — NO import needed
229
+ ```
230
+
231
+ ## Reference: Valid Permission Names
232
+
233
+ Commonly used SDK-validated permissions for `module.json5`:
234
+
235
+ - `ohos.permission.INTERNET`
236
+ - `ohos.permission.GET_NETWORK_INFO`
237
+ - `ohos.permission.GET_WIFI_INFO`
238
+ - `ohos.permission.KEEP_BACKGROUND_RUNNING`
239
+ - `ohos.permission.PUBLISH_AGENT_REMINDER`
240
+ - `ohos.permission.CAMERA`
241
+ - `ohos.permission.MICROPHONE`
242
+ - `ohos.permission.APPROXIMATELY_LOCATION`
243
+ - `ohos.permission.LOCATION`
244
+ - `ohos.permission.READ_MEDIA`
245
+ - `ohos.permission.WRITE_MEDIA`
246
+ - `ohos.permission.USE_BLUETOOTH`
247
+ - `ohos.permission.VIBRATE`
248
+
249
+ **Note**: `ohos.permission.NOTIFICATION` does NOT exist. When in doubt, omit the permission.
250
+
251
+ ## Reference: ArkTS Strict Mode Rules
252
+
253
+ All code must comply with ArkTS strict mode:
254
+
255
+ 1. **No `any` type** — Use explicit types or `object`
256
+ 2. **No `var`** — Only `let` and `const`
257
+ 3. **No dynamic property access** — Use typed interfaces instead of `obj['key']` on typed objects
258
+ 4. **`throw` must throw Error instances** — Never `throw 'string'` or `throw unknownVar`
259
+ 5. **All object literals must match declared interfaces** — No anonymous `{ key: val }` returns without a matching interface
260
+ 6. **No inline object literal types** — `function(): { a: string }` is forbidden; define a named `interface`
261
+ 7. **All `@Component` structs must have `build()`** — Missing build method is a compile error
262
+ 8. **`$r()` resource references validated at compile time** — All referenced resources must exist
263
+ 9. **`fontColor()` expects `ResourceColor`**, not `Resource[]` — Don't wrap in array brackets (exception: `SymbolGlyph`)
264
+ 10. **Permission names in `module.json5`** — Must be SDK-predefined values
265
+
266
+ ## Important Notes
267
+
268
+ - **Timeout**: Individual build commands may take up to 5 minutes. Use a 300000ms timeout.
269
+ - **Max iterations**: Stop after 20 iterations to prevent infinite loops. If build still fails after 20 attempts, report the remaining errors to the user.
270
+ - **Don't over-fix**: Only fix errors reported by the compiler. Don't proactively refactor unrelated code.
271
+ - **Read before edit**: Always read a file before modifying it. Understand the surrounding context.
272
+ - **One error can cause many**: A single root-cause fix (like adding a missing interface) may resolve multiple reported errors. After fixing root causes, rebuild to see remaining issues.
273
+ - **ohpm errors**: If the build fails because of missing packages, run `ohpm install` again.
274
+
275
+ ---
276
+
277
+ ## References
278
+
279
+ - `references/arkts-strict-patterns.md` — ArkTS 严格模式编译错误的确定性修复 Pattern(throw/any/var/interface 等)
280
+ - `references/known-patterns.md` — 已知常见编译错误 Pattern 及修复方案
281
+ - `references/rdb-entity-pattern.md` — RDB 实体类编译错误 Pattern(数据库实体相关)
@@ -0,0 +1,219 @@
1
+ # ArkTS 严格模式确定性修复 Pattern
2
+ # 适用于: ArkTS 严格模式编译错误
3
+ # 触发场景: 编译报错 arkts-no-xxx 系列
4
+ # 经验来源: EinkBro 迁移 (2026-03-26)
5
+
6
+ ---
7
+
8
+ ## Pattern 1: throw 语句
9
+
10
+ ### 错误写法
11
+ ```typescript
12
+ throw err; // ERROR: arkts-limited-throw
13
+ throw 'error string'; // ERROR: arkts-limited-throw
14
+ throw unknownVariable; // ERROR: arkts-limited-throw
15
+ ```
16
+
17
+ ### 正确写法
18
+ ```typescript
19
+ throw new Error(String(error));
20
+ ```
21
+
22
+ ### 不需要修改的情况
23
+ ```typescript
24
+ throw new Error('specific message'); // OK - 已经是 Error 实例
25
+ ```
26
+
27
+ ---
28
+
29
+ ## Pattern 2: 对象字面量作为参数 (arkts-no-untyped-obj-literals)
30
+
31
+ ### 错误写法
32
+ ```typescript
33
+ // ERROR: Object literal must correspond to some explicitly declared class or interface
34
+ const response = await this.sendRequest(url, { contents });
35
+ ```
36
+
37
+ ### 正确写法 — 先声明变量
38
+ ```typescript
39
+ interface GeminiRequestBody {
40
+ contents: GeminiContent[];
41
+ }
42
+
43
+ const requestBody: GeminiRequestBody = { contents };
44
+ const response = await this.sendRequest(url, requestBody);
45
+ ```
46
+
47
+ ### 内联参数场景
48
+ ```typescript
49
+ // 方法参数也是对象字面量,同样需要处理
50
+ httpRequest.request(url, {
51
+ method: http.RequestMethod.POST,
52
+ header: { 'Content-Type': 'application/json' },
53
+ extraData: JSON.stringify(body),
54
+ connectTimeout: 30000,
55
+ readTimeout: 30000
56
+ });
57
+ // ^ 这种场景 SDK 方法签名本身接受 object 类型,通常 OK
58
+ // 但自定义方法调用时必须用已声明接口的变量
59
+ ```
60
+
61
+ ---
62
+
63
+ ## Pattern 3: Margin vertical 简写不支持
64
+
65
+ ### 错误写法
66
+ ```typescript
67
+ .margin({ vertical: 8 }); // ERROR: 'vertical' does not exist in type
68
+ ```
69
+
70
+ ### 正确写法
71
+ ```typescript
72
+ .margin({ top: 8, bottom: 8 });
73
+ ```
74
+
75
+ ### 常见场景
76
+ | 错误 | 正确 |
77
+ |------|------|
78
+ | `.margin({ vertical: 8 })` | `.margin({ top: 8, bottom: 8 })` |
79
+ | `.margin({ horizontal: 16 })` | `.margin({ left: 16, right: 16 })` |
80
+
81
+ ---
82
+
83
+ ## Pattern 4: List 内不能直接放 Divider
84
+
85
+ ### 错误写法
86
+ ```typescript
87
+ List() {
88
+ ForEach(items, (item) => {
89
+ ListItem() { /* ... */ }
90
+ })
91
+ Divider() // ERROR: List children must be ListItem only
92
+ }
93
+ ```
94
+
95
+ ### 正确写法 — 用 ListItem + border
96
+ ```typescript
97
+ List() {
98
+ ForEach(items, (item) => {
99
+ ListItem() {
100
+ Column() {
101
+ Text(item.name)
102
+ }
103
+ .width('100%')
104
+ .padding(12)
105
+ .border({ width: { bottom: 1 }, color: '#E0E0E0' }) // 替代 Divider 分隔线
106
+ }
107
+ })
108
+ }
109
+ ```
110
+
111
+ ### 另一种方案 — border 直接在 ListItem 上
112
+ ```typescript
113
+ ListItem() {
114
+ // content
115
+ }
116
+ .border({ width: { bottom: 1 }, color: '#E0E0E0' })
117
+ ```
118
+
119
+ ---
120
+
121
+ ## Pattern 5: 数组字面量类型推断 (arkts-no-noninferrable-arr-literals)
122
+
123
+ ### 错误写法
124
+ ```typescript
125
+ const arr = [1, 2, 3].map(x => ({ val: x }));
126
+ // ERROR: Array literals must contain elements of only inferrable types
127
+ ```
128
+
129
+ ### 正确写法 — 显式类型
130
+ ```typescript
131
+ interface Item { val: number; }
132
+ const arr: Item[] = [1, 2, 3].map((x): Item => ({ val: x }));
133
+ ```
134
+
135
+ ---
136
+
137
+ ## Pattern 6: TextDecoder 不存在
138
+
139
+ ### 错误写法
140
+ ```typescript
141
+ const decoder = new TextDecoder(); // ERROR: Cannot find name 'TextDecoder'
142
+ const str = decoder.decode(data);
143
+ ```
144
+
145
+ ### 正确写法
146
+ ```typescript
147
+ const bytes = new Uint8Array(data);
148
+ let chunk = '';
149
+ for (let i = 0; i < bytes.length; i++) {
150
+ chunk += String.fromCharCode(bytes[i]);
151
+ }
152
+ ```
153
+
154
+ ---
155
+
156
+ ## Pattern 7: HTTP 组件事件名
157
+
158
+ | 错误事件 | 正确事件 | 说明 |
159
+ |---------|---------|------|
160
+ | `request.on('requestEnd', ...)` | `request.on('dataEnd', ...)` | 请求结束事件 |
161
+ | `request.on('error', ...)` | 改用 Promise 的 catch | HTTP 组件 error 事件签名不标准 |
162
+
163
+ ---
164
+
165
+ ## Pattern 8: GeminiService 等自定义类缺少成员
166
+
167
+ ### 错误场景
168
+ ```typescript
169
+ class GeminiService {
170
+ private async sendRequest(url: string, body: object): Promise<Object> {
171
+ httpRequest.request(url, { extraData: JSON.stringify(body),
172
+ connectTimeout: this.timeout, // ERROR: Property 'timeout' does not exist
173
+ readTimeout: this.timeout
174
+ });
175
+ }
176
+ // timeout 属性忘记声明
177
+ }
178
+ ```
179
+
180
+ ### 正确 — 确保所有成员都在类体内声明
181
+ ```typescript
182
+ class GeminiService {
183
+ private timeout: number = 30000; // 在类体内声明
184
+ private async sendRequest(...) { ... }
185
+ }
186
+ ```
187
+
188
+ ---
189
+
190
+ ## Pattern 9: Button 不支持 emoji
191
+
192
+ ### 错误写法
193
+ ```typescript
194
+ Button('X') // 有时 emoji 渲染异常
195
+ Button('🗑')
196
+ ```
197
+
198
+ ### 正确写法
199
+ ```typescript
200
+ Button('Del') // 纯文本
201
+ Button('Copy')
202
+ Button('Back')
203
+ ```
204
+
205
+ ---
206
+
207
+ ## 快速检查清单
208
+
209
+ 遇到 ArkTS 编译错误时,按序检查:
210
+
211
+ 1. throw → `throw new Error(String(x))`
212
+ 2. 对象字面量作为参数 → 先赋值给显式类型变量
213
+ 3. any / unknown → `Object` + `as Function` / `as SomeType`
214
+ 4. // @ts-ignore → 禁止,必须用类型操作替代
215
+ 5. ValuesBucket → 普通对象字面量 `{}`
216
+ 6. margin { vertical } → `{ top, bottom }`
217
+ 7. List 内 Divider → ListItem + border
218
+ 8. TextDecoder → Uint8Array 遍历
219
+ 9. `new SomeType()` 报错 → 检查是否是 type alias 而非 class
@@ -0,0 +1,157 @@
1
+ # Known Compile Error Patterns
2
+
3
+ > **This file is auto-maintained by `a2h-retrospect`.**
4
+ > Manual edits are allowed but may be overwritten when retrospect detects updated patterns.
5
+ > Last updated: 2026-03-27
6
+
7
+ ---
8
+
9
+ ## Pattern Index
10
+
11
+ | # | Error Code / Type | Frequency | Short Description |
12
+ |---|-------------------|-----------|-------------------|
13
+ | 1 | arkts-identifiers-as-prop-names | 85 | ValuesBucket computed property name |
14
+ | 2 | type mismatch (EventData) | 16 | EventData double type cast |
15
+ | 3 | arkts-no-untyped-obj-literals | 9 | Untyped object literal |
16
+ | 4 | type mismatch (promptAction) | 8 | promptAction button color type |
17
+ | 5 | type error (@Prop) | 3 | @Prop naming conflict |
18
+
19
+ ---
20
+
21
+ ## 1. ValuesBucket Computed Property Name
22
+
23
+ - **Date**: 2026-03-27
24
+ - **Error code**: `arkts-identifiers-as-prop-names`
25
+ - **Frequency**: 85 occurrences
26
+ - **Source**: AntennaPod V1 migration (a2h-retrospect-report-2026-03-27)
27
+
28
+ **Error code**:
29
+ ```typescript
30
+ const bucket: ValuesBucket = {
31
+ [ColumnName.TITLE]: title, // ERROR: computed property name not allowed
32
+ [ColumnName.URL]: url,
33
+ };
34
+ ```
35
+
36
+ **Correct code**:
37
+ ```typescript
38
+ const bucket: ValuesBucket = {};
39
+ bucket[ColumnName.TITLE] = title;
40
+ bucket[ColumnName.URL] = url;
41
+ ```
42
+
43
+ **Rule**: ArkTS forbids computed property names (`[expr]: value`) in object literals. Build the object first, then assign properties via bracket notation.
44
+
45
+ ---
46
+
47
+ ## 2. EventData Double Type Cast
48
+
49
+ - **Date**: 2026-03-27
50
+ - **Error code**: type mismatch
51
+ - **Frequency**: 16 occurrences
52
+ - **Source**: AntennaPod V1 migration (a2h-retrospect-report-2026-03-27)
53
+
54
+ **Error code**:
55
+ ```typescript
56
+ emitter.on({ eventId: 1 }, (data: emitter.EventData) => {
57
+ const value = data.data?.['key'] as string; // ERROR: data.data is optional Record, direct cast fails
58
+ });
59
+ ```
60
+
61
+ **Correct code**:
62
+ ```typescript
63
+ emitter.on({ eventId: 1 }, (data: emitter.EventData) => {
64
+ const raw = data.data as Record<string, Object>;
65
+ const value = raw['key'] as string;
66
+ });
67
+ ```
68
+
69
+ **Rule**: `EventData.data` is typed `Record<string, Object> | undefined`. Access requires two steps: (1) cast to `Record<string, Object>`, (2) cast the extracted value to the target type.
70
+
71
+ ---
72
+
73
+ ## 3. Untyped Object Literal
74
+
75
+ - **Date**: 2026-03-27
76
+ - **Error code**: `arkts-no-untyped-obj-literals`
77
+ - **Frequency**: 9 occurrences
78
+ - **Source**: AntennaPod V1 migration (a2h-retrospect-report-2026-03-27)
79
+
80
+ **Error code**:
81
+ ```typescript
82
+ const options = {
83
+ title: 'Hello',
84
+ message: 'World',
85
+ }; // ERROR: object literal without explicit type annotation
86
+ ```
87
+
88
+ **Correct code**:
89
+ ```typescript
90
+ interface DialogOptions {
91
+ title: string;
92
+ message: string;
93
+ }
94
+ const options: DialogOptions = {
95
+ title: 'Hello',
96
+ message: 'World',
97
+ };
98
+ ```
99
+
100
+ **Rule**: ArkTS requires all object literals to have an explicit type. Define an `interface` or `class` and annotate the variable.
101
+
102
+ ---
103
+
104
+ ## 4. promptAction Button Color Type
105
+
106
+ - **Date**: 2026-03-27
107
+ - **Error code**: type mismatch
108
+ - **Frequency**: 8 occurrences
109
+ - **Source**: AntennaPod V1 migration (a2h-retrospect-report-2026-03-27)
110
+
111
+ **Error code**:
112
+ ```typescript
113
+ promptAction.showDialog({
114
+ buttons: [
115
+ { text: 'OK', color: '#ff0000' } // ERROR: color expects ResourceColor, not string
116
+ ]
117
+ });
118
+ ```
119
+
120
+ **Correct code**:
121
+ ```typescript
122
+ promptAction.showDialog({
123
+ buttons: [
124
+ { text: 'OK', color: Color.Red }
125
+ ]
126
+ });
127
+ // Or use $r('app.color.xxx') for resource reference
128
+ ```
129
+
130
+ **Rule**: `promptAction.showDialog` button `color` property expects `ResourceColor` type (Color enum or `$r()` resource reference), not a raw hex string.
131
+
132
+ ---
133
+
134
+ ## 5. @Prop Naming Conflict
135
+
136
+ - **Date**: 2026-03-27
137
+ - **Error code**: type error
138
+ - **Frequency**: 3 occurrences
139
+ - **Source**: AntennaPod V1 migration (a2h-retrospect-report-2026-03-27)
140
+
141
+ **Error code**:
142
+ ```typescript
143
+ @Component
144
+ struct MyComponent {
145
+ @Prop title: string = ''; // ERROR: 'title' conflicts with built-in component property
146
+ }
147
+ ```
148
+
149
+ **Correct code**:
150
+ ```typescript
151
+ @Component
152
+ struct MyComponent {
153
+ @Prop itemTitle: string = ''; // Renamed to avoid conflict
154
+ }
155
+ ```
156
+
157
+ **Rule**: Certain property names (`title`, `content`, `action`, etc.) conflict with built-in component attributes. Prefix with a domain-specific qualifier (e.g., `itemTitle`, `feedTitle`).