codeply-cli 0.3.1 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (375) hide show
  1. package/THIRD_PARTY_NOTICES.md +63 -63
  2. package/bin/codeply.js +127 -0
  3. package/lib/agent.mjs +2139 -2139
  4. package/lib/ai.mjs +6 -6
  5. package/lib/apply-patch.js +217 -217
  6. package/lib/arity-table.json +138 -138
  7. package/lib/arity.js +70 -70
  8. package/lib/auth.mjs +6 -6
  9. package/lib/cloud.mjs +796 -0
  10. package/lib/commands.js +103 -103
  11. package/lib/design-library/assemble-artifact.mjs +21 -21
  12. package/lib/design-library/cleanup.mjs +45 -45
  13. package/lib/design-library/index.json +22379 -22379
  14. package/lib/design-library/make-table-data.mjs +39 -39
  15. package/lib/diagnostics.js +192 -192
  16. package/lib/edit-engine.js +364 -364
  17. package/lib/github-agent.mjs +311 -307
  18. package/lib/history.js +75 -75
  19. package/lib/mcp.js +258 -258
  20. package/lib/native-tools.mjs +189 -189
  21. package/lib/oauth-connectors.js +2 -1
  22. package/lib/permissions.js +109 -109
  23. package/lib/plugins.js +353 -353
  24. package/lib/server.mjs +457 -457
  25. package/lib/session-db.js +220 -220
  26. package/lib/share.js +168 -168
  27. package/lib/skills.js +416 -416
  28. package/lib/snapshot.js +146 -146
  29. package/lib/terminal-hints.js +154 -154
  30. package/lib/tools.mjs +2012 -2012
  31. package/lib/typecheck-worker.js +147 -147
  32. package/lib/web-tools.js +158 -158
  33. package/package.json +49 -47
  34. package/skills/SOURCE.md +58 -58
  35. package/skills/accessibility/SKILL.md +147 -147
  36. package/skills/agent-architecture-audit/SKILL.md +257 -257
  37. package/skills/agent-eval/SKILL.md +147 -147
  38. package/skills/agent-harness-construction/SKILL.md +74 -74
  39. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  40. package/skills/agent-payment-x402/SKILL.md +225 -225
  41. package/skills/agent-self-evaluation/SKILL.md +182 -182
  42. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  43. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  44. package/skills/agent-sort/SKILL.md +216 -216
  45. package/skills/agentic-engineering/SKILL.md +64 -64
  46. package/skills/agentic-os/SKILL.md +388 -388
  47. package/skills/ai-first-engineering/SKILL.md +52 -52
  48. package/skills/ai-regression-testing/SKILL.md +386 -386
  49. package/skills/android-clean-architecture/SKILL.md +340 -340
  50. package/skills/angular-developer/SKILL.md +155 -155
  51. package/skills/angular-developer/references/angular-animations.md +160 -160
  52. package/skills/angular-developer/references/angular-aria.md +410 -410
  53. package/skills/angular-developer/references/cli.md +86 -86
  54. package/skills/angular-developer/references/component-harnesses.md +59 -59
  55. package/skills/angular-developer/references/component-styling.md +91 -91
  56. package/skills/angular-developer/references/components.md +117 -117
  57. package/skills/angular-developer/references/creating-services.md +97 -97
  58. package/skills/angular-developer/references/data-resolvers.md +69 -69
  59. package/skills/angular-developer/references/define-routes.md +67 -67
  60. package/skills/angular-developer/references/defining-providers.md +72 -72
  61. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  62. package/skills/angular-developer/references/e2e-testing.md +56 -56
  63. package/skills/angular-developer/references/effects.md +83 -83
  64. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  65. package/skills/angular-developer/references/host-elements.md +80 -80
  66. package/skills/angular-developer/references/injection-context.md +63 -63
  67. package/skills/angular-developer/references/inputs.md +101 -101
  68. package/skills/angular-developer/references/linked-signal.md +59 -59
  69. package/skills/angular-developer/references/loading-strategies.md +61 -61
  70. package/skills/angular-developer/references/mcp.md +108 -108
  71. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  72. package/skills/angular-developer/references/outputs.md +86 -86
  73. package/skills/angular-developer/references/reactive-forms.md +122 -122
  74. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  75. package/skills/angular-developer/references/resource.md +77 -77
  76. package/skills/angular-developer/references/route-animations.md +56 -56
  77. package/skills/angular-developer/references/route-guards.md +52 -52
  78. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  79. package/skills/angular-developer/references/router-testing.md +87 -87
  80. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  81. package/skills/angular-developer/references/signal-forms.md +795 -795
  82. package/skills/angular-developer/references/signals-overview.md +94 -94
  83. package/skills/angular-developer/references/tailwind-css.md +69 -69
  84. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  85. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  86. package/skills/api-connector-builder/SKILL.md +121 -121
  87. package/skills/api-design/SKILL.md +524 -524
  88. package/skills/architecture-decision-records/SKILL.md +180 -180
  89. package/skills/article-writing/SKILL.md +80 -80
  90. package/skills/automation-audit-ops/SKILL.md +143 -143
  91. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  92. package/skills/autonomous-loops/SKILL.md +611 -611
  93. package/skills/backend-patterns/SKILL.md +562 -562
  94. package/skills/benchmark/SKILL.md +95 -95
  95. package/skills/benchmark-methodology/SKILL.md +191 -191
  96. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  97. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  98. package/skills/blueprint/SKILL.md +106 -106
  99. package/skills/brand-discovery/SKILL.md +145 -145
  100. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  101. package/skills/brand-discovery/references/20_positioning.md +44 -44
  102. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  103. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  104. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  105. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  106. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  107. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  108. package/skills/brand-voice/SKILL.md +98 -98
  109. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  110. package/skills/browser-qa/SKILL.md +105 -105
  111. package/skills/bun-runtime/SKILL.md +85 -85
  112. package/skills/canary-watch/SKILL.md +108 -108
  113. package/skills/carrier-relationship-management/SKILL.md +212 -212
  114. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  115. package/skills/ck/SKILL.md +148 -148
  116. package/skills/claude-devfleet/SKILL.md +112 -112
  117. package/skills/click-path-audit/SKILL.md +245 -245
  118. package/skills/clickhouse-io/SKILL.md +445 -445
  119. package/skills/code-tour/SKILL.md +254 -254
  120. package/skills/codebase-onboarding/SKILL.md +234 -234
  121. package/skills/codehealth-mcp/SKILL.md +167 -167
  122. package/skills/coding-standards/SKILL.md +551 -551
  123. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  124. package/skills/competitive-report-structure/SKILL.md +162 -162
  125. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  126. package/skills/config-gc/SKILL.md +120 -120
  127. package/skills/configure-ecc/SKILL.md +385 -385
  128. package/skills/connections-optimizer/SKILL.md +190 -190
  129. package/skills/content-engine/SKILL.md +132 -132
  130. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  131. package/skills/context-budget/SKILL.md +136 -136
  132. package/skills/continuous-agent-loop/SKILL.md +46 -46
  133. package/skills/continuous-learning/SKILL.md +132 -132
  134. package/skills/continuous-learning-v2/SKILL.md +361 -361
  135. package/skills/contract-first/SKILL.md +287 -287
  136. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  137. package/skills/cost-tracking/SKILL.md +97 -97
  138. package/skills/council/SKILL.md +204 -204
  139. package/skills/cpp-coding-standards/SKILL.md +724 -724
  140. package/skills/cpp-testing/SKILL.md +325 -325
  141. package/skills/crosspost/SKILL.md +112 -112
  142. package/skills/csharp-testing/SKILL.md +322 -322
  143. package/skills/customer-billing-ops/SKILL.md +141 -141
  144. package/skills/customs-trade-compliance/SKILL.md +263 -263
  145. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  146. package/skills/dashboard-builder/SKILL.md +109 -109
  147. package/skills/data-scraper-agent/SKILL.md +765 -765
  148. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  149. package/skills/database-migrations/SKILL.md +430 -430
  150. package/skills/deep-research/SKILL.md +160 -160
  151. package/skills/defi-amm-security/SKILL.md +167 -167
  152. package/skills/delivery-gate/SKILL.md +126 -126
  153. package/skills/deployment-patterns/SKILL.md +428 -428
  154. package/skills/design-system/SKILL.md +83 -83
  155. package/skills/django-celery/SKILL.md +458 -458
  156. package/skills/django-patterns/SKILL.md +735 -735
  157. package/skills/django-security/SKILL.md +644 -644
  158. package/skills/django-tdd/SKILL.md +730 -730
  159. package/skills/django-verification/SKILL.md +470 -470
  160. package/skills/dmux-workflows/SKILL.md +192 -192
  161. package/skills/docker-patterns/SKILL.md +365 -365
  162. package/skills/documentation-lookup/SKILL.md +91 -91
  163. package/skills/dotnet-patterns/SKILL.md +322 -322
  164. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  165. package/skills/e2e-testing/SKILL.md +327 -327
  166. package/skills/ecc-guide/SKILL.md +190 -190
  167. package/skills/ecc-recipes/SKILL.md +149 -149
  168. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  169. package/skills/email-ops/SKILL.md +122 -122
  170. package/skills/energy-procurement/SKILL.md +228 -228
  171. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  172. package/skills/error-handling/SKILL.md +377 -377
  173. package/skills/eval-harness/SKILL.md +271 -271
  174. package/skills/evm-token-decimals/SKILL.md +131 -131
  175. package/skills/exa-search/SKILL.md +108 -108
  176. package/skills/fal-ai-media/SKILL.md +289 -289
  177. package/skills/fastapi-patterns/SKILL.md +514 -514
  178. package/skills/finance-billing-ops/SKILL.md +128 -128
  179. package/skills/flox-environments/SKILL.md +497 -497
  180. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  181. package/skills/foundation-models-on-device/SKILL.md +243 -243
  182. package/skills/frontend-a11y/SKILL.md +446 -446
  183. package/skills/frontend-design-direction/SKILL.md +93 -93
  184. package/skills/frontend-patterns/SKILL.md +657 -657
  185. package/skills/frontend-slides/SKILL.md +185 -185
  186. package/skills/fsharp-testing/SKILL.md +281 -281
  187. package/skills/gan-style-harness/SKILL.md +279 -279
  188. package/skills/gateguard/SKILL.md +133 -133
  189. package/skills/generating-python-installer/SKILL.md +820 -820
  190. package/skills/git-workflow/SKILL.md +716 -716
  191. package/skills/github-ops/SKILL.md +145 -145
  192. package/skills/golang-patterns/SKILL.md +676 -676
  193. package/skills/golang-testing/SKILL.md +721 -721
  194. package/skills/google-workspace-ops/SKILL.md +96 -96
  195. package/skills/growth-log/SKILL.md +128 -128
  196. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  197. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  198. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  199. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  200. package/skills/hermes-imports/SKILL.md +89 -89
  201. package/skills/hexagonal-architecture/SKILL.md +277 -277
  202. package/skills/hipaa-compliance/SKILL.md +79 -79
  203. package/skills/homelab-network-readiness/SKILL.md +170 -170
  204. package/skills/homelab-network-setup/SKILL.md +130 -130
  205. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  206. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  207. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  208. package/skills/hookify-rules/SKILL.md +128 -128
  209. package/skills/inherit-legacy-style/SKILL.md +157 -157
  210. package/skills/intent-driven-development/SKILL.md +360 -360
  211. package/skills/inventory-demand-planning/SKILL.md +247 -247
  212. package/skills/investor-materials/SKILL.md +97 -97
  213. package/skills/investor-outreach/SKILL.md +92 -92
  214. package/skills/ios-icon-gen/SKILL.md +158 -158
  215. package/skills/iterative-retrieval/SKILL.md +212 -212
  216. package/skills/ito-basket-compare/SKILL.md +64 -64
  217. package/skills/ito-compute/SKILL.md +129 -129
  218. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  219. package/skills/ito-market-intelligence/SKILL.md +61 -61
  220. package/skills/ito-trade-planner/SKILL.md +68 -68
  221. package/skills/java-coding-standards/SKILL.md +384 -384
  222. package/skills/jira-integration/SKILL.md +303 -303
  223. package/skills/jpa-patterns/SKILL.md +152 -152
  224. package/skills/knowledge-ops/SKILL.md +155 -155
  225. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  226. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  227. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  228. package/skills/kotlin-patterns/SKILL.md +712 -712
  229. package/skills/kotlin-testing/SKILL.md +825 -825
  230. package/skills/kubernetes-patterns/SKILL.md +756 -756
  231. package/skills/laravel-patterns/SKILL.md +416 -416
  232. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  233. package/skills/laravel-security/SKILL.md +948 -948
  234. package/skills/laravel-tdd/SKILL.md +675 -675
  235. package/skills/laravel-verification/SKILL.md +180 -180
  236. package/skills/latency-critical-systems/SKILL.md +75 -75
  237. package/skills/lead-intelligence/SKILL.md +322 -322
  238. package/skills/liquid-glass-design/SKILL.md +279 -279
  239. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  240. package/skills/logistics-exception-management/SKILL.md +222 -222
  241. package/skills/loop-design-check/SKILL.md +143 -143
  242. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  243. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  244. package/skills/manim-video/SKILL.md +90 -90
  245. package/skills/market-research/SKILL.md +76 -76
  246. package/skills/marketing-campaign/SKILL.md +114 -114
  247. package/skills/mcp-server-patterns/SKILL.md +70 -70
  248. package/skills/messages-ops/SKILL.md +105 -105
  249. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  250. package/skills/mle-workflow/SKILL.md +348 -348
  251. package/skills/motion-advanced/SKILL.md +596 -596
  252. package/skills/motion-foundations/SKILL.md +299 -299
  253. package/skills/motion-patterns/SKILL.md +434 -434
  254. package/skills/motion-ui/SKILL.md +576 -576
  255. package/skills/mysql-patterns/SKILL.md +413 -413
  256. package/skills/nanoclaw-repl/SKILL.md +34 -34
  257. package/skills/nestjs-patterns/SKILL.md +231 -231
  258. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  259. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  260. package/skills/network-config-validation/SKILL.md +211 -211
  261. package/skills/network-interface-health/SKILL.md +153 -153
  262. package/skills/nextjs-turbopack/SKILL.md +58 -58
  263. package/skills/nodejs-keccak256/SKILL.md +103 -103
  264. package/skills/nutrient-document-processing/SKILL.md +168 -168
  265. package/skills/nuxt4-patterns/SKILL.md +101 -101
  266. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  267. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  268. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  269. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  270. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  271. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  272. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  273. package/skills/opensource-pipeline/SKILL.md +256 -256
  274. package/skills/orch-add-feature/SKILL.md +45 -45
  275. package/skills/orch-build-mvp/SKILL.md +49 -49
  276. package/skills/orch-change-feature/SKILL.md +43 -43
  277. package/skills/orch-fix-defect/SKILL.md +43 -43
  278. package/skills/orch-pipeline/SKILL.md +121 -121
  279. package/skills/orch-refine-code/SKILL.md +44 -44
  280. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  281. package/skills/perl-patterns/SKILL.md +505 -505
  282. package/skills/perl-security/SKILL.md +504 -504
  283. package/skills/perl-testing/SKILL.md +476 -476
  284. package/skills/plan-canvas/SKILL.md +153 -153
  285. package/skills/plan-orchestrate/SKILL.md +263 -263
  286. package/skills/plankton-code-quality/SKILL.md +237 -237
  287. package/skills/postgres-patterns/SKILL.md +148 -148
  288. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  289. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  290. package/skills/premium-web-design/SKILL.md +154 -154
  291. package/skills/prisma-patterns/SKILL.md +401 -401
  292. package/skills/product-capability/SKILL.md +142 -142
  293. package/skills/product-lens/SKILL.md +93 -93
  294. package/skills/production-audit/SKILL.md +207 -207
  295. package/skills/production-scheduling/SKILL.md +238 -238
  296. package/skills/project-flow-ops/SKILL.md +112 -112
  297. package/skills/prompt-optimizer/SKILL.md +398 -398
  298. package/skills/python-patterns/SKILL.md +751 -751
  299. package/skills/python-testing/SKILL.md +817 -817
  300. package/skills/pytorch-patterns/SKILL.md +397 -397
  301. package/skills/quality-nonconformance/SKILL.md +260 -260
  302. package/skills/quarkus-patterns/SKILL.md +723 -723
  303. package/skills/quarkus-security/SKILL.md +468 -468
  304. package/skills/quarkus-tdd/SKILL.md +812 -812
  305. package/skills/quarkus-verification/SKILL.md +480 -480
  306. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  307. package/skills/react-native-patterns/SKILL.md +326 -326
  308. package/skills/react-patterns/SKILL.md +342 -342
  309. package/skills/react-performance/SKILL.md +575 -575
  310. package/skills/react-testing/SKILL.md +424 -424
  311. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  312. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  313. package/skills/redis-patterns/SKILL.md +404 -404
  314. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  315. package/skills/remotion-video-creation/SKILL.md +43 -43
  316. package/skills/repo-scan/SKILL.md +79 -79
  317. package/skills/research-ops/SKILL.md +113 -113
  318. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  319. package/skills/rules-distill/SKILL.md +265 -265
  320. package/skills/rust-patterns/SKILL.md +500 -500
  321. package/skills/rust-testing/SKILL.md +501 -501
  322. package/skills/safety-guard/SKILL.md +76 -76
  323. package/skills/santa-method/SKILL.md +307 -307
  324. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  325. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  326. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  327. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  328. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  329. package/skills/search-first/SKILL.md +183 -183
  330. package/skills/security-bounty-hunter/SKILL.md +100 -100
  331. package/skills/security-review/SKILL.md +504 -504
  332. package/skills/security-scan/SKILL.md +166 -166
  333. package/skills/seo/SKILL.md +155 -155
  334. package/skills/skill-comply/SKILL.md +59 -59
  335. package/skills/skill-scout/SKILL.md +141 -141
  336. package/skills/skill-stocktake/SKILL.md +195 -195
  337. package/skills/social-graph-ranker/SKILL.md +155 -155
  338. package/skills/social-publisher/SKILL.md +130 -130
  339. package/skills/springboot-patterns/SKILL.md +315 -315
  340. package/skills/springboot-security/SKILL.md +273 -273
  341. package/skills/springboot-tdd/SKILL.md +159 -159
  342. package/skills/springboot-verification/SKILL.md +232 -232
  343. package/skills/strategic-compact/SKILL.md +142 -142
  344. package/skills/swift-actor-persistence/SKILL.md +144 -144
  345. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  346. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  347. package/skills/swiftui-patterns/SKILL.md +259 -259
  348. package/skills/taste/SKILL.md +264 -264
  349. package/skills/taste/references/genre-taxonomy.md +87 -87
  350. package/skills/tdd-workflow/SKILL.md +583 -583
  351. package/skills/team-agent-orchestration/SKILL.md +111 -111
  352. package/skills/team-builder/SKILL.md +169 -169
  353. package/skills/terminal-ops/SKILL.md +110 -110
  354. package/skills/tinystruct-patterns/SKILL.md +279 -279
  355. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  356. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  357. package/skills/tinystruct-patterns/references/database.md +99 -99
  358. package/skills/tinystruct-patterns/references/routing.md +64 -64
  359. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  360. package/skills/tinystruct-patterns/references/testing.md +72 -72
  361. package/skills/token-budget-advisor/SKILL.md +134 -134
  362. package/skills/ui-demo/SKILL.md +466 -466
  363. package/skills/ui-to-vue/SKILL.md +135 -135
  364. package/skills/uncloud/SKILL.md +344 -344
  365. package/skills/unified-memory/SKILL.md +170 -170
  366. package/skills/unified-notifications-ops/SKILL.md +188 -188
  367. package/skills/verification-loop/SKILL.md +129 -129
  368. package/skills/video-editing/SKILL.md +311 -311
  369. package/skills/videodb/SKILL.md +375 -375
  370. package/skills/visa-doc-translate/SKILL.md +117 -117
  371. package/skills/vite-patterns/SKILL.md +450 -450
  372. package/skills/vue-patterns/SKILL.md +471 -471
  373. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  374. package/skills/workspace-surface-audit/SKILL.md +126 -126
  375. package/skills/x-api/SKILL.md +235 -235
