@hivehub/rulebook 5.8.2 → 6.0.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 (512) hide show
  1. package/README.md +86 -216
  2. package/dist/cli/commands/claude.d.ts.map +1 -1
  3. package/dist/cli/commands/claude.js +10 -4
  4. package/dist/cli/commands/claude.js.map +1 -1
  5. package/dist/cli/commands/context-intelligence.d.ts.map +1 -1
  6. package/dist/cli/commands/context-intelligence.js.map +1 -1
  7. package/dist/cli/commands/index.d.ts +1 -2
  8. package/dist/cli/commands/index.d.ts.map +1 -1
  9. package/dist/cli/commands/index.js +1 -2
  10. package/dist/cli/commands/index.js.map +1 -1
  11. package/dist/cli/commands/init.d.ts.map +1 -1
  12. package/dist/cli/commands/init.js +16 -91
  13. package/dist/cli/commands/init.js.map +1 -1
  14. package/dist/cli/commands/mcp.d.ts.map +1 -1
  15. package/dist/cli/commands/mcp.js.map +1 -1
  16. package/dist/cli/commands/misc.d.ts +0 -1
  17. package/dist/cli/commands/misc.d.ts.map +1 -1
  18. package/dist/cli/commands/misc.js +0 -76
  19. package/dist/cli/commands/misc.js.map +1 -1
  20. package/dist/cli/commands/plans.d.ts.map +1 -1
  21. package/dist/cli/commands/plans.js.map +1 -1
  22. package/dist/cli/commands/skills.d.ts.map +1 -1
  23. package/dist/cli/commands/skills.js +6 -2
  24. package/dist/cli/commands/skills.js.map +1 -1
  25. package/dist/cli/commands/task.d.ts.map +1 -1
  26. package/dist/cli/commands/task.js +3 -1
  27. package/dist/cli/commands/task.js.map +1 -1
  28. package/dist/cli/commands/update.d.ts +7 -0
  29. package/dist/cli/commands/update.d.ts.map +1 -1
  30. package/dist/cli/commands/update.js +61 -165
  31. package/dist/cli/commands/update.js.map +1 -1
  32. package/dist/cli/commands/workspace.d.ts.map +1 -1
  33. package/dist/cli/commands/workspace.js +4 -3
  34. package/dist/cli/commands/workspace.js.map +1 -1
  35. package/dist/cli/prompts.d.ts.map +1 -1
  36. package/dist/cli/prompts.js +0 -40
  37. package/dist/cli/prompts.js.map +1 -1
  38. package/dist/core/claude/claude-mcp.d.ts.map +1 -1
  39. package/dist/core/claude/claude-mcp.js +1 -1
  40. package/dist/core/claude/claude-mcp.js.map +1 -1
  41. package/dist/core/claude/claude-md-generator.d.ts.map +1 -1
  42. package/dist/core/claude/claude-md-generator.js.map +1 -1
  43. package/dist/core/claude/claude-settings-manager.d.ts.map +1 -1
  44. package/dist/core/claude/claude-settings-manager.js +9 -6
  45. package/dist/core/claude/claude-settings-manager.js.map +1 -1
  46. package/dist/core/custom-templates.d.ts.map +1 -1
  47. package/dist/core/custom-templates.js.map +1 -1
  48. package/dist/core/detect/detector.d.ts +0 -28
  49. package/dist/core/detect/detector.d.ts.map +1 -1
  50. package/dist/core/detect/detector.js +5 -84
  51. package/dist/core/detect/detector.js.map +1 -1
  52. package/dist/core/detect/library-registry.d.ts.map +1 -1
  53. package/dist/core/detect/library-registry.js.map +1 -1
  54. package/dist/core/docs/docs-generator.d.ts.map +1 -1
  55. package/dist/core/docs/docs-generator.js.map +1 -1
  56. package/dist/core/docs/mcp-reference-generator.d.ts.map +1 -1
  57. package/dist/core/docs/mcp-reference-generator.js.map +1 -1
  58. package/dist/core/generators/generator.d.ts.map +1 -1
  59. package/dist/core/generators/generator.js +0 -72
  60. package/dist/core/generators/generator.js.map +1 -1
  61. package/dist/core/generators/gitignore-generator.d.ts.map +1 -1
  62. package/dist/core/generators/gitignore-generator.js +12 -1
  63. package/dist/core/generators/gitignore-generator.js.map +1 -1
  64. package/dist/core/generators/minimal-scaffolder.d.ts.map +1 -1
  65. package/dist/core/generators/minimal-scaffolder.js.map +1 -1
  66. package/dist/core/generators/rules-generator.d.ts.map +1 -1
  67. package/dist/core/generators/rules-generator.js.map +1 -1
  68. package/dist/core/generators/workflow-generator.d.ts +0 -10
  69. package/dist/core/generators/workflow-generator.d.ts.map +1 -1
  70. package/dist/core/generators/workflow-generator.js +0 -307
  71. package/dist/core/generators/workflow-generator.js.map +1 -1
  72. package/dist/core/logger.d.ts.map +1 -1
  73. package/dist/core/logger.js.map +1 -1
  74. package/dist/core/merger.d.ts.map +1 -1
  75. package/dist/core/merger.js.map +1 -1
  76. package/dist/core/migrator.d.ts.map +1 -1
  77. package/dist/core/migrator.js +2 -1
  78. package/dist/core/migrator.js.map +1 -1
  79. package/dist/core/quality/coverage-checker.d.ts.map +1 -1
  80. package/dist/core/quality/coverage-checker.js.map +1 -1
  81. package/dist/core/quality/dependency-checker.d.ts.map +1 -1
  82. package/dist/core/quality/dependency-checker.js +3 -1
  83. package/dist/core/quality/dependency-checker.js.map +1 -1
  84. package/dist/core/quality/doctor.d.ts.map +1 -1
  85. package/dist/core/quality/doctor.js.map +1 -1
  86. package/dist/core/quality/validator.d.ts.map +1 -1
  87. package/dist/core/quality/validator.js.map +1 -1
  88. package/dist/core/rule-engine.d.ts +5 -21
  89. package/dist/core/rule-engine.d.ts.map +1 -1
  90. package/dist/core/rule-engine.js +9 -191
  91. package/dist/core/rule-engine.js.map +1 -1
  92. package/dist/core/skills/skills-manager.d.ts.map +1 -1
  93. package/dist/core/skills/skills-manager.js.map +1 -1
  94. package/dist/core/state/config-manager.d.ts.map +1 -1
  95. package/dist/core/state/config-manager.js +6 -50
  96. package/dist/core/state/config-manager.js.map +1 -1
  97. package/dist/core/state/override-manager.js.map +1 -1
  98. package/dist/core/state/state-writer.d.ts.map +1 -1
  99. package/dist/core/state/state-writer.js.map +1 -1
  100. package/dist/core/state/version-bumper.d.ts.map +1 -1
  101. package/dist/core/state/version-bumper.js.map +1 -1
  102. package/dist/core/tasks/decision-manager.d.ts.map +1 -1
  103. package/dist/core/tasks/decision-manager.js +6 -1
  104. package/dist/core/tasks/decision-manager.js.map +1 -1
  105. package/dist/core/tasks/knowledge-manager.d.ts.map +1 -1
  106. package/dist/core/tasks/knowledge-manager.js.map +1 -1
  107. package/dist/core/tasks/learn-manager.d.ts.map +1 -1
  108. package/dist/core/tasks/learn-manager.js.map +1 -1
  109. package/dist/core/tasks/plans-manager.d.ts.map +1 -1
  110. package/dist/core/tasks/plans-manager.js.map +1 -1
  111. package/dist/core/tasks/task-manager.d.ts.map +1 -1
  112. package/dist/core/tasks/task-manager.js.map +1 -1
  113. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -1
  114. package/dist/core/workspace/legacy-migrator.js.map +1 -1
  115. package/dist/core/workspace/project-worker.d.ts +0 -4
  116. package/dist/core/workspace/project-worker.d.ts.map +1 -1
  117. package/dist/core/workspace/project-worker.js +0 -28
  118. package/dist/core/workspace/project-worker.js.map +1 -1
  119. package/dist/core/workspace/workspace-manager.d.ts +0 -11
  120. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  121. package/dist/core/workspace/workspace-manager.js +6 -30
  122. package/dist/core/workspace/workspace-manager.js.map +1 -1
  123. package/dist/core/workspace/workspace-types.d.ts +0 -1
  124. package/dist/core/workspace/workspace-types.d.ts.map +1 -1
  125. package/dist/hooks/safe-flag-io.js.map +1 -1
  126. package/dist/index.d.ts +1 -1
  127. package/dist/index.d.ts.map +1 -1
  128. package/dist/index.js +3 -82
  129. package/dist/index.js.map +1 -1
  130. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  131. package/dist/mcp/rulebook-server.js +55 -1634
  132. package/dist/mcp/rulebook-server.js.map +1 -1
  133. package/dist/mcp/tools/context.d.ts +23 -0
  134. package/dist/mcp/tools/context.d.ts.map +1 -0
  135. package/dist/mcp/tools/context.js +2 -0
  136. package/dist/mcp/tools/context.js.map +1 -0
  137. package/dist/mcp/tools/decision-tools.d.ts +5 -0
  138. package/dist/mcp/tools/decision-tools.d.ts.map +1 -0
  139. package/dist/mcp/tools/decision-tools.js +220 -0
  140. package/dist/mcp/tools/decision-tools.js.map +1 -0
  141. package/dist/mcp/tools/knowledge-tools.d.ts +5 -0
  142. package/dist/mcp/tools/knowledge-tools.d.ts.map +1 -0
  143. package/dist/mcp/tools/knowledge-tools.js +157 -0
  144. package/dist/mcp/tools/knowledge-tools.js.map +1 -0
  145. package/dist/mcp/tools/learn-tools.d.ts +5 -0
  146. package/dist/mcp/tools/learn-tools.d.ts.map +1 -0
  147. package/dist/mcp/tools/learn-tools.js +150 -0
  148. package/dist/mcp/tools/learn-tools.js.map +1 -0
  149. package/dist/mcp/tools/rules-tools.d.ts +4 -0
  150. package/dist/mcp/tools/rules-tools.d.ts.map +1 -0
  151. package/dist/mcp/tools/rules-tools.js +47 -0
  152. package/dist/mcp/tools/rules-tools.js.map +1 -0
  153. package/dist/mcp/tools/skill-tools.d.ts +5 -0
  154. package/dist/mcp/tools/skill-tools.d.ts.map +1 -0
  155. package/dist/mcp/tools/skill-tools.js +330 -0
  156. package/dist/mcp/tools/skill-tools.js.map +1 -0
  157. package/dist/mcp/tools/task-tools.d.ts +5 -0
  158. package/dist/mcp/tools/task-tools.d.ts.map +1 -0
  159. package/dist/mcp/tools/task-tools.js +185 -0
  160. package/dist/mcp/tools/task-tools.js.map +1 -0
  161. package/dist/mcp/tools/workspace-tools.d.ts +6 -0
  162. package/dist/mcp/tools/workspace-tools.d.ts.map +1 -0
  163. package/dist/mcp/tools/workspace-tools.js +118 -0
  164. package/dist/mcp/tools/workspace-tools.js.map +1 -0
  165. package/dist/types.d.ts +1 -46
  166. package/dist/types.d.ts.map +1 -1
  167. package/dist/utils/file-system.d.ts.map +1 -1
  168. package/dist/utils/file-system.js.map +1 -1
  169. package/dist/utils/git-hooks.d.ts.map +1 -1
  170. package/dist/utils/git-hooks.js.map +1 -1
  171. package/dist/utils/gitignore.d.ts.map +1 -1
  172. package/dist/utils/gitignore.js.map +1 -1
  173. package/dist/utils/rulesignore.d.ts.map +1 -1
  174. package/dist/utils/rulesignore.js.map +1 -1
  175. package/package.json +25 -27
  176. package/templates/agents/architect.md +51 -51
  177. package/templates/agents/build-engineer.md +36 -36
  178. package/templates/agents/code-reviewer.md +47 -47
  179. package/templates/agents/docs-writer.md +38 -38
  180. package/templates/agents/implementer.md +42 -42
  181. package/templates/agents/performance-engineer.md +49 -49
  182. package/templates/agents/researcher.md +38 -38
  183. package/templates/agents/security-reviewer.md +40 -40
  184. package/templates/agents/team-lead.md +37 -37
  185. package/templates/agents/tester.md +48 -48
  186. package/templates/ci/rulebook-review.yml +26 -26
  187. package/templates/cli/CLAUDE.md +102 -117
  188. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  189. package/templates/commands/rulebook-decision-create.md +55 -55
  190. package/templates/commands/rulebook-decision-list.md +15 -15
  191. package/templates/commands/rulebook-knowledge-add.md +41 -41
  192. package/templates/commands/rulebook-knowledge-list.md +15 -15
  193. package/templates/commands/rulebook-learn-capture.md +1 -2
  194. package/templates/commands/rulebook-task-apply.md +67 -67
  195. package/templates/commands/rulebook-task-archive.md +94 -94
  196. package/templates/commands/rulebook-task-create.md +93 -93
  197. package/templates/commands/rulebook-task-list.md +42 -42
  198. package/templates/commands/rulebook-task-show.md +52 -52
  199. package/templates/commands/rulebook-task-validate.md +53 -53
  200. package/templates/compact-context/_default.md +23 -23
  201. package/templates/compact-context/cpp.md +26 -26
  202. package/templates/compact-context/go.md +26 -26
  203. package/templates/compact-context/python.md +26 -26
  204. package/templates/compact-context/rust.md +28 -28
  205. package/templates/compact-context/typescript.md +29 -29
  206. package/templates/core/AGENTS_LEAN.md +4 -9
  207. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  208. package/templates/core/AGENT_AUTOMATION.md +273 -296
  209. package/templates/core/CLAUDE_MD_v2.md +85 -90
  210. package/templates/core/DAG.md +304 -304
  211. package/templates/core/DECISIONS.md +38 -38
  212. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  213. package/templates/core/KNOWLEDGE.md +49 -49
  214. package/templates/core/MULTI_AGENT.md +74 -74
  215. package/templates/core/PLANS.md +28 -28
  216. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  217. package/templates/core/RULEBOOK.md +1936 -1947
  218. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  219. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  220. package/templates/core/WORKSPACE.md +4 -8
  221. package/templates/git/CI_CD_PATTERNS.md +661 -661
  222. package/templates/git/GITHUB_ACTIONS.md +728 -728
  223. package/templates/git/GITLAB_CI.md +730 -730
  224. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  225. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  226. package/templates/hooks/COMMIT_MSG.md +530 -530
  227. package/templates/hooks/POST_CHECKOUT.md +546 -546
  228. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  229. package/templates/hooks/PRE_COMMIT.md +414 -414
  230. package/templates/hooks/PRE_PUSH.md +601 -601
  231. package/templates/hooks/enforce-pre-tool.sh +26 -9
  232. package/templates/hooks/update-check.ps1 +84 -84
  233. package/templates/hooks/update-check.sh +45 -21
  234. package/templates/languages/C.md +333 -333
  235. package/templates/languages/CPP.md +743 -743
  236. package/templates/languages/CSHARP.md +417 -417
  237. package/templates/languages/ELIXIR.md +454 -454
  238. package/templates/languages/ERLANG.md +361 -361
  239. package/templates/languages/GO.md +645 -645
  240. package/templates/languages/HASKELL.md +177 -177
  241. package/templates/languages/JAVA.md +607 -607
  242. package/templates/languages/JAVASCRIPT.md +631 -631
  243. package/templates/languages/JULIA.md +97 -97
  244. package/templates/languages/KOTLIN.md +511 -511
  245. package/templates/languages/LISP.md +100 -100
  246. package/templates/languages/LUA.md +74 -74
  247. package/templates/languages/OBJECTIVEC.md +90 -90
  248. package/templates/languages/PHP.md +416 -416
  249. package/templates/languages/PYTHON.md +682 -682
  250. package/templates/languages/RUBY.md +421 -421
  251. package/templates/languages/RUST.md +477 -477
  252. package/templates/languages/SAS.md +73 -73
  253. package/templates/languages/SCALA.md +348 -348
  254. package/templates/languages/SOLIDITY.md +580 -580
  255. package/templates/languages/SQL.md +137 -137
  256. package/templates/languages/SWIFT.md +466 -466
  257. package/templates/languages/TYPESCRIPT.md +591 -591
  258. package/templates/languages/ZIG.md +265 -265
  259. package/templates/modules/CONTEXT7.md +54 -54
  260. package/templates/modules/GITHUB_MCP.md +64 -64
  261. package/templates/modules/PLAYWRIGHT.md +90 -90
  262. package/templates/modules/RULEBOOK_MCP.md +208 -208
  263. package/templates/modules/SERENA.md +337 -337
  264. package/templates/modules/SUPABASE.md +223 -223
  265. package/templates/modules/SYNAP.md +69 -69
  266. package/templates/modules/VECTORIZER.md +63 -63
  267. package/templates/modules/sequential-thinking.md +42 -42
  268. package/templates/rules/consult-analysis-before-implementing.md +21 -23
  269. package/templates/rules/cpp.md +46 -46
  270. package/templates/rules/csharp.md +44 -44
  271. package/templates/rules/diagnostic-first.md +39 -39
  272. package/templates/rules/fail-twice-escalate.md +46 -46
  273. package/templates/rules/follow-task-sequence.md +36 -36
  274. package/templates/rules/git-safety.md +29 -29
  275. package/templates/rules/go.md +40 -40
  276. package/templates/rules/incremental-implementation.md +56 -56
  277. package/templates/rules/incremental-tests.md +29 -29
  278. package/templates/rules/java.md +43 -43
  279. package/templates/rules/javascript.md +39 -39
  280. package/templates/rules/knowledge-base-usage.md +41 -41
  281. package/templates/rules/multi-agent-teams.md +75 -75
  282. package/templates/rules/no-deferred.md +31 -31
  283. package/templates/rules/no-shortcuts.md +30 -30
  284. package/templates/rules/python.md +43 -43
  285. package/templates/rules/research-first.md +30 -30
  286. package/templates/rules/respect-handoff-trigger.md +41 -41
  287. package/templates/rules/rust.md +40 -40
  288. package/templates/rules/sequential-editing.md +21 -21
  289. package/templates/rules/session-workflow.md +24 -24
  290. package/templates/rules/task-decomposition.md +32 -32
  291. package/templates/rules/typescript.md +40 -40
  292. package/templates/skills/cli/claude/SKILL.md +42 -42
  293. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  294. package/templates/skills/core/dag/SKILL.md +314 -314
  295. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  296. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  297. package/templates/skills/core/rulebook/SKILL.md +176 -176
  298. package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
  299. package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
  300. package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
  301. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  302. package/templates/skills/dev/analysis/SKILL.md +19 -19
  303. package/templates/skills/dev/api-design/SKILL.md +15 -15
  304. package/templates/skills/dev/architect/SKILL.md +17 -17
  305. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  306. package/templates/skills/dev/db-design/SKILL.md +15 -15
  307. package/templates/skills/dev/debug/SKILL.md +16 -16
  308. package/templates/skills/dev/deploy/SKILL.md +17 -17
  309. package/templates/skills/dev/docs/SKILL.md +17 -17
  310. package/templates/skills/dev/handoff/SKILL.md +27 -27
  311. package/templates/skills/dev/migrate/SKILL.md +15 -15
  312. package/templates/skills/dev/perf/SKILL.md +17 -17
  313. package/templates/skills/dev/refactor/SKILL.md +17 -17
  314. package/templates/skills/dev/research/SKILL.md +14 -14
  315. package/templates/skills/dev/review/SKILL.md +18 -18
  316. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  317. package/templates/skills/languages/c/SKILL.md +343 -343
  318. package/templates/skills/languages/cpp/SKILL.md +753 -753
  319. package/templates/skills/languages/csharp/SKILL.md +427 -427
  320. package/templates/skills/languages/elixir/SKILL.md +464 -464
  321. package/templates/skills/languages/erlang/SKILL.md +371 -371
  322. package/templates/skills/languages/go/SKILL.md +655 -655
  323. package/templates/skills/languages/haskell/SKILL.md +187 -187
  324. package/templates/skills/languages/java/SKILL.md +617 -617
  325. package/templates/skills/languages/javascript/SKILL.md +641 -641
  326. package/templates/skills/languages/julia/SKILL.md +107 -107
  327. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  328. package/templates/skills/languages/lisp/SKILL.md +110 -110
  329. package/templates/skills/languages/lua/SKILL.md +84 -84
  330. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  331. package/templates/skills/languages/php/SKILL.md +426 -426
  332. package/templates/skills/languages/python/SKILL.md +692 -692
  333. package/templates/skills/languages/ruby/SKILL.md +431 -431
  334. package/templates/skills/languages/rust/SKILL.md +487 -487
  335. package/templates/skills/languages/sas/SKILL.md +83 -83
  336. package/templates/skills/languages/scala/SKILL.md +358 -358
  337. package/templates/skills/languages/solidity/SKILL.md +590 -590
  338. package/templates/skills/languages/sql/SKILL.md +147 -147
  339. package/templates/skills/languages/swift/SKILL.md +476 -476
  340. package/templates/skills/languages/typescript/SKILL.md +302 -302
  341. package/templates/skills/languages/zig/SKILL.md +275 -275
  342. package/templates/skills/modules/context7/SKILL.md +64 -64
  343. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  344. package/templates/skills/modules/playwright/SKILL.md +100 -100
  345. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  346. package/templates/skills/modules/serena/SKILL.md +347 -347
  347. package/templates/skills/modules/supabase/SKILL.md +233 -233
  348. package/templates/skills/modules/synap/SKILL.md +79 -79
  349. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  350. package/.claude/commands/analysis.md +0 -35
  351. package/.claude/commands/continue.md +0 -33
  352. package/.claude/commands/rulebook-decision-create.md +0 -55
  353. package/.claude/commands/rulebook-decision-list.md +0 -15
  354. package/.claude/commands/rulebook-knowledge-add.md +0 -41
  355. package/.claude/commands/rulebook-knowledge-list.md +0 -15
  356. package/.claude/commands/rulebook-learn-capture.md +0 -41
  357. package/.claude/commands/rulebook-learn-list.md +0 -13
  358. package/.claude/commands/rulebook-memory-save.md +0 -48
  359. package/.claude/commands/rulebook-memory-search.md +0 -47
  360. package/.claude/commands/rulebook-task-apply.md +0 -67
  361. package/.claude/commands/rulebook-task-archive.md +0 -94
  362. package/.claude/commands/rulebook-task-create.md +0 -93
  363. package/.claude/commands/rulebook-task-list.md +0 -42
  364. package/.claude/commands/rulebook-task-show.md +0 -52
  365. package/.claude/commands/rulebook-task-validate.md +0 -53
  366. package/.claude-plugin/marketplace.json +0 -28
  367. package/.claude-plugin/plugin.json +0 -8
  368. package/dist/agents/claude-code.d.ts +0 -69
  369. package/dist/agents/claude-code.d.ts.map +0 -1
  370. package/dist/agents/claude-code.js +0 -180
  371. package/dist/agents/claude-code.js.map +0 -1
  372. package/dist/agents/cursor-agent.d.ts +0 -184
  373. package/dist/agents/cursor-agent.d.ts.map +0 -1
  374. package/dist/agents/cursor-agent.js +0 -299
  375. package/dist/agents/cursor-agent.js.map +0 -1
  376. package/dist/agents/gemini-cli.d.ts +0 -69
  377. package/dist/agents/gemini-cli.d.ts.map +0 -1
  378. package/dist/agents/gemini-cli.js +0 -180
  379. package/dist/agents/gemini-cli.js.map +0 -1
  380. package/dist/cli/commands/memory.d.ts +0 -30
  381. package/dist/cli/commands/memory.d.ts.map +0 -1
  382. package/dist/cli/commands/memory.js +0 -259
  383. package/dist/cli/commands/memory.js.map +0 -1
  384. package/dist/core/console/cli-bridge.d.ts +0 -113
  385. package/dist/core/console/cli-bridge.d.ts.map +0 -1
  386. package/dist/core/console/cli-bridge.js +0 -1094
  387. package/dist/core/console/cli-bridge.js.map +0 -1
  388. package/dist/core/ide/multi-tool-generator.d.ts +0 -59
  389. package/dist/core/ide/multi-tool-generator.d.ts.map +0 -1
  390. package/dist/core/ide/multi-tool-generator.js +0 -157
  391. package/dist/core/ide/multi-tool-generator.js.map +0 -1
  392. package/dist/core/ide/opencode-generator.d.ts +0 -72
  393. package/dist/core/ide/opencode-generator.d.ts.map +0 -1
  394. package/dist/core/ide/opencode-generator.js +0 -450
  395. package/dist/core/ide/opencode-generator.js.map +0 -1
  396. package/dist/core/indexer/background-indexer.d.ts +0 -35
  397. package/dist/core/indexer/background-indexer.d.ts.map +0 -1
  398. package/dist/core/indexer/background-indexer.js +0 -267
  399. package/dist/core/indexer/background-indexer.js.map +0 -1
  400. package/dist/core/indexer/file-parser.d.ts +0 -28
  401. package/dist/core/indexer/file-parser.d.ts.map +0 -1
  402. package/dist/core/indexer/file-parser.js +0 -171
  403. package/dist/core/indexer/file-parser.js.map +0 -1
  404. package/dist/core/indexer/indexer-types.d.ts +0 -37
  405. package/dist/core/indexer/indexer-types.d.ts.map +0 -1
  406. package/dist/core/indexer/indexer-types.js +0 -8
  407. package/dist/core/indexer/indexer-types.js.map +0 -1
  408. package/dist/memory/file-search.d.ts +0 -43
  409. package/dist/memory/file-search.d.ts.map +0 -1
  410. package/dist/memory/file-search.js +0 -228
  411. package/dist/memory/file-search.js.map +0 -1
  412. package/dist/memory/file-store.d.ts +0 -99
  413. package/dist/memory/file-store.d.ts.map +0 -1
  414. package/dist/memory/file-store.js +0 -615
  415. package/dist/memory/file-store.js.map +0 -1
  416. package/dist/memory/legacy-migrator.d.ts +0 -27
  417. package/dist/memory/legacy-migrator.d.ts.map +0 -1
  418. package/dist/memory/legacy-migrator.js +0 -185
  419. package/dist/memory/legacy-migrator.js.map +0 -1
  420. package/dist/memory/memory-hooks.d.ts +0 -48
  421. package/dist/memory/memory-hooks.d.ts.map +0 -1
  422. package/dist/memory/memory-hooks.js +0 -248
  423. package/dist/memory/memory-hooks.js.map +0 -1
  424. package/dist/memory/memory-manager.d.ts +0 -65
  425. package/dist/memory/memory-manager.d.ts.map +0 -1
  426. package/dist/memory/memory-manager.js +0 -223
  427. package/dist/memory/memory-manager.js.map +0 -1
  428. package/dist/memory/memory-types.d.ts +0 -85
  429. package/dist/memory/memory-types.d.ts.map +0 -1
  430. package/dist/memory/memory-types.js +0 -7
  431. package/dist/memory/memory-types.js.map +0 -1
  432. package/templates/agents/accessibility-reviewer.md +0 -43
  433. package/templates/agents/api-designer.md +0 -42
  434. package/templates/agents/compiler/codegen-debugger.md +0 -34
  435. package/templates/agents/compiler/stdlib-engineer.md +0 -28
  436. package/templates/agents/compiler/test-coverage-guardian.md +0 -31
  437. package/templates/agents/context-intelligence.md +0 -50
  438. package/templates/agents/database-architect.md +0 -41
  439. package/templates/agents/devops-engineer.md +0 -42
  440. package/templates/agents/game-engine/cpp-core-expert.md +0 -35
  441. package/templates/agents/game-engine/render-engineer.md +0 -22
  442. package/templates/agents/game-engine/shader-engineer.md +0 -38
  443. package/templates/agents/game-engine/systems-integration.md +0 -43
  444. package/templates/agents/generic/code-reviewer.md +0 -41
  445. package/templates/agents/generic/docs-writer.md +0 -25
  446. package/templates/agents/generic/project-manager.md +0 -36
  447. package/templates/agents/generic/researcher.md +0 -34
  448. package/templates/agents/generic/test-engineer.md +0 -41
  449. package/templates/agents/i18n-engineer.md +0 -42
  450. package/templates/agents/migration-engineer.md +0 -42
  451. package/templates/agents/mobile/platform-specialist.md +0 -22
  452. package/templates/agents/mobile/ui-engineer.md +0 -22
  453. package/templates/agents/project-manager.md +0 -217
  454. package/templates/agents/refactoring-agent.md +0 -41
  455. package/templates/agents/ux-reviewer.md +0 -43
  456. package/templates/agents/web-app/api-designer.md +0 -22
  457. package/templates/agents/web-app/backend-engineer.md +0 -30
  458. package/templates/agents/web-app/database-engineer.md +0 -22
  459. package/templates/agents/web-app/frontend-engineer.md +0 -29
  460. package/templates/agents/web-app/security-reviewer.md +0 -32
  461. package/templates/cli/AIDER.md +0 -49
  462. package/templates/cli/AMAZON_Q.md +0 -25
  463. package/templates/cli/AUGGIE.md +0 -32
  464. package/templates/cli/CLINE.md +0 -99
  465. package/templates/cli/CODEBUDDY.md +0 -20
  466. package/templates/cli/CODEIUM.md +0 -20
  467. package/templates/cli/CODEX.md +0 -21
  468. package/templates/cli/CONTINUE.md +0 -34
  469. package/templates/cli/CURSOR_CLI.md +0 -62
  470. package/templates/cli/FACTORY.md +0 -18
  471. package/templates/cli/GEMINI.md +0 -35
  472. package/templates/cli/KILOCODE.md +0 -18
  473. package/templates/cli/OPENCODE.md +0 -85
  474. package/templates/cli/gemini-extension.json +0 -77
  475. package/templates/commands/rulebook-memory-save.md +0 -48
  476. package/templates/commands/rulebook-memory-search.md +0 -47
  477. package/templates/ides/CONTINUE_RULES.md +0 -16
  478. package/templates/ides/COPILOT_INSTRUCTIONS.md +0 -23
  479. package/templates/ides/GEMINI_RULES.md +0 -17
  480. package/templates/ides/OPENCODE.md +0 -63
  481. package/templates/ides/WINDSURF_RULES.md +0 -14
  482. package/templates/modules/ATLASSIAN.md +0 -255
  483. package/templates/modules/FIGMA.md +0 -267
  484. package/templates/modules/GRAFANA.md +0 -328
  485. package/templates/modules/MEMORY.md +0 -126
  486. package/templates/modules/NOTION.md +0 -247
  487. package/templates/skills/cli/aider/SKILL.md +0 -59
  488. package/templates/skills/cli/amazon-q/SKILL.md +0 -35
  489. package/templates/skills/cli/auggie/SKILL.md +0 -42
  490. package/templates/skills/cli/cline/SKILL.md +0 -42
  491. package/templates/skills/cli/codebuddy/SKILL.md +0 -30
  492. package/templates/skills/cli/codeium/SKILL.md +0 -30
  493. package/templates/skills/cli/codex/SKILL.md +0 -31
  494. package/templates/skills/cli/continue/SKILL.md +0 -44
  495. package/templates/skills/cli/cursor-cli/SKILL.md +0 -38
  496. package/templates/skills/cli/factory/SKILL.md +0 -28
  497. package/templates/skills/cli/gemini/SKILL.md +0 -45
  498. package/templates/skills/cli/kilocode/SKILL.md +0 -28
  499. package/templates/skills/cli/opencode/SKILL.md +0 -82
  500. package/templates/skills/ides/copilot/SKILL.md +0 -47
  501. package/templates/skills/ides/cursor/SKILL.md +0 -53
  502. package/templates/skills/ides/jetbrains-ai/SKILL.md +0 -45
  503. package/templates/skills/ides/replit/SKILL.md +0 -46
  504. package/templates/skills/ides/tabnine/SKILL.md +0 -39
  505. package/templates/skills/ides/vscode/SKILL.md +0 -50
  506. package/templates/skills/ides/windsurf/SKILL.md +0 -46
  507. package/templates/skills/ides/zed/SKILL.md +0 -42
  508. package/templates/skills/modules/atlassian/SKILL.md +0 -265
  509. package/templates/skills/modules/figma/SKILL.md +0 -277
  510. package/templates/skills/modules/grafana/SKILL.md +0 -338
  511. package/templates/skills/modules/memory/SKILL.md +0 -73
  512. package/templates/skills/modules/notion/SKILL.md +0 -257
@@ -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
+