@hivehub/rulebook 5.1.3 → 5.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (374) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-decision-create.md +55 -55
  9. package/.claude/commands/rulebook-decision-list.md +15 -15
  10. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  11. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  12. package/.claude/commands/rulebook-learn-capture.md +48 -48
  13. package/.claude/commands/rulebook-learn-list.md +13 -13
  14. package/.claude/commands/rulebook-memory-save.md +48 -48
  15. package/.claude/commands/rulebook-memory-search.md +47 -47
  16. package/.claude/commands/rulebook-task-apply.md +85 -67
  17. package/.claude/commands/rulebook-task-archive.md +103 -94
  18. package/.claude/commands/rulebook-task-create.md +93 -93
  19. package/.claude/commands/rulebook-task-list.md +42 -42
  20. package/.claude/commands/rulebook-task-show.md +52 -52
  21. package/.claude/commands/rulebook-task-validate.md +53 -53
  22. package/.claude-plugin/marketplace.json +28 -28
  23. package/.claude-plugin/plugin.json +8 -8
  24. package/README.md +25 -43
  25. package/dist/cli/commands.d.ts.map +1 -1
  26. package/dist/cli/commands.js +11 -0
  27. package/dist/cli/commands.js.map +1 -1
  28. package/dist/core/agent-template-engine.js +28 -28
  29. package/dist/core/generator.js +28 -28
  30. package/dist/core/task-manager.d.ts +23 -0
  31. package/dist/core/task-manager.d.ts.map +1 -1
  32. package/dist/core/task-manager.js +161 -27
  33. package/dist/core/task-manager.js.map +1 -1
  34. package/dist/index.js +0 -0
  35. package/dist/mcp/rulebook-server.js +3 -3
  36. package/dist/mcp/rulebook-server.js.map +1 -1
  37. package/dist/memory/memory-store.js +91 -91
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -43
  40. package/templates/agents/api-designer.md +42 -42
  41. package/templates/agents/architect.md +51 -51
  42. package/templates/agents/build-engineer.md +36 -36
  43. package/templates/agents/code-reviewer.md +47 -47
  44. package/templates/agents/compiler/codegen-debugger.md +34 -34
  45. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  46. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  47. package/templates/agents/context-intelligence.md +52 -52
  48. package/templates/agents/database-architect.md +41 -41
  49. package/templates/agents/devops-engineer.md +42 -42
  50. package/templates/agents/docs-writer.md +38 -38
  51. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  52. package/templates/agents/game-engine/render-engineer.md +22 -22
  53. package/templates/agents/game-engine/shader-engineer.md +38 -38
  54. package/templates/agents/game-engine/systems-integration.md +43 -43
  55. package/templates/agents/generic/code-reviewer.md +41 -41
  56. package/templates/agents/generic/docs-writer.md +25 -25
  57. package/templates/agents/generic/project-manager.md +36 -36
  58. package/templates/agents/generic/researcher.md +34 -34
  59. package/templates/agents/generic/test-engineer.md +41 -41
  60. package/templates/agents/i18n-engineer.md +42 -42
  61. package/templates/agents/implementer.md +42 -42
  62. package/templates/agents/migration-engineer.md +42 -42
  63. package/templates/agents/mobile/platform-specialist.md +22 -22
  64. package/templates/agents/mobile/ui-engineer.md +22 -22
  65. package/templates/agents/performance-engineer.md +49 -49
  66. package/templates/agents/refactoring-agent.md +41 -41
  67. package/templates/agents/researcher.md +38 -38
  68. package/templates/agents/security-reviewer.md +40 -40
  69. package/templates/agents/team-lead.md +37 -37
  70. package/templates/agents/tester.md +48 -48
  71. package/templates/agents/ux-reviewer.md +43 -43
  72. package/templates/agents/web-app/api-designer.md +22 -22
  73. package/templates/agents/web-app/backend-engineer.md +30 -30
  74. package/templates/agents/web-app/database-engineer.md +22 -22
  75. package/templates/agents/web-app/frontend-engineer.md +29 -29
  76. package/templates/agents/web-app/security-reviewer.md +32 -32
  77. package/templates/ci/rulebook-review.yml +26 -26
  78. package/templates/cli/AIDER.md +49 -49
  79. package/templates/cli/AMAZON_Q.md +25 -25
  80. package/templates/cli/AUGGIE.md +32 -32
  81. package/templates/cli/CLAUDE.md +117 -117
  82. package/templates/cli/CLINE.md +99 -99
  83. package/templates/cli/CODEBUDDY.md +20 -20
  84. package/templates/cli/CODEIUM.md +20 -20
  85. package/templates/cli/CODEX.md +21 -21
  86. package/templates/cli/CONTINUE.md +34 -34
  87. package/templates/cli/CURSOR_CLI.md +62 -62
  88. package/templates/cli/FACTORY.md +18 -18
  89. package/templates/cli/GEMINI.md +35 -35
  90. package/templates/cli/KILOCODE.md +18 -18
  91. package/templates/cli/OPENCODE.md +18 -18
  92. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  93. package/templates/commands/rulebook-decision-create.md +55 -55
  94. package/templates/commands/rulebook-decision-list.md +15 -15
  95. package/templates/commands/rulebook-knowledge-add.md +41 -41
  96. package/templates/commands/rulebook-knowledge-list.md +15 -15
  97. package/templates/commands/rulebook-learn-capture.md +48 -48
  98. package/templates/commands/rulebook-learn-list.md +13 -13
  99. package/templates/commands/rulebook-memory-save.md +48 -48
  100. package/templates/commands/rulebook-memory-search.md +47 -47
  101. package/templates/commands/rulebook-task-apply.md +67 -67
  102. package/templates/commands/rulebook-task-archive.md +94 -94
  103. package/templates/commands/rulebook-task-create.md +93 -93
  104. package/templates/commands/rulebook-task-list.md +42 -42
  105. package/templates/commands/rulebook-task-show.md +52 -52
  106. package/templates/commands/rulebook-task-validate.md +53 -53
  107. package/templates/core/AGENTS_LEAN.md +25 -25
  108. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  109. package/templates/core/AGENT_AUTOMATION.md +296 -296
  110. package/templates/core/DAG.md +304 -304
  111. package/templates/core/DECISIONS.md +38 -38
  112. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  113. package/templates/core/KNOWLEDGE.md +49 -49
  114. package/templates/core/MULTI_AGENT.md +74 -74
  115. package/templates/core/PLANS.md +28 -28
  116. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  117. package/templates/core/RALPH.md +471 -471
  118. package/templates/core/RULEBOOK.md +1947 -1947
  119. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  120. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  121. package/templates/frameworks/ANGULAR.md +36 -36
  122. package/templates/frameworks/DJANGO.md +83 -83
  123. package/templates/frameworks/ELECTRON.md +147 -147
  124. package/templates/frameworks/FLASK.md +38 -38
  125. package/templates/frameworks/FLUTTER.md +55 -55
  126. package/templates/frameworks/JQUERY.md +32 -32
  127. package/templates/frameworks/LARAVEL.md +38 -38
  128. package/templates/frameworks/NESTJS.md +43 -43
  129. package/templates/frameworks/NEXTJS.md +127 -127
  130. package/templates/frameworks/NUXT.md +40 -40
  131. package/templates/frameworks/RAILS.md +66 -66
  132. package/templates/frameworks/REACT.md +38 -38
  133. package/templates/frameworks/REACT_NATIVE.md +47 -47
  134. package/templates/frameworks/SPRING.md +39 -39
  135. package/templates/frameworks/SYMFONY.md +36 -36
  136. package/templates/frameworks/VUE.md +36 -36
  137. package/templates/frameworks/ZEND.md +35 -35
  138. package/templates/git/CI_CD_PATTERNS.md +661 -661
  139. package/templates/git/GITHUB_ACTIONS.md +728 -728
  140. package/templates/git/GITLAB_CI.md +730 -730
  141. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  142. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  143. package/templates/hooks/COMMIT_MSG.md +530 -530
  144. package/templates/hooks/POST_CHECKOUT.md +546 -546
  145. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  146. package/templates/hooks/PRE_COMMIT.md +414 -414
  147. package/templates/hooks/PRE_PUSH.md +601 -601
  148. package/templates/ides/CONTINUE_RULES.md +16 -16
  149. package/templates/ides/COPILOT.md +37 -37
  150. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  151. package/templates/ides/CURSOR.md +43 -43
  152. package/templates/ides/GEMINI_RULES.md +17 -17
  153. package/templates/ides/JETBRAINS_AI.md +35 -35
  154. package/templates/ides/REPLIT.md +36 -36
  155. package/templates/ides/TABNINE.md +29 -29
  156. package/templates/ides/VSCODE.md +40 -40
  157. package/templates/ides/WINDSURF.md +36 -36
  158. package/templates/ides/WINDSURF_RULES.md +14 -14
  159. package/templates/ides/ZED.md +32 -32
  160. package/templates/ides/cursor-mdc/go.mdc +24 -24
  161. package/templates/ides/cursor-mdc/python.mdc +24 -24
  162. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  163. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  164. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  165. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  166. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  167. package/templates/languages/C.md +333 -333
  168. package/templates/languages/CPP.md +743 -743
  169. package/templates/languages/CSHARP.md +417 -417
  170. package/templates/languages/ELIXIR.md +454 -454
  171. package/templates/languages/ERLANG.md +361 -361
  172. package/templates/languages/GO.md +645 -645
  173. package/templates/languages/HASKELL.md +177 -177
  174. package/templates/languages/JAVA.md +607 -607
  175. package/templates/languages/JAVASCRIPT.md +631 -631
  176. package/templates/languages/JULIA.md +97 -97
  177. package/templates/languages/KOTLIN.md +511 -511
  178. package/templates/languages/LISP.md +100 -100
  179. package/templates/languages/LUA.md +74 -74
  180. package/templates/languages/OBJECTIVEC.md +90 -90
  181. package/templates/languages/PHP.md +416 -416
  182. package/templates/languages/PYTHON.md +682 -682
  183. package/templates/languages/RUBY.md +421 -421
  184. package/templates/languages/RUST.md +477 -477
  185. package/templates/languages/SAS.md +73 -73
  186. package/templates/languages/SCALA.md +348 -348
  187. package/templates/languages/SOLIDITY.md +580 -580
  188. package/templates/languages/SQL.md +137 -137
  189. package/templates/languages/SWIFT.md +466 -466
  190. package/templates/languages/TYPESCRIPT.md +591 -591
  191. package/templates/languages/ZIG.md +265 -265
  192. package/templates/modules/ATLASSIAN.md +255 -255
  193. package/templates/modules/CONTEXT7.md +54 -54
  194. package/templates/modules/FIGMA.md +267 -267
  195. package/templates/modules/GITHUB_MCP.md +64 -64
  196. package/templates/modules/GRAFANA.md +328 -328
  197. package/templates/modules/MEMORY.md +126 -126
  198. package/templates/modules/NOTION.md +247 -247
  199. package/templates/modules/PLAYWRIGHT.md +90 -90
  200. package/templates/modules/RULEBOOK_MCP.md +156 -156
  201. package/templates/modules/SERENA.md +337 -337
  202. package/templates/modules/SUPABASE.md +223 -223
  203. package/templates/modules/SYNAP.md +69 -69
  204. package/templates/modules/VECTORIZER.md +63 -63
  205. package/templates/modules/sequential-thinking.md +42 -42
  206. package/templates/ralph/ralph-history.bat +4 -4
  207. package/templates/ralph/ralph-history.sh +5 -5
  208. package/templates/ralph/ralph-init.bat +5 -5
  209. package/templates/ralph/ralph-init.sh +5 -5
  210. package/templates/ralph/ralph-pause.bat +5 -5
  211. package/templates/ralph/ralph-pause.sh +5 -5
  212. package/templates/ralph/ralph-run.bat +5 -5
  213. package/templates/ralph/ralph-run.sh +5 -5
  214. package/templates/ralph/ralph-status.bat +4 -4
  215. package/templates/ralph/ralph-status.sh +5 -5
  216. package/templates/rules/follow-task-sequence.md +36 -36
  217. package/templates/rules/git-safety.md +29 -29
  218. package/templates/rules/incremental-tests.md +29 -29
  219. package/templates/rules/knowledge-base-usage.md +41 -0
  220. package/templates/rules/no-deferred.md +31 -31
  221. package/templates/rules/no-shortcuts.md +30 -30
  222. package/templates/rules/research-first.md +30 -30
  223. package/templates/rules/sequential-editing.md +21 -21
  224. package/templates/rules/session-workflow.md +24 -24
  225. package/templates/rules/task-decomposition.md +32 -32
  226. package/templates/services/AZURE_BLOB.md +184 -184
  227. package/templates/services/CASSANDRA.md +239 -239
  228. package/templates/services/DATADOG.md +26 -26
  229. package/templates/services/DOCKER.md +124 -124
  230. package/templates/services/DOCKER_COMPOSE.md +168 -168
  231. package/templates/services/DYNAMODB.md +308 -308
  232. package/templates/services/ELASTICSEARCH.md +347 -347
  233. package/templates/services/GCS.md +178 -178
  234. package/templates/services/HELM.md +194 -194
  235. package/templates/services/INFLUXDB.md +265 -265
  236. package/templates/services/KAFKA.md +341 -341
  237. package/templates/services/KUBERNETES.md +208 -208
  238. package/templates/services/MARIADB.md +183 -183
  239. package/templates/services/MEMCACHED.md +242 -242
  240. package/templates/services/MINIO.md +201 -201
  241. package/templates/services/MONGODB.md +268 -268
  242. package/templates/services/MYSQL.md +358 -358
  243. package/templates/services/NEO4J.md +247 -247
  244. package/templates/services/OPENTELEMETRY.md +25 -25
  245. package/templates/services/ORACLE.md +290 -290
  246. package/templates/services/PINO.md +24 -24
  247. package/templates/services/POSTGRESQL.md +326 -326
  248. package/templates/services/PROMETHEUS.md +33 -33
  249. package/templates/services/RABBITMQ.md +286 -286
  250. package/templates/services/REDIS.md +292 -292
  251. package/templates/services/S3.md +298 -298
  252. package/templates/services/SENTRY.md +23 -23
  253. package/templates/services/SQLITE.md +294 -294
  254. package/templates/services/SQLSERVER.md +294 -294
  255. package/templates/services/WINSTON.md +30 -30
  256. package/templates/skills/cli/aider/SKILL.md +59 -59
  257. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  258. package/templates/skills/cli/auggie/SKILL.md +42 -42
  259. package/templates/skills/cli/claude/SKILL.md +42 -42
  260. package/templates/skills/cli/cline/SKILL.md +42 -42
  261. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  262. package/templates/skills/cli/codeium/SKILL.md +30 -30
  263. package/templates/skills/cli/codex/SKILL.md +31 -31
  264. package/templates/skills/cli/continue/SKILL.md +44 -44
  265. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  266. package/templates/skills/cli/factory/SKILL.md +28 -28
  267. package/templates/skills/cli/gemini/SKILL.md +45 -45
  268. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  269. package/templates/skills/cli/opencode/SKILL.md +28 -28
  270. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  271. package/templates/skills/core/dag/SKILL.md +314 -314
  272. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  273. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  274. package/templates/skills/core/rulebook/SKILL.md +176 -176
  275. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  276. package/templates/skills/dev/api-design/SKILL.md +15 -15
  277. package/templates/skills/dev/architect/SKILL.md +17 -17
  278. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  279. package/templates/skills/dev/db-design/SKILL.md +15 -15
  280. package/templates/skills/dev/debug/SKILL.md +16 -16
  281. package/templates/skills/dev/deploy/SKILL.md +17 -17
  282. package/templates/skills/dev/docs/SKILL.md +17 -17
  283. package/templates/skills/dev/migrate/SKILL.md +15 -15
  284. package/templates/skills/dev/perf/SKILL.md +17 -17
  285. package/templates/skills/dev/refactor/SKILL.md +17 -17
  286. package/templates/skills/dev/research/SKILL.md +14 -14
  287. package/templates/skills/dev/review/SKILL.md +18 -18
  288. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  289. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  290. package/templates/skills/frameworks/django/SKILL.md +93 -93
  291. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  292. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  293. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  294. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  295. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  296. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  297. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  298. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  299. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  300. package/templates/skills/frameworks/react/SKILL.md +48 -48
  301. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  302. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  303. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  304. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  305. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  306. package/templates/skills/ides/copilot/SKILL.md +47 -47
  307. package/templates/skills/ides/cursor/SKILL.md +53 -53
  308. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  309. package/templates/skills/ides/replit/SKILL.md +46 -46
  310. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  311. package/templates/skills/ides/vscode/SKILL.md +50 -50
  312. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  313. package/templates/skills/ides/zed/SKILL.md +42 -42
  314. package/templates/skills/languages/c/SKILL.md +343 -343
  315. package/templates/skills/languages/cpp/SKILL.md +753 -753
  316. package/templates/skills/languages/csharp/SKILL.md +427 -427
  317. package/templates/skills/languages/elixir/SKILL.md +464 -464
  318. package/templates/skills/languages/erlang/SKILL.md +371 -371
  319. package/templates/skills/languages/go/SKILL.md +655 -655
  320. package/templates/skills/languages/haskell/SKILL.md +187 -187
  321. package/templates/skills/languages/java/SKILL.md +617 -617
  322. package/templates/skills/languages/javascript/SKILL.md +641 -641
  323. package/templates/skills/languages/julia/SKILL.md +107 -107
  324. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  325. package/templates/skills/languages/lisp/SKILL.md +110 -110
  326. package/templates/skills/languages/lua/SKILL.md +84 -84
  327. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  328. package/templates/skills/languages/php/SKILL.md +426 -426
  329. package/templates/skills/languages/python/SKILL.md +692 -692
  330. package/templates/skills/languages/ruby/SKILL.md +431 -431
  331. package/templates/skills/languages/rust/SKILL.md +487 -487
  332. package/templates/skills/languages/sas/SKILL.md +83 -83
  333. package/templates/skills/languages/scala/SKILL.md +358 -358
  334. package/templates/skills/languages/solidity/SKILL.md +590 -590
  335. package/templates/skills/languages/sql/SKILL.md +147 -147
  336. package/templates/skills/languages/swift/SKILL.md +476 -476
  337. package/templates/skills/languages/typescript/SKILL.md +302 -302
  338. package/templates/skills/languages/zig/SKILL.md +275 -275
  339. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  340. package/templates/skills/modules/context7/SKILL.md +64 -64
  341. package/templates/skills/modules/figma/SKILL.md +277 -277
  342. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  343. package/templates/skills/modules/grafana/SKILL.md +338 -338
  344. package/templates/skills/modules/memory/SKILL.md +73 -73
  345. package/templates/skills/modules/notion/SKILL.md +257 -257
  346. package/templates/skills/modules/playwright/SKILL.md +100 -100
  347. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  348. package/templates/skills/modules/serena/SKILL.md +347 -347
  349. package/templates/skills/modules/supabase/SKILL.md +233 -233
  350. package/templates/skills/modules/synap/SKILL.md +79 -79
  351. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  352. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  353. package/templates/skills/services/cassandra/SKILL.md +249 -249
  354. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  355. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  356. package/templates/skills/services/gcs/SKILL.md +188 -188
  357. package/templates/skills/services/influxdb/SKILL.md +275 -275
  358. package/templates/skills/services/kafka/SKILL.md +351 -351
  359. package/templates/skills/services/mariadb/SKILL.md +193 -193
  360. package/templates/skills/services/memcached/SKILL.md +252 -252
  361. package/templates/skills/services/minio/SKILL.md +211 -211
  362. package/templates/skills/services/mongodb/SKILL.md +278 -278
  363. package/templates/skills/services/mysql/SKILL.md +368 -368
  364. package/templates/skills/services/neo4j/SKILL.md +257 -257
  365. package/templates/skills/services/oracle/SKILL.md +300 -300
  366. package/templates/skills/services/postgresql/SKILL.md +336 -336
  367. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  368. package/templates/skills/services/redis/SKILL.md +302 -302
  369. package/templates/skills/services/s3/SKILL.md +308 -308
  370. package/templates/skills/services/sqlite/SKILL.md +304 -304
  371. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  372. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  373. package/templates/skills/workflows/ralph/install.sh +87 -87
  374. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,521 +1,521 @@
