@hivehub/rulebook 5.1.2 → 5.1.3

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 (406) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-decision-create.md +55 -55
  9. package/.claude/commands/rulebook-decision-list.md +15 -15
  10. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  11. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  12. package/.claude/commands/rulebook-learn-capture.md +48 -48
  13. package/.claude/commands/rulebook-learn-list.md +13 -13
  14. package/.claude/commands/rulebook-memory-save.md +48 -48
  15. package/.claude/commands/rulebook-memory-search.md +47 -47
  16. package/.claude/commands/rulebook-task-apply.md +67 -67
  17. package/.claude/commands/rulebook-task-archive.md +94 -94
  18. package/.claude/commands/rulebook-task-create.md +93 -93
  19. package/.claude/commands/rulebook-task-list.md +42 -42
  20. package/.claude/commands/rulebook-task-show.md +52 -52
  21. package/.claude/commands/rulebook-task-validate.md +53 -53
  22. package/.claude-plugin/marketplace.json +28 -28
  23. package/.claude-plugin/plugin.json +8 -8
  24. package/README.md +4 -0
  25. package/dist/cli/commands.d.ts.map +1 -1
  26. package/dist/cli/commands.js +39 -8
  27. package/dist/cli/commands.js.map +1 -1
  28. package/dist/core/agent-template-engine.d.ts.map +1 -1
  29. package/dist/core/agent-template-engine.js +36 -30
  30. package/dist/core/agent-template-engine.js.map +1 -1
  31. package/dist/core/complexity-detector.d.ts.map +1 -1
  32. package/dist/core/complexity-detector.js +109 -29
  33. package/dist/core/complexity-detector.js.map +1 -1
  34. package/dist/core/decision-manager.d.ts.map +1 -1
  35. package/dist/core/decision-manager.js +2 -7
  36. package/dist/core/decision-manager.js.map +1 -1
  37. package/dist/core/generator.d.ts.map +1 -1
  38. package/dist/core/generator.js +28 -28
  39. package/dist/core/generator.js.map +1 -1
  40. package/dist/core/indexer/background-indexer.d.ts +1 -0
  41. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  42. package/dist/core/indexer/background-indexer.js +107 -19
  43. package/dist/core/indexer/background-indexer.js.map +1 -1
  44. package/dist/core/indexer/indexer-types.d.ts +2 -0
  45. package/dist/core/indexer/indexer-types.d.ts.map +1 -1
  46. package/dist/core/knowledge-manager.d.ts.map +1 -1
  47. package/dist/core/knowledge-manager.js +1 -1
  48. package/dist/core/knowledge-manager.js.map +1 -1
  49. package/dist/core/learn-manager.d.ts.map +1 -1
  50. package/dist/core/learn-manager.js +1 -1
  51. package/dist/core/learn-manager.js.map +1 -1
  52. package/dist/core/rule-engine.d.ts.map +1 -1
  53. package/dist/core/rule-engine.js +1 -3
  54. package/dist/core/rule-engine.js.map +1 -1
  55. package/dist/core/task-manager.d.ts.map +1 -1
  56. package/dist/core/task-manager.js +24 -24
  57. package/dist/core/task-manager.js.map +1 -1
  58. package/dist/index.js +23 -7
  59. package/dist/index.js.map +1 -1
  60. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  61. package/dist/mcp/rulebook-server.js +18 -6
  62. package/dist/mcp/rulebook-server.js.map +1 -1
  63. package/dist/memory/hnsw-index.d.ts.map +1 -1
  64. package/dist/memory/hnsw-index.js +12 -4
  65. package/dist/memory/hnsw-index.js.map +1 -1
  66. package/dist/memory/memory-store.d.ts.map +1 -1
  67. package/dist/memory/memory-store.js +136 -107
  68. package/dist/memory/memory-store.js.map +1 -1
  69. package/dist/types.d.ts +7 -0
  70. package/dist/types.d.ts.map +1 -1
  71. package/package.json +22 -21
  72. package/templates/agents/accessibility-reviewer.md +43 -43
  73. package/templates/agents/api-designer.md +42 -42
  74. package/templates/agents/architect.md +51 -51
  75. package/templates/agents/build-engineer.md +36 -36
  76. package/templates/agents/code-reviewer.md +47 -47
  77. package/templates/agents/compiler/codegen-debugger.md +34 -34
  78. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  79. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  80. package/templates/agents/context-intelligence.md +52 -52
  81. package/templates/agents/database-architect.md +41 -41
  82. package/templates/agents/devops-engineer.md +42 -42
  83. package/templates/agents/docs-writer.md +38 -38
  84. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  85. package/templates/agents/game-engine/render-engineer.md +22 -22
  86. package/templates/agents/game-engine/shader-engineer.md +38 -38
  87. package/templates/agents/game-engine/systems-integration.md +43 -43
  88. package/templates/agents/generic/code-reviewer.md +41 -41
  89. package/templates/agents/generic/docs-writer.md +25 -25
  90. package/templates/agents/generic/project-manager.md +36 -36
  91. package/templates/agents/generic/researcher.md +34 -34
  92. package/templates/agents/generic/test-engineer.md +41 -41
  93. package/templates/agents/i18n-engineer.md +42 -42
  94. package/templates/agents/implementer.md +42 -42
  95. package/templates/agents/migration-engineer.md +42 -42
  96. package/templates/agents/mobile/platform-specialist.md +22 -22
  97. package/templates/agents/mobile/ui-engineer.md +22 -22
  98. package/templates/agents/performance-engineer.md +49 -49
  99. package/templates/agents/refactoring-agent.md +41 -41
  100. package/templates/agents/researcher.md +38 -38
  101. package/templates/agents/security-reviewer.md +40 -40
  102. package/templates/agents/team-lead.md +37 -37
  103. package/templates/agents/tester.md +48 -48
  104. package/templates/agents/ux-reviewer.md +43 -43
  105. package/templates/agents/web-app/api-designer.md +22 -22
  106. package/templates/agents/web-app/backend-engineer.md +30 -30
  107. package/templates/agents/web-app/database-engineer.md +22 -22
  108. package/templates/agents/web-app/frontend-engineer.md +29 -29
  109. package/templates/agents/web-app/security-reviewer.md +32 -32
  110. package/templates/ci/rulebook-review.yml +26 -26
  111. package/templates/cli/AIDER.md +49 -49
  112. package/templates/cli/AMAZON_Q.md +25 -25
  113. package/templates/cli/AUGGIE.md +32 -32
  114. package/templates/cli/CLAUDE.md +117 -117
  115. package/templates/cli/CLINE.md +99 -99
  116. package/templates/cli/CODEBUDDY.md +20 -20
  117. package/templates/cli/CODEIUM.md +20 -20
  118. package/templates/cli/CODEX.md +21 -21
  119. package/templates/cli/CONTINUE.md +34 -34
  120. package/templates/cli/CURSOR_CLI.md +62 -62
  121. package/templates/cli/FACTORY.md +18 -18
  122. package/templates/cli/GEMINI.md +35 -35
  123. package/templates/cli/KILOCODE.md +18 -18
  124. package/templates/cli/OPENCODE.md +18 -18
  125. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  126. package/templates/commands/rulebook-decision-create.md +55 -55
  127. package/templates/commands/rulebook-decision-list.md +15 -15
  128. package/templates/commands/rulebook-knowledge-add.md +41 -41
  129. package/templates/commands/rulebook-knowledge-list.md +15 -15
  130. package/templates/commands/rulebook-learn-capture.md +48 -48
  131. package/templates/commands/rulebook-learn-list.md +13 -13
  132. package/templates/commands/rulebook-memory-save.md +48 -48
  133. package/templates/commands/rulebook-memory-search.md +47 -47
  134. package/templates/commands/rulebook-task-apply.md +67 -67
  135. package/templates/commands/rulebook-task-archive.md +94 -94
  136. package/templates/commands/rulebook-task-create.md +93 -93
  137. package/templates/commands/rulebook-task-list.md +42 -42
  138. package/templates/commands/rulebook-task-show.md +52 -52
  139. package/templates/commands/rulebook-task-validate.md +53 -53
  140. package/templates/core/AGENTS_LEAN.md +25 -25
  141. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  142. package/templates/core/AGENT_AUTOMATION.md +296 -296
  143. package/templates/core/DAG.md +304 -304
  144. package/templates/core/DECISIONS.md +38 -38
  145. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  146. package/templates/core/KNOWLEDGE.md +49 -49
  147. package/templates/core/MULTI_AGENT.md +74 -74
  148. package/templates/core/PLANS.md +28 -28
  149. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  150. package/templates/core/RALPH.md +471 -471
  151. package/templates/core/RULEBOOK.md +1947 -1947
  152. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  153. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  154. package/templates/frameworks/ANGULAR.md +36 -36
  155. package/templates/frameworks/DJANGO.md +83 -83
  156. package/templates/frameworks/ELECTRON.md +147 -147
  157. package/templates/frameworks/FLASK.md +38 -38
  158. package/templates/frameworks/FLUTTER.md +55 -55
  159. package/templates/frameworks/JQUERY.md +32 -32
  160. package/templates/frameworks/LARAVEL.md +38 -38
  161. package/templates/frameworks/NESTJS.md +43 -43
  162. package/templates/frameworks/NEXTJS.md +127 -127
  163. package/templates/frameworks/NUXT.md +40 -40
  164. package/templates/frameworks/RAILS.md +66 -66
  165. package/templates/frameworks/REACT.md +38 -38
  166. package/templates/frameworks/REACT_NATIVE.md +47 -47
  167. package/templates/frameworks/SPRING.md +39 -39
  168. package/templates/frameworks/SYMFONY.md +36 -36
  169. package/templates/frameworks/VUE.md +36 -36
  170. package/templates/frameworks/ZEND.md +35 -35
  171. package/templates/git/CI_CD_PATTERNS.md +661 -661
  172. package/templates/git/GITHUB_ACTIONS.md +728 -728
  173. package/templates/git/GITLAB_CI.md +730 -730
  174. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  175. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  176. package/templates/hooks/COMMIT_MSG.md +530 -530
  177. package/templates/hooks/POST_CHECKOUT.md +546 -546
  178. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  179. package/templates/hooks/PRE_COMMIT.md +414 -414
  180. package/templates/hooks/PRE_PUSH.md +601 -601
  181. package/templates/ides/CONTINUE_RULES.md +16 -16
  182. package/templates/ides/COPILOT.md +37 -37
  183. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  184. package/templates/ides/CURSOR.md +43 -43
  185. package/templates/ides/GEMINI_RULES.md +17 -17
  186. package/templates/ides/JETBRAINS_AI.md +35 -35
  187. package/templates/ides/REPLIT.md +36 -36
  188. package/templates/ides/TABNINE.md +29 -29
  189. package/templates/ides/VSCODE.md +40 -40
  190. package/templates/ides/WINDSURF.md +36 -36
  191. package/templates/ides/WINDSURF_RULES.md +14 -14
  192. package/templates/ides/ZED.md +32 -32
  193. package/templates/ides/cursor-mdc/go.mdc +24 -24
  194. package/templates/ides/cursor-mdc/python.mdc +24 -24
  195. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  196. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  197. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  198. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  199. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  200. package/templates/languages/C.md +333 -333
  201. package/templates/languages/CPP.md +743 -743
  202. package/templates/languages/CSHARP.md +417 -417
  203. package/templates/languages/ELIXIR.md +454 -454
  204. package/templates/languages/ERLANG.md +361 -361
  205. package/templates/languages/GO.md +645 -645
  206. package/templates/languages/HASKELL.md +177 -177
  207. package/templates/languages/JAVA.md +607 -607
  208. package/templates/languages/JAVASCRIPT.md +631 -631
  209. package/templates/languages/JULIA.md +97 -97
  210. package/templates/languages/KOTLIN.md +511 -511
  211. package/templates/languages/LISP.md +100 -100
  212. package/templates/languages/LUA.md +74 -74
  213. package/templates/languages/OBJECTIVEC.md +90 -90
  214. package/templates/languages/PHP.md +416 -416
  215. package/templates/languages/PYTHON.md +682 -682
  216. package/templates/languages/RUBY.md +421 -421
  217. package/templates/languages/RUST.md +477 -477
  218. package/templates/languages/SAS.md +73 -73
  219. package/templates/languages/SCALA.md +348 -348
  220. package/templates/languages/SOLIDITY.md +580 -580
  221. package/templates/languages/SQL.md +137 -137
  222. package/templates/languages/SWIFT.md +466 -466
  223. package/templates/languages/TYPESCRIPT.md +591 -591
  224. package/templates/languages/ZIG.md +265 -265
  225. package/templates/modules/ATLASSIAN.md +255 -255
  226. package/templates/modules/CONTEXT7.md +54 -54
  227. package/templates/modules/FIGMA.md +267 -267
  228. package/templates/modules/GITHUB_MCP.md +64 -64
  229. package/templates/modules/GRAFANA.md +328 -328
  230. package/templates/modules/MEMORY.md +126 -126
  231. package/templates/modules/NOTION.md +247 -247
  232. package/templates/modules/PLAYWRIGHT.md +90 -90
  233. package/templates/modules/RULEBOOK_MCP.md +156 -156
  234. package/templates/modules/SERENA.md +337 -337
  235. package/templates/modules/SUPABASE.md +223 -223
  236. package/templates/modules/SYNAP.md +69 -69
  237. package/templates/modules/VECTORIZER.md +63 -63
  238. package/templates/modules/sequential-thinking.md +42 -42
  239. package/templates/ralph/ralph-history.bat +4 -4
  240. package/templates/ralph/ralph-history.sh +5 -5
  241. package/templates/ralph/ralph-init.bat +5 -5
  242. package/templates/ralph/ralph-init.sh +5 -5
  243. package/templates/ralph/ralph-pause.bat +5 -5
  244. package/templates/ralph/ralph-pause.sh +5 -5
  245. package/templates/ralph/ralph-run.bat +5 -5
  246. package/templates/ralph/ralph-run.sh +5 -5
  247. package/templates/ralph/ralph-status.bat +4 -4
  248. package/templates/ralph/ralph-status.sh +5 -5
  249. package/templates/rules/follow-task-sequence.md +36 -36
  250. package/templates/rules/git-safety.md +29 -29
  251. package/templates/rules/incremental-tests.md +29 -29
  252. package/templates/rules/no-deferred.md +31 -31
  253. package/templates/rules/no-shortcuts.md +30 -30
  254. package/templates/rules/research-first.md +30 -30
  255. package/templates/rules/sequential-editing.md +21 -21
  256. package/templates/rules/session-workflow.md +24 -24
  257. package/templates/rules/task-decomposition.md +32 -32
  258. package/templates/services/AZURE_BLOB.md +184 -184
  259. package/templates/services/CASSANDRA.md +239 -239
  260. package/templates/services/DATADOG.md +26 -26
  261. package/templates/services/DOCKER.md +124 -124
  262. package/templates/services/DOCKER_COMPOSE.md +168 -168
  263. package/templates/services/DYNAMODB.md +308 -308
  264. package/templates/services/ELASTICSEARCH.md +347 -347
  265. package/templates/services/GCS.md +178 -178
  266. package/templates/services/HELM.md +194 -194
  267. package/templates/services/INFLUXDB.md +265 -265
  268. package/templates/services/KAFKA.md +341 -341
  269. package/templates/services/KUBERNETES.md +208 -208
  270. package/templates/services/MARIADB.md +183 -183
  271. package/templates/services/MEMCACHED.md +242 -242
  272. package/templates/services/MINIO.md +201 -201
  273. package/templates/services/MONGODB.md +268 -268
  274. package/templates/services/MYSQL.md +358 -358
  275. package/templates/services/NEO4J.md +247 -247
  276. package/templates/services/OPENTELEMETRY.md +25 -25
  277. package/templates/services/ORACLE.md +290 -290
  278. package/templates/services/PINO.md +24 -24
  279. package/templates/services/POSTGRESQL.md +326 -326
  280. package/templates/services/PROMETHEUS.md +33 -33
  281. package/templates/services/RABBITMQ.md +286 -286
  282. package/templates/services/REDIS.md +292 -292
  283. package/templates/services/S3.md +298 -298
  284. package/templates/services/SENTRY.md +23 -23
  285. package/templates/services/SQLITE.md +294 -294
  286. package/templates/services/SQLSERVER.md +294 -294
  287. package/templates/services/WINSTON.md +30 -30
  288. package/templates/skills/cli/aider/SKILL.md +59 -59
  289. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  290. package/templates/skills/cli/auggie/SKILL.md +42 -42
  291. package/templates/skills/cli/claude/SKILL.md +42 -42
  292. package/templates/skills/cli/cline/SKILL.md +42 -42
  293. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  294. package/templates/skills/cli/codeium/SKILL.md +30 -30
  295. package/templates/skills/cli/codex/SKILL.md +31 -31
  296. package/templates/skills/cli/continue/SKILL.md +44 -44
  297. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  298. package/templates/skills/cli/factory/SKILL.md +28 -28
  299. package/templates/skills/cli/gemini/SKILL.md +45 -45
  300. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  301. package/templates/skills/cli/opencode/SKILL.md +28 -28
  302. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  303. package/templates/skills/core/dag/SKILL.md +314 -314
  304. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  305. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  306. package/templates/skills/core/rulebook/SKILL.md +176 -176
  307. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  308. package/templates/skills/dev/api-design/SKILL.md +15 -15
  309. package/templates/skills/dev/architect/SKILL.md +17 -17
  310. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  311. package/templates/skills/dev/db-design/SKILL.md +15 -15
  312. package/templates/skills/dev/debug/SKILL.md +16 -16
  313. package/templates/skills/dev/deploy/SKILL.md +17 -17
  314. package/templates/skills/dev/docs/SKILL.md +17 -17
  315. package/templates/skills/dev/migrate/SKILL.md +15 -15
  316. package/templates/skills/dev/perf/SKILL.md +17 -17
  317. package/templates/skills/dev/refactor/SKILL.md +17 -17
  318. package/templates/skills/dev/research/SKILL.md +14 -14
  319. package/templates/skills/dev/review/SKILL.md +18 -18
  320. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  321. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  322. package/templates/skills/frameworks/django/SKILL.md +93 -93
  323. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  324. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  325. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  326. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  327. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  328. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  329. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  330. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  331. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  332. package/templates/skills/frameworks/react/SKILL.md +48 -48
  333. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  334. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  335. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  336. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  337. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  338. package/templates/skills/ides/copilot/SKILL.md +47 -47
  339. package/templates/skills/ides/cursor/SKILL.md +53 -53
  340. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  341. package/templates/skills/ides/replit/SKILL.md +46 -46
  342. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  343. package/templates/skills/ides/vscode/SKILL.md +50 -50
  344. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  345. package/templates/skills/ides/zed/SKILL.md +42 -42
  346. package/templates/skills/languages/c/SKILL.md +343 -343
  347. package/templates/skills/languages/cpp/SKILL.md +753 -753
  348. package/templates/skills/languages/csharp/SKILL.md +427 -427
  349. package/templates/skills/languages/elixir/SKILL.md +464 -464
  350. package/templates/skills/languages/erlang/SKILL.md +371 -371
  351. package/templates/skills/languages/go/SKILL.md +655 -655
  352. package/templates/skills/languages/haskell/SKILL.md +187 -187
  353. package/templates/skills/languages/java/SKILL.md +617 -617
  354. package/templates/skills/languages/javascript/SKILL.md +641 -641
  355. package/templates/skills/languages/julia/SKILL.md +107 -107
  356. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  357. package/templates/skills/languages/lisp/SKILL.md +110 -110
  358. package/templates/skills/languages/lua/SKILL.md +84 -84
  359. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  360. package/templates/skills/languages/php/SKILL.md +426 -426
  361. package/templates/skills/languages/python/SKILL.md +692 -692
  362. package/templates/skills/languages/ruby/SKILL.md +431 -431
  363. package/templates/skills/languages/rust/SKILL.md +487 -487
  364. package/templates/skills/languages/sas/SKILL.md +83 -83
  365. package/templates/skills/languages/scala/SKILL.md +358 -358
  366. package/templates/skills/languages/solidity/SKILL.md +590 -590
  367. package/templates/skills/languages/sql/SKILL.md +147 -147
  368. package/templates/skills/languages/swift/SKILL.md +476 -476
  369. package/templates/skills/languages/typescript/SKILL.md +302 -302
  370. package/templates/skills/languages/zig/SKILL.md +275 -275
  371. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  372. package/templates/skills/modules/context7/SKILL.md +64 -64
  373. package/templates/skills/modules/figma/SKILL.md +277 -277
  374. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  375. package/templates/skills/modules/grafana/SKILL.md +338 -338
  376. package/templates/skills/modules/memory/SKILL.md +73 -73
  377. package/templates/skills/modules/notion/SKILL.md +257 -257
  378. package/templates/skills/modules/playwright/SKILL.md +100 -100
  379. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  380. package/templates/skills/modules/serena/SKILL.md +347 -347
  381. package/templates/skills/modules/supabase/SKILL.md +233 -233
  382. package/templates/skills/modules/synap/SKILL.md +79 -79
  383. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  384. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  385. package/templates/skills/services/cassandra/SKILL.md +249 -249
  386. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  387. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  388. package/templates/skills/services/gcs/SKILL.md +188 -188
  389. package/templates/skills/services/influxdb/SKILL.md +275 -275
  390. package/templates/skills/services/kafka/SKILL.md +351 -351
  391. package/templates/skills/services/mariadb/SKILL.md +193 -193
  392. package/templates/skills/services/memcached/SKILL.md +252 -252
  393. package/templates/skills/services/minio/SKILL.md +211 -211
  394. package/templates/skills/services/mongodb/SKILL.md +278 -278
  395. package/templates/skills/services/mysql/SKILL.md +368 -368
  396. package/templates/skills/services/neo4j/SKILL.md +257 -257
  397. package/templates/skills/services/oracle/SKILL.md +300 -300
  398. package/templates/skills/services/postgresql/SKILL.md +336 -336
  399. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  400. package/templates/skills/services/redis/SKILL.md +302 -302
  401. package/templates/skills/services/s3/SKILL.md +308 -308
  402. package/templates/skills/services/sqlite/SKILL.md +304 -304
  403. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  404. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  405. package/templates/skills/workflows/ralph/install.sh +87 -87
  406. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,617 +1,617 @@
