@hivehub/rulebook 4.2.2 → 4.3.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/README.md +8 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +4 -4
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +8 -1
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +32 -1
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/generator.d.ts +13 -0
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +283 -28
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  31. package/dist/core/workspace/workspace-manager.js +2 -6
  32. package/dist/core/workspace/workspace-manager.js.map +1 -1
  33. package/dist/index.js +1 -3
  34. package/dist/index.js.map +1 -1
  35. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  36. package/dist/mcp/rulebook-server.js +5 -4
  37. package/dist/mcp/rulebook-server.js.map +1 -1
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -0
  40. package/templates/agents/api-designer.md +42 -0
  41. package/templates/agents/architect.md +51 -0
  42. package/templates/agents/build-engineer.md +36 -0
  43. package/templates/agents/code-reviewer.md +47 -0
  44. package/templates/agents/database-architect.md +41 -0
  45. package/templates/agents/devops-engineer.md +42 -0
  46. package/templates/agents/docs-writer.md +38 -0
  47. package/templates/agents/i18n-engineer.md +42 -0
  48. package/templates/agents/implementer.md +38 -35
  49. package/templates/agents/migration-engineer.md +42 -0
  50. package/templates/agents/performance-engineer.md +49 -0
  51. package/templates/agents/refactoring-agent.md +41 -0
  52. package/templates/agents/researcher.md +38 -34
  53. package/templates/agents/security-reviewer.md +40 -0
  54. package/templates/agents/team-lead.md +37 -34
  55. package/templates/agents/tester.md +45 -42
  56. package/templates/agents/ux-reviewer.md +43 -0
  57. package/templates/ci/rulebook-review.yml +26 -26
  58. package/templates/cli/AIDER.md +49 -49
  59. package/templates/cli/AMAZON_Q.md +25 -25
  60. package/templates/cli/AUGGIE.md +32 -32
  61. package/templates/cli/CLAUDE.md +117 -117
  62. package/templates/cli/CLINE.md +99 -99
  63. package/templates/cli/CODEBUDDY.md +20 -20
  64. package/templates/cli/CODEIUM.md +20 -20
  65. package/templates/cli/CODEX.md +21 -21
  66. package/templates/cli/CONTINUE.md +34 -34
  67. package/templates/cli/CURSOR_CLI.md +62 -62
  68. package/templates/cli/FACTORY.md +18 -18
  69. package/templates/cli/GEMINI.md +35 -35
  70. package/templates/cli/KILOCODE.md +18 -18
  71. package/templates/cli/OPENCODE.md +18 -18
  72. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  73. package/templates/commands/rulebook-memory-save.md +48 -48
  74. package/templates/commands/rulebook-memory-search.md +47 -47
  75. package/templates/commands/rulebook-task-apply.md +67 -67
  76. package/templates/commands/rulebook-task-archive.md +94 -94
  77. package/templates/commands/rulebook-task-create.md +93 -93
  78. package/templates/commands/rulebook-task-list.md +42 -42
  79. package/templates/commands/rulebook-task-show.md +52 -52
  80. package/templates/commands/rulebook-task-validate.md +53 -53
  81. package/templates/core/AGENTS_LEAN.md +25 -25
  82. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  83. package/templates/core/AGENT_AUTOMATION.md +288 -288
  84. package/templates/core/DAG.md +304 -304
  85. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  86. package/templates/core/MULTI_AGENT.md +74 -74
  87. package/templates/core/PLANS.md +28 -28
  88. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  89. package/templates/core/RALPH.md +471 -471
  90. package/templates/core/RULEBOOK.md +1935 -1935
  91. package/templates/frameworks/ANGULAR.md +36 -36
  92. package/templates/frameworks/DJANGO.md +83 -83
  93. package/templates/frameworks/ELECTRON.md +147 -147
  94. package/templates/frameworks/FLASK.md +38 -38
  95. package/templates/frameworks/FLUTTER.md +55 -55
  96. package/templates/frameworks/JQUERY.md +32 -32
  97. package/templates/frameworks/LARAVEL.md +38 -38
  98. package/templates/frameworks/NESTJS.md +43 -43
  99. package/templates/frameworks/NEXTJS.md +127 -127
  100. package/templates/frameworks/NUXT.md +40 -40
  101. package/templates/frameworks/RAILS.md +66 -66
  102. package/templates/frameworks/REACT.md +38 -38
  103. package/templates/frameworks/REACT_NATIVE.md +47 -47
  104. package/templates/frameworks/SPRING.md +39 -39
  105. package/templates/frameworks/SYMFONY.md +36 -36
  106. package/templates/frameworks/VUE.md +36 -36
  107. package/templates/frameworks/ZEND.md +35 -35
  108. package/templates/git/CI_CD_PATTERNS.md +661 -661
  109. package/templates/git/GITHUB_ACTIONS.md +728 -728
  110. package/templates/git/GITLAB_CI.md +730 -730
  111. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  112. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  113. package/templates/hooks/COMMIT_MSG.md +530 -530
  114. package/templates/hooks/POST_CHECKOUT.md +546 -546
  115. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  116. package/templates/hooks/PRE_COMMIT.md +414 -414
  117. package/templates/hooks/PRE_PUSH.md +601 -601
  118. package/templates/ides/CONTINUE_RULES.md +16 -16
  119. package/templates/ides/COPILOT.md +37 -37
  120. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  121. package/templates/ides/CURSOR.md +43 -43
  122. package/templates/ides/GEMINI_RULES.md +17 -17
  123. package/templates/ides/JETBRAINS_AI.md +35 -35
  124. package/templates/ides/REPLIT.md +36 -36
  125. package/templates/ides/TABNINE.md +29 -29
  126. package/templates/ides/VSCODE.md +40 -40
  127. package/templates/ides/WINDSURF.md +36 -36
  128. package/templates/ides/WINDSURF_RULES.md +14 -14
  129. package/templates/ides/ZED.md +32 -32
  130. package/templates/ides/cursor-mdc/go.mdc +24 -24
  131. package/templates/ides/cursor-mdc/python.mdc +24 -24
  132. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  133. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  134. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  135. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  136. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  137. package/templates/languages/C.md +333 -333
  138. package/templates/languages/CPP.md +743 -743
  139. package/templates/languages/CSHARP.md +417 -417
  140. package/templates/languages/ELIXIR.md +454 -454
  141. package/templates/languages/ERLANG.md +361 -361
  142. package/templates/languages/GO.md +645 -645
  143. package/templates/languages/HASKELL.md +177 -177
  144. package/templates/languages/JAVA.md +607 -607
  145. package/templates/languages/JAVASCRIPT.md +631 -631
  146. package/templates/languages/JULIA.md +97 -97
  147. package/templates/languages/KOTLIN.md +511 -511
  148. package/templates/languages/LISP.md +100 -100
  149. package/templates/languages/LUA.md +74 -74
  150. package/templates/languages/OBJECTIVEC.md +90 -90
  151. package/templates/languages/PHP.md +416 -416
  152. package/templates/languages/PYTHON.md +682 -682
  153. package/templates/languages/RUBY.md +421 -421
  154. package/templates/languages/RUST.md +477 -477
  155. package/templates/languages/SAS.md +73 -73
  156. package/templates/languages/SCALA.md +348 -348
  157. package/templates/languages/SOLIDITY.md +580 -580
  158. package/templates/languages/SQL.md +137 -137
  159. package/templates/languages/SWIFT.md +466 -466
  160. package/templates/languages/TYPESCRIPT.md +591 -591
  161. package/templates/languages/ZIG.md +265 -265
  162. package/templates/modules/ATLASSIAN.md +255 -255
  163. package/templates/modules/CONTEXT7.md +54 -54
  164. package/templates/modules/FIGMA.md +267 -267
  165. package/templates/modules/GITHUB_MCP.md +64 -64
  166. package/templates/modules/GRAFANA.md +328 -328
  167. package/templates/modules/MEMORY.md +126 -126
  168. package/templates/modules/NOTION.md +247 -247
  169. package/templates/modules/PLAYWRIGHT.md +90 -90
  170. package/templates/modules/RULEBOOK_MCP.md +156 -156
  171. package/templates/modules/SERENA.md +337 -337
  172. package/templates/modules/SUPABASE.md +223 -223
  173. package/templates/modules/SYNAP.md +69 -69
  174. package/templates/modules/VECTORIZER.md +63 -63
  175. package/templates/modules/sequential-thinking.md +42 -42
  176. package/templates/ralph/ralph-history.bat +4 -4
  177. package/templates/ralph/ralph-history.sh +5 -5
  178. package/templates/ralph/ralph-init.bat +5 -5
  179. package/templates/ralph/ralph-init.sh +5 -5
  180. package/templates/ralph/ralph-pause.bat +5 -5
  181. package/templates/ralph/ralph-pause.sh +5 -5
  182. package/templates/ralph/ralph-run.bat +5 -5
  183. package/templates/ralph/ralph-run.sh +5 -5
  184. package/templates/ralph/ralph-status.bat +4 -4
  185. package/templates/ralph/ralph-status.sh +5 -5
  186. package/templates/services/AZURE_BLOB.md +184 -184
  187. package/templates/services/CASSANDRA.md +239 -239
  188. package/templates/services/DATADOG.md +26 -26
  189. package/templates/services/DOCKER.md +124 -124
  190. package/templates/services/DOCKER_COMPOSE.md +168 -168
  191. package/templates/services/DYNAMODB.md +308 -308
  192. package/templates/services/ELASTICSEARCH.md +347 -347
  193. package/templates/services/GCS.md +178 -178
  194. package/templates/services/HELM.md +194 -194
  195. package/templates/services/INFLUXDB.md +265 -265
  196. package/templates/services/KAFKA.md +341 -341
  197. package/templates/services/KUBERNETES.md +208 -208
  198. package/templates/services/MARIADB.md +183 -183
  199. package/templates/services/MEMCACHED.md +242 -242
  200. package/templates/services/MINIO.md +201 -201
  201. package/templates/services/MONGODB.md +268 -268
  202. package/templates/services/MYSQL.md +358 -358
  203. package/templates/services/NEO4J.md +247 -247
  204. package/templates/services/OPENTELEMETRY.md +25 -25
  205. package/templates/services/ORACLE.md +290 -290
  206. package/templates/services/PINO.md +24 -24
  207. package/templates/services/POSTGRESQL.md +326 -326
  208. package/templates/services/PROMETHEUS.md +33 -33
  209. package/templates/services/RABBITMQ.md +286 -286
  210. package/templates/services/REDIS.md +292 -292
  211. package/templates/services/S3.md +298 -298
  212. package/templates/services/SENTRY.md +23 -23
  213. package/templates/services/SQLITE.md +294 -294
  214. package/templates/services/SQLSERVER.md +294 -294
  215. package/templates/services/WINSTON.md +30 -30
  216. package/templates/skills/cli/aider/SKILL.md +59 -59
  217. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  218. package/templates/skills/cli/auggie/SKILL.md +42 -42
  219. package/templates/skills/cli/claude/SKILL.md +42 -42
  220. package/templates/skills/cli/cline/SKILL.md +42 -42
  221. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  222. package/templates/skills/cli/codeium/SKILL.md +30 -30
  223. package/templates/skills/cli/codex/SKILL.md +31 -31
  224. package/templates/skills/cli/continue/SKILL.md +44 -44
  225. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  226. package/templates/skills/cli/factory/SKILL.md +28 -28
  227. package/templates/skills/cli/gemini/SKILL.md +45 -45
  228. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  229. package/templates/skills/cli/opencode/SKILL.md +28 -28
  230. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  231. package/templates/skills/core/dag/SKILL.md +314 -314
  232. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  233. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  234. package/templates/skills/core/rulebook/SKILL.md +176 -176
  235. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  236. package/templates/skills/dev/api-design/SKILL.md +15 -0
  237. package/templates/skills/dev/architect/SKILL.md +17 -0
  238. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  239. package/templates/skills/dev/db-design/SKILL.md +15 -0
  240. package/templates/skills/dev/debug/SKILL.md +16 -0
  241. package/templates/skills/dev/deploy/SKILL.md +17 -0
  242. package/templates/skills/dev/docs/SKILL.md +17 -0
  243. package/templates/skills/dev/migrate/SKILL.md +15 -0
  244. package/templates/skills/dev/perf/SKILL.md +17 -0
  245. package/templates/skills/dev/refactor/SKILL.md +17 -0
  246. package/templates/skills/dev/research/SKILL.md +14 -0
  247. package/templates/skills/dev/review/SKILL.md +18 -0
  248. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  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
