@akanjs/devkit 3.0.0-beta.2 → 3.0.0-beta.21

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 (289) hide show
  1. package/README.ko.md +2 -2
  2. package/README.md +3 -2
  3. package/abstractDoc.test.ts +6 -15
  4. package/abstractDoc.ts +6 -8
  5. package/agentsIndex.test.ts +4 -7
  6. package/agentsIndex.ts +6 -22
  7. package/akanApp/BackendImportGraph.test.ts +8 -22
  8. package/akanApp/BackendImportGraph.ts +1 -20
  9. package/akanApp/akanApp.host.test.ts +1 -3
  10. package/akanApp/akanApp.host.ts +82 -254
  11. package/akanApp/devHostPolicy.test.ts +10 -34
  12. package/akanApp/devHostPolicy.ts +12 -98
  13. package/akanConfig/akanConfig.test.ts +142 -106
  14. package/akanConfig/akanConfig.ts +147 -191
  15. package/akanConfig/types.ts +4 -3
  16. package/akanContext.ts +110 -160
  17. package/akanMcpContract.ts +28 -73
  18. package/appSelectionMemory.ts +1 -4
  19. package/applicationBuildReporter.ts +37 -5
  20. package/applicationBuildRunner.test.ts +5 -3
  21. package/applicationBuildRunner.ts +54 -61
  22. package/applicationTestPreload.ts +3 -12
  23. package/artifact/implicitRootLayout.test.ts +32 -30
  24. package/artifact/implicitRootLayout.ts +58 -106
  25. package/artifact/routeSeedIndex.test.ts +7 -6
  26. package/artifact/routeSeedIndex.ts +11 -44
  27. package/biome.base.json +32 -1
  28. package/biomeBase.ts +2 -5
  29. package/cloud/cloudApi.test.ts +202 -0
  30. package/cloud/cloudApi.ts +77 -39
  31. package/cloud/configLock.test.ts +64 -0
  32. package/cloud/configLock.ts +96 -0
  33. package/cloud/constants.ts +26 -5
  34. package/cloud/globalConfig.ts +70 -32
  35. package/codeAgent/agent/AkanCodeServices.ts +97 -0
  36. package/codeAgent/agent/AkanContextFiles.ts +94 -0
  37. package/codeAgent/agent/CodeAgent.ts +551 -0
  38. package/codeAgent/agent/CodeAgentAsks.ts +66 -0
  39. package/codeAgent/agent/CodeAgentEventMapper.ts +225 -0
  40. package/codeAgent/agent/CodeAgentGate.ts +93 -0
  41. package/codeAgent/agent/CodeAgentProxy.ts +82 -0
  42. package/codeAgent/agent/CodeAgentRpcHost.ts +103 -0
  43. package/codeAgent/agent/CodeAgentRpcListener.ts +109 -0
  44. package/codeAgent/agent/CodeAgentStreamPrinter.ts +86 -0
  45. package/codeAgent/agent/CodeAgentSuspended.ts +85 -0
  46. package/codeAgent/agent/CodeAgentUi.ts +47 -0
  47. package/codeAgent/agent/CodeMailbox.ts +148 -0
  48. package/codeAgent/agent/CodeSessionFork.ts +56 -0
  49. package/codeAgent/agent/CodeSessionIndex.ts +78 -0
  50. package/codeAgent/agent/SubagentPool.ts +214 -0
  51. package/codeAgent/agent/akanCodeModel.ts +47 -0
  52. package/codeAgent/agent/akanCodePaths.ts +31 -0
  53. package/codeAgent/agent/akanContextFiles.test.ts +114 -0
  54. package/codeAgent/agent/akanSystemPrompt.ts +46 -0
  55. package/codeAgent/agent/codeAgent.test.ts +178 -0
  56. package/codeAgent/agent/codeAgentContract.test.ts +523 -0
  57. package/codeAgent/agent/codeAgentProxy.test.ts +74 -0
  58. package/codeAgent/agent/codeAgentRpcListener.test.ts +113 -0
  59. package/codeAgent/agent/codeAgentSuspended.test.ts +47 -0
  60. package/codeAgent/agent/codeMailbox.test.ts +76 -0
  61. package/codeAgent/agent/codeSessionFork.test.ts +58 -0
  62. package/codeAgent/agent/codeSessionIndex.test.ts +77 -0
  63. package/codeAgent/agent/consoleToStderr.ts +8 -0
  64. package/codeAgent/agent/jsonLines.ts +29 -0
  65. package/codeAgent/agent/stringArg.ts +5 -0
  66. package/codeAgent/feedback/DevLogFeedback.ts +82 -0
  67. package/codeAgent/feedback/PreviewChrome.ts +82 -0
  68. package/codeAgent/feedback/PreviewFeedback.ts +46 -0
  69. package/codeAgent/feedback/PreviewView.ts +95 -0
  70. package/codeAgent/feedback/TurnFeedback.ts +98 -0
  71. package/codeAgent/feedback/VerifyFeedback.ts +40 -0
  72. package/codeAgent/feedback/previewChrome.test.ts +73 -0
  73. package/codeAgent/index.ts +34 -0
  74. package/codeAgent/skills/akan-code/SKILL.md +130 -0
  75. package/codeAgent/skills/akan-debug/SKILL.md +42 -0
  76. package/codeAgent/skills/akan-deps/SKILL.md +50 -0
  77. package/codeAgent/skills/akan-err/SKILL.md +39 -0
  78. package/codeAgent/skills/akan-module/SKILL.md +45 -0
  79. package/codeAgent/skills/akan-scaffold/SKILL.md +76 -0
  80. package/codeAgent/skills/akan-scalar/SKILL.md +52 -0
  81. package/codeAgent/skills/akan-service/SKILL.md +34 -0
  82. package/codeAgent/skills/akan-store/SKILL.md +67 -0
  83. package/codeAgent/skills/akan-ui/SKILL.md +63 -0
  84. package/codeAgent/skills/akan-validate/SKILL.md +44 -0
  85. package/codeAgent/tools/AkanCli.ts +50 -0
  86. package/codeAgent/tools/AkanCodePlugins.ts +136 -0
  87. package/codeAgent/tools/AkanEditScope.ts +48 -0
  88. package/codeAgent/tools/AkanEnvKeys.ts +50 -0
  89. package/codeAgent/tools/AkanToolPack.ts +92 -0
  90. package/codeAgent/tools/AkanVerifier.ts +48 -0
  91. package/codeAgent/tools/AskToolPack.ts +99 -0
  92. package/codeAgent/tools/MailToolPack.ts +76 -0
  93. package/codeAgent/tools/McpClient.ts +187 -0
  94. package/codeAgent/tools/McpOAuth.ts +233 -0
  95. package/codeAgent/tools/McpOAuthLoopback.ts +64 -0
  96. package/codeAgent/tools/McpServerConfig.ts +129 -0
  97. package/codeAgent/tools/McpSignIn.ts +158 -0
  98. package/codeAgent/tools/McpTokenStore.ts +81 -0
  99. package/codeAgent/tools/McpToolPack.ts +199 -0
  100. package/codeAgent/tools/SessionToolPack.ts +91 -0
  101. package/codeAgent/tools/WebToolPack.ts +147 -0
  102. package/codeAgent/tools/akanCodePlugins.test.ts +677 -0
  103. package/codeAgent/tools/askToolPack.test.ts +116 -0
  104. package/codeAgent/tools/mcpOAuth.test.ts +612 -0
  105. package/codeAgent/tools/mcpServerConfig.test.ts +212 -0
  106. package/codegenLock.test.ts +4 -13
  107. package/codegenLock.ts +3 -17
  108. package/commandDecorators/argMeta.ts +1 -5
  109. package/commandDecorators/camelToKebabCase.ts +1 -0
  110. package/commandDecorators/command.ts +46 -102
  111. package/commandDecorators/commandBuilder.ts +30 -61
  112. package/commandDecorators/commandDecorators.test.ts +2 -10
  113. package/commandDecorators/dependencyBuilder.ts +10 -1
  114. package/commandDecorators/helpFormatter.ts +68 -145
  115. package/commandDecorators/index.ts +0 -2
  116. package/commandDecorators/targetMeta.ts +9 -7
  117. package/createTunnel.ts +7 -14
  118. package/dependencyScanner.test.ts +4 -16
  119. package/dependencyScanner.ts +31 -80
  120. package/devkitUtils.test.ts +48 -20
  121. package/executors.linkFallback.test.ts +103 -0
  122. package/executors.test.ts +132 -106
  123. package/executors.ts +195 -496
  124. package/fileEditor.ts +9 -37
  125. package/{getDirname.test.ts → fileSys.test.ts} +5 -3
  126. package/fileSys.ts +6 -8
  127. package/formSetterScanner.ts +3 -16
  128. package/frontendBuild/allRoutesBuilder.ts +7 -21
  129. package/frontendBuild/autoImportSync.test.ts +27 -38
  130. package/frontendBuild/autoImportSync.ts +31 -65
  131. package/frontendBuild/buildRouteClient.test.ts +62 -37
  132. package/frontendBuild/bundleDefine.ts +12 -0
  133. package/frontendBuild/clientBuildTypes.ts +5 -36
  134. package/frontendBuild/clientEntriesBundler.ts +9 -40
  135. package/frontendBuild/clientEntryDiscovery.ts +6 -41
  136. package/frontendBuild/csrArtifactBuilder.ts +6 -25
  137. package/frontendBuild/cssCandidateCache.test.ts +0 -6
  138. package/frontendBuild/cssCandidateCache.ts +6 -41
  139. package/frontendBuild/cssCompiler.ts +29 -78
  140. package/frontendBuild/cssImportResolver.ts +6 -19
  141. package/frontendBuild/devChangePlanner.ts +7 -10
  142. package/frontendBuild/devGeneratedIndexSync.test.ts +12 -27
  143. package/frontendBuild/devGeneratedIndexSync.ts +1 -4
  144. package/frontendBuild/fontOptimizer.test.ts +6 -14
  145. package/frontendBuild/fontOptimizer.ts +15 -72
  146. package/frontendBuild/fontPruner.test.ts +5 -10
  147. package/frontendBuild/fontPruner.ts +5 -20
  148. package/frontendBuild/frontendBuild.test.ts +46 -69
  149. package/frontendBuild/hmrChangeClassifier.ts +2 -2
  150. package/frontendBuild/hmrWatcher.test.ts +8 -32
  151. package/frontendBuild/hmrWatcher.ts +14 -71
  152. package/frontendBuild/pagesBundleBuilder.ts +4 -29
  153. package/frontendBuild/precompressArtifacts.ts +5 -18
  154. package/frontendBuild/routeClientBuilder.ts +23 -46
  155. package/frontendBuild/routesManifestArtifactSerializer.ts +5 -36
  156. package/frontendBuild/sourceMtimeIndex.test.ts +41 -97
  157. package/frontendBuild/sourceMtimeIndex.ts +19 -130
  158. package/frontendBuild/ssrBaseArtifactBuilder.ts +2 -8
  159. package/frontendBuild/styleContract.ts +1 -8
  160. package/frontendBuild/themeValidator.ts +4 -26
  161. package/frontendBuild/watchRootResolver.test.ts +23 -42
  162. package/frontendBuild/watchRootResolver.ts +5 -27
  163. package/getRelatedCnsts.ts +12 -92
  164. package/incrementalBuilder/buildBatch.proc.ts +29 -58
  165. package/incrementalBuilder/buildBatchProtocol.ts +8 -36
  166. package/incrementalBuilder/buildBatchRunner.test.ts +34 -0
  167. package/incrementalBuilder/buildBatchRunner.ts +10 -31
  168. package/incrementalBuilder/builderChannel.test.ts +24 -49
  169. package/incrementalBuilder/builderChannel.ts +6 -37
  170. package/incrementalBuilder/builderRequestRouter.test.ts +0 -8
  171. package/incrementalBuilder/builderRequestRouter.ts +5 -24
  172. package/incrementalBuilder/devWatchBatch.test.ts +21 -24
  173. package/incrementalBuilder/incrementalBuilder.host.test.ts +18 -55
  174. package/incrementalBuilder/incrementalBuilder.host.ts +18 -76
  175. package/incrementalBuilder/incrementalBuilder.proc.test.ts +81 -0
  176. package/incrementalBuilder/incrementalBuilder.proc.ts +49 -161
  177. package/index.ts +5 -19
  178. package/integration/devResourceProbe.ts +50 -56
  179. package/integration/devStability.integration.test.ts +47 -194
  180. package/integration/devStabilityHarness.test.ts +13 -28
  181. package/integration/devStabilityHarness.ts +65 -330
  182. package/integration/ssrMemoryProbe.ts +41 -167
  183. package/libSource.test.ts +4 -15
  184. package/libSource.ts +19 -31
  185. package/lint/__fixtures__/no-document-cookie/bad.tsx +4 -0
  186. package/lint/__fixtures__/no-document-cookie/good.tsx +7 -0
  187. package/lint/__fixtures__/no-web-only-api-outside-webkit/bad.tsx +7 -0
  188. package/lint/__fixtures__/no-web-only-api-outside-webkit/good.tsx +11 -0
  189. package/lint/__fixtures__/no-web-storage/bad.tsx +6 -0
  190. package/lint/__fixtures__/no-web-storage/good.tsx +7 -0
  191. package/lint/gritRules.test.ts +8 -24
  192. package/lint/no-deep-internal-import.grit +2 -2
  193. package/lint/no-document-cookie.grit +29 -0
  194. package/lint/no-redeclare-predefined-endpoint.grit +2 -1
  195. package/lint/no-web-only-api-outside-webkit.grit +44 -0
  196. package/lint/no-web-storage.grit +30 -0
  197. package/linter.test.ts +1 -2
  198. package/linter.ts +26 -116
  199. package/mobile/index.ts +6 -0
  200. package/mobile/mobileTarget.ts +16 -13
  201. package/mobile/nativeApi.test.ts +30 -0
  202. package/mobile/nativeApi.ts +40 -0
  203. package/mobile/nativeApp.test.ts +85 -0
  204. package/mobile/nativeApp.ts +210 -0
  205. package/mobile/nativeConfig.test.ts +199 -0
  206. package/mobile/nativeConfig.ts +184 -0
  207. package/mobile/nativeWebDir.test.ts +80 -0
  208. package/mobile/nativeWebDir.ts +62 -0
  209. package/mobile/placeholderAppId.test.ts +13 -0
  210. package/mobile/placeholderAppId.ts +16 -0
  211. package/mobile/usageDescriptions.test.ts +27 -0
  212. package/mobile/usageDescriptions.ts +24 -0
  213. package/package.json +10 -10
  214. package/packageExports.test.ts +3 -18
  215. package/packageExportsMap.ts +3 -19
  216. package/piDependencyPins.test.ts +46 -0
  217. package/platformTest/BunTestReport.test.ts +60 -0
  218. package/platformTest/BunTestReport.ts +65 -0
  219. package/platformTest/IdleWatchedProcess.test.ts +56 -0
  220. package/platformTest/IdleWatchedProcess.ts +73 -0
  221. package/platformTest/LinuxDockerTarget.ts +105 -0
  222. package/platformTest/PlatformTestRun.test.ts +64 -0
  223. package/platformTest/PlatformTestRun.ts +141 -0
  224. package/platformTest/PlatformTestTarget.ts +142 -0
  225. package/platformTest/TestSnapshot.test.ts +72 -0
  226. package/platformTest/TestSnapshot.ts +103 -0
  227. package/platformTest/WindowsSshTarget.ts +151 -0
  228. package/prompter.ts +3 -13
  229. package/qualityScanner.test.ts +9 -26
  230. package/qualityScanner.ts +200 -286
  231. package/recipeScanner.test.ts +7 -12
  232. package/recipeScanner.ts +9 -38
  233. package/repoIdentity.ts +2 -9
  234. package/routeSourceValidator.test.ts +0 -1
  235. package/routeSourceValidator.ts +7 -42
  236. package/scanInfo.ts +91 -225
  237. package/selectModel.ts +1 -2
  238. package/semver.ts +3 -5
  239. package/slicePlanner.test.ts +6 -24
  240. package/slicePlanner.ts +11 -32
  241. package/spinner.test.ts +3 -8
  242. package/spinner.ts +4 -16
  243. package/sshTunnel.ts +1 -6
  244. package/ssrScanner.test.ts +1 -6
  245. package/ssrScanner.ts +103 -113
  246. package/stripAnsi.ts +3 -0
  247. package/subspace.test.ts +30 -25
  248. package/subspace.ts +81 -115
  249. package/subspaceConfig.ts +11 -9
  250. package/testHelpers.ts +194 -0
  251. package/transforms/asyncDefaultExportDetector.ts +3 -11
  252. package/transforms/barrelAnalyzer.ts +43 -135
  253. package/transforms/barrelImportsPlugin.ts +38 -175
  254. package/transforms/externalizeFrameworkPlugin.test.ts +39 -118
  255. package/transforms/externalizeFrameworkPlugin.ts +13 -87
  256. package/transforms/moduleSyntax.ts +32 -0
  257. package/transforms/rscUseClientTransform.ts +35 -20
  258. package/transforms/transforms.test.ts +153 -44
  259. package/transforms/tsconfigPackageResolver.test.ts +6 -24
  260. package/transforms/useClientBundlePlugin.ts +2 -22
  261. package/typeChecker.ts +7 -63
  262. package/types.ts +1 -0
  263. package/uploadRelease.ts +10 -25
  264. package/workflow/artifacts.ts +18 -0
  265. package/workflow/executor.test.ts +1 -12
  266. package/workflow/executor.ts +101 -110
  267. package/workflow/index.ts +0 -1
  268. package/workflow/moduleIndex.test.ts +4 -15
  269. package/workflow/moduleIndex.ts +9 -49
  270. package/workflow/plan.ts +18 -25
  271. package/workflow/render.ts +80 -96
  272. package/workflow/rolloutGate.test.ts +1 -1
  273. package/workflow/source.ts +52 -69
  274. package/workflow/sourceAst.ts +50 -0
  275. package/workspaceLayout.test.ts +13 -3
  276. package/workspaceLayout.ts +20 -23
  277. package/abstractCompactor.ts +0 -112
  278. package/aiEditor.test.ts +0 -60
  279. package/aiEditor.ts +0 -387
  280. package/applicationReleasePackager.ts +0 -209
  281. package/capacitorApp.test.ts +0 -372
  282. package/capacitorApp.ts +0 -1648
  283. package/commandDecorators/commandMeta.ts +0 -7
  284. package/commandDecorators/types.ts +0 -10
  285. package/getDirname.ts +0 -4
  286. package/guideline.ts +0 -19
  287. package/local/optimize-resource/ipcprobe/child.ts +0 -1
  288. package/local/optimize-resource/ipcprobe/parent.ts +0 -11
  289. package/workflow/primitive.ts +0 -59