@@ -1,712 +1,712 @@
1
- ---
2
- name: kotlin-patterns
3
- description: Idiomatic Kotlin patterns, best practices, and conventions for building robust, efficient, and maintainable Kotlin applications with coroutines, null safety, and DSL builders.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Kotlin Development Patterns
9
-
10
- Idiomatic Kotlin patterns and best practices for building robust, efficient, and maintainable applications.
11
-
12
- ## When to Use
13
-
14
- - Writing new Kotlin code
15
- - Reviewing Kotlin code
16
- - Refactoring existing Kotlin code
17
- - Designing Kotlin modules or libraries
18
- - Configuring Gradle Kotlin DSL builds
19
-
20
- ## How It Works
21
-
22
- This skill enforces idiomatic Kotlin conventions across seven key areas: null safety using the type system and safe-call operators, immutability via `val` and `copy()` on data classes, sealed classes and interfaces for exhaustive type hierarchies, structured concurrency with coroutines and `Flow`, extension functions for adding behaviour without inheritance, type-safe DSL builders using `@DslMarker` and lambda receivers, and Gradle Kotlin DSL for build configuration.
23
-
24
- ## Examples
25
-
26
- **Null safety with Elvis operator:**
27
- ```kotlin
28
- fun getUserEmail(userId: String): String {
29
- val user = userRepository.findById(userId)
30
- return user?.email ?: "unknown@example.com"
31
- }
32
- ```
33
-
34
- **Sealed class for exhaustive results:**
35
- ```kotlin
36
- sealed class Result<out T> {
37
- data class Success<T>(val data: T) : Result<T>()
38
- data class Failure(val error: AppError) : Result<Nothing>()
39
- data object Loading : Result<Nothing>()
40
- }
41
- ```
42
-
43
- **Structured concurrency with async/await:**
44
- ```kotlin
45
- suspend fun fetchUserWithPosts(userId: String): UserProfile =
46
- coroutineScope {
47
- val user = async { userService.getUser(userId) }
48
- val posts = async { postService.getUserPosts(userId) }
49
- UserProfile(user = user.await(), posts = posts.await())
50
- }
51
- ```
52
-
53
- ## Core Principles
54
-
55
- ### 1. Null Safety
56
-
57
- Kotlin's type system distinguishes nullable and non-nullable types. Leverage it fully.
58
-
59
- ```kotlin
60
- // Good: Use non-nullable types by default
61
- fun getUser(id: String): User {
62
- return userRepository.findById(id)
63
- ?: throw UserNotFoundException("User $id not found")
64
- }
65
-
66
- // Good: Safe calls and Elvis operator
67
- fun getUserEmail(userId: String): String {
68
- val user = userRepository.findById(userId)
69
- return user?.email ?: "unknown@example.com"
70
- }
71
-
72
- // Bad: Force-unwrapping nullable types
73
- fun getUserEmail(userId: String): String {
74
- val user = userRepository.findById(userId)
75
- return user!!.email // Throws NPE if null
76
- }
77
- ```
78
-
79
- ### 2. Immutability by Default
80
-
81
- Prefer `val` over `var`, immutable collections over mutable ones.
82
-
83
- ```kotlin
84
- // Good: Immutable data
85
- data class User(
86
- val id: String,
87
- val name: String,
88
- val email: String,
89
- )
90
-
91
- // Good: Transform with copy()
92
- fun updateEmail(user: User, newEmail: String): User =
93
- user.copy(email = newEmail)
94
-
95
- // Good: Immutable collections
96
- val users: List<User> = listOf(user1, user2)
97
- val filtered = users.filter { it.email.isNotBlank() }
98
-
99
- // Bad: Mutable state
100
- var currentUser: User? = null // Avoid mutable global state
101
- val mutableUsers = mutableListOf<User>() // Avoid unless truly needed
102
- ```
103
-
104
- ### 3. Expression Bodies and Single-Expression Functions
105
-
106
- Use expression bodies for concise, readable functions.
107
-
108
- ```kotlin
109
- // Good: Expression body
110
- fun isAdult(age: Int): Boolean = age >= 18
111
-
112
- fun formatFullName(first: String, last: String): String =
113
- "$first $last".trim()
114
-
115
- fun User.displayName(): String =
116
- name.ifBlank { email.substringBefore('@') }
117
-
118
- // Good: When as expression
119
- fun statusMessage(code: Int): String = when (code) {
120
- 200 -> "OK"
121
- 404 -> "Not Found"
122
- 500 -> "Internal Server Error"
123
- else -> "Unknown status: $code"
124
- }
125
-
126
- // Bad: Unnecessary block body
127
- fun isAdult(age: Int): Boolean {
128
- return age >= 18
129
- }
130
- ```
131
-
132
- ### 4. Data Classes for Value Objects
133
-
134
- Use data classes for types that primarily hold data.
135
-
136
- ```kotlin
137
- // Good: Data class with copy, equals, hashCode, toString
138
- data class CreateUserRequest(
139
- val name: String,
140
- val email: String,
141
- val role: Role = Role.USER,
142
- )
143
-
144
- // Good: Value class for type safety (zero overhead at runtime)
145
- @JvmInline
146
- value class UserId(val value: String) {
147
- init {
148
- require(value.isNotBlank()) { "UserId cannot be blank" }
149
- }
150
- }
151
-
152
- @JvmInline
153
- value class Email(val value: String) {
154
- init {
155
- require('@' in value) { "Invalid email: $value" }
156
- }
157
- }
158
-
159
- fun getUser(id: UserId): User = userRepository.findById(id)
160
- ```
161
-
162
- ## Sealed Classes and Interfaces
163
-
164
- ### Modeling Restricted Hierarchies
165
-
166
- ```kotlin
167
- // Good: Sealed class for exhaustive when
168
- sealed class Result<out T> {
169
- data class Success<T>(val data: T) : Result<T>()
170
- data class Failure(val error: AppError) : Result<Nothing>()
171
- data object Loading : Result<Nothing>()
172
- }
173
-
174
- fun <T> Result<T>.getOrNull(): T? = when (this) {
175
- is Result.Success -> data
176
- is Result.Failure -> null
177
- is Result.Loading -> null
178
- }
179
-
180
- fun <T> Result<T>.getOrThrow(): T = when (this) {
181
- is Result.Success -> data
182
- is Result.Failure -> throw error.toException()
183
- is Result.Loading -> throw IllegalStateException("Still loading")
184
- }
185
- ```
186
-
187
- ### Sealed Interfaces for API Responses
188
-
189
- ```kotlin
190
- sealed interface ApiError {
191
- val message: String
192
-
193
- data class NotFound(override val message: String) : ApiError
194
- data class Unauthorized(override val message: String) : ApiError
195
- data class Validation(
196
- override val message: String,
197
- val field: String,
198
- ) : ApiError
199
- data class Internal(
200
- override val message: String,
201
- val cause: Throwable? = null,
202
- ) : ApiError
203
- }
204
-
205
- fun ApiError.toStatusCode(): Int = when (this) {
206
- is ApiError.NotFound -> 404
207
- is ApiError.Unauthorized -> 401
208
- is ApiError.Validation -> 422
209
- is ApiError.Internal -> 500
210
- }
211
- ```
212
-
213
- ## Scope Functions
214
-
215
- ### When to Use Each
216
-
217
- ```kotlin
218
- // let: Transform nullable or scoped result
219
- val length: Int? = name?.let { it.trim().length }
220
-
221
- // apply: Configure an object (returns the object)
222
- val user = User().apply {
223
- name = "Alice"
224
- email = "alice@example.com"
225
- }
226
-
227
- // also: Side effects (returns the object)
228
- val user = createUser(request).also { logger.info("Created user: ${it.id}") }
229
-
230
- // run: Execute a block with receiver (returns result)
231
- val result = connection.run {
232
- prepareStatement(sql)
233
- executeQuery()
234
- }
235
-
236
- // with: Non-extension form of run
237
- val csv = with(StringBuilder()) {
238
- appendLine("name,email")
239
- users.forEach { appendLine("${it.name},${it.email}") }
240
- toString()
241
- }
242
- ```
243
-
244
- ### Anti-Patterns
245
-
246
- ```kotlin
247
- // Bad: Nesting scope functions
248
- user?.let { u ->
249
- u.address?.let { addr ->
250
- addr.city?.let { city ->
251
- println(city) // Hard to read
252
- }
253
- }
254
- }
255
-
256
- // Good: Chain safe calls instead
257
- val city = user?.address?.city
258
- city?.let { println(it) }
259
- ```
260
-
261
- ## Extension Functions
262
-
263
- ### Adding Functionality Without Inheritance
264
-
265
- ```kotlin
266
- // Good: Domain-specific extensions
267
- fun String.toSlug(): String =
268
- lowercase()
269
- .replace(Regex("[^a-z0-9\\s-]"), "")
270
- .replace(Regex("\\s+"), "-")
271
- .trim('-')
272
-
273
- fun Instant.toLocalDate(zone: ZoneId = ZoneId.systemDefault()): LocalDate =
274
- atZone(zone).toLocalDate()
275
-
276
- // Good: Collection extensions
277
- fun <T> List<T>.second(): T = this[1]
278
-
279
- fun <T> List<T>.secondOrNull(): T? = getOrNull(1)
280
-
281
- // Good: Scoped extensions (not polluting global namespace)
282
- class UserService {
283
- private fun User.isActive(): Boolean =
284
- status == Status.ACTIVE && lastLogin.isAfter(Instant.now().minus(30, ChronoUnit.DAYS))
285
-
286
- fun getActiveUsers(): List<User> = userRepository.findAll().filter { it.isActive() }
287
- }
288
- ```
289
-
290
- ## Coroutines
291
-
292
- ### Structured Concurrency
293
-
294
- ```kotlin
295
- // Good: Structured concurrency with coroutineScope
296
- suspend fun fetchUserWithPosts(userId: String): UserProfile =
297
- coroutineScope {
298
- val userDeferred = async { userService.getUser(userId) }
299
- val postsDeferred = async { postService.getUserPosts(userId) }
300
-
301
- UserProfile(
302
- user = userDeferred.await(),
303
- posts = postsDeferred.await(),
304
- )
305
- }
306
-
307
- // Good: supervisorScope when children can fail independently
308
- suspend fun fetchDashboard(userId: String): Dashboard =
309
- supervisorScope {
310
- val user = async { userService.getUser(userId) }
311
- val notifications = async { notificationService.getRecent(userId) }
312
- val recommendations = async { recommendationService.getFor(userId) }
313
-
314
- Dashboard(
315
- user = user.await(),
316
- notifications = try {
317
- notifications.await()
318
- } catch (e: CancellationException) {
319
- throw e
320
- } catch (e: Exception) {
321
- emptyList()
322
- },
323
- recommendations = try {
324
- recommendations.await()
325
- } catch (e: CancellationException) {
326
- throw e
327
- } catch (e: Exception) {
328
- emptyList()
329
- },
330
- )
331
- }
332
- ```
333
-
334
- ### Flow for Reactive Streams
335
-
336
- ```kotlin
337
- // Good: Cold flow with proper error handling
338
- fun observeUsers(): Flow<List<User>> = flow {
339
- while (currentCoroutineContext().isActive) {
340
- val users = userRepository.findAll()
341
- emit(users)
342
- delay(5.seconds)
343
- }
344
- }.catch { e ->
345
- logger.error("Error observing users", e)
346
- emit(emptyList())
347
- }
348
-
349
- // Good: Flow operators
350
- fun searchUsers(query: Flow<String>): Flow<List<User>> =
351
- query
352
- .debounce(300.milliseconds)
353
- .distinctUntilChanged()
354
- .filter { it.length >= 2 }
355
- .mapLatest { q -> userRepository.search(q) }
356
- .catch { emit(emptyList()) }
357
- ```
358
-
359
- ### Cancellation and Cleanup
360
-
361
- ```kotlin
362
- // Good: Respect cancellation
363
- suspend fun processItems(items: List<Item>) {
364
- items.forEach { item ->
365
- ensureActive() // Check cancellation before expensive work
366
- processItem(item)
367
- }
368
- }
369
-
370
- // Good: Cleanup with try/finally
371
- suspend fun acquireAndProcess() {
372
- val resource = acquireResource()
373
- try {
374
- resource.process()
375
- } finally {
376
- withContext(NonCancellable) {
377
- resource.release() // Always release, even on cancellation
378
- }
379
- }
380
- }
381
- ```
382
-
383
- ## Delegation
384
-
385
- ### Property Delegation
386
-
387
- ```kotlin
388
- // Lazy initialization
389
- val expensiveData: List<User> by lazy {
390
- userRepository.findAll()
391
- }
392
-
393
- // Observable property
394
- var name: String by Delegates.observable("initial") { _, old, new ->
395
- logger.info("Name changed from '$old' to '$new'")
396
- }
397
-
398
- // Map-backed properties
399
- class Config(private val map: Map<String, Any?>) {
400
- val host: String by map
401
- val port: Int by map
402
- val debug: Boolean by map
403
- }
404
-
405
- val config = Config(mapOf("host" to "localhost", "port" to 8080, "debug" to true))
406
- ```
407
-
408
- ### Interface Delegation
409
-
410
- ```kotlin
411
- // Good: Delegate interface implementation
412
- class LoggingUserRepository(
413
- private val delegate: UserRepository,
414
- private val logger: Logger,
415
- ) : UserRepository by delegate {
416
- // Only override what you need to add logging to
417
- override suspend fun findById(id: String): User? {
418
- logger.info("Finding user by id: $id")
419
- return delegate.findById(id).also {
420
- logger.info("Found user: ${it?.name ?: "null"}")
421
- }
422
- }
423
- }
424
- ```
425
-
426
- ## DSL Builders
427
-
428
- ### Type-Safe Builders
429
-
430
- ```kotlin
431
- // Good: DSL with @DslMarker
432
- @DslMarker
433
- annotation class HtmlDsl
434
-
435
- @HtmlDsl
436
- class HTML {
437
- private val children = mutableListOf<Element>()
438
-
439
- fun head(init: Head.() -> Unit) {
440
- children += Head().apply(init)
441
- }
442
-
443
- fun body(init: Body.() -> Unit) {
444
- children += Body().apply(init)
445
- }
446
-
447
- override fun toString(): String = children.joinToString("\n")
448
- }
449
-
450
- fun html(init: HTML.() -> Unit): HTML = HTML().apply(init)
451
-
452
- // Usage
453
- val page = html {
454
- head { title("My Page") }
455
- body {
456
- h1("Welcome")
457
- p("Hello, World!")
458
- }
459
- }
460
- ```
461
-
462
- ### Configuration DSL
463
-
464
- ```kotlin
465
- data class ServerConfig(
466
- val host: String = "0.0.0.0",
467
- val port: Int = 8080,
468
- val ssl: SslConfig? = null,
469
- val database: DatabaseConfig? = null,
470
- )
471
-
472
- data class SslConfig(val certPath: String, val keyPath: String)
473
- data class DatabaseConfig(val url: String, val maxPoolSize: Int = 10)
474
-
475
- class ServerConfigBuilder {
476
- var host: String = "0.0.0.0"
477
- var port: Int = 8080
478
- private var ssl: SslConfig? = null
479
- private var database: DatabaseConfig? = null
480
-
481
- fun ssl(certPath: String, keyPath: String) {
482
- ssl = SslConfig(certPath, keyPath)
483
- }
484
-
485
- fun database(url: String, maxPoolSize: Int = 10) {
486
- database = DatabaseConfig(url, maxPoolSize)
487
- }
488
-
489
- fun build(): ServerConfig = ServerConfig(host, port, ssl, database)
490
- }
491
-
492
- fun serverConfig(init: ServerConfigBuilder.() -> Unit): ServerConfig =
493
- ServerConfigBuilder().apply(init).build()
494
-
495
- // Usage
496
- val config = serverConfig {
497
- host = "0.0.0.0"
498
- port = 443
499
- ssl("/certs/cert.pem", "/certs/key.pem")
500
- database("jdbc:postgresql://localhost:5432/mydb", maxPoolSize = 20)
501
- }
502
- ```
503
-
504
- ## Sequences for Lazy Evaluation
505
-
506
- ```kotlin
507
- // Good: Use sequences for large collections with multiple operations
508
- val result = users.asSequence()
509
- .filter { it.isActive }
510
- .map { it.email }
511
- .filter { it.endsWith("@company.com") }
512
- .take(10)
513
- .toList()
514
-
515
- // Good: Generate infinite sequences
516
- val fibonacci: Sequence<Long> = sequence {
517
- var a = 0L
518
- var b = 1L
519
- while (true) {
520
- yield(a)
521
- val next = a + b
522
- a = b
523
- b = next
524
- }
525
- }
526
-
527
- val first20 = fibonacci.take(20).toList()
528
- ```
529
-
530
- ## Gradle Kotlin DSL
531
-
532
- ### build.gradle.kts Configuration
533
-
534
- ```kotlin
535
- // Check for latest versions: https://kotlinlang.org/docs/releases.html
536
- plugins {
537
- kotlin("jvm") version "2.3.10"
538
- kotlin("plugin.serialization") version "2.3.10"
539
- id("io.ktor.plugin") version "3.4.0"
540
- id("org.jetbrains.kotlinx.kover") version "0.9.7"
541
- id("io.gitlab.arturbosch.detekt") version "1.23.8"
542
- }
543
-
544
- group = "com.example"
545
- version = "1.0.0"
546
-
547
- kotlin {
548
- jvmToolchain(21)
549
- }
550
-
551
- dependencies {
552
- // Ktor
553
- implementation("io.ktor:ktor-server-core:3.4.0")
554
- implementation("io.ktor:ktor-server-netty:3.4.0")
555
- implementation("io.ktor:ktor-server-content-negotiation:3.4.0")
556
- implementation("io.ktor:ktor-serialization-kotlinx-json:3.4.0")
557
-
558
- // Exposed
559
- implementation("org.jetbrains.exposed:exposed-core:1.0.0")
560
- implementation("org.jetbrains.exposed:exposed-dao:1.0.0")
561
- implementation("org.jetbrains.exposed:exposed-jdbc:1.0.0")
562
- implementation("org.jetbrains.exposed:exposed-kotlin-datetime:1.0.0")
563
-
564
- // Koin
565
- implementation("io.insert-koin:koin-ktor:4.2.0")
566
-
567
- // Coroutines
568
- implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
569
-
570
- // Testing
571
- testImplementation("io.kotest:kotest-runner-junit5:6.1.4")
572
- testImplementation("io.kotest:kotest-assertions-core:6.1.4")
573
- testImplementation("io.kotest:kotest-property:6.1.4")
574
- testImplementation("io.mockk:mockk:1.14.9")
575
- testImplementation("io.ktor:ktor-server-test-host:3.4.0")
576
- testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.10.2")
577
- }
578
-
579
- tasks.withType<Test> {
580
- useJUnitPlatform()
581
- }
582
-
583
- detekt {
584
- config.setFrom(files("config/detekt/detekt.yml"))
585
- buildUponDefaultConfig = true
586
- }
587
- ```
588
-
589
- ## Error Handling Patterns
590
-
591
- ### Result Type for Domain Operations
592
-
593
- ```kotlin
594
- // Good: Use Kotlin's Result or a custom sealed class
595
- suspend fun createUser(request: CreateUserRequest): Result<User> = runCatching {
596
- require(request.name.isNotBlank()) { "Name cannot be blank" }
597
- require('@' in request.email) { "Invalid email format" }
598
-
599
- val user = User(
600
- id = UserId(UUID.randomUUID().toString()),
601
- name = request.name,
602
- email = Email(request.email),
603
- )
604
- userRepository.save(user)
605
- user
606
- }
607
-
608
- // Good: Chain results
609
- val displayName = createUser(request)
610
- .map { it.name }
611
- .getOrElse { "Unknown" }
612
- ```
613
-
614
- ### require, check, error
615
-
616
- ```kotlin
617
- // Good: Preconditions with clear messages
618
- fun withdraw(account: Account, amount: Money): Account {
619
- require(amount.value > 0) { "Amount must be positive: $amount" }
620
- check(account.balance >= amount) { "Insufficient balance: ${account.balance} < $amount" }
621
-
622
- return account.copy(balance = account.balance - amount)
623
- }
624
- ```
625
-
626
- ## Collection Operations
627
-
628
- ### Idiomatic Collection Processing
629
-
630
- ```kotlin
631
- // Good: Chained operations
632
- val activeAdminEmails: List<String> = users
633
- .filter { it.role == Role.ADMIN && it.isActive }
634
- .sortedBy { it.name }
635
- .map { it.email }
636
-
637
- // Good: Grouping and aggregation
638
- val usersByRole: Map<Role, List<User>> = users.groupBy { it.role }
639
-
640
- val oldestByRole: Map<Role, User?> = users.groupBy { it.role }
641
- .mapValues { (_, users) -> users.minByOrNull { it.createdAt } }
642
-
643
- // Good: Associate for map creation
644
- val usersById: Map<UserId, User> = users.associateBy { it.id }
645
-
646
- // Good: Partition for splitting
647
- val (active, inactive) = users.partition { it.isActive }
648
- ```
649
-
650
- ## Quick Reference: Kotlin Idioms
651
-
652
- | Idiom | Description |
653
- |-------|-------------|
654
- | `val` over `var` | Prefer immutable variables |
655
- | `data class` | For value objects with equals/hashCode/copy |
656
- | `sealed class/interface` | For restricted type hierarchies |
657
- | `value class` | For type-safe wrappers with zero overhead |
658
- | Expression `when` | Exhaustive pattern matching |
659
- | Safe call `?.` | Null-safe member access |
660
- | Elvis `?:` | Default value for nullables |
661
- | `let`/`apply`/`also`/`run`/`with` | Scope functions for clean code |
662
- | Extension functions | Add behavior without inheritance |
663
- | `copy()` | Immutable updates on data classes |
664
- | `require`/`check` | Precondition assertions |
665
- | Coroutine `async`/`await` | Structured concurrent execution |
666
- | `Flow` | Cold reactive streams |
667
- | `sequence` | Lazy evaluation |
668
- | Delegation `by` | Reuse implementation without inheritance |
669
-
670
- ## Anti-Patterns to Avoid
671
-
672
- ```kotlin
673
- // Bad: Force-unwrapping nullable types
674
- val name = user!!.name
675
-
676
- // Bad: Platform type leakage from Java
677
- fun getLength(s: String) = s.length // Safe
678
- fun getLength(s: String?) = s?.length ?: 0 // Handle nulls from Java
679
-
680
- // Bad: Mutable data classes
681
- data class MutableUser(var name: String, var email: String)
682
-
683
- // Bad: Using exceptions for control flow
684
- try {
685
- val user = findUser(id)
686
- } catch (e: NotFoundException) {
687
- // Don't use exceptions for expected cases
688
- }
689
-
690
- // Good: Use nullable return or Result
691
- val user: User? = findUserOrNull(id)
692
-
693
- // Bad: Ignoring coroutine scope
694
- GlobalScope.launch { /* Avoid GlobalScope */ }
695
-
696
- // Good: Use structured concurrency
697
- coroutineScope {
698
- launch { /* Properly scoped */ }
699
- }
700
-
701
- // Bad: Deeply nested scope functions
702
- user?.let { u ->
703
- u.address?.let { a ->
704
- a.city?.let { c -> process(c) }
705
- }
706
- }
707
-
708
- // Good: Direct null-safe chain
709
- user?.address?.city?.let { process(it) }
710
- ```
711
-
712
- **Remember**: Kotlin code should be concise but readable. Leverage the type system for safety, prefer immutability, and use coroutines for concurrency. When in doubt, let the compiler help you.
1
+ ---
2
+ name: kotlin-patterns
3
+ description: Idiomatic Kotlin patterns, best practices, and conventions for building robust, efficient, and maintainable Kotlin applications with coroutines, null safety, and DSL builders.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Kotlin Development Patterns
9
+
10
+ Idiomatic Kotlin patterns and best practices for building robust, efficient, and maintainable applications.
11
+
12
+ ## When to Use
13
+
14
+ - Writing new Kotlin code
15
+ - Reviewing Kotlin code
16
+ - Refactoring existing Kotlin code
17
+ - Designing Kotlin modules or libraries
18
+ - Configuring Gradle Kotlin DSL builds
19
+
20
+ ## How It Works
21
+
22
+ This skill enforces idiomatic Kotlin conventions across seven key areas: null safety using the type system and safe-call operators, immutability via `val` and `copy()` on data classes, sealed classes and interfaces for exhaustive type hierarchies, structured concurrency with coroutines and `Flow`, extension functions for adding behaviour without inheritance, type-safe DSL builders using `@DslMarker` and lambda receivers, and Gradle Kotlin DSL for build configuration.
23
+
24
+ ## Examples
25
+
26
+ **Null safety with Elvis operator:**
27
+ ```kotlin
28
+ fun getUserEmail(userId: String): String {
29
+ val user = userRepository.findById(userId)
30
+ return user?.email ?: "unknown@example.com"
31
+ }
32
+ ```
33
+
34
+ **Sealed class for exhaustive results:**
35
+ ```kotlin
36
+ sealed class Result<out T> {
37
+ data class Success<T>(val data: T) : Result<T>()
38
+ data class Failure(val error: AppError) : Result<Nothing>()
39
+ data object Loading : Result<Nothing>()
40
+ }
41
+ ```
42
+
43
+ **Structured concurrency with async/await:**
44
+ ```kotlin
45
+ suspend fun fetchUserWithPosts(userId: String): UserProfile =
46
+ coroutineScope {
47
+ val user = async { userService.getUser(userId) }
48
+ val posts = async { postService.getUserPosts(userId) }
49
+ UserProfile(user = user.await(), posts = posts.await())
50
+ }
51
+ ```
52
+
53
+ ## Core Principles
54
+
55
+ ### 1. Null Safety
56
+
57
+ Kotlin's type system distinguishes nullable and non-nullable types. Leverage it fully.
58
+
59
+ ```kotlin
60
+ // Good: Use non-nullable types by default
61
+ fun getUser(id: String): User {
62
+ return userRepository.findById(id)
63
+ ?: throw UserNotFoundException("User $id not found")
64
+ }
65
+
66
+ // Good: Safe calls and Elvis operator
67
+ fun getUserEmail(userId: String): String {
68
+ val user = userRepository.findById(userId)
69
+ return user?.email ?: "unknown@example.com"
70
+ }
71
+
72
+ // Bad: Force-unwrapping nullable types
73
+ fun getUserEmail(userId: String): String {
74
+ val user = userRepository.findById(userId)
75
+ return user!!.email // Throws NPE if null
76
+ }
77
+ ```
78
+
79
+ ### 2. Immutability by Default
80
+
81
+ Prefer `val` over `var`, immutable collections over mutable ones.
82
+
83
+ ```kotlin
84
+ // Good: Immutable data
85
+ data class User(
86
+ val id: String,
87
+ val name: String,
88
+ val email: String,
89
+ )
90
+
91
+ // Good: Transform with copy()
92
+ fun updateEmail(user: User, newEmail: String): User =
93
+ user.copy(email = newEmail)
94
+
95
+ // Good: Immutable collections
96
+ val users: List<User> = listOf(user1, user2)
97
+ val filtered = users.filter { it.email.isNotBlank() }
98
+
99
+ // Bad: Mutable state
100
+ var currentUser: User? = null // Avoid mutable global state
101
+ val mutableUsers = mutableListOf<User>() // Avoid unless truly needed
102
+ ```
103
+
104
+ ### 3. Expression Bodies and Single-Expression Functions
105
+
106
+ Use expression bodies for concise, readable functions.
107
+
108
+ ```kotlin
109
+ // Good: Expression body
110
+ fun isAdult(age: Int): Boolean = age >= 18
111
+
112
+ fun formatFullName(first: String, last: String): String =
113
+ "$first $last".trim()
114
+
115
+ fun User.displayName(): String =
116
+ name.ifBlank { email.substringBefore('@') }
117
+
118
+ // Good: When as expression
119
+ fun statusMessage(code: Int): String = when (code) {
120
+ 200 -> "OK"
121
+ 404 -> "Not Found"
122
+ 500 -> "Internal Server Error"
123
+ else -> "Unknown status: $code"
124
+ }
125
+
126
+ // Bad: Unnecessary block body
127
+ fun isAdult(age: Int): Boolean {
128
+ return age >= 18
129
+ }
130
+ ```
131
+
132
+ ### 4. Data Classes for Value Objects
133
+
134
+ Use data classes for types that primarily hold data.
135
+
136
+ ```kotlin
137
+ // Good: Data class with copy, equals, hashCode, toString
138
+ data class CreateUserRequest(
139
+ val name: String,
140
+ val email: String,
141
+ val role: Role = Role.USER,
142
+ )
143
+
144
+ // Good: Value class for type safety (zero overhead at runtime)
145
+ @JvmInline
146
+ value class UserId(val value: String) {
147
+ init {
148
+ require(value.isNotBlank()) { "UserId cannot be blank" }
149
+ }
150
+ }
151
+
152
+ @JvmInline
153
+ value class Email(val value: String) {
154
+ init {
155
+ require('@' in value) { "Invalid email: $value" }
156
+ }
157
+ }
158
+
159
+ fun getUser(id: UserId): User = userRepository.findById(id)
160
+ ```
161
+
162
+ ## Sealed Classes and Interfaces
163
+
164
+ ### Modeling Restricted Hierarchies
165
+
166
+ ```kotlin
167
+ // Good: Sealed class for exhaustive when
168
+ sealed class Result<out T> {
169
+ data class Success<T>(val data: T) : Result<T>()
170
+ data class Failure(val error: AppError) : Result<Nothing>()
171
+ data object Loading : Result<Nothing>()
172
+ }
173
+
174
+ fun <T> Result<T>.getOrNull(): T? = when (this) {
175
+ is Result.Success -> data
176
+ is Result.Failure -> null
177
+ is Result.Loading -> null
178
+ }
179
+
180
+ fun <T> Result<T>.getOrThrow(): T = when (this) {
181
+ is Result.Success -> data
182
+ is Result.Failure -> throw error.toException()
183
+ is Result.Loading -> throw IllegalStateException("Still loading")
184
+ }
185
+ ```
186
+
187
+ ### Sealed Interfaces for API Responses
188
+
189
+ ```kotlin
190
+ sealed interface ApiError {
191
+ val message: String
192
+
193
+ data class NotFound(override val message: String) : ApiError
194
+ data class Unauthorized(override val message: String) : ApiError
195
+ data class Validation(
196
+ override val message: String,
197
+ val field: String,
198
+ ) : ApiError
199
+ data class Internal(
200
+ override val message: String,
201
+ val cause: Throwable? = null,
202
+ ) : ApiError
203
+ }
204
+
205
+ fun ApiError.toStatusCode(): Int = when (this) {
206
+ is ApiError.NotFound -> 404
207
+ is ApiError.Unauthorized -> 401
208
+ is ApiError.Validation -> 422
209
+ is ApiError.Internal -> 500
210
+ }
211
+ ```
212
+
213
+ ## Scope Functions
214
+
215
+ ### When to Use Each
216
+
217
+ ```kotlin
218
+ // let: Transform nullable or scoped result
219
+ val length: Int? = name?.let { it.trim().length }
220
+
221
+ // apply: Configure an object (returns the object)
222
+ val user = User().apply {
223
+ name = "Alice"
224
+ email = "alice@example.com"
225
+ }
226
+
227
+ // also: Side effects (returns the object)
228
+ val user = createUser(request).also { logger.info("Created user: ${it.id}") }
229
+
230
+ // run: Execute a block with receiver (returns result)
231
+ val result = connection.run {
232
+ prepareStatement(sql)
233
+ executeQuery()
234
+ }
235
+
236
+ // with: Non-extension form of run
237
+ val csv = with(StringBuilder()) {
238
+ appendLine("name,email")
239
+ users.forEach { appendLine("${it.name},${it.email}") }
240
+ toString()
241
+ }
242
+ ```
243
+
244
+ ### Anti-Patterns
245
+
246
+ ```kotlin
247
+ // Bad: Nesting scope functions
248
+ user?.let { u ->
249
+ u.address?.let { addr ->
250
+ addr.city?.let { city ->
251
+ println(city) // Hard to read
252
+ }
253
+ }
254
+ }
255
+
256
+ // Good: Chain safe calls instead
257
+ val city = user?.address?.city
258
+ city?.let { println(it) }
259
+ ```
260
+
261
+ ## Extension Functions
262
+
263
+ ### Adding Functionality Without Inheritance
264
+
265
+ ```kotlin
266
+ // Good: Domain-specific extensions
267
+ fun String.toSlug(): String =
268
+ lowercase()
269
+ .replace(Regex("[^a-z0-9\\s-]"), "")
270
+ .replace(Regex("\\s+"), "-")
271
+ .trim('-')
272
+
273
+ fun Instant.toLocalDate(zone: ZoneId = ZoneId.systemDefault()): LocalDate =
274
+ atZone(zone).toLocalDate()
275
+
276
+ // Good: Collection extensions
277
+ fun <T> List<T>.second(): T = this[1]
278
+
279
+ fun <T> List<T>.secondOrNull(): T? = getOrNull(1)
280
+
281
+ // Good: Scoped extensions (not polluting global namespace)
282
+ class UserService {
283
+ private fun User.isActive(): Boolean =
284
+ status == Status.ACTIVE && lastLogin.isAfter(Instant.now().minus(30, ChronoUnit.DAYS))
285
+
286
+ fun getActiveUsers(): List<User> = userRepository.findAll().filter { it.isActive() }
287
+ }
288
+ ```
289
+
290
+ ## Coroutines
291
+
292
+ ### Structured Concurrency
293
+
294
+ ```kotlin
295
+ // Good: Structured concurrency with coroutineScope
296
+ suspend fun fetchUserWithPosts(userId: String): UserProfile =
297
+ coroutineScope {
298
+ val userDeferred = async { userService.getUser(userId) }
299
+ val postsDeferred = async { postService.getUserPosts(userId) }
300
+
301
+ UserProfile(
302
+ user = userDeferred.await(),
303
+ posts = postsDeferred.await(),
304
+ )
305
+ }
306
+
307
+ // Good: supervisorScope when children can fail independently
308
+ suspend fun fetchDashboard(userId: String): Dashboard =
309
+ supervisorScope {
310
+ val user = async { userService.getUser(userId) }
311
+ val notifications = async { notificationService.getRecent(userId) }
312
+ val recommendations = async { recommendationService.getFor(userId) }
313
+
314
+ Dashboard(
315
+ user = user.await(),
316
+ notifications = try {
317
+ notifications.await()
318
+ } catch (e: CancellationException) {
319
+ throw e
320
+ } catch (e: Exception) {
321
+ emptyList()
322
+ },
323
+ recommendations = try {
324
+ recommendations.await()
325
+ } catch (e: CancellationException) {
326
+ throw e
327
+ } catch (e: Exception) {
328
+ emptyList()
329
+ },
330
+ )
331
+ }
332
+ ```
333
+
334
+ ### Flow for Reactive Streams
335
+
336
+ ```kotlin
337
+ // Good: Cold flow with proper error handling
338
+ fun observeUsers(): Flow<List<User>> = flow {
339
+ while (currentCoroutineContext().isActive) {
340
+ val users = userRepository.findAll()
341
+ emit(users)
342
+ delay(5.seconds)
343
+ }
344
+ }.catch { e ->
345
+ logger.error("Error observing users", e)
346
+ emit(emptyList())
347
+ }
348
+
349
+ // Good: Flow operators
350
+ fun searchUsers(query: Flow<String>): Flow<List<User>> =
351
+ query
352
+ .debounce(300.milliseconds)
353
+ .distinctUntilChanged()
354
+ .filter { it.length >= 2 }
355
+ .mapLatest { q -> userRepository.search(q) }
356
+ .catch { emit(emptyList()) }
357
+ ```
358
+
359
+ ### Cancellation and Cleanup
360
+
361
+ ```kotlin
362
+ // Good: Respect cancellation
363
+ suspend fun processItems(items: List<Item>) {
364
+ items.forEach { item ->
365
+ ensureActive() // Check cancellation before expensive work
366
+ processItem(item)
367
+ }
368
+ }
369
+
370
+ // Good: Cleanup with try/finally
371
+ suspend fun acquireAndProcess() {
372
+ val resource = acquireResource()
373
+ try {
374
+ resource.process()
375
+ } finally {
376
+ withContext(NonCancellable) {
377
+ resource.release() // Always release, even on cancellation
378
+ }
379
+ }
380
+ }
381
+ ```
382
+
383
+ ## Delegation
384
+
385
+ ### Property Delegation
386
+
387
+ ```kotlin
388
+ // Lazy initialization
389
+ val expensiveData: List<User> by lazy {
390
+ userRepository.findAll()
391
+ }
392
+
393
+ // Observable property
394
+ var name: String by Delegates.observable("initial") { _, old, new ->
395
+ logger.info("Name changed from '$old' to '$new'")
396
+ }
397
+
398
+ // Map-backed properties
399
+ class Config(private val map: Map<String, Any?>) {
400
+ val host: String by map
401
+ val port: Int by map
402
+ val debug: Boolean by map
403
+ }
404
+
405
+ val config = Config(mapOf("host" to "localhost", "port" to 8080, "debug" to true))
406
+ ```
407
+
408
+ ### Interface Delegation
409
+
410
+ ```kotlin
411
+ // Good: Delegate interface implementation
412
+ class LoggingUserRepository(
413
+ private val delegate: UserRepository,
414
+ private val logger: Logger,
415
+ ) : UserRepository by delegate {
416
+ // Only override what you need to add logging to
417
+ override suspend fun findById(id: String): User? {
418
+ logger.info("Finding user by id: $id")
419
+ return delegate.findById(id).also {
420
+ logger.info("Found user: ${it?.name ?: "null"}")
421
+ }
422
+ }
423
+ }
424
+ ```
425
+
426
+ ## DSL Builders
427
+
428
+ ### Type-Safe Builders
429
+
430
+ ```kotlin
431
+ // Good: DSL with @DslMarker
432
+ @DslMarker
433
+ annotation class HtmlDsl
434
+
435
+ @HtmlDsl
436
+ class HTML {
437
+ private val children = mutableListOf<Element>()
438
+
439
+ fun head(init: Head.() -> Unit) {
440
+ children += Head().apply(init)
441
+ }
442
+
443
+ fun body(init: Body.() -> Unit) {
444
+ children += Body().apply(init)
445
+ }
446
+
447
+ override fun toString(): String = children.joinToString("\n")
448
+ }
449
+
450
+ fun html(init: HTML.() -> Unit): HTML = HTML().apply(init)
451
+
452
+ // Usage
453
+ val page = html {
454
+ head { title("My Page") }
455
+ body {
456
+ h1("Welcome")
457
+ p("Hello, World!")
458
+ }
459
+ }
460
+ ```
461
+
462
+ ### Configuration DSL
463
+
464
+ ```kotlin
465
+ data class ServerConfig(
466
+ val host: String = "0.0.0.0",
467
+ val port: Int = 8080,
468
+ val ssl: SslConfig? = null,
469
+ val database: DatabaseConfig? = null,
470
+ )
471
+
472
+ data class SslConfig(val certPath: String, val keyPath: String)
473
+ data class DatabaseConfig(val url: String, val maxPoolSize: Int = 10)
474
+
475
+ class ServerConfigBuilder {
476
+ var host: String = "0.0.0.0"
477
+ var port: Int = 8080
478
+ private var ssl: SslConfig? = null
479
+ private var database: DatabaseConfig? = null
480
+
481
+ fun ssl(certPath: String, keyPath: String) {
482
+ ssl = SslConfig(certPath, keyPath)
483
+ }
484
+
485
+ fun database(url: String, maxPoolSize: Int = 10) {
486
+ database = DatabaseConfig(url, maxPoolSize)
487
+ }
488
+
489
+ fun build(): ServerConfig = ServerConfig(host, port, ssl, database)
490
+ }
491
+
492
+ fun serverConfig(init: ServerConfigBuilder.() -> Unit): ServerConfig =
493
+ ServerConfigBuilder().apply(init).build()
494
+
495
+ // Usage
496
+ val config = serverConfig {
497
+ host = "0.0.0.0"
498
+ port = 443
499
+ ssl("/certs/cert.pem", "/certs/key.pem")
500
+ database("jdbc:postgresql://localhost:5432/mydb", maxPoolSize = 20)
501
+ }
502
+ ```
503
+
504
+ ## Sequences for Lazy Evaluation
505
+
506
+ ```kotlin
507
+ // Good: Use sequences for large collections with multiple operations
508
+ val result = users.asSequence()
509
+ .filter { it.isActive }
510
+ .map { it.email }
511
+ .filter { it.endsWith("@company.com") }
512
+ .take(10)
513
+ .toList()
514
+
515
+ // Good: Generate infinite sequences
516
+ val fibonacci: Sequence<Long> = sequence {
517
+ var a = 0L
518
+ var b = 1L
519
+ while (true) {
520
+ yield(a)
521
+ val next = a + b
522
+ a = b
523
+ b = next
524
+ }
525
+ }
526
+
527
+ val first20 = fibonacci.take(20).toList()
528
+ ```
529
+
530
+ ## Gradle Kotlin DSL
531
+
532
+ ### build.gradle.kts Configuration
533
+
534
+ ```kotlin
535
+ // Check for latest versions: https://kotlinlang.org/docs/releases.html
536
+ plugins {
537
+ kotlin("jvm") version "2.3.10"
538
+ kotlin("plugin.serialization") version "2.3.10"
539
+ id("io.ktor.plugin") version "3.4.0"
540
+ id("org.jetbrains.kotlinx.kover") version "0.9.7"
541
+ id("io.gitlab.arturbosch.detekt") version "1.23.8"
542
+ }
543
+
544
+ group = "com.example"
545
+ version = "1.0.0"
546
+
547
+ kotlin {
548
+ jvmToolchain(21)
549
+ }
550
+
551
+ dependencies {
552
+ // Ktor
553
+ implementation("io.ktor:ktor-server-core:3.4.0")
554
+ implementation("io.ktor:ktor-server-netty:3.4.0")
555
+ implementation("io.ktor:ktor-server-content-negotiation:3.4.0")
556
+ implementation("io.ktor:ktor-serialization-kotlinx-json:3.4.0")
557
+
558
+ // Exposed
559
+ implementation("org.jetbrains.exposed:exposed-core:1.0.0")
560
+ implementation("org.jetbrains.exposed:exposed-dao:1.0.0")
561
+ implementation("org.jetbrains.exposed:exposed-jdbc:1.0.0")
562
+ implementation("org.jetbrains.exposed:exposed-kotlin-datetime:1.0.0")
563
+
564
+ // Koin
565
+ implementation("io.insert-koin:koin-ktor:4.2.0")
566
+
567
+ // Coroutines
568
+ implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
569
+
570
+ // Testing
571
+ testImplementation("io.kotest:kotest-runner-junit5:6.1.4")
572
+ testImplementation("io.kotest:kotest-assertions-core:6.1.4")
573
+ testImplementation("io.kotest:kotest-property:6.1.4")
574
+ testImplementation("io.mockk:mockk:1.14.9")
575
+ testImplementation("io.ktor:ktor-server-test-host:3.4.0")
576
+ testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.10.2")
577
+ }
578
+
579
+ tasks.withType<Test> {
580
+ useJUnitPlatform()
581
+ }
582
+
583
+ detekt {
584
+ config.setFrom(files("config/detekt/detekt.yml"))
585
+ buildUponDefaultConfig = true
586
+ }
587
+ ```
588
+
589
+ ## Error Handling Patterns
590
+
591
+ ### Result Type for Domain Operations
592
+
593
+ ```kotlin
594
+ // Good: Use Kotlin's Result or a custom sealed class
595
+ suspend fun createUser(request: CreateUserRequest): Result<User> = runCatching {
596
+ require(request.name.isNotBlank()) { "Name cannot be blank" }
597
+ require('@' in request.email) { "Invalid email format" }
598
+
599
+ val user = User(
600
+ id = UserId(UUID.randomUUID().toString()),
601
+ name = request.name,
602
+ email = Email(request.email),
603
+ )
604
+ userRepository.save(user)
605
+ user
606
+ }
607
+
608
+ // Good: Chain results
609
+ val displayName = createUser(request)
610
+ .map { it.name }
611
+ .getOrElse { "Unknown" }
612
+ ```
613
+
614
+ ### require, check, error
615
+
616
+ ```kotlin
617
+ // Good: Preconditions with clear messages
618
+ fun withdraw(account: Account, amount: Money): Account {
619
+ require(amount.value > 0) { "Amount must be positive: $amount" }
620
+ check(account.balance >= amount) { "Insufficient balance: ${account.balance} < $amount" }
621
+
622
+ return account.copy(balance = account.balance - amount)
623
+ }
624
+ ```
625
+
626
+ ## Collection Operations
627
+
628
+ ### Idiomatic Collection Processing
629
+
630
+ ```kotlin
631
+ // Good: Chained operations
632
+ val activeAdminEmails: List<String> = users
633
+ .filter { it.role == Role.ADMIN && it.isActive }
634
+ .sortedBy { it.name }
635
+ .map { it.email }
636
+
637
+ // Good: Grouping and aggregation
638
+ val usersByRole: Map<Role, List<User>> = users.groupBy { it.role }
639
+
640
+ val oldestByRole: Map<Role, User?> = users.groupBy { it.role }
641
+ .mapValues { (_, users) -> users.minByOrNull { it.createdAt } }
642
+
643
+ // Good: Associate for map creation
644
+ val usersById: Map<UserId, User> = users.associateBy { it.id }
645
+
646
+ // Good: Partition for splitting
647
+ val (active, inactive) = users.partition { it.isActive }
648
+ ```
649
+
650
+ ## Quick Reference: Kotlin Idioms
651
+
652
+ | Idiom | Description |
653
+ |-------|-------------|
654
+ | `val` over `var` | Prefer immutable variables |
655
+ | `data class` | For value objects with equals/hashCode/copy |
656
+ | `sealed class/interface` | For restricted type hierarchies |
657
+ | `value class` | For type-safe wrappers with zero overhead |
658
+ | Expression `when` | Exhaustive pattern matching |
659
+ | Safe call `?.` | Null-safe member access |
660
+ | Elvis `?:` | Default value for nullables |
661
+ | `let`/`apply`/`also`/`run`/`with` | Scope functions for clean code |
662
+ | Extension functions | Add behavior without inheritance |
663
+ | `copy()` | Immutable updates on data classes |
664
+ | `require`/`check` | Precondition assertions |
665
+ | Coroutine `async`/`await` | Structured concurrent execution |
666
+ | `Flow` | Cold reactive streams |
667
+ | `sequence` | Lazy evaluation |
668
+ | Delegation `by` | Reuse implementation without inheritance |
669
+
670
+ ## Anti-Patterns to Avoid
671
+
672
+ ```kotlin
673
+ // Bad: Force-unwrapping nullable types
674
+ val name = user!!.name
675
+
676
+ // Bad: Platform type leakage from Java
677
+ fun getLength(s: String) = s.length // Safe
678
+ fun getLength(s: String?) = s?.length ?: 0 // Handle nulls from Java
679
+
680
+ // Bad: Mutable data classes
681
+ data class MutableUser(var name: String, var email: String)
682
+
683
+ // Bad: Using exceptions for control flow
684
+ try {
685
+ val user = findUser(id)
686
+ } catch (e: NotFoundException) {
687
+ // Don't use exceptions for expected cases
688
+ }
689
+
690
+ // Good: Use nullable return or Result
691
+ val user: User? = findUserOrNull(id)
692
+
693
+ // Bad: Ignoring coroutine scope
694
+ GlobalScope.launch { /* Avoid GlobalScope */ }
695
+
696
+ // Good: Use structured concurrency
697
+ coroutineScope {
698
+ launch { /* Properly scoped */ }
699
+ }
700
+
701
+ // Bad: Deeply nested scope functions
702
+ user?.let { u ->
703
+ u.address?.let { a ->
704
+ a.city?.let { c -> process(c) }
705
+ }
706
+ }
707
+
708
+ // Good: Direct null-safe chain
709
+ user?.address?.city?.let { process(it) }
710
+ ```
711
+
712
+ **Remember**: Kotlin code should be concise but readable. Leverage the type system for safety, prefer immutability, and use coroutines for concurrency. When in doubt, let the compiler help you.