1
- ---
2
- name: "Java"
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
- <!-- JAVA:START -->
12
- # Java 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
- # Maven projects:
20
- mvn spotless:check # Format check
21
- mvn checkstyle:check # Linting
22
- mvn test # All tests (100% pass)
23
- mvn package -DskipTests # Build
24
- mvn jacoco:check # Coverage (95%+ required)
25
-
26
- # Security audit:
27
- mvn dependency:analyze # Dependency check
28
- mvn versions:display-dependency-updates # Outdated deps
29
-
30
- # Gradle projects:
31
- ./gradlew spotlessCheck # Format check
32
- ./gradlew checkstyleMain # Linting
33
- ./gradlew test # All tests
34
- ./gradlew build -x test # Build
35
- ./gradlew jacocoTestCoverageVerification # Coverage
36
- ```
37
-
38
- ## Java Version
39
-
40
- **CRITICAL**: Use Java 17 LTS or Java 21 LTS for modern features and long-term support.
41
-
42
- - **Minimum Version**: Java 17 LTS
43
- - **Recommended**: Java 21 LTS
44
- - **Build Tool**: Maven or Gradle
45
-
46
- ### Formatting
47
-
48
- - Use Spotless or Google Java Format
49
- - Consistent formatting across entire project
50
- - Format before committing
51
-
52
- Maven configuration (`pom.xml`):
53
- ```xml
54
- <plugin>
55
- <groupId>com.diffplug.spotless</groupId>
56
- <artifactId>spotless-maven-plugin</artifactId>
57
- <version>2.40.0</version>
58
- <configuration>
59
- <java>
60
- <googleJavaFormat>
61
- <version>1.17.0</version>
62
- <style>GOOGLE</style>
63
- </googleJavaFormat>
64
- </java>
65
- </configuration>
66
- </plugin>
67
- ```
68
-
69
- Gradle configuration (`build.gradle`):
70
- ```gradle
71
- plugins {
72
- id 'com.diffplug.spotless' version '6.23.0'
73
- }
74
-
75
- spotless {
76
- java {
77
- googleJavaFormat('1.17.0').aosp()
78
- }
79
- }
80
- ```
81
-
82
- ### Linting
83
-
84
- - Use Checkstyle for style checks
85
- - Use PMD for code quality
86
- - Use SpotBugs for bug detection
87
- - Configure in `checkstyle.xml`, `pmd.xml`
88
-
89
- ### Testing
90
-
91
- - **Framework**: JUnit 5 (JUnit Jupiter)
92
- - **Location**: `src/test/java`
93
- - **Coverage**: Must meet project threshold (default 95%)
94
- - **Assertions**: Use AssertJ or JUnit assertions
95
- - **Mocking**: Use Mockito when needed
96
-
97
- Example test structure:
98
- ```java
99
- package com.example.myapp;
100
-
101
- import org.junit.jupiter.api.Test;
102
- import org.junit.jupiter.api.BeforeEach;
103
- import org.junit.jupiter.api.DisplayName;
104
- import static org.assertj.core.api.Assertions.*;
105
-
106
- class UserServiceTest {
107
-
108
- private UserService userService;
109
-
110
- @BeforeEach
111
- void setUp() {
112
- userService = new UserService();
113
- }
114
-
115
- @Test
116
- @DisplayName("Should create user with valid data")
117
- void shouldCreateUserWithValidData() {
118
- // Given
119
- UserInput input = new UserInput("test@example.com", "password");
120
-
121
- // When
122
- User user = userService.createUser(input);
123
-
124
- // Then
125
- assertThat(user).isNotNull();
126
- assertThat(user.getEmail()).isEqualTo("test@example.com");
127
- }
128
-
129
- @Test
130
- @DisplayName("Should throw exception for invalid email")
131
- void shouldThrowExceptionForInvalidEmail() {
132
- // Given
133
- UserInput input = new UserInput("invalid", "password");
134
-
135
- // When/Then
136
- assertThatThrownBy(() -> userService.createUser(input))
137
- .isInstanceOf(ValidationException.class)
138
- .hasMessageContaining("Invalid email");
139
- }
140
- }
141
- ```
142
-
143
- ## Dependency Management
144
-
145
- **CRITICAL**: Use Maven or Gradle with dependency management.
146
-
147
- ### Maven (pom.xml)
148
-
149
- ```xml
150
- <properties>
151
- <java.version>21</java.version>
152
- <maven.compiler.source>21</maven.compiler.source>
153
- <maven.compiler.target>21</maven.compiler.target>
154
- </properties>
155
-
156
- <dependencies>
157
- <dependency>
158
- <groupId>org.springframework.boot</groupId>
159
- <artifactId>spring-boot-starter</artifactId>
160
- <version>3.2.0</version>
161
- </dependency>
162
-
163
- <!-- Testing -->
164
- <dependency>
165
- <groupId>org.junit.jupiter</groupId>
166
- <artifactId>junit-jupiter</artifactId>
167
- <version>5.10.1</version>
168
- <scope>test</scope>
169
- </dependency>
170
- </dependencies>
171
- ```
172
-
173
- ### Gradle (build.gradle)
174
-
175
- ```gradle
176
- plugins {
177
- id 'java'
178
- id 'org.springframework.boot' version '3.2.0'
179
- }
180
-
181
- java {
182
- sourceCompatibility = JavaVersion.VERSION_21
183
- targetCompatibility = JavaVersion.VERSION_21
184
- }
185
-
186
- dependencies {
187
- implementation 'org.springframework.boot:spring-boot-starter'
188
-
189
- testImplementation 'org.junit.jupiter:junit-jupiter:5.10.1'
190
- testImplementation 'org.assertj:assertj-core:3.24.2'
191
- }
192
-
193
- test {
194
- useJUnitPlatform()
195
- }
196
- ```
197
-
198
- ### Dependency Guidelines
199
-
200
- 1. **Check for latest versions**:
201
- - Use Context7 MCP tool if available
202
- - Check Maven Central for latest releases
203
- - Review changelog for breaking changes
204
-
205
- 2. **Version Management**:
206
- - ✅ Use BOM (Bill of Materials) for version consistency
207
- - ✅ Keep dependencies updated regularly
208
- - ✅ Use dependency management in parent POM
209
- - ❌ Don't use SNAPSHOT in production
210
- - ❌ Don't use vulnerable dependencies
211
-
212
- ## Error Handling
213
-
214
- - Use exceptions for exceptional cases only
215
- - Create custom exceptions extending RuntimeException or Exception
216
- - Use try-with-resources for resource management
217
- - Log errors appropriately
218
- - Never catch and ignore exceptions
219
-
220
- Example:
221
- ```java
222
- public class UserService {
223
-
224
- public User createUser(UserInput input) throws ValidationException {
225
- if (input.getEmail() == null || input.getEmail().isEmpty()) {
226
- throw new ValidationException("Email is required");
227
- }
228
-
229
- try {
230
- return userRepository.save(input);
231
- } catch (DataAccessException e) {
232
- throw new ServiceException("Failed to create user", e);
233
- }
234
- }
235
- }
236
-
237
- public class ValidationException extends RuntimeException {
238
- public ValidationException(String message) {
239
- super(message);
240
- }
241
- }
242
- ```
243
-
244
- ## Documentation
245
-
246
- - **Javadoc**: Document all public APIs
247
- - **Package Info**: Create `package-info.java`
248
- - **Examples**: Include usage examples
249
- - **Generate**: `mvn javadoc:javadoc` or `./gradlew javadoc`
250
-
251
- Example:
252
- ```java
253
- /**
254
- * Processes user data and returns validated result.
255
- *
256
- * <p>This method validates the input data according to business rules
257
- * and returns a validated User object. If validation fails, it throws
258
- * a ValidationException with details about the failure.
259
- *
260
- * @param input the user input data to process
261
- * @return validated User object
262
- * @throws ValidationException if input validation fails
263
- * @throws ServiceException if database operation fails
264
- *
265
- * @see UserInput
266
- * @see ValidationException
267
- *
268
- * @since 1.0.0
269
- */
270
- public User processUser(UserInput input) throws ValidationException {
271
- // Implementation
272
- return null;
273
- }
274
- ```
275
-
276
- ## Project Structure
277
-
278
- ```
279
- project/
280
- ├── pom.xml # Maven config (or build.gradle)
281
- ├── README.md # Project overview (allowed in root)
282
- ├── CHANGELOG.md # Version history (allowed in root)
283
- ├── AGENTS.md # AI assistant rules (allowed in root)
284
- ├── LICENSE # Project license (allowed in root)
285
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
286
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
287
- ├── SECURITY.md # Security policy (allowed in root)
288
- ├── src/
289
- │ ├── main/
290
- │ │ ├── java/
291
- │ │ │ └── com/example/
292
- │ │ │ ├── Application.java
293
- │ │ │ ├── controller/
294
- │ │ │ ├── service/
295
- │ │ │ └── repository/
296
- │ │ └── resources/
297
- │ │ └── application.properties
298
- │ └── test/
299
- │ ├── java/
300
- │ │ └── com/example/
301
- │ │ ├── service/
302
- │ │ └── repository/
303
- │ └── resources/
304
- ├── target/ # Build output (gitignored)
305
- └── docs/ # Documentation
306
- ```
307
-
308
- ## Modern Java Features
309
-
310
- ### Records (Java 14+)
311
-
312
- ```java
313
- public record User(String email, String name, LocalDateTime createdAt) {
314
- // Compact constructor
315
- public User {
316
- if (email == null || email.isEmpty()) {
317
- throw new IllegalArgumentException("Email required");
318
- }
319
- }
320
- }
321
- ```
322
-
323
- ### Pattern Matching (Java 17+)
324
-
325
- ```java
326
- public String processValue(Object value) {
327
- return switch (value) {
328
- case String s -> "String: " + s;
329
- case Integer i -> "Integer: " + i;
330
- case null -> "Null value";
331
- default -> "Unknown type";
332
- };
333
- }
334
- ```
335
-
336
- ### Sealed Classes (Java 17+)
337
-
338
- ```java
339
- public sealed interface Result<T, E> permits Success, Failure {
340
- // Interface definition
341
- }
342
-
343
- public record Success<T, E>(T value) implements Result<T, E> {}
344
- public record Failure<T, E>(E error) implements Result<T, E> {}
345
- ```
346
-
347
- ## CI/CD Requirements
348
-
349
- Must include GitHub Actions workflows for:
350
-
351
- 1. **Testing** (`java-test.yml`):
352
- - Test on ubuntu-latest, windows-latest
353
- - Test on Java 17, 21
354
- - Upload coverage to Codecov
355
-
356
- 2. **Linting** (`java-lint.yml`):
357
- - Checkstyle checks
358
- - PMD analysis
359
- - SpotBugs detection
360
-
361
- 3. **Build** (`java-build.yml`):
362
- - Build with Maven/Gradle
363
- - Verify JAR creation
364
- - Check dependencies
365
-
366
- ## Package Publication
367
-
368
- ### Publishing to Maven Central
369
-
370
- **Prerequisites:**
371
- 1. Sonatype OSSRH account (https://issues.sonatype.org)
372
- 2. GPG key for signing
373
- 3. Group ID approval (e.g., `io.github.username`)
374
- 4. Add credentials to GitHub Secrets
375
-
376
- **Maven (pom.xml) Configuration:**
377
-
378
- ```xml
379
- <project>
380
- <modelVersion>4.0.0</modelVersion>
381
-
382
- <groupId>io.github.your-username</groupId>
383
- <artifactId>your-library</artifactId>
384
- <version>1.0.0</version>
385
- <packaging>jar</packaging>
386
-
387
- <name>Your Library</name>
388
- <description>A concise description of your library</description>
389
- <url>https://github.com/your-org/your-library</url>
390
-
391
- <licenses>
392
- <license>
393
- <name>MIT License</name>
394
- <url>https://opensource.org/licenses/MIT</url>
395
- </license>
396
- </licenses>
397
-
398
- <developers>
399
- <developer>
400
- <name>Your Name</name>
401
- <email>your.email@example.com</email>
402
- <organization>Your Organization</organization>
403
- <organizationUrl>https://your-org.com</organizationUrl>
404
- </developer>
405
- </developers>
406
-
407
- <scm>
408
- <connection>scm:git:git://github.com/your-org/your-library.git</connection>
409
- <developerConnection>scm:git:ssh://github.com:your-org/your-library.git</developerConnection>
410
- <url>https://github.com/your-org/your-library/tree/main</url>
411
- </scm>
412
-
413
- <distributionManagement>
414
- <repository>
415
- <id>ossrh</id>
416
- <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
417
- </repository>
418
- </distributionManagement>
419
-
420
- <build>
421
- <plugins>
422
- <!-- Source JAR -->
423
- <plugin>
424
- <groupId>org.apache.maven.plugins</groupId>
425
- <artifactId>maven-source-plugin</artifactId>
426
- <version>3.3.0</version>
427
- <executions>
428
- <execution>
429
- <id>attach-sources</id>
430
- <goals>
431
- <goal>jar-no-fork</goal>
432
- </goals>
433
- </execution>
434
- </executions>
435
- </plugin>
436
-
437
- <!-- Javadoc JAR -->
438
- <plugin>
439
- <groupId>org.apache.maven.plugins</groupId>
440
- <artifactId>maven-javadoc-plugin</artifactId>
441
- <version>3.6.3</version>
442
- <executions>
443
- <execution>
444
- <id>attach-javadocs</id>
445
- <goals>
446
- <goal>jar</goal>
447
- </goals>
448
- </execution>
449
- </executions>
450
- </plugin>
451
-
452
- <!-- GPG Signing -->
453
- <plugin>
454
- <groupId>org.apache.maven.plugins</groupId>
455
- <artifactId>maven-gpg-plugin</artifactId>
456
- <version>3.1.0</version>
457
- <executions>
458
- <execution>
459
- <id>sign-artifacts</id>
460
- <phase>verify</phase>
461
- <goals>
462
- <goal>sign</goal>
463
- </goals>
464
- </execution>
465
- </executions>
466
- </plugin>
467
- </plugins>
468
- </build>
469
- </project>
470
- ```
471
-
472
- **Gradle (build.gradle.kts) Configuration:**
473
-
474
- ```kotlin
475
- plugins {
476
- `java-library`
477
- `maven-publish`
478
- signing
479
- id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
480
- }
481
-
482
- group = "io.github.your-username"
483
- version = "1.0.0"
484
-
485
- java {
486
- sourceCompatibility = JavaVersion.VERSION_17
487
- targetCompatibility = JavaVersion.VERSION_17
488
- withSourcesJar()
489
- withJavadocJar()
490
- }
491
-
492
- publishing {
493
- publications {
494
- create<MavenPublication>("mavenJava") {
495
- from(components["java"])
496
-
497
- pom {
498
- name.set("Your Library")
499
- description.set("A concise description of your library")
500
- url.set("https://github.com/your-org/your-library")
501
-
502
- licenses {
503
- license {
504
- name.set("MIT License")
505
- url.set("https://opensource.org/licenses/MIT")
506
- }
507
- }
508
-
509
- developers {
510
- developer {
511
- id.set("your-username")
512
- name.set("Your Name")
513
- email.set("your.email@example.com")
514
- }
515
- }
516
-
517
- scm {
518
- connection.set("scm:git:git://github.com/your-org/your-library.git")
519
- developerConnection.set("scm:git:ssh://github.com:your-org/your-library.git")
520
- url.set("https://github.com/your-org/your-library")
521
- }
522
- }
523
- }
524
- }
525
- }
526
-
527
- signing {
528
- sign(publishing.publications["mavenJava"])
529
- }
530
-
531
- nexusPublishing {
532
- repositories {
533
- sonatype {
534
- nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
535
- snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
536
- }
537
- }
538
- }
539
- ```
540
-
541
- **Publishing Workflow:**
542
-
543
- 1. Update version in pom.xml/build.gradle
544
- 2. Update CHANGELOG.md
545
- 3. Run quality checks:
546
- ```bash
547
- # Maven
548
- mvn clean test
549
- mvn checkstyle:check
550
- mvn pmd:check
551
-
552
- # Gradle
553
- ./gradlew test
554
- ./gradlew checkstyleMain
555
- ./gradlew pmdMain
556
- ```
557
-
558
- 4. Create git tag: `git tag v1.0.0 && git push --tags`
559
- 5. GitHub Actions automatically publishes to Maven Central
560
- 6. Or manual publish:
561
- ```bash
562
- # Maven
563
- mvn clean deploy -P release
564
-
565
- # Gradle
566
- ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository
567
- ```
568
-
569
- **Publishing Checklist:**
570
-
571
- - ✅ All tests passing
572
- - ✅ Checkstyle passes
573
- - ✅ PMD analysis clean
574
- - ✅ SpotBugs finds no issues
575
- - ✅ Version updated
576
- - ✅ CHANGELOG.md updated
577
- - ✅ README.md up to date
578
- - ✅ LICENSE file present
579
- - ✅ Source JAR generated
580
- - ✅ Javadoc JAR generated
581
- - ✅ Artifacts signed with GPG
582
- - ✅ POM metadata complete
583
-
584
- **GitHub Secrets:**
585
-
586
- Add these secrets to your repository:
587
-
588
- - `MAVEN_USERNAME`: Sonatype username
589
- - `MAVEN_PASSWORD`: Sonatype password
590
- - `GPG_PRIVATE_KEY`: Your GPG private key (exported as ASCII)
591
- - `GPG_PASSPHRASE`: GPG key passphrase
592
-
593
- **Alternative: GitHub Packages**
594
-
595
- For simpler setup, publish to GitHub Packages:
596
-
597
- ```xml
598
- <distributionManagement>
599
- <repository>
600
- <id>github</id>
601
- <url>https://maven.pkg.github.com/your-org/your-library</url>
602
- </repository>
603
- </distributionManagement>
604
- ```
605
-
606
- Users can then add to their pom.xml:
607
- ```xml
608
- <repositories>
609
- <repository>
610
- <id>github</id>
611
- <url>https://maven.pkg.github.com/your-org/*</url>
612
- </repository>
613
- </repositories>
614
- ```
615
-
616
- <!-- JAVA:END -->
617
-
1
+ ---
2
+ name: "Java"
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
+ <!-- JAVA:START -->
12
+ # Java 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
+ # Maven projects:
20
+ mvn spotless:check # Format check
21
+ mvn checkstyle:check # Linting
22
+ mvn test # All tests (100% pass)
23
+ mvn package -DskipTests # Build
24
+ mvn jacoco:check # Coverage (95%+ required)
25
+
26
+ # Security audit:
27
+ mvn dependency:analyze # Dependency check
28
+ mvn versions:display-dependency-updates # Outdated deps
29
+
30
+ # Gradle projects:
31
+ ./gradlew spotlessCheck # Format check
32
+ ./gradlew checkstyleMain # Linting
33
+ ./gradlew test # All tests
34
+ ./gradlew build -x test # Build
35
+ ./gradlew jacocoTestCoverageVerification # Coverage
36
+ ```
37
+
38
+ ## Java Version
39
+
40
+ **CRITICAL**: Use Java 17 LTS or Java 21 LTS for modern features and long-term support.
41
+
42
+ - **Minimum Version**: Java 17 LTS
43
+ - **Recommended**: Java 21 LTS
44
+ - **Build Tool**: Maven or Gradle
45
+
46
+ ### Formatting
47
+
48
+ - Use Spotless or Google Java Format
49
+ - Consistent formatting across entire project
50
+ - Format before committing
51
+
52
+ Maven configuration (`pom.xml`):
53
+ ```xml
54
+ <plugin>
55
+ <groupId>com.diffplug.spotless</groupId>
56
+ <artifactId>spotless-maven-plugin</artifactId>
57
+ <version>2.40.0</version>
58
+ <configuration>
59
+ <java>
60
+ <googleJavaFormat>
61
+ <version>1.17.0</version>
62
+ <style>GOOGLE</style>
63
+ </googleJavaFormat>
64
+ </java>
65
+ </configuration>
66
+ </plugin>
67
+ ```
68
+
69
+ Gradle configuration (`build.gradle`):
70
+ ```gradle
71
+ plugins {
72
+ id 'com.diffplug.spotless' version '6.23.0'
73
+ }
74
+
75
+ spotless {
76
+ java {
77
+ googleJavaFormat('1.17.0').aosp()
78
+ }
79
+ }
80
+ ```
81
+
82
+ ### Linting
83
+
84
+ - Use Checkstyle for style checks
85
+ - Use PMD for code quality
86
+ - Use SpotBugs for bug detection
87
+ - Configure in `checkstyle.xml`, `pmd.xml`
88
+
89
+ ### Testing
90
+
91
+ - **Framework**: JUnit 5 (JUnit Jupiter)
92
+ - **Location**: `src/test/java`
93
+ - **Coverage**: Must meet project threshold (default 95%)
94
+ - **Assertions**: Use AssertJ or JUnit assertions
95
+ - **Mocking**: Use Mockito when needed
96
+
97
+ Example test structure:
98
+ ```java
99
+ package com.example.myapp;
100
+
101
+ import org.junit.jupiter.api.Test;
102
+ import org.junit.jupiter.api.BeforeEach;
103
+ import org.junit.jupiter.api.DisplayName;
104
+ import static org.assertj.core.api.Assertions.*;
105
+
106
+ class UserServiceTest {
107
+
108
+ private UserService userService;
109
+
110
+ @BeforeEach
111
+ void setUp() {
112
+ userService = new UserService();
113
+ }
114
+
115
+ @Test
116
+ @DisplayName("Should create user with valid data")
117
+ void shouldCreateUserWithValidData() {
118
+ // Given
119
+ UserInput input = new UserInput("test@example.com", "password");
120
+
121
+ // When
122
+ User user = userService.createUser(input);
123
+
124
+ // Then
125
+ assertThat(user).isNotNull();
126
+ assertThat(user.getEmail()).isEqualTo("test@example.com");
127
+ }
128
+
129
+ @Test
130
+ @DisplayName("Should throw exception for invalid email")
131
+ void shouldThrowExceptionForInvalidEmail() {
132
+ // Given
133
+ UserInput input = new UserInput("invalid", "password");
134
+
135
+ // When/Then
136
+ assertThatThrownBy(() -> userService.createUser(input))
137
+ .isInstanceOf(ValidationException.class)
138
+ .hasMessageContaining("Invalid email");
139
+ }
140
+ }
141
+ ```
142
+
143
+ ## Dependency Management
144
+
145
+ **CRITICAL**: Use Maven or Gradle with dependency management.
146
+
147
+ ### Maven (pom.xml)
148
+
149
+ ```xml
150
+ <properties>
151
+ <java.version>21</java.version>
152
+ <maven.compiler.source>21</maven.compiler.source>
153
+ <maven.compiler.target>21</maven.compiler.target>
154
+ </properties>
155
+
156
+ <dependencies>
157
+ <dependency>
158
+ <groupId>org.springframework.boot</groupId>
159
+ <artifactId>spring-boot-starter</artifactId>
160
+ <version>3.2.0</version>
161
+ </dependency>
162
+
163
+ <!-- Testing -->
164
+ <dependency>
165
+ <groupId>org.junit.jupiter</groupId>
166
+ <artifactId>junit-jupiter</artifactId>
167
+ <version>5.10.1</version>
168
+ <scope>test</scope>
169
+ </dependency>
170
+ </dependencies>
171
+ ```
172
+
173
+ ### Gradle (build.gradle)
174
+
175
+ ```gradle
176
+ plugins {
177
+ id 'java'
178
+ id 'org.springframework.boot' version '3.2.0'
179
+ }
180
+
181
+ java {
182
+ sourceCompatibility = JavaVersion.VERSION_21
183
+ targetCompatibility = JavaVersion.VERSION_21
184
+ }
185
+
186
+ dependencies {
187
+ implementation 'org.springframework.boot:spring-boot-starter'
188
+
189
+ testImplementation 'org.junit.jupiter:junit-jupiter:5.10.1'
190
+ testImplementation 'org.assertj:assertj-core:3.24.2'
191
+ }
192
+
193
+ test {
194
+ useJUnitPlatform()
195
+ }
196
+ ```
197
+
198
+ ### Dependency Guidelines
199
+
200
+ 1. **Check for latest versions**:
201
+ - Use Context7 MCP tool if available
202
+ - Check Maven Central for latest releases
203
+ - Review changelog for breaking changes
204
+
205
+ 2. **Version Management**:
206
+ - ✅ Use BOM (Bill of Materials) for version consistency
207
+ - ✅ Keep dependencies updated regularly
208
+ - ✅ Use dependency management in parent POM
209
+ - ❌ Don't use SNAPSHOT in production
210
+ - ❌ Don't use vulnerable dependencies
211
+
212
+ ## Error Handling
213
+
214
+ - Use exceptions for exceptional cases only
215
+ - Create custom exceptions extending RuntimeException or Exception
216
+ - Use try-with-resources for resource management
217
+ - Log errors appropriately
218
+ - Never catch and ignore exceptions
219
+
220
+ Example:
221
+ ```java
222
+ public class UserService {
223
+
224
+ public User createUser(UserInput input) throws ValidationException {
225
+ if (input.getEmail() == null || input.getEmail().isEmpty()) {
226
+ throw new ValidationException("Email is required");
227
+ }
228
+
229
+ try {
230
+ return userRepository.save(input);
231
+ } catch (DataAccessException e) {
232
+ throw new ServiceException("Failed to create user", e);
233
+ }
234
+ }
235
+ }
236
+
237
+ public class ValidationException extends RuntimeException {
238
+ public ValidationException(String message) {
239
+ super(message);
240
+ }
241
+ }
242
+ ```
243
+
244
+ ## Documentation
245
+
246
+ - **Javadoc**: Document all public APIs
247
+ - **Package Info**: Create `package-info.java`
248
+ - **Examples**: Include usage examples
249
+ - **Generate**: `mvn javadoc:javadoc` or `./gradlew javadoc`
250
+
251
+ Example:
252
+ ```java
253
+ /**
254
+ * Processes user data and returns validated result.
255
+ *
256
+ * <p>This method validates the input data according to business rules
257
+ * and returns a validated User object. If validation fails, it throws
258
+ * a ValidationException with details about the failure.
259
+ *
260
+ * @param input the user input data to process
261
+ * @return validated User object
262
+ * @throws ValidationException if input validation fails
263
+ * @throws ServiceException if database operation fails
264
+ *
265
+ * @see UserInput
266
+ * @see ValidationException
267
+ *
268
+ * @since 1.0.0
269
+ */
270
+ public User processUser(UserInput input) throws ValidationException {
271
+ // Implementation
272
+ return null;
273
+ }
274
+ ```
275
+
276
+ ## Project Structure
277
+
278
+ ```
279
+ project/
280
+ ├── pom.xml # Maven config (or build.gradle)
281
+ ├── README.md # Project overview (allowed in root)
282
+ ├── CHANGELOG.md # Version history (allowed in root)
283
+ ├── AGENTS.md # AI assistant rules (allowed in root)
284
+ ├── LICENSE # Project license (allowed in root)
285
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
286
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
287
+ ├── SECURITY.md # Security policy (allowed in root)
288
+ ├── src/
289
+ │ ├── main/
290
+ │ │ ├── java/
291
+ │ │ │ └── com/example/
292
+ │ │ │ ├── Application.java
293
+ │ │ │ ├── controller/
294
+ │ │ │ ├── service/
295
+ │ │ │ └── repository/
296
+ │ │ └── resources/
297
+ │ │ └── application.properties
298
+ │ └── test/
299
+ │ ├── java/
300
+ │ │ └── com/example/
301
+ │ │ ├── service/
302
+ │ │ └── repository/
303
+ │ └── resources/
304
+ ├── target/ # Build output (gitignored)
305
+ └── docs/ # Documentation
306
+ ```
307
+
308
+ ## Modern Java Features
309
+
310
+ ### Records (Java 14+)
311
+
312
+ ```java
313
+ public record User(String email, String name, LocalDateTime createdAt) {
314
+ // Compact constructor
315
+ public User {
316
+ if (email == null || email.isEmpty()) {
317
+ throw new IllegalArgumentException("Email required");
318
+ }
319
+ }
320
+ }
321
+ ```
322
+
323
+ ### Pattern Matching (Java 17+)
324
+
325
+ ```java
326
+ public String processValue(Object value) {
327
+ return switch (value) {
328
+ case String s -> "String: " + s;
329
+ case Integer i -> "Integer: " + i;
330
+ case null -> "Null value";
331
+ default -> "Unknown type";
332
+ };
333
+ }
334
+ ```
335
+
336
+ ### Sealed Classes (Java 17+)
337
+
338
+ ```java
339
+ public sealed interface Result<T, E> permits Success, Failure {
340
+ // Interface definition
341
+ }
342
+
343
+ public record Success<T, E>(T value) implements Result<T, E> {}
344
+ public record Failure<T, E>(E error) implements Result<T, E> {}
345
+ ```
346
+
347
+ ## CI/CD Requirements
348
+
349
+ Must include GitHub Actions workflows for:
350
+
351
+ 1. **Testing** (`java-test.yml`):
352
+ - Test on ubuntu-latest, windows-latest
353
+ - Test on Java 17, 21
354
+ - Upload coverage to Codecov
355
+
356
+ 2. **Linting** (`java-lint.yml`):
357
+ - Checkstyle checks
358
+ - PMD analysis
359
+ - SpotBugs detection
360
+
361
+ 3. **Build** (`java-build.yml`):
362
+ - Build with Maven/Gradle
363
+ - Verify JAR creation
364
+ - Check dependencies
365
+
366
+ ## Package Publication
367
+
368
+ ### Publishing to Maven Central
369
+
370
+ **Prerequisites:**
371
+ 1. Sonatype OSSRH account (https://issues.sonatype.org)
372
+ 2. GPG key for signing
373
+ 3. Group ID approval (e.g., `io.github.username`)
374
+ 4. Add credentials to GitHub Secrets
375
+
376
+ **Maven (pom.xml) Configuration:**
377
+
378
+ ```xml
379
+ <project>
380
+ <modelVersion>4.0.0</modelVersion>
381
+
382
+ <groupId>io.github.your-username</groupId>
383
+ <artifactId>your-library</artifactId>
384
+ <version>1.0.0</version>
385
+ <packaging>jar</packaging>
386
+
387
+ <name>Your Library</name>
388
+ <description>A concise description of your library</description>
389
+ <url>https://github.com/your-org/your-library</url>
390
+
391
+ <licenses>
392
+ <license>
393
+ <name>MIT License</name>
394
+ <url>https://opensource.org/licenses/MIT</url>
395
+ </license>
396
+ </licenses>
397
+
398
+ <developers>
399
+ <developer>
400
+ <name>Your Name</name>
401
+ <email>your.email@example.com</email>
402
+ <organization>Your Organization</organization>
403
+ <organizationUrl>https://your-org.com</organizationUrl>
404
+ </developer>
405
+ </developers>
406
+
407
+ <scm>
408
+ <connection>scm:git:git://github.com/your-org/your-library.git</connection>
409
+ <developerConnection>scm:git:ssh://github.com:your-org/your-library.git</developerConnection>
410
+ <url>https://github.com/your-org/your-library/tree/main</url>
411
+ </scm>
412
+
413
+ <distributionManagement>
414
+ <repository>
415
+ <id>ossrh</id>
416
+ <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
417
+ </repository>
418
+ </distributionManagement>
419
+
420
+ <build>
421
+ <plugins>
422
+ <!-- Source JAR -->
423
+ <plugin>
424
+ <groupId>org.apache.maven.plugins</groupId>
425
+ <artifactId>maven-source-plugin</artifactId>
426
+ <version>3.3.0</version>
427
+ <executions>
428
+ <execution>
429
+ <id>attach-sources</id>
430
+ <goals>
431
+ <goal>jar-no-fork</goal>
432
+ </goals>
433
+ </execution>
434
+ </executions>
435
+ </plugin>
436
+
437
+ <!-- Javadoc JAR -->
438
+ <plugin>
439
+ <groupId>org.apache.maven.plugins</groupId>
440
+ <artifactId>maven-javadoc-plugin</artifactId>
441
+ <version>3.6.3</version>
442
+ <executions>
443
+ <execution>
444
+ <id>attach-javadocs</id>
445
+ <goals>
446
+ <goal>jar</goal>
447
+ </goals>
448
+ </execution>
449
+ </executions>
450
+ </plugin>
451
+
452
+ <!-- GPG Signing -->
453
+ <plugin>
454
+ <groupId>org.apache.maven.plugins</groupId>
455
+ <artifactId>maven-gpg-plugin</artifactId>
456
+ <version>3.1.0</version>
457
+ <executions>
458
+ <execution>
459
+ <id>sign-artifacts</id>
460
+ <phase>verify</phase>
461
+ <goals>
462
+ <goal>sign</goal>
463
+ </goals>
464
+ </execution>
465
+ </executions>
466
+ </plugin>
467
+ </plugins>
468
+ </build>
469
+ </project>
470
+ ```
471
+
472
+ **Gradle (build.gradle.kts) Configuration:**
473
+
474
+ ```kotlin
475
+ plugins {
476
+ `java-library`
477
+ `maven-publish`
478
+ signing
479
+ id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
480
+ }
481
+
482
+ group = "io.github.your-username"
483
+ version = "1.0.0"
484
+
485
+ java {
486
+ sourceCompatibility = JavaVersion.VERSION_17
487
+ targetCompatibility = JavaVersion.VERSION_17
488
+ withSourcesJar()
489
+ withJavadocJar()
490
+ }
491
+
492
+ publishing {
493
+ publications {
494
+ create<MavenPublication>("mavenJava") {
495
+ from(components["java"])
496
+
497
+ pom {
498
+ name.set("Your Library")
499
+ description.set("A concise description of your library")
500
+ url.set("https://github.com/your-org/your-library")
501
+
502
+ licenses {
503
+ license {
504
+ name.set("MIT License")
505
+ url.set("https://opensource.org/licenses/MIT")
506
+ }
507
+ }
508
+
509
+ developers {
510
+ developer {
511
+ id.set("your-username")
512
+ name.set("Your Name")
513
+ email.set("your.email@example.com")
514
+ }
515
+ }
516
+
517
+ scm {
518
+ connection.set("scm:git:git://github.com/your-org/your-library.git")
519
+ developerConnection.set("scm:git:ssh://github.com:your-org/your-library.git")
520
+ url.set("https://github.com/your-org/your-library")
521
+ }
522
+ }
523
+ }
524
+ }
525
+ }
526
+
527
+ signing {
528
+ sign(publishing.publications["mavenJava"])
529
+ }
530
+
531
+ nexusPublishing {
532
+ repositories {
533
+ sonatype {
534
+ nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
535
+ snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
536
+ }
537
+ }
538
+ }
539
+ ```
540
+
541
+ **Publishing Workflow:**
542
+
543
+ 1. Update version in pom.xml/build.gradle
544
+ 2. Update CHANGELOG.md
545
+ 3. Run quality checks:
546
+ ```bash
547
+ # Maven
548
+ mvn clean test
549
+ mvn checkstyle:check
550
+ mvn pmd:check
551
+
552
+ # Gradle
553
+ ./gradlew test
554
+ ./gradlew checkstyleMain
555
+ ./gradlew pmdMain
556
+ ```
557
+
558
+ 4. Create git tag: `git tag v1.0.0 && git push --tags`
559
+ 5. GitHub Actions automatically publishes to Maven Central
560
+ 6. Or manual publish:
561
+ ```bash
562
+ # Maven
563
+ mvn clean deploy -P release
564
+
565
+ # Gradle
566
+ ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository
567
+ ```
568
+
569
+ **Publishing Checklist:**
570
+
571
+ - ✅ All tests passing
572
+ - ✅ Checkstyle passes
573
+ - ✅ PMD analysis clean
574
+ - ✅ SpotBugs finds no issues
575
+ - ✅ Version updated
576
+ - ✅ CHANGELOG.md updated
577
+ - ✅ README.md up to date
578
+ - ✅ LICENSE file present
579
+ - ✅ Source JAR generated
580
+ - ✅ Javadoc JAR generated
581
+ - ✅ Artifacts signed with GPG
582
+ - ✅ POM metadata complete
583
+
584
+ **GitHub Secrets:**
585
+
586
+ Add these secrets to your repository:
587
+
588
+ - `MAVEN_USERNAME`: Sonatype username
589
+ - `MAVEN_PASSWORD`: Sonatype password
590
+ - `GPG_PRIVATE_KEY`: Your GPG private key (exported as ASCII)
591
+ - `GPG_PASSPHRASE`: GPG key passphrase
592
+
593
+ **Alternative: GitHub Packages**
594
+
595
+ For simpler setup, publish to GitHub Packages:
596
+
597
+ ```xml
598
+ <distributionManagement>
599
+ <repository>
600
+ <id>github</id>
601
+ <url>https://maven.pkg.github.com/your-org/your-library</url>
602
+ </repository>
603
+ </distributionManagement>
604
+ ```
605
+
606
+ Users can then add to their pom.xml:
607
+ ```xml
608
+ <repositories>
609
+ <repository>
610
+ <id>github</id>
611
+ <url>https://maven.pkg.github.com/your-org/*</url>
612
+ </repository>
613
+ </repositories>
614
+ ```
615
+
616
+ <!-- JAVA:END -->
617
+