1
- ---
2
- name: "Kotlin"
3
- description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
- version: "1.0.0"
5
- category: "languages"
6
- author: "Rulebook"
7
- tags: ["languages", "language"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- KOTLIN:START -->
12
- # Kotlin Project Rules
13
-
14
- ## Agent Automation Commands
15
-
16
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
-
18
- ```bash
19
- # Complete quality check sequence (Gradle):
20
- ./gradlew ktlintCheck # Format check
21
- ./gradlew detekt # Linting
22
- ./gradlew test # All tests (100% pass)
23
- ./gradlew build # Build verification
24
- ./gradlew koverVerify # Coverage (95%+ required)
25
-
26
- # Security audit:
27
- ./gradlew dependencyCheckAnalyze # Vulnerability scan
28
- ./gradlew dependencyUpdates # Check outdated deps
29
- ```
30
-
31
- ## Kotlin Configuration
32
-
33
- **CRITICAL**: Use Kotlin 2.0+ with strict null safety.
34
-
35
- - **Version**: Kotlin 2.0+
36
- - **JVM Target**: 17+
37
- - **Language Features**: All enabled
38
- - **Compiler**: K2 compiler
39
- - **Null Safety**: Strict
40
-
41
- ### build.gradle.kts Requirements
42
-
43
- ```kotlin
44
- plugins {
45
- kotlin("jvm") version "2.0.0"
46
- id("org.jetbrains.dokka") version "1.9.20"
47
- id("io.gitlab.arturbosch.detekt") version "1.23.5"
48
- id("org.jlleitschuh.gradle.ktlint") version "12.1.0"
49
- `maven-publish`
50
- signing
51
- }
52
-
53
- group = "io.github.your-username"
54
- version = "1.0.0"
55
-
56
- repositories {
57
- mavenCentral()
58
- }
59
-
60
- dependencies {
61
- implementation(kotlin("stdlib"))
62
- implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
63
-
64
- testImplementation(kotlin("test"))
65
- testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.8.0")
66
- testImplementation("io.mockk:mockk:1.13.9")
67
- }
68
-
69
- kotlin {
70
- jvmToolchain(17)
71
-
72
- compilerOptions {
73
- freeCompilerArgs.add("-Xjsr305=strict")
74
- freeCompilerArgs.add("-Xcontext-receivers")
75
- allWarningsAsErrors.set(true)
76
- }
77
- }
78
-
79
- tasks.test {
80
- useJUnitPlatform()
81
- }
82
-
83
- tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
84
- kotlinOptions {
85
- jvmTarget = "17"
86
- freeCompilerArgs = listOf(
87
- "-Xjsr305=strict",
88
- "-Xcontext-receivers"
89
- )
90
- allWarningsAsErrors = true
91
- }
92
- }
93
-
94
- detekt {
95
- config.setFrom(files("$rootDir/detekt.yml"))
96
- buildUponDefaultConfig = true
97
- allRules = false
98
- }
99
-
100
- ktlint {
101
- version.set("1.1.0")
102
- android.set(false)
103
- ignoreFailures.set(false)
104
- }
105
- ```
106
-
107
- ## Code Quality Standards
108
-
109
- ### Mandatory Quality Checks
110
-
111
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
112
-
113
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
114
-
115
- ```bash
116
- # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
117
-
118
- # 1. Format check (matches workflow - use Check, not Format!)
119
- ./gradlew ktlintCheck
120
-
121
- # 2. Lint (matches workflow)
122
- ./gradlew detekt
123
-
124
- # 3. Build (MUST pass with no warnings - matches workflow)
125
- ./gradlew build -x test
126
-
127
- # 4. Run all tests (MUST pass 100% - matches workflow)
128
- ./gradlew test
129
-
130
- # 5. Check coverage (MUST meet threshold)
131
- ./gradlew koverVerify
132
-
133
- # If ANY fails: ❌ DO NOT COMMIT - Fix first!
134
- ```
135
-
136
- **If ANY of these fail, you MUST fix the issues before committing.**
137
-
138
- **Why This Matters:**
139
- - CI/CD failures happen when local commands differ from workflows
140
- - Example: Using `ktlintFormat` locally but `ktlintCheck` in CI = failure
141
- - Example: Using `koverHtmlReport` locally but `koverVerify` in CI = coverage failures
142
-
143
- ### Code Style
144
-
145
- Use ktlint with `.editorconfig`:
146
-
147
- ```ini
148
- root = true
149
-
150
- [*]
151
- charset = utf-8
152
- end_of_line = lf
153
- indent_size = 4
154
- indent_style = space
155
- insert_final_newline = true
156
- max_line_length = 120
157
- tab_width = 4
158
-
159
- [*.{kt,kts}]
160
- ij_kotlin_allow_trailing_comma = true
161
- ij_kotlin_allow_trailing_comma_on_call_site = true
162
-
163
- # Imports
164
- ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
165
-
166
- # Wrapping
167
- ij_kotlin_line_break_after_multiline_when_entry = true
168
- ij_kotlin_wrap_expression_body_functions = 1
169
- ij_kotlin_wrap_first_method_in_call_chain = false
170
-
171
- # Spacing
172
- ij_kotlin_space_after_type_colon = true
173
- ij_kotlin_space_before_type_colon = false
174
- ```
175
-
176
- ### Static Analysis
177
-
178
- Use Detekt. Configuration in `detekt.yml`:
179
-
180
- ```yaml
181
- build:
182
- maxIssues: 0
183
- weights:
184
- complexity: 2
185
- LongParameterList: 1
186
- style: 1
187
- comments: 1
188
-
189
- complexity:
190
- active: true
191
- ComplexMethod:
192
- threshold: 15
193
- LongMethod:
194
- threshold: 60
195
- LongParameterList:
196
- functionThreshold: 6
197
- TooManyFunctions:
198
- thresholdInFiles: 15
199
-
200
- naming:
201
- active: true
202
- FunctionNaming:
203
- active: true
204
- ClassNaming:
205
- active: true
206
- VariableNaming:
207
- active: true
208
-
209
- style:
210
- active: true
211
- MagicNumber:
212
- active: true
213
- ReturnCount:
214
- max: 3
215
-
216
- coroutines:
217
- active: true
218
- GlobalCoroutineUsage:
219
- active: true
220
- SuspendFunWithFlowReturnType:
221
- active: true
222
- ```
223
-
224
- ### Testing
225
-
226
- - **Framework**: JUnit 5 (Jupiter)
227
- - **Mocking**: MockK
228
- - **Coroutines**: kotlinx-coroutines-test
229
- - **Coverage**: Kover
230
- - **Coverage Threshold**: 95%+
231
-
232
- Example test:
233
-
234
- ```kotlin
235
- import io.mockk.*
236
- import kotlinx.coroutines.test.runTest
237
- import org.junit.jupiter.api.Test
238
- import org.junit.jupiter.api.assertThrows
239
- import kotlin.test.assertEquals
240
-
241
- class DataProcessorTest {
242
-
243
- @Test
244
- fun `process valid input returns uppercase`() {
245
- val processor = DataProcessor()
246
- val result = processor.process("hello")
247
-
248
- assertEquals("HELLO", result)
249
- }
250
-
251
- @Test
252
- fun `process empty input throws exception`() {
253
- val processor = DataProcessor()
254
-
255
- assertThrows<IllegalArgumentException> {
256
- processor.process("")
257
- }
258
- }
259
-
260
- @Test
261
- fun `processAsync works correctly`() = runTest {
262
- val processor = DataProcessor()
263
- val result = processor.processAsync("test")
264
-
265
- assertEquals("TEST", result)
266
- }
267
-
268
- @Test
269
- fun `test with mocking`() {
270
- val repository = mockk<UserRepository>()
271
- every { repository.findById(1) } returns User(1, "John")
272
-
273
- val service = UserService(repository)
274
- val user = service.getUser(1)
275
-
276
- assertEquals("John", user?.name)
277
- verify { repository.findById(1) }
278
- }
279
- }
280
- ```
281
-
282
- ### Null Safety
283
-
284
- - Use non-null types by default
285
- - Use `?` for nullable types
286
- - Use safe calls `?.` and Elvis operator `?:`
287
- - Avoid `!!` operator (use only when absolutely necessary)
288
-
289
- Example:
290
-
291
- ```kotlin
292
- data class User(
293
- val id: Int,
294
- val name: String,
295
- val email: String?,
296
- val phone: String? = null
297
- )
298
-
299
- class UserService(private val repository: UserRepository) {
300
-
301
- fun findUser(id: Int): User? {
302
- return repository.findById(id)
303
- }
304
-
305
- fun getUserName(id: Int): String {
306
- val user = findUser(id) ?: throw UserNotFoundException(id)
307
- return user.name
308
- }
309
-
310
- fun getUserEmail(id: Int): String {
311
- val user = findUser(id) ?: return "unknown@example.com"
312
- return user.email ?: "no-email@example.com"
313
- }
314
-
315
- fun processUsers(ids: List<Int>): List<String> {
316
- return ids.mapNotNull { id ->
317
- findUser(id)?.name
318
- }
319
- }
320
- }
321
- ```
322
-
323
- ### Coroutines
324
-
325
- - Use structured concurrency
326
- - Prefer `suspend` functions over callbacks
327
- - Use `Flow` for reactive streams
328
- - Handle cancellation properly
329
-
330
- Example:
331
-
332
- ```kotlin
333
- import kotlinx.coroutines.*
334
- import kotlinx.coroutines.flow.*
335
-
336
- class DataService(private val api: ApiClient) {
337
-
338
- suspend fun fetchData(id: Int): Result<Data> = withContext(Dispatchers.IO) {
339
- try {
340
- val data = api.getData(id)
341
- Result.success(data)
342
- } catch (e: Exception) {
343
- Result.failure(e)
344
- }
345
- }
346
-
347
- fun observeData(id: Int): Flow<Data> = flow {
348
- while (currentCoroutineContext().isActive) {
349
- val data = api.getData(id)
350
- emit(data)
351
- delay(1000)
352
- }
353
- }.flowOn(Dispatchers.IO)
354
-
355
- suspend fun fetchMultiple(ids: List<Int>): List<Data> = coroutineScope {
356
- ids.map { id ->
357
- async { fetchData(id).getOrNull() }
358
- }.awaitAll().filterNotNull()
359
- }
360
- }
361
- ```
362
-
363
- ### Data Classes & Sealed Classes
364
-
365
- - Use `data class` for value objects
366
- - Use `sealed class`/`sealed interface` for restricted hierarchies
367
- - Use `value class` for single-property wrappers
368
-
369
- Example:
370
-
371
- ```kotlin
372
- // Data class for DTOs
373
- data class User(
374
- val id: Int,
375
- val name: String,
376
- val email: String
377
- )
378
-
379
- // Sealed hierarchy for results
380
- sealed interface Result<out T> {
381
- data class Success<T>(val data: T) : Result<T>
382
- data class Error(val exception: Exception) : Result<Nothing>
383
- data object Loading : Result<Nothing>
384
- }
385
-
386
- // Value class for type safety
387
- @JvmInline
388
- value class UserId(val value: Int)
389
-
390
- @JvmInline
391
- value class Email(val value: String) {
392
- init {
393
- require(value.contains("@")) { "Invalid email format" }
394
- }
395
- }
396
- ```
397
-
398
- ### Documentation
399
-
400
- - Use KDoc for documentation
401
- - Document all public APIs
402
- - Include examples with `@sample`
403
-
404
- Example:
405
-
406
- ```kotlin
407
- /**
408
- * A processor that transforms input data.
409
- *
410
- * This class provides methods for processing strings synchronously and asynchronously.
411
- * All processing is done in a thread-safe manner.
412
- *
413
- * @property config Configuration for the processor
414
- * @constructor Creates a processor with the given configuration
415
- */
416
- class DataProcessor(private val config: ProcessorConfig = ProcessorConfig()) {
417
-
418
- /**
419
- * Processes the input string synchronously.
420
- *
421
- * @param input The string to process. Must not be empty.
422
- * @return The processed string in uppercase.
423
- * @throws IllegalArgumentException if [input] is empty.
424
- * @sample samples.DataProcessorSamples.processExample
425
- */
426
- fun process(input: String): String {
427
- require(input.isNotEmpty()) { "Input cannot be empty" }
428
- return input.uppercase()
429
- }
430
-
431
- /**
432
- * Processes the input string asynchronously.
433
- *
434
- * This is a suspending function that can be called from a coroutine.
435
- *
436
- * @param input The string to process.
437
- * @return The processed string in uppercase.
438
- */
439
- suspend fun processAsync(input: String): String = withContext(Dispatchers.Default) {
440
- process(input)
441
- }
442
- }
443
-
444
- // Sample code for documentation
445
- object samples {
446
- object DataProcessorSamples {
447
- fun processExample() {
448
- val processor = DataProcessor()
449
- val result = processor.process("hello")
450
- println(result) // Prints: HELLO
451
- }
452
- }
453
- }
454
- ```
455
-
456
- ## Project Structure
457
-
458
- ```
459
- project/
460
- ├── build.gradle.kts # Gradle build configuration
461
- ├── settings.gradle.kts # Gradle settings
462
- ├── detekt.yml # Detekt configuration
463
- ├── .editorconfig # EditorConfig for ktlint
464
- ├── README.md # Project overview (allowed in root)
465
- ├── CHANGELOG.md # Version history (allowed in root)
466
- ├── LICENSE # Project license (allowed in root)
467
- ├── src/
468
- │ ├── main/
469
- │ │ └── kotlin/
470
- │ │ └── com/yourorg/yourproject/
471
- │ │ └── YourClass.kt
472
- │ └── test/
473
- │ └── kotlin/
474
- │ └── com/yourorg/yourproject/
475
- │ └── YourClassTest.kt
476
- └── docs/ # Project documentation
477
- ```
478
-
479
- ## CI/CD Requirements
480
-
481
- Must include GitHub Actions workflows for:
482
-
483
- 1. **Testing** (`kotlin-test.yml`):
484
- - Test on ubuntu-latest, windows-latest
485
- - Test on Java 17, 21
486
- - Upload coverage reports
487
-
488
- 2. **Linting** (`kotlin-lint.yml`):
489
- - Detekt: `./gradlew detekt`
490
- - ktlint: `./gradlew ktlintCheck`
491
- - Build with warnings as errors
492
-
493
- ## Package Publication
494
-
495
- ### Publishing to Maven Central
496
-
497
- Same process as Java (see JAVA.md), but with Kotlin-specific configuration.
498
-
499
- **Publishing Checklist:**
500
-
501
- - ✅ All tests passing
502
- - ✅ Detekt passes
503
- - ✅ ktlint passes
504
- - ✅ Build succeeds with warnings as errors
505
- - ✅ Version updated in build.gradle.kts
506
- - ✅ CHANGELOG.md updated
507
- - ✅ README.md up to date
508
- - ✅ LICENSE file present
509
- - ✅ Dokka documentation generated
510
- - ✅ Artifacts signed with GPG
511
-
512
- **Dokka Documentation:**
513
-
514
- ```kotlin
515
- tasks.dokkaHtml.configure {
516
- outputDirectory.set(buildDir.resolve("dokka"))
517
- }
518
- ```
519
-
520
- <!-- KOTLIN:END -->
521
-
1
+ ---
2
+ name: "Kotlin"
3
+ description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
+ version: "1.0.0"
5
+ category: "languages"
6
+ author: "Rulebook"
7
+ tags: ["languages", "language"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- KOTLIN:START -->
12
+ # Kotlin Project Rules
13
+
14
+ ## Agent Automation Commands
15
+
16
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
+
18
+ ```bash
19
+ # Complete quality check sequence (Gradle):
20
+ ./gradlew ktlintCheck # Format check
21
+ ./gradlew detekt # Linting
22
+ ./gradlew test # All tests (100% pass)
23
+ ./gradlew build # Build verification
24
+ ./gradlew koverVerify # Coverage (95%+ required)
25
+
26
+ # Security audit:
27
+ ./gradlew dependencyCheckAnalyze # Vulnerability scan
28
+ ./gradlew dependencyUpdates # Check outdated deps
29
+ ```
30
+
31
+ ## Kotlin Configuration
32
+
33
+ **CRITICAL**: Use Kotlin 2.0+ with strict null safety.
34
+
35
+ - **Version**: Kotlin 2.0+
36
+ - **JVM Target**: 17+
37
+ - **Language Features**: All enabled
38
+ - **Compiler**: K2 compiler
39
+ - **Null Safety**: Strict
40
+
41
+ ### build.gradle.kts Requirements
42
+
43
+ ```kotlin
44
+ plugins {
45
+ kotlin("jvm") version "2.0.0"
46
+ id("org.jetbrains.dokka") version "1.9.20"
47
+ id("io.gitlab.arturbosch.detekt") version "1.23.5"
48
+ id("org.jlleitschuh.gradle.ktlint") version "12.1.0"
49
+ `maven-publish`
50
+ signing
51
+ }
52
+
53
+ group = "io.github.your-username"
54
+ version = "1.0.0"
55
+
56
+ repositories {
57
+ mavenCentral()
58
+ }
59
+
60
+ dependencies {
61
+ implementation(kotlin("stdlib"))
62
+ implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
63
+
64
+ testImplementation(kotlin("test"))
65
+ testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.8.0")
66
+ testImplementation("io.mockk:mockk:1.13.9")
67
+ }
68
+
69
+ kotlin {
70
+ jvmToolchain(17)
71
+
72
+ compilerOptions {
73
+ freeCompilerArgs.add("-Xjsr305=strict")
74
+ freeCompilerArgs.add("-Xcontext-receivers")
75
+ allWarningsAsErrors.set(true)
76
+ }
77
+ }
78
+
79
+ tasks.test {
80
+ useJUnitPlatform()
81
+ }
82
+
83
+ tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
84
+ kotlinOptions {
85
+ jvmTarget = "17"
86
+ freeCompilerArgs = listOf(
87
+ "-Xjsr305=strict",
88
+ "-Xcontext-receivers"
89
+ )
90
+ allWarningsAsErrors = true
91
+ }
92
+ }
93
+
94
+ detekt {
95
+ config.setFrom(files("$rootDir/detekt.yml"))
96
+ buildUponDefaultConfig = true
97
+ allRules = false
98
+ }
99
+
100
+ ktlint {
101
+ version.set("1.1.0")
102
+ android.set(false)
103
+ ignoreFailures.set(false)
104
+ }
105
+ ```
106
+
107
+ ## Code Quality Standards
108
+
109
+ ### Mandatory Quality Checks
110
+
111
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
112
+
113
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
114
+
115
+ ```bash
116
+ # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
117
+
118
+ # 1. Format check (matches workflow - use Check, not Format!)
119
+ ./gradlew ktlintCheck
120
+
121
+ # 2. Lint (matches workflow)
122
+ ./gradlew detekt
123
+
124
+ # 3. Build (MUST pass with no warnings - matches workflow)
125
+ ./gradlew build -x test
126
+
127
+ # 4. Run all tests (MUST pass 100% - matches workflow)
128
+ ./gradlew test
129
+
130
+ # 5. Check coverage (MUST meet threshold)
131
+ ./gradlew koverVerify
132
+
133
+ # If ANY fails: ❌ DO NOT COMMIT - Fix first!
134
+ ```
135
+
136
+ **If ANY of these fail, you MUST fix the issues before committing.**
137
+
138
+ **Why This Matters:**
139
+ - CI/CD failures happen when local commands differ from workflows
140
+ - Example: Using `ktlintFormat` locally but `ktlintCheck` in CI = failure
141
+ - Example: Using `koverHtmlReport` locally but `koverVerify` in CI = coverage failures
142
+
143
+ ### Code Style
144
+
145
+ Use ktlint with `.editorconfig`:
146
+
147
+ ```ini
148
+ root = true
149
+
150
+ [*]
151
+ charset = utf-8
152
+ end_of_line = lf
153
+ indent_size = 4
154
+ indent_style = space
155
+ insert_final_newline = true
156
+ max_line_length = 120
157
+ tab_width = 4
158
+
159
+ [*.{kt,kts}]
160
+ ij_kotlin_allow_trailing_comma = true
161
+ ij_kotlin_allow_trailing_comma_on_call_site = true
162
+
163
+ # Imports
164
+ ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
165
+
166
+ # Wrapping
167
+ ij_kotlin_line_break_after_multiline_when_entry = true
168
+ ij_kotlin_wrap_expression_body_functions = 1
169
+ ij_kotlin_wrap_first_method_in_call_chain = false
170
+
171
+ # Spacing
172
+ ij_kotlin_space_after_type_colon = true
173
+ ij_kotlin_space_before_type_colon = false
174
+ ```
175
+
176
+ ### Static Analysis
177
+
178
+ Use Detekt. Configuration in `detekt.yml`:
179
+
180
+ ```yaml
181
+ build:
182
+ maxIssues: 0
183
+ weights:
184
+ complexity: 2
185
+ LongParameterList: 1
186
+ style: 1
187
+ comments: 1
188
+
189
+ complexity:
190
+ active: true
191
+ ComplexMethod:
192
+ threshold: 15
193
+ LongMethod:
194
+ threshold: 60
195
+ LongParameterList:
196
+ functionThreshold: 6
197
+ TooManyFunctions:
198
+ thresholdInFiles: 15
199
+
200
+ naming:
201
+ active: true
202
+ FunctionNaming:
203
+ active: true
204
+ ClassNaming:
205
+ active: true
206
+ VariableNaming:
207
+ active: true
208
+
209
+ style:
210
+ active: true
211
+ MagicNumber:
212
+ active: true
213
+ ReturnCount:
214
+ max: 3
215
+
216
+ coroutines:
217
+ active: true
218
+ GlobalCoroutineUsage:
219
+ active: true
220
+ SuspendFunWithFlowReturnType:
221
+ active: true
222
+ ```
223
+
224
+ ### Testing
225
+
226
+ - **Framework**: JUnit 5 (Jupiter)
227
+ - **Mocking**: MockK
228
+ - **Coroutines**: kotlinx-coroutines-test
229
+ - **Coverage**: Kover
230
+ - **Coverage Threshold**: 95%+
231
+
232
+ Example test:
233
+
234
+ ```kotlin
235
+ import io.mockk.*
236
+ import kotlinx.coroutines.test.runTest
237
+ import org.junit.jupiter.api.Test
238
+ import org.junit.jupiter.api.assertThrows
239
+ import kotlin.test.assertEquals
240
+
241
+ class DataProcessorTest {
242
+
243
+ @Test
244
+ fun `process valid input returns uppercase`() {
245
+ val processor = DataProcessor()
246
+ val result = processor.process("hello")
247
+
248
+ assertEquals("HELLO", result)
249
+ }
250
+
251
+ @Test
252
+ fun `process empty input throws exception`() {
253
+ val processor = DataProcessor()
254
+
255
+ assertThrows<IllegalArgumentException> {
256
+ processor.process("")
257
+ }
258
+ }
259
+
260
+ @Test
261
+ fun `processAsync works correctly`() = runTest {
262
+ val processor = DataProcessor()
263
+ val result = processor.processAsync("test")
264
+
265
+ assertEquals("TEST", result)
266
+ }
267
+
268
+ @Test
269
+ fun `test with mocking`() {
270
+ val repository = mockk<UserRepository>()
271
+ every { repository.findById(1) } returns User(1, "John")
272
+
273
+ val service = UserService(repository)
274
+ val user = service.getUser(1)
275
+
276
+ assertEquals("John", user?.name)
277
+ verify { repository.findById(1) }
278
+ }
279
+ }
280
+ ```
281
+
282
+ ### Null Safety
283
+
284
+ - Use non-null types by default
285
+ - Use `?` for nullable types
286
+ - Use safe calls `?.` and Elvis operator `?:`
287
+ - Avoid `!!` operator (use only when absolutely necessary)
288
+
289
+ Example:
290
+
291
+ ```kotlin
292
+ data class User(
293
+ val id: Int,
294
+ val name: String,
295
+ val email: String?,
296
+ val phone: String? = null
297
+ )
298
+
299
+ class UserService(private val repository: UserRepository) {
300
+
301
+ fun findUser(id: Int): User? {
302
+ return repository.findById(id)
303
+ }
304
+
305
+ fun getUserName(id: Int): String {
306
+ val user = findUser(id) ?: throw UserNotFoundException(id)
307
+ return user.name
308
+ }
309
+
310
+ fun getUserEmail(id: Int): String {
311
+ val user = findUser(id) ?: return "unknown@example.com"
312
+ return user.email ?: "no-email@example.com"
313
+ }
314
+
315
+ fun processUsers(ids: List<Int>): List<String> {
316
+ return ids.mapNotNull { id ->
317
+ findUser(id)?.name
318
+ }
319
+ }
320
+ }
321
+ ```
322
+
323
+ ### Coroutines
324
+
325
+ - Use structured concurrency
326
+ - Prefer `suspend` functions over callbacks
327
+ - Use `Flow` for reactive streams
328
+ - Handle cancellation properly
329
+
330
+ Example:
331
+
332
+ ```kotlin
333
+ import kotlinx.coroutines.*
334
+ import kotlinx.coroutines.flow.*
335
+
336
+ class DataService(private val api: ApiClient) {
337
+
338
+ suspend fun fetchData(id: Int): Result<Data> = withContext(Dispatchers.IO) {
339
+ try {
340
+ val data = api.getData(id)
341
+ Result.success(data)
342
+ } catch (e: Exception) {
343
+ Result.failure(e)
344
+ }
345
+ }
346
+
347
+ fun observeData(id: Int): Flow<Data> = flow {
348
+ while (currentCoroutineContext().isActive) {
349
+ val data = api.getData(id)
350
+ emit(data)
351
+ delay(1000)
352
+ }
353
+ }.flowOn(Dispatchers.IO)
354
+
355
+ suspend fun fetchMultiple(ids: List<Int>): List<Data> = coroutineScope {
356
+ ids.map { id ->
357
+ async { fetchData(id).getOrNull() }
358
+ }.awaitAll().filterNotNull()
359
+ }
360
+ }
361
+ ```
362
+
363
+ ### Data Classes & Sealed Classes
364
+
365
+ - Use `data class` for value objects
366
+ - Use `sealed class`/`sealed interface` for restricted hierarchies
367
+ - Use `value class` for single-property wrappers
368
+
369
+ Example:
370
+
371
+ ```kotlin
372
+ // Data class for DTOs
373
+ data class User(
374
+ val id: Int,
375
+ val name: String,
376
+ val email: String
377
+ )
378
+
379
+ // Sealed hierarchy for results
380
+ sealed interface Result<out T> {
381
+ data class Success<T>(val data: T) : Result<T>
382
+ data class Error(val exception: Exception) : Result<Nothing>
383
+ data object Loading : Result<Nothing>
384
+ }
385
+
386
+ // Value class for type safety
387
+ @JvmInline
388
+ value class UserId(val value: Int)
389
+
390
+ @JvmInline
391
+ value class Email(val value: String) {
392
+ init {
393
+ require(value.contains("@")) { "Invalid email format" }
394
+ }
395
+ }
396
+ ```
397
+
398
+ ### Documentation
399
+
400
+ - Use KDoc for documentation
401
+ - Document all public APIs
402
+ - Include examples with `@sample`
403
+
404
+ Example:
405
+
406
+ ```kotlin
407
+ /**
408
+ * A processor that transforms input data.
409
+ *
410
+ * This class provides methods for processing strings synchronously and asynchronously.
411
+ * All processing is done in a thread-safe manner.
412
+ *
413
+ * @property config Configuration for the processor
414
+ * @constructor Creates a processor with the given configuration
415
+ */
416
+ class DataProcessor(private val config: ProcessorConfig = ProcessorConfig()) {
417
+
418
+ /**
419
+ * Processes the input string synchronously.
420
+ *
421
+ * @param input The string to process. Must not be empty.
422
+ * @return The processed string in uppercase.
423
+ * @throws IllegalArgumentException if [input] is empty.
424
+ * @sample samples.DataProcessorSamples.processExample
425
+ */
426
+ fun process(input: String): String {
427
+ require(input.isNotEmpty()) { "Input cannot be empty" }
428
+ return input.uppercase()
429
+ }
430
+
431
+ /**
432
+ * Processes the input string asynchronously.
433
+ *
434
+ * This is a suspending function that can be called from a coroutine.
435
+ *
436
+ * @param input The string to process.
437
+ * @return The processed string in uppercase.
438
+ */
439
+ suspend fun processAsync(input: String): String = withContext(Dispatchers.Default) {
440
+ process(input)
441
+ }
442
+ }
443
+
444
+ // Sample code for documentation
445
+ object samples {
446
+ object DataProcessorSamples {
447
+ fun processExample() {
448
+ val processor = DataProcessor()
449
+ val result = processor.process("hello")
450
+ println(result) // Prints: HELLO
451
+ }
452
+ }
453
+ }
454
+ ```
455
+
456
+ ## Project Structure
457
+
458
+ ```
459
+ project/
460
+ ├── build.gradle.kts # Gradle build configuration
461
+ ├── settings.gradle.kts # Gradle settings
462
+ ├── detekt.yml # Detekt configuration
463
+ ├── .editorconfig # EditorConfig for ktlint
464
+ ├── README.md # Project overview (allowed in root)
465
+ ├── CHANGELOG.md # Version history (allowed in root)
466
+ ├── LICENSE # Project license (allowed in root)
467
+ ├── src/
468
+ │ ├── main/
469
+ │ │ └── kotlin/
470
+ │ │ └── com/yourorg/yourproject/
471
+ │ │ └── YourClass.kt
472
+ │ └── test/
473
+ │ └── kotlin/
474
+ │ └── com/yourorg/yourproject/
475
+ │ └── YourClassTest.kt
476
+ └── docs/ # Project documentation
477
+ ```
478
+
479
+ ## CI/CD Requirements
480
+
481
+ Must include GitHub Actions workflows for:
482
+
483
+ 1. **Testing** (`kotlin-test.yml`):
484
+ - Test on ubuntu-latest, windows-latest
485
+ - Test on Java 17, 21
486
+ - Upload coverage reports
487
+
488
+ 2. **Linting** (`kotlin-lint.yml`):
489
+ - Detekt: `./gradlew detekt`
490
+ - ktlint: `./gradlew ktlintCheck`
491
+ - Build with warnings as errors
492
+
493
+ ## Package Publication
494
+
495
+ ### Publishing to Maven Central
496
+
497
+ Same process as Java (see JAVA.md), but with Kotlin-specific configuration.
498
+
499
+ **Publishing Checklist:**
500
+
501
+ - ✅ All tests passing
502
+ - ✅ Detekt passes
503
+ - ✅ ktlint passes
504
+ - ✅ Build succeeds with warnings as errors
505
+ - ✅ Version updated in build.gradle.kts
506
+ - ✅ CHANGELOG.md updated
507
+ - ✅ README.md up to date
508
+ - ✅ LICENSE file present
509
+ - ✅ Dokka documentation generated
510
+ - ✅ Artifacts signed with GPG
511
+
512
+ **Dokka Documentation:**
513
+
514
+ ```kotlin
515
+ tasks.dokkaHtml.configure {
516
+ outputDirectory.set(buildDir.resolve("dokka"))
517
+ }
518
+ ```
519
+
520
+ <!-- KOTLIN:END -->
521
+