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