package/templates/hooks/COMMIT_MSG.md CHANGED
@@ -1,530 +1,530 @@
1
- # Commit Message Hook
2
-
3
- This template provides guidance for implementing commit-msg git hooks that enforce commit message standards and conventions.
4
-
5
- ## Purpose
6
-
7
- Commit-msg hooks run after commit message is entered to:
8
- - Enforce conventional commit format
9
- - Validate commit message structure
10
- - Ensure clear, actionable commit messages
11
- - Maintain consistent commit history
12
- - Enable automated changelog generation
13
-
14
- ## Agent Automation Commands
15
-
16
- When implementing or modifying commit-msg hooks, use these patterns:
17
-
18
- ### Standard Commit Format
19
- ```bash
20
- # Conventional Commits format
21
- git commit -m "feat: add user authentication"
22
- git commit -m "fix: resolve memory leak in parser"
23
- git commit -m "docs: update API documentation"
24
-
25
- # With scope
26
- git commit -m "feat(auth): add JWT token validation"
27
- git commit -m "fix(api): handle null responses gracefully"
28
-
29
- # With breaking change
30
- git commit -m "feat!: redesign API endpoints" -m "BREAKING CHANGE: API v1 endpoints removed"
31
-
32
- # Skip validation (emergency only)
33
- git commit --no-verify -m "WIP: work in progress"
34
- ```
35
-
36
- ## Conventional Commits Format
37
-
38
- ### Structure
39
- ```
40
- <type>(<scope>): <subject>
41
-
42
- <body>
43
-
44
- <footer>
45
- ```
46
-
47
- ### Required Components
48
-
49
- **Type** (required): Must be one of:
50
- - `feat`: New feature
51
- - `fix`: Bug fix
52
- - `docs`: Documentation only changes
53
- - `style`: Code style changes (formatting, semicolons, etc.)
54
- - `refactor`: Code change that neither fixes a bug nor adds a feature
55
- - `perf`: Performance improvement
56
- - `test`: Adding or updating tests
57
- - `build`: Changes to build system or dependencies
58
- - `ci`: Changes to CI configuration
59
- - `chore`: Other changes that don't modify src or test files
60
- - `revert`: Reverts a previous commit
61
-
62
- **Subject** (required):
63
- - Brief description (50 chars or less)
64
- - Lowercase first letter
65
- - No period at end
66
- - Imperative mood ("add" not "added" or "adds")
67
-
68
- **Scope** (optional):
69
- - Noun describing section of codebase
70
- - Examples: `api`, `ui`, `auth`, `parser`, `cli`
71
-
72
- **Body** (optional):
73
- - Detailed explanation
74
- - Separate from subject with blank line
75
- - Wrap at 72 characters
76
-
77
- **Footer** (optional):
78
- - Breaking changes: `BREAKING CHANGE: description`
79
- - Issue references: `Closes #123, #456`
80
- - Co-authors: `Co-authored-by: Name <email>`
81
-
82
- ### Examples
83
-
84
- **Good Commits**:
85
- ```
86
- feat(auth): add OAuth2 authentication
87
-
88
- Implement OAuth2 flow with support for Google and GitHub providers.
89
- Includes token refresh mechanism and secure storage.
90
-
91
- Closes #234
92
- ```
93
-
94
- ```
95
- fix: prevent race condition in task queue
96
-
97
- Add mutex to protect concurrent access to task queue.
98
- This resolves intermittent task duplication issues.
99
-
100
- Fixes #567
101
- ```
102
-
103
- ```
104
- docs: add contributing guidelines
105
-
106
- Create CONTRIBUTING.md with:
107
- - Code style requirements
108
- - PR submission process
109
- - Testing guidelines
110
- ```
111
-
112
- **Bad Commits** (will be rejected):
113
- ```
114
- ❌ "Fixed stuff" # No type, unclear
115
- ❌ "feat: Added new feature." # Period at end, "Added" not imperative
116
- ❌ "WIP" # No type, not descriptive
117
- ❌ "Update files" # No type, too vague
118
- ```
119
-
120
- ## Hook Implementation Patterns
121
-
122
- ### Node.js Implementation (Recommended)
123
-
124
- **Shell Wrapper** (`.git/hooks/commit-msg`):
125
- ```bash
126
- #!/bin/sh
127
-
128
- # Find Node.js executable (cross-platform)
129
- NODE_PATH=""
130
- if command -v node >/dev/null 2>&1; then
131
- NODE_PATH="node"
132
- elif [ -f "/c/Program Files/nodejs/node.exe" ]; then
133
- NODE_PATH="/c/Program Files/nodejs/node.exe"
134
- elif [ -f "/usr/bin/node" ]; then
135
- NODE_PATH="/usr/bin/node"
136
- else
137
- echo "Error: Node.js not found"
138
- exit 1
139
- fi
140
-
141
- # Execute Node.js script with commit message file path
142
- "$NODE_PATH" "$(dirname "$0")/commit-msg.js" "$1"
143
- exit $?
144
- ```
145
-
146
- **Node.js Script** (`.git/hooks/commit-msg.js`):
147
- ```javascript
148
- #!/usr/bin/env node
149
-
150
- const fs = require('fs');
151
-
152
- // Conventional commit pattern
153
- const PATTERN = /^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?: .{1,50}$/;
154
-
155
- const TYPES = {
156
- feat: 'A new feature',
157
- fix: 'A bug fix',
158
- docs: 'Documentation only changes',
159
- style: 'Code style changes (formatting, semicolons, etc.)',
160
- refactor: 'Code refactor without fixing bugs or adding features',
161
- perf: 'Performance improvement',
162
- test: 'Adding or updating tests',
163
- build: 'Changes to build system or dependencies',
164
- ci: 'Changes to CI configuration',
165
- chore: 'Other changes (tooling, etc.)',
166
- revert: 'Reverts a previous commit',
167
- };
168
-
169
- function validateCommitMessage(message) {
170
- const lines = message.split('\n');
171
- const subject = lines[0];
172
-
173
- // Check if matches conventional commit format
174
- if (!PATTERN.test(subject)) {
175
- return {
176
- valid: false,
177
- errors: [
178
- 'Commit message does not follow Conventional Commits format.',
179
- '',
180
- 'Expected format: <type>(<scope>): <subject>',
181
- '',
182
- 'Valid types:',
183
- ...Object.entries(TYPES).map(([type, desc]) => ` ${type.padEnd(10)} - ${desc}`),
184
- '',
185
- 'Examples:',
186
- ' feat: add user authentication',
187
- ' fix(api): resolve null pointer exception',
188
- ' docs: update README with installation steps',
189
- '',
190
- 'Your message:',
191
- ` "${subject}"`,
192
- ],
193
- };
194
- }
195
-
196
- // Check subject length
197
- if (subject.length > 72) {
198
- return {
199
- valid: false,
200
- errors: [
201
- `Subject line too long (${subject.length} > 72 characters)`,
202
- 'Keep the subject line concise and under 72 characters.',
203
- ],
204
- };
205
- }
206
-
207
- // Check for period at end
208
- if (subject.endsWith('.')) {
209
- return {
210
- valid: false,
211
- errors: [
212
- 'Subject line should not end with a period.',
213
- '',
214
- 'Correct format:',
215
- ` ${subject.slice(0, -1)}`,
216
- ],
217
- };
218
- }
219
-
220
- // Check for capital letter after colon
221
- const colonIndex = subject.indexOf(':');
222
- if (colonIndex !== -1 && subject[colonIndex + 2] && subject[colonIndex + 2] !== subject[colonIndex + 2].toLowerCase()) {
223
- return {
224
- valid: false,
225
- errors: [
226
- 'Subject should start with lowercase letter after colon.',
227
- '',
228
- 'Correct format:',
229
- ` ${subject.slice(0, colonIndex + 2)}${subject[colonIndex + 2].toLowerCase()}${subject.slice(colonIndex + 3)}`,
230
- ],
231
- };
232
- }
233
-
234
- return { valid: true };
235
- }
236
-
237
- function main() {
238
- const messageFile = process.argv[2];
239
-
240
- if (!messageFile) {
241
- console.error('❌ No commit message file provided');
242
- process.exit(1);
243
- }
244
-
245
- const message = fs.readFileSync(messageFile, 'utf-8').trim();
246
-
247
- // Skip validation for merge commits, revert commits, etc.
248
- if (message.startsWith('Merge') || message.startsWith('Revert')) {
249
- process.exit(0);
250
- }
251
-
252
- const result = validateCommitMessage(message);
253
-
254
- if (!result.valid) {
255
- console.error('\n❌ Invalid commit message!\n');
256
- console.error(result.errors.join('\n'));
257
- console.error('\n💡 Use --no-verify to skip validation (not recommended)\n');
258
- process.exit(1);
259
- }
260
-
261
- console.log('✅ Commit message valid');
262
- process.exit(0);
263
- }
264
-
265
- main();
266
- ```
267
-
268
- ### Shell-Only Implementation (Simple)
269
-
270
- **`.git/hooks/commit-msg`**:
271
- ```bash
272
- #!/bin/sh
273
-
274
- # Read commit message
275
- MESSAGE=$(cat "$1")
276
-
277
- # Skip merge commits
278
- if echo "$MESSAGE" | grep -q "^Merge"; then
279
- exit 0
280
- fi
281
-
282
- # Check conventional commit format
283
- if ! echo "$MESSAGE" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?: .{1,50}"; then
284
- echo ""
285
- echo "❌ Invalid commit message format!"
286
- echo ""
287
- echo "Expected: <type>(<scope>): <subject>"
288
- echo ""
289
- echo "Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
290
- echo ""
291
- echo "Examples:"
292
- echo " feat: add user authentication"
293
- echo " fix(api): resolve null pointer"
294
- echo " docs: update README"
295
- echo ""
296
- exit 1
297
- fi
298
-
299
- echo "✅ Commit message valid"
300
- exit 0
301
- ```
302
-
303
- ## Advanced Validation Rules
304
-
305
- ### Check for Issue References
306
-
307
- ```javascript
308
- function validateIssueReference(message, requiredForTypes = ['feat', 'fix']) {
309
- const lines = message.split('\n');
310
- const subject = lines[0];
311
- const type = subject.match(/^([a-z]+)/)?.[1];
312
-
313
- // Check if issue reference required for this type
314
- if (requiredForTypes.includes(type)) {
315
- const hasIssueRef = /(?:closes|fixes|resolves|refs?) #\d+/i.test(message);
316
-
317
- if (!hasIssueRef) {
318
- return {
319
- valid: false,
320
- errors: [
321
- `Commit type '${type}' requires an issue reference.`,
322
- '',
323
- 'Add to footer:',
324
- ' Closes #123',
325
- ' Fixes #456',
326
- ' Refs #789',
327
- ],
328
- };
329
- }
330
- }
331
-
332
- return { valid: true };
333
- }
334
- ```
335
-
336
- ### Check for Breaking Changes
337
-
338
- ```javascript
339
- function validateBreakingChange(message) {
340
- const hasBreakingIndicator = /^[a-z]+(\(.+\))?!:/.test(message);
341
- const hasBreakingFooter = /BREAKING CHANGE:/m.test(message);
342
-
343
- if (hasBreakingIndicator && !hasBreakingFooter) {
344
- return {
345
- valid: false,
346
- errors: [
347
- 'Breaking change indicator (!) used but no BREAKING CHANGE footer found.',
348
- '',
349
- 'Add to footer:',
350
- ' BREAKING CHANGE: description of what broke',
351
- ],
352
- };
353
- }
354
-
355
- return { valid: true };
356
- }
357
- ```
358
-
359
- ### Check for Co-Authors
360
-
361
- ```javascript
362
- function validateCoAuthors(message) {
363
- const coAuthorLines = message.match(/^Co-authored-by: .+/gm) || [];
364
-
365
- for (const line of coAuthorLines) {
366
- // Validate email format
367
- if (!/^Co-authored-by: .+ <.+@.+\..+>$/.test(line)) {
368
- return {
369
- valid: false,
370
- errors: [
371
- 'Invalid Co-authored-by format.',
372
- '',
373
- 'Expected format:',
374
- ' Co-authored-by: Name <email@example.com>',
375
- '',
376
- `Got: ${line}`,
377
- ],
378
- };
379
- }
380
- }
381
-
382
- return { valid: true };
383
- }
384
- ```
385
-
386
- ## Best Practices
387
-
388
- ### ✅ DO
389
-
390
- 1. **Keep subject line concise** (50 characters or less)
391
- 2. **Use imperative mood** ("add" not "added")
392
- 3. **Reference issues** in footer for feat/fix commits
393
- 4. **Document breaking changes** with BREAKING CHANGE footer
394
- 5. **Add body** for complex changes (explain why, not what)
395
- 6. **Use scopes** for multi-module projects
396
- 7. **Start with lowercase** after colon
397
-
398
- ### ❌ DON'T
399
-
400
- 1. **Don't end subject with period**
401
- 2. **Don't use past tense** ("added" or "adds")
402
- 3. **Don't be vague** ("fix stuff", "update files")
403
- 4. **Don't exceed 72 characters** in subject
404
- 5. **Don't mix multiple changes** in one commit
405
- 6. **Don't forget issue references** for bug fixes
406
- 7. **Don't capitalize** first word after colon
407
-
408
- ## Automated Commit Message Preparation
409
-
410
- Use `prepare-commit-msg` hook to pre-populate message:
411
-
412
- **`.git/hooks/prepare-commit-msg`**:
413
- ```bash
414
- #!/bin/sh
415
-
416
- # Get branch name
417
- BRANCH=$(git rev-parse --abbrev-ref HEAD)
418
-
419
- # Extract issue number from branch (e.g., feature/123-user-auth)
420
- ISSUE=$(echo "$BRANCH" | grep -oE '[0-9]+' | head -1)
421
-
422
- # Add issue reference if found
423
- if [ -n "$ISSUE" ]; then
424
- echo "" >> "$1"
425
- echo "Refs #$ISSUE" >> "$1"
426
- fi
427
- ```
428
-
429
- ## Integration with Tools
430
-
431
- ### Commitlint (npm)
432
-
433
- ```bash
434
- # Install
435
- npm install --save-dev @commitlint/cli @commitlint/config-conventional
436
-
437
- # Configure
438
- echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
439
-
440
- # Create hook
441
- echo "npx --no -- commitlint --edit \$1" > .git/hooks/commit-msg
442
- chmod +x .git/hooks/commit-msg
443
- ```
444
-
445
- ### Husky + Commitlint
446
-
447
- ```bash
448
- # Install
449
- npm install --save-dev husky @commitlint/cli @commitlint/config-conventional
450
-
451
- # Setup husky
452
- npx husky init
453
-
454
- # Add commit-msg hook
455
- npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
456
- ```
457
-
458
- ## Troubleshooting
459
-
460
- ### Hook Not Running
461
-
462
- **Solutions**:
463
- 1. Check permissions: `chmod +x .git/hooks/commit-msg`
464
- 2. Verify shebang: `#!/bin/sh`
465
- 3. Check file location: Must be `.git/hooks/commit-msg` (no extension)
466
-
467
- ### False Positives
468
-
469
- **Issue**: Valid messages rejected
470
-
471
- **Solutions**:
472
- 1. Adjust regex pattern for your team's conventions
473
- 2. Add exceptions for specific message patterns
474
- 3. Allow more types if needed (e.g., `wip`, `hotfix`)
475
-
476
- ### Merge Commits Failing
477
-
478
- **Issue**: Merge commit messages rejected
479
-
480
- **Solution**: Skip validation for merge commits:
481
- ```javascript
482
- if (message.startsWith('Merge') || message.startsWith('Revert')) {
483
- process.exit(0);
484
- }
485
- ```
486
-
487
- ## Emergency Bypass
488
-
489
- ```bash
490
- # Skip commit-msg validation
491
- git commit --no-verify -m "Emergency fix"
492
-
493
- # Or use environment variable
494
- HUSKY_SKIP_HOOKS=1 git commit -m "message"
495
- ```
496
-
497
- ## Integration with Rulebook
498
-
499
- If using `@hivehub/rulebook`, commit-msg hooks are automatically generated:
500
-
501
- ```bash
502
- # Initialize with hooks
503
- npx @hivehub/rulebook init
504
-
505
- # Configuration in .rulebook
506
- {
507
- "hooks": {
508
- "commitMsg": {
509
- "enabled": true,
510
- "enforceConventional": true,
511
- "requireIssueRef": ["feat", "fix"]
512
- }
513
- }
514
- }
515
- ```
516
-
517
- ## Common Pitfalls
518
-
519
- 1. **❌ Too strict validation**: Allow flexibility for trivial commits
520
- 2. **❌ No escape hatch**: Always allow `--no-verify`
521
- 3. **❌ Blocking merge commits**: Skip validation for merge/revert
522
- 4. **❌ Unclear error messages**: Show examples of valid format
523
- 5. **❌ Not documenting conventions**: Add CONTRIBUTING.md with examples
524
-
525
- ## Related Templates
526
-
527
- - See `/.rulebook/specs/PRE_COMMIT.md` for quality checks before commit
528
- - See `/.rulebook/specs/PREPARE_COMMIT_MSG.md` for auto-generating commit messages
529
- - See `/.rulebook/specs/GIT.md` for git workflow and commit conventions
530
- - See `/.rulebook/specs/DOCUMENTATION_RULES.md` for changelog generation from commits
1
+ # Commit Message Hook
2
+
3
+ This template provides guidance for implementing commit-msg git hooks that enforce commit message standards and conventions.
4
+
5
+ ## Purpose
6
+
7
+ Commit-msg hooks run after commit message is entered to:
8
+ - Enforce conventional commit format
9
+ - Validate commit message structure
10
+ - Ensure clear, actionable commit messages
11
+ - Maintain consistent commit history
12
+ - Enable automated changelog generation
13
+
14
+ ## Agent Automation Commands
15
+
16
+ When implementing or modifying commit-msg hooks, use these patterns:
17
+
18
+ ### Standard Commit Format
19
+ ```bash
20
+ # Conventional Commits format
21
+ git commit -m "feat: add user authentication"
22
+ git commit -m "fix: resolve memory leak in parser"
23
+ git commit -m "docs: update API documentation"
24
+
25
+ # With scope
26
+ git commit -m "feat(auth): add JWT token validation"
27
+ git commit -m "fix(api): handle null responses gracefully"
28
+
29
+ # With breaking change
30
+ git commit -m "feat!: redesign API endpoints" -m "BREAKING CHANGE: API v1 endpoints removed"
31
+
32
+ # Skip validation (emergency only)
33
+ git commit --no-verify -m "WIP: work in progress"
34
+ ```
35
+
36
+ ## Conventional Commits Format
37
+
38
+ ### Structure
39
+ ```
40
+ <type>(<scope>): <subject>
41
+
42
+ <body>
43
+
44
+ <footer>
45
+ ```
46
+
47
+ ### Required Components
48
+
49
+ **Type** (required): Must be one of:
50
+ - `feat`: New feature
51
+ - `fix`: Bug fix
52
+ - `docs`: Documentation only changes
53
+ - `style`: Code style changes (formatting, semicolons, etc.)
54
+ - `refactor`: Code change that neither fixes a bug nor adds a feature
55
+ - `perf`: Performance improvement
56
+ - `test`: Adding or updating tests
57
+ - `build`: Changes to build system or dependencies
58
+ - `ci`: Changes to CI configuration
59
+ - `chore`: Other changes that don't modify src or test files
60
+ - `revert`: Reverts a previous commit
61
+
62
+ **Subject** (required):
63
+ - Brief description (50 chars or less)
64
+ - Lowercase first letter
65
+ - No period at end
66
+ - Imperative mood ("add" not "added" or "adds")
67
+
68
+ **Scope** (optional):
69
+ - Noun describing section of codebase
70
+ - Examples: `api`, `ui`, `auth`, `parser`, `cli`
71
+
72
+ **Body** (optional):
73
+ - Detailed explanation
74
+ - Separate from subject with blank line
75
+ - Wrap at 72 characters
76
+
77
+ **Footer** (optional):
78
+ - Breaking changes: `BREAKING CHANGE: description`
79
+ - Issue references: `Closes #123, #456`
80
+ - Co-authors: `Co-authored-by: Name <email>`
81
+
82
+ ### Examples
83
+
84
+ **Good Commits**:
85
+ ```
86
+ feat(auth): add OAuth2 authentication
87
+
88
+ Implement OAuth2 flow with support for Google and GitHub providers.
89
+ Includes token refresh mechanism and secure storage.
90
+
91
+ Closes #234
92
+ ```
93
+
94
+ ```
95
+ fix: prevent race condition in task queue
96
+
97
+ Add mutex to protect concurrent access to task queue.
98
+ This resolves intermittent task duplication issues.
99
+
100
+ Fixes #567
101
+ ```
102
+
103
+ ```
104
+ docs: add contributing guidelines
105
+
106
+ Create CONTRIBUTING.md with:
107
+ - Code style requirements
108
+ - PR submission process
109
+ - Testing guidelines
110
+ ```
111
+
112
+ **Bad Commits** (will be rejected):
113
+ ```
114
+ ❌ "Fixed stuff" # No type, unclear
115
+ ❌ "feat: Added new feature." # Period at end, "Added" not imperative
116
+ ❌ "WIP" # No type, not descriptive
117
+ ❌ "Update files" # No type, too vague
118
+ ```
119
+
120
+ ## Hook Implementation Patterns
121
+
122
+ ### Node.js Implementation (Recommended)
123
+
124
+ **Shell Wrapper** (`.git/hooks/commit-msg`):
125
+ ```bash
126
+ #!/bin/sh
127
+
128
+ # Find Node.js executable (cross-platform)
129
+ NODE_PATH=""
130
+ if command -v node >/dev/null 2>&1; then
131
+ NODE_PATH="node"
132
+ elif [ -f "/c/Program Files/nodejs/node.exe" ]; then
133
+ NODE_PATH="/c/Program Files/nodejs/node.exe"
134
+ elif [ -f "/usr/bin/node" ]; then
135
+ NODE_PATH="/usr/bin/node"
136
+ else
137
+ echo "Error: Node.js not found"
138
+ exit 1
139
+ fi
140
+
141
+ # Execute Node.js script with commit message file path
142
+ "$NODE_PATH" "$(dirname "$0")/commit-msg.js" "$1"
143
+ exit $?
144
+ ```
145
+
146
+ **Node.js Script** (`.git/hooks/commit-msg.js`):
147
+ ```javascript
148
+ #!/usr/bin/env node
149
+
150
+ const fs = require('fs');
151
+
152
+ // Conventional commit pattern
153
+ const PATTERN = /^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?: .{1,50}$/;
154
+
155
+ const TYPES = {
156
+ feat: 'A new feature',
157
+ fix: 'A bug fix',
158
+ docs: 'Documentation only changes',
159
+ style: 'Code style changes (formatting, semicolons, etc.)',
160
+ refactor: 'Code refactor without fixing bugs or adding features',
161
+ perf: 'Performance improvement',
162
+ test: 'Adding or updating tests',
163
+ build: 'Changes to build system or dependencies',
164
+ ci: 'Changes to CI configuration',
165
+ chore: 'Other changes (tooling, etc.)',
166
+ revert: 'Reverts a previous commit',
167
+ };
168
+
169
+ function validateCommitMessage(message) {
170
+ const lines = message.split('\n');
171
+ const subject = lines[0];
172
+
173
+ // Check if matches conventional commit format
174
+ if (!PATTERN.test(subject)) {
175
+ return {
176
+ valid: false,
177
+ errors: [
178
+ 'Commit message does not follow Conventional Commits format.',
179
+ '',
180
+ 'Expected format: <type>(<scope>): <subject>',
181
+ '',
182
+ 'Valid types:',
183
+ ...Object.entries(TYPES).map(([type, desc]) => ` ${type.padEnd(10)} - ${desc}`),
184
+ '',
185
+ 'Examples:',
186
+ ' feat: add user authentication',
187
+ ' fix(api): resolve null pointer exception',
188
+ ' docs: update README with installation steps',
189
+ '',
190
+ 'Your message:',
191
+ ` "${subject}"`,
192
+ ],
193
+ };
194
+ }
195
+
196
+ // Check subject length
197
+ if (subject.length > 72) {
198
+ return {
199
+ valid: false,
200
+ errors: [
201
+ `Subject line too long (${subject.length} > 72 characters)`,
202
+ 'Keep the subject line concise and under 72 characters.',
203
+ ],
204
+ };
205
+ }
206
+
207
+ // Check for period at end
208
+ if (subject.endsWith('.')) {
209
+ return {
210
+ valid: false,
211
+ errors: [
212
+ 'Subject line should not end with a period.',
213
+ '',
214
+ 'Correct format:',
215
+ ` ${subject.slice(0, -1)}`,
216
+ ],
217
+ };
218
+ }
219
+
220
+ // Check for capital letter after colon
221
+ const colonIndex = subject.indexOf(':');
222
+ if (colonIndex !== -1 && subject[colonIndex + 2] && subject[colonIndex + 2] !== subject[colonIndex + 2].toLowerCase()) {
223
+ return {
224
+ valid: false,
225
+ errors: [
226
+ 'Subject should start with lowercase letter after colon.',
227
+ '',
228
+ 'Correct format:',
229
+ ` ${subject.slice(0, colonIndex + 2)}${subject[colonIndex + 2].toLowerCase()}${subject.slice(colonIndex + 3)}`,
230
+ ],
231
+ };
232
+ }
233
+
234
+ return { valid: true };
235
+ }
236
+
237
+ function main() {
238
+ const messageFile = process.argv[2];
239
+
240
+ if (!messageFile) {
241
+ console.error('❌ No commit message file provided');
242
+ process.exit(1);
243
+ }
244
+
245
+ const message = fs.readFileSync(messageFile, 'utf-8').trim();
246
+
247
+ // Skip validation for merge commits, revert commits, etc.
248
+ if (message.startsWith('Merge') || message.startsWith('Revert')) {
249
+ process.exit(0);
250
+ }
251
+
252
+ const result = validateCommitMessage(message);
253
+
254
+ if (!result.valid) {
255
+ console.error('\n❌ Invalid commit message!\n');
256
+ console.error(result.errors.join('\n'));
257
+ console.error('\n💡 Use --no-verify to skip validation (not recommended)\n');
258
+ process.exit(1);
259
+ }
260
+
261
+ console.log('✅ Commit message valid');
262
+ process.exit(0);
263
+ }
264
+
265
+ main();
266
+ ```
267
+
268
+ ### Shell-Only Implementation (Simple)
269
+
270
+ **`.git/hooks/commit-msg`**:
271
+ ```bash
272
+ #!/bin/sh
273
+
274
+ # Read commit message
275
+ MESSAGE=$(cat "$1")
276
+
277
+ # Skip merge commits
278
+ if echo "$MESSAGE" | grep -q "^Merge"; then
279
+ exit 0
280
+ fi
281
+
282
+ # Check conventional commit format
283
+ if ! echo "$MESSAGE" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?!?: .{1,50}"; then
284
+ echo ""
285
+ echo "❌ Invalid commit message format!"
286
+ echo ""
287
+ echo "Expected: <type>(<scope>): <subject>"
288
+ echo ""
289
+ echo "Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
290
+ echo ""
291
+ echo "Examples:"
292
+ echo " feat: add user authentication"
293
+ echo " fix(api): resolve null pointer"
294
+ echo " docs: update README"
295
+ echo ""
296
+ exit 1
297
+ fi
298
+
299
+ echo "✅ Commit message valid"
300
+ exit 0
301
+ ```
302
+
303
+ ## Advanced Validation Rules
304
+
305
+ ### Check for Issue References
306
+
307
+ ```javascript
308
+ function validateIssueReference(message, requiredForTypes = ['feat', 'fix']) {
309
+ const lines = message.split('\n');
310
+ const subject = lines[0];
311
+ const type = subject.match(/^([a-z]+)/)?.[1];
312
+
313
+ // Check if issue reference required for this type
314
+ if (requiredForTypes.includes(type)) {
315
+ const hasIssueRef = /(?:closes|fixes|resolves|refs?) #\d+/i.test(message);
316
+
317
+ if (!hasIssueRef) {
318
+ return {
319
+ valid: false,
320
+ errors: [
321
+ `Commit type '${type}' requires an issue reference.`,
322
+ '',
323
+ 'Add to footer:',
324
+ ' Closes #123',
325
+ ' Fixes #456',
326
+ ' Refs #789',
327
+ ],
328
+ };
329
+ }
330
+ }
331
+
332
+ return { valid: true };
333
+ }
334
+ ```
335
+
336
+ ### Check for Breaking Changes
337
+
338
+ ```javascript
339
+ function validateBreakingChange(message) {
340
+ const hasBreakingIndicator = /^[a-z]+(\(.+\))?!:/.test(message);
341
+ const hasBreakingFooter = /BREAKING CHANGE:/m.test(message);
342
+
343
+ if (hasBreakingIndicator && !hasBreakingFooter) {
344
+ return {
345
+ valid: false,
346
+ errors: [
347
+ 'Breaking change indicator (!) used but no BREAKING CHANGE footer found.',
348
+ '',
349
+ 'Add to footer:',
350
+ ' BREAKING CHANGE: description of what broke',
351
+ ],
352
+ };
353
+ }
354
+
355
+ return { valid: true };
356
+ }
357
+ ```
358
+
359
+ ### Check for Co-Authors
360
+
361
+ ```javascript
362
+ function validateCoAuthors(message) {
363
+ const coAuthorLines = message.match(/^Co-authored-by: .+/gm) || [];
364
+
365
+ for (const line of coAuthorLines) {
366
+ // Validate email format
367
+ if (!/^Co-authored-by: .+ <.+@.+\..+>$/.test(line)) {
368
+ return {
369
+ valid: false,
370
+ errors: [
371
+ 'Invalid Co-authored-by format.',
372
+ '',
373
+ 'Expected format:',
374
+ ' Co-authored-by: Name <email@example.com>',
375
+ '',
376
+ `Got: ${line}`,
377
+ ],
378
+ };
379
+ }
380
+ }
381
+
382
+ return { valid: true };
383
+ }
384
+ ```
385
+
386
+ ## Best Practices
387
+
388
+ ### ✅ DO
389
+
390
+ 1. **Keep subject line concise** (50 characters or less)
391
+ 2. **Use imperative mood** ("add" not "added")
392
+ 3. **Reference issues** in footer for feat/fix commits
393
+ 4. **Document breaking changes** with BREAKING CHANGE footer
394
+ 5. **Add body** for complex changes (explain why, not what)
395
+ 6. **Use scopes** for multi-module projects
396
+ 7. **Start with lowercase** after colon
397
+
398
+ ### ❌ DON'T
399
+
400
+ 1. **Don't end subject with period**
401
+ 2. **Don't use past tense** ("added" or "adds")
402
+ 3. **Don't be vague** ("fix stuff", "update files")
403
+ 4. **Don't exceed 72 characters** in subject
404
+ 5. **Don't mix multiple changes** in one commit
405
+ 6. **Don't forget issue references** for bug fixes
406
+ 7. **Don't capitalize** first word after colon
407
+
408
+ ## Automated Commit Message Preparation
409
+
410
+ Use `prepare-commit-msg` hook to pre-populate message:
411
+
412
+ **`.git/hooks/prepare-commit-msg`**:
413
+ ```bash
414
+ #!/bin/sh
415
+
416
+ # Get branch name
417
+ BRANCH=$(git rev-parse --abbrev-ref HEAD)
418
+
419
+ # Extract issue number from branch (e.g., feature/123-user-auth)
420
+ ISSUE=$(echo "$BRANCH" | grep -oE '[0-9]+' | head -1)
421
+
422
+ # Add issue reference if found
423
+ if [ -n "$ISSUE" ]; then
424
+ echo "" >> "$1"
425
+ echo "Refs #$ISSUE" >> "$1"
426
+ fi
427
+ ```
428
+
429
+ ## Integration with Tools
430
+
431
+ ### Commitlint (npm)
432
+
433
+ ```bash
434
+ # Install
435
+ npm install --save-dev @commitlint/cli @commitlint/config-conventional
436
+
437
+ # Configure
438
+ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
439
+
440
+ # Create hook
441
+ echo "npx --no -- commitlint --edit \$1" > .git/hooks/commit-msg
442
+ chmod +x .git/hooks/commit-msg
443
+ ```
444
+
445
+ ### Husky + Commitlint
446
+
447
+ ```bash
448
+ # Install
449
+ npm install --save-dev husky @commitlint/cli @commitlint/config-conventional
450
+
451
+ # Setup husky
452
+ npx husky init
453
+
454
+ # Add commit-msg hook
455
+ npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
456
+ ```
457
+
458
+ ## Troubleshooting
459
+
460
+ ### Hook Not Running
461
+
462
+ **Solutions**:
463
+ 1. Check permissions: `chmod +x .git/hooks/commit-msg`
464
+ 2. Verify shebang: `#!/bin/sh`
465
+ 3. Check file location: Must be `.git/hooks/commit-msg` (no extension)
466
+
467
+ ### False Positives
468
+
469
+ **Issue**: Valid messages rejected
470
+
471
+ **Solutions**:
472
+ 1. Adjust regex pattern for your team's conventions
473
+ 2. Add exceptions for specific message patterns
474
+ 3. Allow more types if needed (e.g., `wip`, `hotfix`)
475
+
476
+ ### Merge Commits Failing
477
+
478
+ **Issue**: Merge commit messages rejected
479
+
480
+ **Solution**: Skip validation for merge commits:
481
+ ```javascript
482
+ if (message.startsWith('Merge') || message.startsWith('Revert')) {
483
+ process.exit(0);
484
+ }
485
+ ```
486
+
487
+ ## Emergency Bypass
488
+
489
+ ```bash
490
+ # Skip commit-msg validation
491
+ git commit --no-verify -m "Emergency fix"
492
+
493
+ # Or use environment variable
494
+ HUSKY_SKIP_HOOKS=1 git commit -m "message"
495
+ ```
496
+
497
+ ## Integration with Rulebook
498
+
499
+ If using `@hivehub/rulebook`, commit-msg hooks are automatically generated:
500
+
501
+ ```bash
502
+ # Initialize with hooks
503
+ npx @hivehub/rulebook init
504
+
505
+ # Configuration in .rulebook
506
+ {
507
+ "hooks": {
508
+ "commitMsg": {
509
+ "enabled": true,
510
+ "enforceConventional": true,
511
+ "requireIssueRef": ["feat", "fix"]
512
+ }
513
+ }
514
+ }
515
+ ```
516
+
517
+ ## Common Pitfalls
518
+
519
+ 1. **❌ Too strict validation**: Allow flexibility for trivial commits
520
+ 2. **❌ No escape hatch**: Always allow `--no-verify`
521
+ 3. **❌ Blocking merge commits**: Skip validation for merge/revert
522
+ 4. **❌ Unclear error messages**: Show examples of valid format
523
+ 5. **❌ Not documenting conventions**: Add CONTRIBUTING.md with examples
524
+
525
+ ## Related Templates
526
+
527
+ - See `/.rulebook/specs/PRE_COMMIT.md` for quality checks before commit
528
+ - See `/.rulebook/specs/PREPARE_COMMIT_MSG.md` for auto-generating commit messages
529
+ - See `/.rulebook/specs/GIT.md` for git workflow and commit conventions
530
+ - See `/.rulebook/specs/DOCUMENTATION_RULES.md` for changelog generation from commits