@@ -0,0 +1,44 @@
1
+ engine biome(1.0)
2
+ language js(typescript, jsx)
3
+
4
+ // Browser APIs a native shell's WebView lacks: Android's WebView has no Web Share, an app:// page on iOS has no
5
+ // service worker, no WebView has the Notification API, and iOS has no vibration. They stay legal on the web, so the
6
+ // rule does not ban them — it keeps them in `webkit/`, the layer whose hooks branch on the platform (and is
7
+ // excluded from this rule's scope in biome.base.json), and names the native side where one exists.
8
+ //
9
+ // Pinned to member access, so JSX text naming an API does not match; `Notification` only through its static entry
10
+ // points, because the name is also the libs/shared model (`Notification.View`, `cnst.Notification`).
11
+ or {
12
+ JsStaticMemberExpression() as $access where {
13
+ $access <: or { `navigator.share`, `navigator.canShare` },
14
+ register_diagnostic(
15
+ span = $access,
16
+ message = "Android's WebView has no Web Share, so this does nothing in the app. Move it into a `webkit/` hook that branches on `isNativeApp()` from `akanjs/client/native`; the runtime's `share` plugin is the app side.",
17
+ severity = "warn"
18
+ )
19
+ },
20
+ JsStaticMemberExpression() as $access where {
21
+ $access <: or { `navigator.serviceWorker`, `Notification.requestPermission`, `Notification.permission` },
22
+ register_diagnostic(
23
+ span = $access,
24
+ message = "A native app page has no service worker or Notification API. Keep this in a `webkit/` hook behind `isNativeApp()`; native push is `push` from `akanjs/client/native`, and `usePushNotification` in libs/util wraps both.",
25
+ severity = "warn"
26
+ )
27
+ },
28
+ JsStaticMemberExpression() as $access where {
29
+ $access <: `navigator.geolocation`,
30
+ register_diagnostic(
31
+ span = $access,
32
+ message = "`navigator.geolocation` skips the app's location plugin and its permission flow. Use `useGeoLocation` from `akanjs/webkit`.",
33
+ severity = "warn"
34
+ )
35
+ },
36
+ JsStaticMemberExpression() as $access where {
37
+ $access <: `navigator.vibrate`,
38
+ register_diagnostic(
39
+ span = $access,
40
+ message = "iOS has no `navigator.vibrate`. Use `haptics` from `akanjs/client/native` in a `webkit/` hook.",
41
+ severity = "warn"
42
+ )
43
+ }
44
+ }
@@ -0,0 +1,30 @@
1
+ engine biome(1.0)
2
+ language js(typescript, jsx)
3
+
4
+ // Web Storage works inside the native shells, so this is not about a crash: akanjs/client's `storage` is where the
5
+ // backend is chosen per platform (the shell's Preferences — UserDefaults, SharedPreferences, a JSON file on the
6
+ // desktop — in an app, localStorage on the web), `secretStorage` keeps credentials in the Keychain/Keystore and
7
+ // clears them on a reinstall, and both answer nothing on the server where a bare `localStorage` read during SSR
8
+ // throws.
9
+ //
10
+ // Only the global is matched — a reference, or a member of window/globalThis/self — pinned to those node kinds: a
11
+ // bare snippet matches the name in any position, a field, an object key or JSX text included.
12
+ or {
13
+ JsIdentifierExpression() as $access where {
14
+ $access <: or { `localStorage`, `sessionStorage` },
15
+ register_diagnostic(
16
+ span = $access,
17
+ message = "Web Storage bypasses the store akanjs picks per platform (the shell's Preferences in an app) and throws during SSR. Use `storage` from `akanjs/client`, or `secretStorage` for tokens and credentials; a value that may be lost with the tab belongs in component state or the store.",
18
+ severity = "error"
19
+ )
20
+ },
21
+ JsStaticMemberExpression(object = $root, member = $name) as $access where {
22
+ $root <: or { `window`, `globalThis`, `self` },
23
+ $name <: or { `localStorage`, `sessionStorage` },
24
+ register_diagnostic(
25
+ span = $access,
26
+ message = "Web Storage bypasses the store akanjs picks per platform (the shell's Preferences in an app) and throws during SSR. Use `storage` from `akanjs/client`, or `secretStorage` for tokens and credentials; a value that may be lost with the tab belongs in component state or the store.",
27
+ severity = "error"
28
+ )
29
+ }
30
+ }
package/linter.test.ts CHANGED
@@ -27,8 +27,7 @@ describe("parseBiomeReport", () => {
27
27
  });
