@hivehub/rulebook 4.2.2 → 4.3.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 (340) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +15 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +43 -18
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +10 -2
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +48 -9
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/config-manager.d.ts.map +1 -1
  27. package/dist/core/config-manager.js +1 -2
  28. package/dist/core/config-manager.js.map +1 -1
  29. package/dist/core/generator.d.ts +13 -0
  30. package/dist/core/generator.d.ts.map +1 -1
  31. package/dist/core/generator.js +283 -28
  32. package/dist/core/generator.js.map +1 -1
  33. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  34. package/dist/core/indexer/background-indexer.js +10 -3
  35. package/dist/core/indexer/background-indexer.js.map +1 -1
  36. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  37. package/dist/core/workspace/workspace-manager.js +2 -6
  38. package/dist/core/workspace/workspace-manager.js.map +1 -1
  39. package/dist/index.js +1 -3
  40. package/dist/index.js.map +1 -1
  41. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  42. package/dist/mcp/rulebook-server.js +23 -10
  43. package/dist/mcp/rulebook-server.js.map +1 -1
  44. package/package.json +21 -22
  45. package/templates/agents/accessibility-reviewer.md +43 -0
  46. package/templates/agents/api-designer.md +42 -0
  47. package/templates/agents/architect.md +51 -0
  48. package/templates/agents/build-engineer.md +36 -0
  49. package/templates/agents/code-reviewer.md +47 -0
  50. package/templates/agents/database-architect.md +41 -0
  51. package/templates/agents/devops-engineer.md +42 -0
  52. package/templates/agents/docs-writer.md +38 -0
  53. package/templates/agents/i18n-engineer.md +42 -0
  54. package/templates/agents/implementer.md +38 -35
  55. package/templates/agents/migration-engineer.md +42 -0
  56. package/templates/agents/performance-engineer.md +49 -0
  57. package/templates/agents/refactoring-agent.md +41 -0
  58. package/templates/agents/researcher.md +38 -34
  59. package/templates/agents/security-reviewer.md +40 -0
  60. package/templates/agents/team-lead.md +37 -34
  61. package/templates/agents/tester.md +45 -42
  62. package/templates/agents/ux-reviewer.md +43 -0
  63. package/templates/ci/rulebook-review.yml +26 -26
  64. package/templates/cli/AIDER.md +49 -49
  65. package/templates/cli/AMAZON_Q.md +25 -25
  66. package/templates/cli/AUGGIE.md +32 -32
  67. package/templates/cli/CLAUDE.md +117 -117
  68. package/templates/cli/CLINE.md +99 -99
  69. package/templates/cli/CODEBUDDY.md +20 -20
  70. package/templates/cli/CODEIUM.md +20 -20
  71. package/templates/cli/CODEX.md +21 -21
  72. package/templates/cli/CONTINUE.md +34 -34
  73. package/templates/cli/CURSOR_CLI.md +62 -62
  74. package/templates/cli/FACTORY.md +18 -18
  75. package/templates/cli/GEMINI.md +35 -35
  76. package/templates/cli/KILOCODE.md +18 -18
  77. package/templates/cli/OPENCODE.md +18 -18
  78. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  79. package/templates/commands/rulebook-memory-save.md +48 -48
  80. package/templates/commands/rulebook-memory-search.md +47 -47
  81. package/templates/commands/rulebook-task-apply.md +67 -67
  82. package/templates/commands/rulebook-task-archive.md +94 -94
  83. package/templates/commands/rulebook-task-create.md +93 -93
  84. package/templates/commands/rulebook-task-list.md +42 -42
  85. package/templates/commands/rulebook-task-show.md +52 -52
  86. package/templates/commands/rulebook-task-validate.md +53 -53
  87. package/templates/core/AGENTS_LEAN.md +25 -25
  88. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  89. package/templates/core/AGENT_AUTOMATION.md +288 -288
  90. package/templates/core/DAG.md +304 -304
  91. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  92. package/templates/core/MULTI_AGENT.md +74 -74
  93. package/templates/core/PLANS.md +28 -28
  94. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  95. package/templates/core/RALPH.md +471 -471
  96. package/templates/core/RULEBOOK.md +1935 -1935
  97. package/templates/frameworks/ANGULAR.md +36 -36
  98. package/templates/frameworks/DJANGO.md +83 -83
  99. package/templates/frameworks/ELECTRON.md +147 -147
  100. package/templates/frameworks/FLASK.md +38 -38
  101. package/templates/frameworks/FLUTTER.md +55 -55
  102. package/templates/frameworks/JQUERY.md +32 -32
  103. package/templates/frameworks/LARAVEL.md +38 -38
  104. package/templates/frameworks/NESTJS.md +43 -43
  105. package/templates/frameworks/NEXTJS.md +127 -127
  106. package/templates/frameworks/NUXT.md +40 -40
  107. package/templates/frameworks/RAILS.md +66 -66
  108. package/templates/frameworks/REACT.md +38 -38
  109. package/templates/frameworks/REACT_NATIVE.md +47 -47
  110. package/templates/frameworks/SPRING.md +39 -39
  111. package/templates/frameworks/SYMFONY.md +36 -36
  112. package/templates/frameworks/VUE.md +36 -36
  113. package/templates/frameworks/ZEND.md +35 -35
  114. package/templates/git/CI_CD_PATTERNS.md +661 -661
  115. package/templates/git/GITHUB_ACTIONS.md +728 -728
  116. package/templates/git/GITLAB_CI.md +730 -730
  117. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  118. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  119. package/templates/hooks/COMMIT_MSG.md +530 -530
  120. package/templates/hooks/POST_CHECKOUT.md +546 -546
  121. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  122. package/templates/hooks/PRE_COMMIT.md +414 -414
  123. package/templates/hooks/PRE_PUSH.md +601 -601
  124. package/templates/ides/CONTINUE_RULES.md +16 -16
  125. package/templates/ides/COPILOT.md +37 -37
  126. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  127. package/templates/ides/CURSOR.md +43 -43
  128. package/templates/ides/GEMINI_RULES.md +17 -17
  129. package/templates/ides/JETBRAINS_AI.md +35 -35
  130. package/templates/ides/REPLIT.md +36 -36
  131. package/templates/ides/TABNINE.md +29 -29
  132. package/templates/ides/VSCODE.md +40 -40
  133. package/templates/ides/WINDSURF.md +36 -36
  134. package/templates/ides/WINDSURF_RULES.md +14 -14
  135. package/templates/ides/ZED.md +32 -32
  136. package/templates/ides/cursor-mdc/go.mdc +24 -24
  137. package/templates/ides/cursor-mdc/python.mdc +24 -24
  138. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  139. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  140. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  141. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  142. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  143. package/templates/languages/C.md +333 -333
  144. package/templates/languages/CPP.md +743 -743
  145. package/templates/languages/CSHARP.md +417 -417
  146. package/templates/languages/ELIXIR.md +454 -454
  147. package/templates/languages/ERLANG.md +361 -361
  148. package/templates/languages/GO.md +645 -645
  149. package/templates/languages/HASKELL.md +177 -177
  150. package/templates/languages/JAVA.md +607 -607
  151. package/templates/languages/JAVASCRIPT.md +631 -631
  152. package/templates/languages/JULIA.md +97 -97
  153. package/templates/languages/KOTLIN.md +511 -511
  154. package/templates/languages/LISP.md +100 -100
  155. package/templates/languages/LUA.md +74 -74
  156. package/templates/languages/OBJECTIVEC.md +90 -90
  157. package/templates/languages/PHP.md +416 -416
  158. package/templates/languages/PYTHON.md +682 -682
  159. package/templates/languages/RUBY.md +421 -421
  160. package/templates/languages/RUST.md +477 -477
  161. package/templates/languages/SAS.md +73 -73
  162. package/templates/languages/SCALA.md +348 -348
  163. package/templates/languages/SOLIDITY.md +580 -580
  164. package/templates/languages/SQL.md +137 -137
  165. package/templates/languages/SWIFT.md +466 -466
  166. package/templates/languages/TYPESCRIPT.md +591 -591
  167. package/templates/languages/ZIG.md +265 -265
  168. package/templates/modules/ATLASSIAN.md +255 -255
  169. package/templates/modules/CONTEXT7.md +54 -54
  170. package/templates/modules/FIGMA.md +267 -267
  171. package/templates/modules/GITHUB_MCP.md +64 -64
  172. package/templates/modules/GRAFANA.md +328 -328
  173. package/templates/modules/MEMORY.md +126 -126
  174. package/templates/modules/NOTION.md +247 -247
  175. package/templates/modules/PLAYWRIGHT.md +90 -90
  176. package/templates/modules/RULEBOOK_MCP.md +156 -156
  177. package/templates/modules/SERENA.md +337 -337
  178. package/templates/modules/SUPABASE.md +223 -223
  179. package/templates/modules/SYNAP.md +69 -69
  180. package/templates/modules/VECTORIZER.md +63 -63
  181. package/templates/modules/sequential-thinking.md +42 -42
  182. package/templates/ralph/ralph-history.bat +4 -4
  183. package/templates/ralph/ralph-history.sh +5 -5
  184. package/templates/ralph/ralph-init.bat +5 -5
  185. package/templates/ralph/ralph-init.sh +5 -5
  186. package/templates/ralph/ralph-pause.bat +5 -5
  187. package/templates/ralph/ralph-pause.sh +5 -5
  188. package/templates/ralph/ralph-run.bat +5 -5
  189. package/templates/ralph/ralph-run.sh +5 -5
  190. package/templates/ralph/ralph-status.bat +4 -4
  191. package/templates/ralph/ralph-status.sh +5 -5
  192. package/templates/services/AZURE_BLOB.md +184 -184
  193. package/templates/services/CASSANDRA.md +239 -239
  194. package/templates/services/DATADOG.md +26 -26
  195. package/templates/services/DOCKER.md +124 -124
  196. package/templates/services/DOCKER_COMPOSE.md +168 -168
  197. package/templates/services/DYNAMODB.md +308 -308
  198. package/templates/services/ELASTICSEARCH.md +347 -347
  199. package/templates/services/GCS.md +178 -178
  200. package/templates/services/HELM.md +194 -194
  201. package/templates/services/INFLUXDB.md +265 -265
  202. package/templates/services/KAFKA.md +341 -341
  203. package/templates/services/KUBERNETES.md +208 -208
  204. package/templates/services/MARIADB.md +183 -183
  205. package/templates/services/MEMCACHED.md +242 -242
  206. package/templates/services/MINIO.md +201 -201
  207. package/templates/services/MONGODB.md +268 -268
  208. package/templates/services/MYSQL.md +358 -358
  209. package/templates/services/NEO4J.md +247 -247
  210. package/templates/services/OPENTELEMETRY.md +25 -25
  211. package/templates/services/ORACLE.md +290 -290
  212. package/templates/services/PINO.md +24 -24
  213. package/templates/services/POSTGRESQL.md +326 -326
  214. package/templates/services/PROMETHEUS.md +33 -33
  215. package/templates/services/RABBITMQ.md +286 -286
  216. package/templates/services/REDIS.md +292 -292
  217. package/templates/services/S3.md +298 -298
  218. package/templates/services/SENTRY.md +23 -23
  219. package/templates/services/SQLITE.md +294 -294
  220. package/templates/services/SQLSERVER.md +294 -294
  221. package/templates/services/WINSTON.md +30 -30
  222. package/templates/skills/cli/aider/SKILL.md +59 -59
  223. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  224. package/templates/skills/cli/auggie/SKILL.md +42 -42
  225. package/templates/skills/cli/claude/SKILL.md +42 -42
  226. package/templates/skills/cli/cline/SKILL.md +42 -42
  227. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  228. package/templates/skills/cli/codeium/SKILL.md +30 -30
  229. package/templates/skills/cli/codex/SKILL.md +31 -31
  230. package/templates/skills/cli/continue/SKILL.md +44 -44
  231. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  232. package/templates/skills/cli/factory/SKILL.md +28 -28
  233. package/templates/skills/cli/gemini/SKILL.md +45 -45
  234. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  235. package/templates/skills/cli/opencode/SKILL.md +28 -28
  236. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  237. package/templates/skills/core/dag/SKILL.md +314 -314
  238. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  239. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  240. package/templates/skills/core/rulebook/SKILL.md +176 -176
  241. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  242. package/templates/skills/dev/api-design/SKILL.md +15 -0
  243. package/templates/skills/dev/architect/SKILL.md +17 -0
  244. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  245. package/templates/skills/dev/db-design/SKILL.md +15 -0
  246. package/templates/skills/dev/debug/SKILL.md +16 -0
  247. package/templates/skills/dev/deploy/SKILL.md +17 -0
  248. package/templates/skills/dev/docs/SKILL.md +17 -0
  249. package/templates/skills/dev/migrate/SKILL.md +15 -0
  250. package/templates/skills/dev/perf/SKILL.md +17 -0
  251. package/templates/skills/dev/refactor/SKILL.md +17 -0
  252. package/templates/skills/dev/research/SKILL.md +14 -0
  253. package/templates/skills/dev/review/SKILL.md +18 -0
  254. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  255. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  256. package/templates/skills/frameworks/django/SKILL.md +93 -93
  257. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  258. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  259. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  260. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  261. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  262. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  263. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  264. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  265. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  266. package/templates/skills/frameworks/react/SKILL.md +48 -48
  267. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  268. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  269. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  270. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  271. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  272. package/templates/skills/ides/copilot/SKILL.md +47 -47
  273. package/templates/skills/ides/cursor/SKILL.md +53 -53
  274. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  275. package/templates/skills/ides/replit/SKILL.md +46 -46
  276. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  277. package/templates/skills/ides/vscode/SKILL.md +50 -50
  278. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  279. package/templates/skills/ides/zed/SKILL.md +42 -42
  280. package/templates/skills/languages/c/SKILL.md +343 -343
  281. package/templates/skills/languages/cpp/SKILL.md +753 -753
  282. package/templates/skills/languages/csharp/SKILL.md +427 -427
  283. package/templates/skills/languages/elixir/SKILL.md +464 -464
  284. package/templates/skills/languages/erlang/SKILL.md +371 -371
  285. package/templates/skills/languages/go/SKILL.md +655 -655
  286. package/templates/skills/languages/haskell/SKILL.md +187 -187
  287. package/templates/skills/languages/java/SKILL.md +617 -617
  288. package/templates/skills/languages/javascript/SKILL.md +641 -641
  289. package/templates/skills/languages/julia/SKILL.md +107 -107
  290. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  291. package/templates/skills/languages/lisp/SKILL.md +110 -110
  292. package/templates/skills/languages/lua/SKILL.md +84 -84
  293. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  294. package/templates/skills/languages/php/SKILL.md +426 -426
  295. package/templates/skills/languages/python/SKILL.md +692 -692
  296. package/templates/skills/languages/ruby/SKILL.md +431 -431
  297. package/templates/skills/languages/rust/SKILL.md +487 -487
  298. package/templates/skills/languages/sas/SKILL.md +83 -83
  299. package/templates/skills/languages/scala/SKILL.md +358 -358
  300. package/templates/skills/languages/solidity/SKILL.md +590 -590
  301. package/templates/skills/languages/sql/SKILL.md +147 -147
  302. package/templates/skills/languages/swift/SKILL.md +476 -476
  303. package/templates/skills/languages/typescript/SKILL.md +302 -302
  304. package/templates/skills/languages/zig/SKILL.md +275 -275
  305. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  306. package/templates/skills/modules/context7/SKILL.md +64 -64
  307. package/templates/skills/modules/figma/SKILL.md +277 -277
  308. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  309. package/templates/skills/modules/grafana/SKILL.md +338 -338
  310. package/templates/skills/modules/memory/SKILL.md +73 -73
  311. package/templates/skills/modules/notion/SKILL.md +257 -257
  312. package/templates/skills/modules/playwright/SKILL.md +100 -100
  313. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  314. package/templates/skills/modules/serena/SKILL.md +347 -347
  315. package/templates/skills/modules/supabase/SKILL.md +233 -233
  316. package/templates/skills/modules/synap/SKILL.md +79 -79
  317. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  318. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  319. package/templates/skills/services/cassandra/SKILL.md +249 -249
  320. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  321. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  322. package/templates/skills/services/gcs/SKILL.md +188 -188
  323. package/templates/skills/services/influxdb/SKILL.md +275 -275
  324. package/templates/skills/services/kafka/SKILL.md +351 -351
  325. package/templates/skills/services/mariadb/SKILL.md +193 -193
  326. package/templates/skills/services/memcached/SKILL.md +252 -252
  327. package/templates/skills/services/minio/SKILL.md +211 -211
  328. package/templates/skills/services/mongodb/SKILL.md +278 -278
  329. package/templates/skills/services/mysql/SKILL.md +368 -368
  330. package/templates/skills/services/neo4j/SKILL.md +257 -257
  331. package/templates/skills/services/oracle/SKILL.md +300 -300
  332. package/templates/skills/services/postgresql/SKILL.md +336 -336
  333. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  334. package/templates/skills/services/redis/SKILL.md +302 -302
  335. package/templates/skills/services/s3/SKILL.md +308 -308
  336. package/templates/skills/services/sqlite/SKILL.md +304 -304
  337. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  338. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  339. package/templates/skills/workflows/ralph/install.sh +87 -87
  340. 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
+