@hivehub/rulebook 5.7.0 → 5.8.1

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