@hivehub/rulebook 4.1.0 → 4.2.0

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