28
28
 
29
29
  test("reads a report behind leading text that carries a brace", () => {
30
- // The whole reason the first-brace-to-last-brace slice was wrong: Biome prints configuration and IO
31
- // diagnostics onto the same stream as the report, and those messages quote source and config.
30
+ // Biome prints configuration and IO diagnostics onto the report's stream, and they quote source and config.
32
31
  const output = [
33
32
  "configuration/deserialize: unknown key `overrides[0].includes { }`",
34
33
  " the file `biome.jsonc` cannot be read",
package/linter.ts CHANGED
@@ -58,16 +58,8 @@ interface LintResponse {
58
58
  warnings: LintMessage[];
59
59
  }
60
60
 
61
- /**
62
- * Extracts the `--reporter=json` report from Biome's output.
63
- *
64
- * Biome mixes configuration and IO diagnostics into the same stream as the report, so the output is not
65
- * always JSON alone. Slicing from the first `{` to the last `}` mis-parses as soon as that leading text
66
- * carries a brace of its own, which is not hypothetical: a config error printed ahead of the report made
67
- * one unchanged command alternate between 2 and 10 diagnostics. So every `{` is tried as a start, its
68
- * match is found by depth while string literals are skipped, and the first candidate that both parses and
69
- * carries a report field wins — a brace in prose parses as nothing, and `{"a":1}` in prose is not a report.
70
- */
61
+ // Biome mixes config and IO diagnostics into the report stream, and that text can carry braces of its own, so every
62
+ // `{` is tried as a start (string literals skipped) and the first candidate that parses and carries a report field wins.
71
63
  export const parseBiomeReport = (output: string): BiomeReport => {
72
64
  for (let start = output.indexOf("{"); start !== -1; start = output.indexOf("{", start + 1)) {
73
65
  const end = objectEndAt(output, start);
@@ -111,7 +103,19 @@ const asBiomeReport = (candidate: string): BiomeReport | null => {
111
103
  /** Biome reads `biome.json` first and `biome.jsonc` second; only the latter may carry comments. */
112
104
  const BIOME_CONFIG_FILES = ["biome.json", "biome.jsonc"] as const;
113
105
 
106
+ const emptyResult = (filePath: string): LintResult => ({
107
+ filePath,
108
+ messages: [],
109
+ errorCount: 0,
110
+ warningCount: 0,
111
+ fixableErrorCount: 0,
112
+ fixableWarningCount: 0,
113
+ });
114
+
114
115
  export class Linter {
116
+ //? Bun links a package bin as `<name>.exe` (plus a `.bunx` stub) on Windows, and a bare `<name>` elsewhere.
117
+ static readonly biomeBinName = process.platform === "win32" ? "biome.exe" : "biome";
118
+
115
119
  lintRoot: string;
116
120
  configPath: string;
117
121
  #biomeBin: string;
@@ -119,7 +123,7 @@ export class Linter {
119
123
  constructor(cwdPath: string) {
120
124
  this.lintRoot = this.#findBiomeRootPath(cwdPath);
121
125
  this.configPath = Linter.#configPathIn(this.lintRoot) ?? path.join(this.lintRoot, "biome.json");
122
- const localBiomeBin = path.join(this.lintRoot, "node_modules/.bin/biome");
126
+ const localBiomeBin = path.join(this.lintRoot, "node_modules", ".bin", Linter.biomeBinName);
123
127
  this.#biomeBin = existsSync(localBiomeBin) ? localBiomeBin : "biome";
124
128
  }
125
129
 
@@ -199,16 +203,7 @@ export class Linter {
199
203
  for (const diagnostic of report.diagnostics ?? []) {
200
204
  if (diagnostic.severity !== "error" && diagnostic.severity !== "warning") continue;
201
205
  const diagnosticFilePath = this.#diagnosticFilePath(diagnostic, filePath);
202
- const result =
203
- resultsByPath.get(diagnosticFilePath) ??
204
- ({
205
- filePath: diagnosticFilePath,
206
- messages: [],
207
- errorCount: 0,
208
- warningCount: 0,
209
- fixableErrorCount: 0,
210
- fixableWarningCount: 0,
211
- } satisfies LintResult);
206
+ const result = resultsByPath.get(diagnosticFilePath) ?? emptyResult(diagnosticFilePath);
212
207
  const message = this.#createLintMessage(diagnostic);
213
208
  result.messages.push(message);
214
209
  if (message.severity === 2) result.errorCount += 1;
@@ -217,15 +212,7 @@ export class Linter {
217
212
  }
218
213
 
219
214
  return [
220
- resultsByPath.get(filePath) ??
221
- ({
222
- filePath,
223
- messages: [],
224
- errorCount: 0,
225
- warningCount: 0,
226
- fixableErrorCount: 0,
227
- fixableWarningCount: 0,
228
- } satisfies LintResult),
215
+ resultsByPath.get(filePath) ?? emptyResult(filePath),
229
216
  ...[...resultsByPath.entries()].filter(([resultPath]) => resultPath !== filePath).map(([, result]) => result),
230
217
  ];
231
218
  }
@@ -269,22 +256,12 @@ export class Linter {
269
256
  return await this.lintFile(filePath);
270
257
  }
271
258
 
272
- /**
273
- * Lint a single file using Biome.
274
- * @param filePath - Path to the file to lint
275
- * @returns Array of Biome results in the legacy lint result shape
276
- */
277
259
  async lintFile(filePath: string): Promise<LintResponse> {
278
260
  const resolvedFilePath = this.#resolveFilePath(filePath);
279
261
  if (!existsSync(resolvedFilePath)) throw new Error(`File not found: ${filePath}`);
280
262
  return await this.#checkFile(resolvedFilePath);
281
263
  }
282
264
 
283
- /**
284
- * Format lint results for console output
285
- * @param results - Array of Biome results
286
- * @returns Formatted string
287
- */
288
265
  formatLintResults(results: LintResult[]): string {
289
266
  if (results.length === 0) return "No files to lint";
290
267
 
@@ -305,7 +282,7 @@ export class Linter {
305
282
  const sourceContent = readFileSync(result.filePath, "utf8");
306
283
  sourceLines = sourceContent.split("\n");
307
284
  } catch {
308
- // Ignore read errors
285
+ //? An unreadable source only loses its code frame.
309
286
  }
310
287
  }
311
288
 
@@ -318,14 +295,12 @@ export class Linter {
318
295
  output.push(`\n ${icon} ${typeColor(type)}: ${message.message}${ruleInfo}`);
319
296
  output.push(` ${chalk.gray("at")} ${result.filePath}:${chalk.bold(`${message.line}:${message.column}`)}`);
320
297
 
321
- // Show source line with underline
322
298
  if (sourceLines.length > 0 && message.line <= sourceLines.length) {
323
299
  const sourceLine = sourceLines[message.line - 1];
324
300
  const lineNumber = message.line.toString().padStart(5, " ");
325
301
 
326
302
  output.push(`\n${chalk.dim(`${lineNumber} |`)} ${sourceLine}`);
327
303
 
328
- // Create underline
329
304
  const underlinePrefix = " ".repeat(message.column - 1);
330
305
  const underlineLength = message.endColumn ? message.endColumn - message.column : 1;
331
306
  const underline = "^".repeat(Math.max(1, underlineLength));
@@ -345,27 +320,7 @@ export class Linter {
345
320
  return summary.concat(output).join("\n");
346
321
  }
347
322
 
348
- /**
349
- * Get detailed lint information
350
- * @param filePath - Path to the file to lint
351
- * @returns Object containing detailed lint information
352
- */
353
- async getDetailedLintInfo(filePath: string): Promise<{
354
- results: LintResult[];
355
- details: {
356
- line: number;
357
- column: number;
358
- message: string;
359
- ruleId: string | null;
360
- severity: "error" | "warning";
361
- }[];
362
- stats: {
363
- errorCount: number;
364
- warningCount: number;
365
- fixableErrorCount: number;
366
- fixableWarningCount: number;
367
- };
368
- }> {
323
+ async getDetailedLintInfo(filePath: string) {
369
324
  const { results } = await this.lintFile(filePath);
370
325
 
371
326
  const details = results.flatMap((result) =>
@@ -385,22 +340,13 @@ export class Linter {
385
340
  fixableErrorCount: acc.fixableErrorCount + result.fixableErrorCount,
386
341
  fixableWarningCount: acc.fixableWarningCount + result.fixableWarningCount,
387
342
  }),
388
- {
389
- errorCount: 0,
390
- warningCount: 0,
391
- fixableErrorCount: 0,
392
- fixableWarningCount: 0,
393
- },
343
+ { errorCount: 0, warningCount: 0, fixableErrorCount: 0, fixableWarningCount: 0 },
394
344
  );
395
345
 
396
346
  return { results, details, stats };
397
347
  }
398
348
 
399
- /**
400
- * Check if a file has lint errors
401
- * @param filePath - Path to the file to check
402
- * @returns true if there are no errors, false otherwise
403
- */
349
+ /** Also false when the file cannot be linted at all. */
404
350
  async hasNoLintErrors(filePath: string): Promise<boolean> {
405
351
  try {
406
352
  const { results } = await this.lintFile(filePath);
@@ -410,32 +356,17 @@ export class Linter {
410
356
  }
411
357
  }
412
358
 
413
- /**
414
- * Get only error messages (excluding warnings)
415
- * @param filePath - Path to the file to lint
416
- * @returns Array of error messages
417
- */
418
359
  async getErrors(filePath: string): Promise<LintMessage[]> {
419
360
  const { results } = await this.lintFile(filePath);
420
361
  return results.flatMap((result) => result.messages.filter((message) => message.severity === 2));
421
362
  }
422
363
 
423
- /**
424
- * Get only warning messages
425
- * @param filePath - Path to the file to lint
426
- * @returns Array of warning messages
427
- */
428
364
  async getWarnings(filePath: string): Promise<LintMessage[]> {
429
365
  const { results } = await this.lintFile(filePath);
430
366
  return results.flatMap((result) => result.messages.filter((message) => message.severity === 1));
431
367
  }
432
368
 
433
- /**
434
- * Fix lint errors automatically
435
- * @param filePath - Path to the file to fix
436
- * @param dryRun - If true, returns the fixed content without writing to file
437
- * @returns Fixed content and remaining issues
438
- */
369
+ /** `dryRun` returns the fixed content in `output` without writing the file. */
439
370
  async fixFile(filePath: string, dryRun = false): Promise<LintResponse> {
440
371
  const resolvedFilePath = this.#resolveFilePath(filePath);
441
372
  if (!existsSync(resolvedFilePath)) throw new Error(`File not found: ${filePath}`);
@@ -451,19 +382,8 @@ export class Linter {
451
382
  return { ...lintResult, fixed: stdout !== source, output: stdout };
452
383
  }
453
384
 
454
- /**
455
- * Get Biome configuration for a file
456
- * @param filePath - Path to the file
457
- * @returns Biome configuration object
458
- */
459
- /**
460
- * Applies Biome's safe fixes to many files in one process.
461
- *
462
- * One spawn, not one per file: Biome's startup dominates a small file, so the per-file path turns a
463
- * fifteen-file scaffold into three seconds of process launches. Paths that do not exist are dropped
464
- * rather than thrown on, because the caller is usually reporting what a template just wrote and a
465
- * template is allowed to decline a file.
466
- */
385
+ // One spawn for all files: Biome's startup dominates a small file. Missing paths are dropped (a template may
386
+ // decline a file).
467
387
  async fixFiles(filePaths: string[]): Promise<{ fixed: string[] }> {
468
388
  const resolved = filePaths.map((filePath) => this.#resolveFilePath(filePath)).filter(existsSync);
469
389
  if (resolved.length === 0) return { fixed: [] };
@@ -489,21 +409,11 @@ export class Linter {
489
409
  return JSON.parse(readFileSync(this.configPath, "utf8")) as unknown;
490
410
  }
491
411
 
492
- /**
493
- * Get rules that are causing errors in a file
494
- * @param filePath - Path to the file to check
495
- * @returns Object mapping rule IDs to their error counts
496
- */
497
412
  async getProblematicRules(filePath: string): Promise<Record<string, number>> {
498
413
  const { results } = await this.lintFile(filePath);
499
414
  const ruleCounts: Record<string, number> = {};
500
-
501
- results.forEach((result) => {
502
- result.messages.forEach((message) => {
503
- if (message.ruleId) ruleCounts[message.ruleId] = (ruleCounts[message.ruleId] || 0) + 1;
504
- });
505
- });
506
-
415
+ for (const message of results.flatMap((result) => result.messages))
416
+ if (message.ruleId) ruleCounts[message.ruleId] = (ruleCounts[message.ruleId] || 0) + 1;
507
417
  return ruleCounts;
508
418
  }
509
419
  }
package/mobile/index.ts CHANGED
@@ -1 +1,7 @@
1
1
  export * from "./mobileTarget";
2
+ export * from "./nativeApi";
3
+ export * from "./nativeApp";
4
+ export * from "./nativeConfig";
5
+ export * from "./nativeWebDir";
6
+ export * from "./placeholderAppId";
7
+ export * from "./usageDescriptions";
@@ -2,6 +2,8 @@ import type { AkanMobileTargetConfig, MobileEnv } from "../akanConfig";
2
2
  import type { App } from "../commandDecorators";
3
3
 
4
4
  export type MobilePlatform = "ios" | "android";
5
+ export type DesktopPlatform = "macos" | "windows" | "linux";
6
+ export type NativePlatform = MobilePlatform | DesktopPlatform;
5
7
  export type MobileTargetSelection = string | "all" | undefined;
6
8
 
7
9
  export interface ResolvedMobileTarget {
@@ -11,6 +13,8 @@ export interface ResolvedMobileTarget {
11
13
 
12
14
  export const MOBILE_ENVS = ["local", "debug", "develop", "main"] as const satisfies readonly MobileEnv[];
13
15
 
16
+ const trimSlashes = (value: string) => value.replace(/^\/+|\/+$/g, "");
17
+
14
18
  export const getMobileTargets = async (app: App): Promise<ResolvedMobileTarget[]> => {
15
19
  const config = await app.getConfig();
16
20
  return Object.entries(config.mobile.targets).map(([name, target]) => ({ name, config: target }));
@@ -20,26 +24,23 @@ export const getMobileTargetChoices = async (app: App): Promise<string[]> => {
20
24
  const config = await app.getConfig();
21
25
  const targetNames = Object.keys(config.mobile.targets);
22
26
  if (targetNames.length > 0) return targetNames;
23
- const basePaths = [...config.basePaths];
24
- return basePaths;
27
+ return [...config.basePaths];
25
28
  };
26
29
 
27
30
  const resolveMobileTargetByBasePath = (
28
31
  targets: ResolvedMobileTarget[],
29
32
  basePath: string,
30
33
  ): ResolvedMobileTarget | undefined => {
31
- const normalizedBasePath = basePath.replace(/^\/+|\/+$/g, "");
32
- const byBasePath = targets.find((target) => target.config.basePath?.replace(/^\/+|\/+$/g, "") === normalizedBasePath);
34
+ const normalizedBasePath = trimSlashes(basePath);
35
+ const byBasePath = targets.find(
36
+ ({ config }) => config.basePath !== undefined && trimSlashes(config.basePath) === normalizedBasePath,
37
+ );
33
38
  if (byBasePath) return byBasePath;
34
39
  const [template] = targets;
35
40
  if (!template) return undefined;
36
41
  return {
37
42
  name: normalizedBasePath,
38
- config: {
39
- ...template.config,
40
- name: normalizedBasePath,
41
- basePath: normalizedBasePath,
42
- },
43
+ config: { ...template.config, name: normalizedBasePath, basePath: normalizedBasePath },
43
44
  };
44
45
  };
45
46
 
@@ -70,18 +71,20 @@ export const resolveMobileTargets = async (
70
71
  const target = targets.find((candidate) => candidate.name === selection);
71
72
  if (target) return [target];
72
73
  const basePathTarget = resolveMobileTargetByBasePath(targets, selection);
73
- if (basePathTarget && config.basePaths.has(selection.replace(/^\/+|\/+$/g, ""))) return [basePathTarget];
74
+ if (basePathTarget && config.basePaths.has(trimSlashes(selection))) return [basePathTarget];
74
75
  const choices = await getMobileTargetChoices(app);
75
76
  throw new Error(`Mobile target '${selection}' was not found. Available: ${choices.join(", ")}`);
76
77
  };
77
78
 
78
79
  export const resolveMobilePath = (target: AkanMobileTargetConfig, pathname: string) => {
79
- const basePath = target.basePath?.replace(/^\/+|\/+$/g, "");
80
+ const basePath = trimSlashes(target.basePath ?? "");
80
81
  const normalizedPath = `/${pathname.replace(/^\/+/, "")}`;
81
82
  if (!basePath) return normalizedPath;
82
83
  if (normalizedPath === `/${basePath}` || normalizedPath.startsWith(`/${basePath}/`)) return normalizedPath;
83
84
  return `/${basePath}${normalizedPath === "/" ? "" : normalizedPath}`;
84
85
  };
85
86
 
86
- export const targetHtmlFilename = (target: AkanMobileTargetConfig) =>
87
- target.basePath?.replace(/^\/+|\/+$/g, "") ? `${target.basePath.replace(/^\/+|\/+$/g, "")}.html` : "index.html";
87
+ export const targetHtmlFilename = (target: AkanMobileTargetConfig) => {
88
+ const basePath = trimSlashes(target.basePath ?? "");
89
+ return basePath ? `${basePath}.html` : "index.html";
90
+ };
@@ -0,0 +1,30 @@
1
+ import { describe, expect, test } from "bun:test";
2
+ import { mkdir, realpath, writeFile } from "node:fs/promises";
3
+ import path from "node:path";
4
+ import { tempDirs } from "../testHelpers";
5
+ import { NativeApi } from "./nativeApi";
6
+
7
+ const makeTempRoot = tempDirs("akan-native-api-");
8
+ const repoApp = path.resolve(import.meta.dir, "../../../../apps/minimal");
9
+
10
+ describe("NativeApi", () => {
11
+ test("inside this repo, loads the workspace package and checks its major", async () => {
12
+ expect(NativeApi.entryOf(repoApp)).toBe(path.resolve(import.meta.dir, "../../native/packages/cli/src/api.ts"));
13
+ const api = await NativeApi.load(repoApp);
14
+ expect(api.API_VERSION.split(".")[0]).toBe(String(NativeApi.supportedMajor));
15
+ });
16
+
17
+ test("elsewhere, looks for the copy akanjs vendors, and says so when it is missing", async () => {
18
+ const root = await realpath(await makeTempRoot());
19
+ await mkdir(path.join(root, "node_modules/akanjs"), { recursive: true });
20
+ await writeFile(
21
+ path.join(root, "node_modules/akanjs/package.json"),
22
+ JSON.stringify({ name: "akanjs", exports: { "./package.json": "./package.json" } }),
23
+ );
24
+
25
+ expect(NativeApi.entryOf(root)).toBe(
26
+ path.join(root, "node_modules/akanjs/vendor/@akanjs/native/packages/cli/src/api.ts"),
27
+ );
28
+ await expect(NativeApi.load(root)).rejects.toThrow("The installed akanjs has no native build");
29
+ });
30
+ });
@@ -0,0 +1,40 @@
1
+ import path from "node:path";
2
+ import type * as NativeBuildApi from "@akanjs/native/api";
3
+
4
+ export type NativeBuildApiModule = typeof NativeBuildApi;
5
+
6
+ export class NativeApi {
7
+ //* The build API versions itself; a major this devkit was not written against is refused before anything builds.
8
+ static readonly supportedMajor = 0;
9
+
10
+ /** The API of the akanjs the app installed: the workspace package inside this repo, akanjs's vendored copy elsewhere. */
11
+ static entryOf(appDir: string): string {
12
+ const workspaceEntry = NativeApi.#resolve("@akanjs/native/api", appDir);
13
+ if (workspaceEntry) return workspaceEntry;
14
+ const akanjsPackage = NativeApi.#resolve("akanjs/package.json", appDir);
15
+ if (!akanjsPackage) throw new Error(`akanjs is not installed for ${appDir}; the native build ships inside it.`);
16
+ return path.join(path.dirname(akanjsPackage), "vendor", "@akanjs", "native", "packages", "cli", "src", "api.ts");
17
+ }
18
+
19
+ static async load(appDir: string): Promise<NativeBuildApiModule> {
20
+ const entry = NativeApi.entryOf(appDir);
21
+ if (!(await Bun.file(entry).exists()))
22
+ throw new Error(`The installed akanjs has no native build at ${entry}; update akanjs.`);
23
+ const api = (await import(entry)) as NativeBuildApiModule;
24
+ const major = Number(api.API_VERSION.split(".")[0]);
25
+ if (major !== NativeApi.supportedMajor)
26
+ throw new Error(
27
+ `The native build API is ${api.API_VERSION}, and this akan CLI speaks ${NativeApi.supportedMajor}.x; install matching versions of akanjs and @akanjs/cli.`,
28
+ );
29
+ return api;
30
+ }
31
+
32
+ static #resolve(specifier: string, from: string) {
33
+ try {
34
+ return Bun.resolveSync(specifier, from);
35
+ } catch {
36
+ // Not installed where the app can reach it, which the caller answers with the next place to look.
37
+ return null;
38
+ }
39
+ }
40
+ }
@@ -0,0 +1,85 @@
1
+ import { describe, expect, test } from "bun:test";
2
+ import path from "node:path";
3
+ import type { AkanPlugin } from "akanjs";
4
+ import type { AkanMobileTargetConfig } from "../akanConfig";
5
+ import type { App } from "../commandDecorators";
6
+ import { NativeApp } from "./nativeApp";
7
+ import { NativeConfig } from "./nativeConfig";
8
+
9
+ const target = (config: Partial<AkanMobileTargetConfig> = {}) => ({
10
+ name: config.name ?? "default",
11
+ config: {
12
+ name: config.name ?? "default",
13
+ appName: "Portal",
14
+ appId: "com.portal.app",
15
+ version: "1.0.0",
16
+ buildNum: 1,
17
+ ...config,
18
+ },
19
+ });
20
+
21
+ const appDir = "/repo/apps/portal";
22
+
23
+ const fakeApp = (plugins: AkanPlugin[] = []) =>
24
+ ({
25
+ cwdPath: appDir,
26
+ dist: { cwdPath: "/repo/dist/apps/portal" },
27
+ getConfig: async () => ({ i18n: { locales: ["en", "ko"] }, api: { prefix: "/api", websocketPrefix: "/ws" } }),
28
+ collectPlugins: async () => plugins,
29
+ logger: { warn: () => undefined },
30
+ }) as unknown as App;
31
+
32
+ describe("NativeApp", () => {
33
+ test("keeps each target's web root and each platform's output apart", () => {
34
+ const admin = new NativeApp(fakeApp(), target({ name: "admin", basePath: "admin" }));
35
+
36
+ expect(admin.web.dir).toBe(path.join(appDir, ".akan/mobile/admin/web"));
37
+ expect(admin.outDir("ios")).toBe(path.join(appDir, ".akan/mobile/admin/native/ios"));
38
+ expect(admin.outDir("android")).toBe(path.join(appDir, ".akan/mobile/admin/native/android"));
39
+ });
40
+
41
+ test("opens a dev build on its target's home, the CSR shell under the locale", () => {
42
+ expect(new NativeApp(fakeApp(), target({ indexPath: "/explore" })).startPath("en")).toBe(
43
+ "/en/explore?csr=true&akanMobileTarget=default&akanMobileIndexPath=%2Fexplore",
44
+ );
45
+ expect(new NativeApp(fakeApp(), target({ name: "admin", basePath: "/admin/" })).startPath("ko")).toBe(
46
+ "/ko/admin?csr=true&akanMobileTarget=admin&akanMobileBasePath=admin",
47
+ );
48
+ });
49
+
50
+ test("builds its config from the app's locales and the plugins' native contributions", async () => {
51
+ const push: AkanPlugin = { name: "push-notification", native: { permission: "push", plugins: ["push"] } };
52
+ const app = new NativeApp(
53
+ fakeApp([push, { name: "other" }]),
54
+ target({ basePath: undefined, permissions: ["push"] }),
55
+ );
56
+
57
+ const { config, warnings } = await app.config();
58
+
59
+ expect(warnings).toEqual([]);
60
+ expect(config.plugins).toEqual([...NativeConfig.basePlugins, "push"]);
61
+ expect(config.web.dir).toBe(path.join(appDir, ".akan/mobile/default/web"));
62
+ });
63
+
64
+ test("a desktop app is this computer's platform", () => {
65
+ expect(["darwin", "win32", "linux"].map((host) => NativeApp.desktopPlatform(host as NodeJS.Platform))).toEqual([
66
+ "macos",
67
+ "windows",
68
+ "linux",
69
+ ]);
70
+ expect(() => NativeApp.desktopPlatform("freebsd")).toThrow("A desktop app builds on macOS, Windows or Linux");
71
+ });
72
+
73
+ test("signs an Android release with the upload key the environment names, and says which part is missing", () => {
74
+ expect(
75
+ NativeApp.androidSigning({
76
+ MYAPP_RELEASE_STORE_FILE: "keys/upload.jks",
77
+ MYAPP_RELEASE_STORE_PASSWORD: "store",
78
+ MYAPP_RELEASE_KEY_ALIAS: "upload",
79
+ }),
80
+ ).toEqual({ keystore: "keys/upload.jks", storePassword: "store", alias: "upload" });
81
+ expect(() => NativeApp.androidSigning({ MYAPP_RELEASE_STORE_FILE: "keys/upload.jks" })).toThrow(
82
+ "set MYAPP_RELEASE_STORE_PASSWORD, MYAPP_RELEASE_KEY_ALIAS in the environment",
83
+ );
84
+ });
85
+ });