@hivehub/rulebook 5.4.0 → 5.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (454) hide show
  1. package/.claude/commands/analysis.md +35 -35
  2. package/.claude/commands/continue.md +33 -33
  3. package/.claude/commands/ralph-config.md +112 -112
  4. package/.claude/commands/ralph-history.md +110 -110
  5. package/.claude/commands/ralph-init.md +72 -72
  6. package/.claude/commands/ralph-pause-resume.md +105 -105
  7. package/.claude/commands/ralph-run.md +101 -101
  8. package/.claude/commands/ralph-status.md +76 -76
  9. package/.claude/commands/rulebook-decision-create.md +55 -55
  10. package/.claude/commands/rulebook-decision-list.md +15 -15
  11. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  12. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  13. package/.claude/commands/rulebook-learn-capture.md +48 -48
  14. package/.claude/commands/rulebook-learn-list.md +13 -13
  15. package/.claude/commands/rulebook-memory-save.md +48 -48
  16. package/.claude/commands/rulebook-memory-search.md +47 -47
  17. package/.claude/commands/rulebook-task-apply.md +67 -67
  18. package/.claude/commands/rulebook-task-archive.md +94 -94
  19. package/.claude/commands/rulebook-task-create.md +93 -93
  20. package/.claude/commands/rulebook-task-list.md +42 -42
  21. package/.claude/commands/rulebook-task-show.md +52 -52
  22. package/.claude/commands/rulebook-task-validate.md +53 -53
  23. package/.claude-plugin/marketplace.json +28 -28
  24. package/.claude-plugin/plugin.json +8 -8
  25. package/LICENSE +191 -191
  26. package/README.md +393 -393
  27. package/dist/index.js +0 -0
  28. package/dist/mcp/rulebook-server.js +0 -0
  29. package/package.json +22 -21
  30. package/templates/agents/accessibility-reviewer.md +43 -43
  31. package/templates/agents/api-designer.md +42 -42
  32. package/templates/agents/architect.md +51 -51
  33. package/templates/agents/build-engineer.md +36 -36
  34. package/templates/agents/code-reviewer.md +47 -47
  35. package/templates/agents/compiler/codegen-debugger.md +34 -34
  36. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  37. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  38. package/templates/agents/context-intelligence.md +52 -52
  39. package/templates/agents/database-architect.md +41 -41
  40. package/templates/agents/devops-engineer.md +42 -42
  41. package/templates/agents/docs-writer.md +38 -38
  42. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  43. package/templates/agents/game-engine/render-engineer.md +22 -22
  44. package/templates/agents/game-engine/shader-engineer.md +38 -38
  45. package/templates/agents/game-engine/systems-integration.md +43 -43
  46. package/templates/agents/generic/code-reviewer.md +41 -41
  47. package/templates/agents/generic/docs-writer.md +25 -25
  48. package/templates/agents/generic/project-manager.md +36 -36
  49. package/templates/agents/generic/researcher.md +34 -34
  50. package/templates/agents/generic/test-engineer.md +41 -41
  51. package/templates/agents/i18n-engineer.md +42 -42
  52. package/templates/agents/implementer.md +42 -42
  53. package/templates/agents/migration-engineer.md +42 -42
  54. package/templates/agents/mobile/platform-specialist.md +22 -22
  55. package/templates/agents/mobile/ui-engineer.md +22 -22
  56. package/templates/agents/performance-engineer.md +49 -49
  57. package/templates/agents/refactoring-agent.md +41 -41
  58. package/templates/agents/researcher.md +38 -38
  59. package/templates/agents/security-reviewer.md +40 -40
  60. package/templates/agents/team-lead.md +37 -37
  61. package/templates/agents/tester.md +48 -48
  62. package/templates/agents/ux-reviewer.md +43 -43
  63. package/templates/agents/web-app/api-designer.md +22 -22
  64. package/templates/agents/web-app/backend-engineer.md +30 -30
  65. package/templates/agents/web-app/database-engineer.md +22 -22
  66. package/templates/agents/web-app/frontend-engineer.md +29 -29
  67. package/templates/agents/web-app/security-reviewer.md +32 -32
  68. package/templates/ci/rulebook-review.yml +26 -26
  69. package/templates/cli/AIDER.md +49 -49
  70. package/templates/cli/AMAZON_Q.md +25 -25
  71. package/templates/cli/AUGGIE.md +32 -32
  72. package/templates/cli/CLAUDE.md +117 -117
  73. package/templates/cli/CLINE.md +99 -99
  74. package/templates/cli/CODEBUDDY.md +20 -20
  75. package/templates/cli/CODEIUM.md +20 -20
  76. package/templates/cli/CODEX.md +21 -21
  77. package/templates/cli/CONTINUE.md +34 -34
  78. package/templates/cli/CURSOR_CLI.md +62 -62
  79. package/templates/cli/FACTORY.md +18 -18
  80. package/templates/cli/GEMINI.md +35 -35
  81. package/templates/cli/KILOCODE.md +18 -18
  82. package/templates/cli/OPENCODE.md +18 -18
  83. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  84. package/templates/cli/gemini-extension.json +77 -77
  85. package/templates/commands/rulebook-decision-create.md +55 -55
  86. package/templates/commands/rulebook-decision-list.md +15 -15
  87. package/templates/commands/rulebook-knowledge-add.md +41 -41
  88. package/templates/commands/rulebook-knowledge-list.md +15 -15
  89. package/templates/commands/rulebook-learn-capture.md +48 -48
  90. package/templates/commands/rulebook-learn-list.md +13 -13
  91. package/templates/commands/rulebook-memory-save.md +48 -48
  92. package/templates/commands/rulebook-memory-search.md +47 -47
  93. package/templates/commands/rulebook-task-apply.md +67 -67
  94. package/templates/commands/rulebook-task-archive.md +94 -94
  95. package/templates/commands/rulebook-task-create.md +93 -93
  96. package/templates/commands/rulebook-task-list.md +42 -42
  97. package/templates/commands/rulebook-task-show.md +52 -52
  98. package/templates/commands/rulebook-task-validate.md +53 -53
  99. package/templates/compact-context/_default.md +23 -23
  100. package/templates/compact-context/cpp.md +26 -26
  101. package/templates/compact-context/go.md +26 -26
  102. package/templates/compact-context/python.md +26 -26
  103. package/templates/compact-context/rust.md +28 -28
  104. package/templates/compact-context/typescript.md +29 -29
  105. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  106. package/templates/core/AGENT_AUTOMATION.md +296 -296
  107. package/templates/core/CLAUDE_MD_v2.md +71 -71
  108. package/templates/core/DAG.md +304 -304
  109. package/templates/core/DECISIONS.md +38 -38
  110. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  111. package/templates/core/KNOWLEDGE.md +49 -49
  112. package/templates/core/MULTI_AGENT.md +74 -74
  113. package/templates/core/PLANS.md +28 -28
  114. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  115. package/templates/core/RALPH.md +471 -471
  116. package/templates/core/RULEBOOK.md +1947 -1947
  117. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  118. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  119. package/templates/core/WORKSPACE.md +69 -69
  120. package/templates/frameworks/ANGULAR.md +36 -36
  121. package/templates/frameworks/DJANGO.md +83 -83
  122. package/templates/frameworks/ELECTRON.md +147 -147
  123. package/templates/frameworks/FLASK.md +38 -38
  124. package/templates/frameworks/FLUTTER.md +55 -55
  125. package/templates/frameworks/JQUERY.md +32 -32
  126. package/templates/frameworks/LARAVEL.md +38 -38
  127. package/templates/frameworks/NESTJS.md +43 -43
  128. package/templates/frameworks/NEXTJS.md +127 -127
  129. package/templates/frameworks/NUXT.md +40 -40
  130. package/templates/frameworks/RAILS.md +66 -66
  131. package/templates/frameworks/REACT.md +38 -38
  132. package/templates/frameworks/REACT_NATIVE.md +47 -47
  133. package/templates/frameworks/SPRING.md +39 -39
  134. package/templates/frameworks/SYMFONY.md +36 -36
  135. package/templates/frameworks/VUE.md +36 -36
  136. package/templates/frameworks/ZEND.md +35 -35
  137. package/templates/git/CI_CD_PATTERNS.md +661 -661
  138. package/templates/git/GITHUB_ACTIONS.md +728 -728
  139. package/templates/git/GITLAB_CI.md +730 -730
  140. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  141. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  142. package/templates/hooks/COMMIT_MSG.md +530 -530
  143. package/templates/hooks/POST_CHECKOUT.md +546 -546
  144. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  145. package/templates/hooks/PRE_COMMIT.md +414 -414
  146. package/templates/hooks/PRE_PUSH.md +601 -601
  147. package/templates/hooks/check-context-and-handoff.ps1 +58 -58
  148. package/templates/hooks/check-context-and-handoff.sh +76 -76
  149. package/templates/hooks/enforce-team-for-background-agents.ps1 +63 -63
  150. package/templates/hooks/enforce-team-for-background-agents.sh +55 -55
  151. package/templates/hooks/on-compact-reinject.sh +34 -34
  152. package/templates/hooks/resume-from-handoff.ps1 +40 -40
  153. package/templates/hooks/resume-from-handoff.sh +61 -61
  154. package/templates/hooks/terse-activate.ps1 +143 -143
  155. package/templates/hooks/terse-activate.sh +197 -197
  156. package/templates/hooks/terse-mode-tracker.ps1 +153 -153
  157. package/templates/hooks/terse-mode-tracker.sh +187 -187
  158. package/templates/ides/CONTINUE_RULES.md +16 -16
  159. package/templates/ides/COPILOT.md +37 -37
  160. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  161. package/templates/ides/CURSOR.md +43 -43
  162. package/templates/ides/GEMINI_RULES.md +17 -17
  163. package/templates/ides/JETBRAINS_AI.md +35 -35
  164. package/templates/ides/REPLIT.md +36 -36
  165. package/templates/ides/TABNINE.md +29 -29
  166. package/templates/ides/VSCODE.md +40 -40
  167. package/templates/ides/WINDSURF.md +36 -36
  168. package/templates/ides/WINDSURF_RULES.md +14 -14
  169. package/templates/ides/ZED.md +32 -32
  170. package/templates/ides/cursor-mdc/go.mdc +24 -24
  171. package/templates/ides/cursor-mdc/python.mdc +24 -24
  172. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  173. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  174. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  175. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  176. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  177. package/templates/languages/C.md +333 -333
  178. package/templates/languages/CPP.md +743 -743
  179. package/templates/languages/CSHARP.md +417 -417
  180. package/templates/languages/ELIXIR.md +454 -454
  181. package/templates/languages/ERLANG.md +361 -361
  182. package/templates/languages/GO.md +645 -645
  183. package/templates/languages/HASKELL.md +177 -177
  184. package/templates/languages/JAVA.md +607 -607
  185. package/templates/languages/JAVASCRIPT.md +631 -631
  186. package/templates/languages/JULIA.md +97 -97
  187. package/templates/languages/KOTLIN.md +511 -511
  188. package/templates/languages/LISP.md +100 -100
  189. package/templates/languages/LUA.md +74 -74
  190. package/templates/languages/OBJECTIVEC.md +90 -90
  191. package/templates/languages/PHP.md +416 -416
  192. package/templates/languages/PYTHON.md +682 -682
  193. package/templates/languages/RUBY.md +421 -421
  194. package/templates/languages/RUST.md +477 -477
  195. package/templates/languages/SAS.md +73 -73
  196. package/templates/languages/SCALA.md +348 -348
  197. package/templates/languages/SOLIDITY.md +580 -580
  198. package/templates/languages/SQL.md +137 -137
  199. package/templates/languages/SWIFT.md +466 -466
  200. package/templates/languages/TYPESCRIPT.md +591 -591
  201. package/templates/languages/ZIG.md +265 -265
  202. package/templates/modules/ATLASSIAN.md +255 -255
  203. package/templates/modules/CONTEXT7.md +54 -54
  204. package/templates/modules/FIGMA.md +267 -267
  205. package/templates/modules/GITHUB_MCP.md +64 -64
  206. package/templates/modules/GRAFANA.md +328 -328
  207. package/templates/modules/MEMORY.md +126 -126
  208. package/templates/modules/NOTION.md +247 -247
  209. package/templates/modules/PLAYWRIGHT.md +90 -90
  210. package/templates/modules/RULEBOOK_MCP.md +208 -208
  211. package/templates/modules/SERENA.md +337 -337
  212. package/templates/modules/SUPABASE.md +223 -223
  213. package/templates/modules/SYNAP.md +69 -69
  214. package/templates/modules/VECTORIZER.md +63 -63
  215. package/templates/modules/sequential-thinking.md +42 -42
  216. package/templates/ralph/ralph-history.bat +4 -4
  217. package/templates/ralph/ralph-history.sh +5 -5
  218. package/templates/ralph/ralph-init.bat +5 -5
  219. package/templates/ralph/ralph-init.sh +5 -5
  220. package/templates/ralph/ralph-pause.bat +5 -5
  221. package/templates/ralph/ralph-pause.sh +5 -5
  222. package/templates/ralph/ralph-run.bat +5 -5
  223. package/templates/ralph/ralph-run.sh +5 -5
  224. package/templates/ralph/ralph-status.bat +4 -4
  225. package/templates/ralph/ralph-status.sh +5 -5
  226. package/templates/rules/consult-analysis-before-implementing.md +23 -23
  227. package/templates/rules/cpp.md +46 -46
  228. package/templates/rules/csharp.md +44 -44
  229. package/templates/rules/diagnostic-first.md +39 -39
  230. package/templates/rules/fail-twice-escalate.md +46 -46
  231. package/templates/rules/follow-task-sequence.md +36 -36
  232. package/templates/rules/git-safety.md +29 -29
  233. package/templates/rules/go.md +40 -40
  234. package/templates/rules/incremental-implementation.md +56 -56
  235. package/templates/rules/incremental-tests.md +29 -29
  236. package/templates/rules/java.md +43 -43
  237. package/templates/rules/javascript.md +39 -39
  238. package/templates/rules/knowledge-base-usage.md +41 -41
  239. package/templates/rules/multi-agent-teams.md +75 -75
  240. package/templates/rules/no-deferred.md +31 -31
  241. package/templates/rules/no-shortcuts.md +30 -30
  242. package/templates/rules/python.md +43 -43
  243. package/templates/rules/research-first.md +30 -30
  244. package/templates/rules/respect-handoff-trigger.md +41 -41
  245. package/templates/rules/rust.md +40 -40
  246. package/templates/rules/sequential-editing.md +21 -21
  247. package/templates/rules/session-workflow.md +24 -24
  248. package/templates/rules/task-decomposition.md +32 -32
  249. package/templates/rules/typescript.md +40 -40
  250. package/templates/services/AZURE_BLOB.md +184 -184
  251. package/templates/services/CASSANDRA.md +239 -239
  252. package/templates/services/DATADOG.md +26 -26
  253. package/templates/services/DOCKER.md +124 -124
  254. package/templates/services/DOCKER_COMPOSE.md +168 -168
  255. package/templates/services/DYNAMODB.md +308 -308
  256. package/templates/services/ELASTICSEARCH.md +347 -347
  257. package/templates/services/GCS.md +178 -178
  258. package/templates/services/HELM.md +194 -194
  259. package/templates/services/INFLUXDB.md +265 -265
  260. package/templates/services/KAFKA.md +341 -341
  261. package/templates/services/KUBERNETES.md +208 -208
  262. package/templates/services/MARIADB.md +183 -183
  263. package/templates/services/MEMCACHED.md +242 -242
  264. package/templates/services/MINIO.md +201 -201
  265. package/templates/services/MONGODB.md +268 -268
  266. package/templates/services/MYSQL.md +358 -358
  267. package/templates/services/NEO4J.md +247 -247
  268. package/templates/services/OPENTELEMETRY.md +25 -25
  269. package/templates/services/ORACLE.md +290 -290
  270. package/templates/services/PINO.md +24 -24
  271. package/templates/services/POSTGRESQL.md +326 -326
  272. package/templates/services/PROMETHEUS.md +33 -33
  273. package/templates/services/RABBITMQ.md +286 -286
  274. package/templates/services/REDIS.md +292 -292
  275. package/templates/services/S3.md +298 -298
  276. package/templates/services/SENTRY.md +23 -23
  277. package/templates/services/SQLITE.md +294 -294
  278. package/templates/services/SQLSERVER.md +294 -294
  279. package/templates/services/WINSTON.md +30 -30
  280. package/templates/skills/cli/aider/SKILL.md +59 -59
  281. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  282. package/templates/skills/cli/auggie/SKILL.md +42 -42
  283. package/templates/skills/cli/claude/SKILL.md +42 -42
  284. package/templates/skills/cli/cline/SKILL.md +42 -42
  285. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  286. package/templates/skills/cli/codeium/SKILL.md +30 -30
  287. package/templates/skills/cli/codex/SKILL.md +31 -31
  288. package/templates/skills/cli/continue/SKILL.md +44 -44
  289. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  290. package/templates/skills/cli/factory/SKILL.md +28 -28
  291. package/templates/skills/cli/gemini/SKILL.md +45 -45
  292. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  293. package/templates/skills/cli/opencode/SKILL.md +28 -28
  294. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  295. package/templates/skills/core/dag/SKILL.md +314 -314
  296. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  297. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  298. package/templates/skills/core/rulebook/SKILL.md +176 -176
  299. package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
  300. package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
  301. package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
  302. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  303. package/templates/skills/dev/analysis/SKILL.md +19 -19
  304. package/templates/skills/dev/api-design/SKILL.md +15 -15
  305. package/templates/skills/dev/architect/SKILL.md +17 -17
  306. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  307. package/templates/skills/dev/db-design/SKILL.md +15 -15
  308. package/templates/skills/dev/debug/SKILL.md +16 -16
  309. package/templates/skills/dev/deploy/SKILL.md +17 -17
  310. package/templates/skills/dev/docs/SKILL.md +17 -17
  311. package/templates/skills/dev/handoff/SKILL.md +27 -27
  312. package/templates/skills/dev/migrate/SKILL.md +15 -15
  313. package/templates/skills/dev/perf/SKILL.md +17 -17
  314. package/templates/skills/dev/refactor/SKILL.md +17 -17
  315. package/templates/skills/dev/research/SKILL.md +14 -14
  316. package/templates/skills/dev/review/SKILL.md +18 -18
  317. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  318. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  319. package/templates/skills/frameworks/django/SKILL.md +93 -93
  320. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  321. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  322. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  323. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  324. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  325. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  326. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  327. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  328. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  329. package/templates/skills/frameworks/react/SKILL.md +48 -48
  330. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  331. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  332. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  333. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  334. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  335. package/templates/skills/ides/copilot/SKILL.md +47 -47
  336. package/templates/skills/ides/cursor/SKILL.md +53 -53
  337. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  338. package/templates/skills/ides/replit/SKILL.md +46 -46
  339. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  340. package/templates/skills/ides/vscode/SKILL.md +50 -50
  341. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  342. package/templates/skills/ides/zed/SKILL.md +42 -42
  343. package/templates/skills/languages/c/SKILL.md +343 -343
  344. package/templates/skills/languages/cpp/SKILL.md +753 -753
  345. package/templates/skills/languages/csharp/SKILL.md +427 -427
  346. package/templates/skills/languages/elixir/SKILL.md +464 -464
  347. package/templates/skills/languages/erlang/SKILL.md +371 -371
  348. package/templates/skills/languages/go/SKILL.md +655 -655
  349. package/templates/skills/languages/haskell/SKILL.md +187 -187
  350. package/templates/skills/languages/java/SKILL.md +617 -617
  351. package/templates/skills/languages/javascript/SKILL.md +641 -641
  352. package/templates/skills/languages/julia/SKILL.md +107 -107
  353. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  354. package/templates/skills/languages/lisp/SKILL.md +110 -110
  355. package/templates/skills/languages/lua/SKILL.md +84 -84
  356. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  357. package/templates/skills/languages/php/SKILL.md +426 -426
  358. package/templates/skills/languages/python/SKILL.md +692 -692
  359. package/templates/skills/languages/ruby/SKILL.md +431 -431
  360. package/templates/skills/languages/rust/SKILL.md +487 -487
  361. package/templates/skills/languages/sas/SKILL.md +83 -83
  362. package/templates/skills/languages/scala/SKILL.md +358 -358
  363. package/templates/skills/languages/solidity/SKILL.md +590 -590
  364. package/templates/skills/languages/sql/SKILL.md +147 -147
  365. package/templates/skills/languages/swift/SKILL.md +476 -476
  366. package/templates/skills/languages/typescript/SKILL.md +302 -302
  367. package/templates/skills/languages/zig/SKILL.md +275 -275
  368. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  369. package/templates/skills/modules/context7/SKILL.md +64 -64
  370. package/templates/skills/modules/figma/SKILL.md +277 -277
  371. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  372. package/templates/skills/modules/grafana/SKILL.md +338 -338
  373. package/templates/skills/modules/memory/SKILL.md +73 -73
  374. package/templates/skills/modules/notion/SKILL.md +257 -257
  375. package/templates/skills/modules/playwright/SKILL.md +100 -100
  376. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  377. package/templates/skills/modules/serena/SKILL.md +347 -347
  378. package/templates/skills/modules/supabase/SKILL.md +233 -233
  379. package/templates/skills/modules/synap/SKILL.md +79 -79
  380. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  381. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  382. package/templates/skills/services/cassandra/SKILL.md +249 -249
  383. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  384. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  385. package/templates/skills/services/gcs/SKILL.md +188 -188
  386. package/templates/skills/services/influxdb/SKILL.md +275 -275
  387. package/templates/skills/services/kafka/SKILL.md +351 -351
  388. package/templates/skills/services/mariadb/SKILL.md +193 -193
  389. package/templates/skills/services/memcached/SKILL.md +252 -252
  390. package/templates/skills/services/minio/SKILL.md +211 -211
  391. package/templates/skills/services/mongodb/SKILL.md +278 -278
  392. package/templates/skills/services/mysql/SKILL.md +368 -368
  393. package/templates/skills/services/neo4j/SKILL.md +257 -257
  394. package/templates/skills/services/oracle/SKILL.md +300 -300
  395. package/templates/skills/services/postgresql/SKILL.md +336 -336
  396. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  397. package/templates/skills/services/redis/SKILL.md +302 -302
  398. package/templates/skills/services/s3/SKILL.md +308 -308
  399. package/templates/skills/services/sqlite/SKILL.md +304 -304
  400. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  401. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  402. package/templates/skills/workflows/ralph/install.sh +87 -87
  403. package/templates/skills/workflows/ralph/manifest.json +158 -158
  404. package/templates/workflows/codespell.yml +31 -31
  405. package/templates/workflows/cpp-lint.yml +47 -47
  406. package/templates/workflows/cpp-publish.yml +119 -119
  407. package/templates/workflows/cpp-test.yml +77 -77
  408. package/templates/workflows/dotnet-lint.yml +29 -29
  409. package/templates/workflows/dotnet-publish.yml +40 -40
  410. package/templates/workflows/dotnet-test.yml +41 -41
  411. package/templates/workflows/elixir-lint.yml +45 -45
  412. package/templates/workflows/elixir-publish.yml +49 -49
  413. package/templates/workflows/elixir-test.yml +54 -54
  414. package/templates/workflows/erlang-lint.yml +47 -47
  415. package/templates/workflows/erlang-test.yml +62 -62
  416. package/templates/workflows/go-lint.yml +39 -39
  417. package/templates/workflows/go-publish.yml +95 -95
  418. package/templates/workflows/go-test.yml +59 -59
  419. package/templates/workflows/java-lint.yml +60 -60
  420. package/templates/workflows/java-publish.yml +120 -120
  421. package/templates/workflows/java-test.yml +85 -85
  422. package/templates/workflows/kotlin-lint.yml +34 -34
  423. package/templates/workflows/kotlin-publish.yml +56 -56
  424. package/templates/workflows/kotlin-test.yml +48 -48
  425. package/templates/workflows/php-lint.yml +39 -39
  426. package/templates/workflows/php-publish.yml +50 -50
  427. package/templates/workflows/php-test.yml +54 -54
  428. package/templates/workflows/python-lint.yml +47 -47
  429. package/templates/workflows/python-publish.yml +91 -91
  430. package/templates/workflows/python-test.yml +59 -59
  431. package/templates/workflows/rust-lint.yml +54 -54
  432. package/templates/workflows/rust-publish.yml +66 -66
  433. package/templates/workflows/rust-test.yml +75 -75
  434. package/templates/workflows/solidity-lint.yml +41 -41
  435. package/templates/workflows/solidity-test.yml +47 -47
  436. package/templates/workflows/swift-lint.yml +32 -32
  437. package/templates/workflows/swift-publish.yml +58 -58
  438. package/templates/workflows/swift-test.yml +44 -44
  439. package/templates/workflows/typescript-publish.yml +60 -60
  440. package/templates/workflows/typescript-test.yml +73 -73
  441. package/templates/workflows/zig-lint.yml +27 -27
  442. package/templates/workflows/zig-test.yml +40 -40
  443. package/dist/hooks/terse-activate.d.ts +0 -59
  444. package/dist/hooks/terse-activate.d.ts.map +0 -1
  445. package/dist/hooks/terse-activate.js +0 -149
  446. package/dist/hooks/terse-activate.js.map +0 -1
  447. package/dist/hooks/terse-config.d.ts +0 -51
  448. package/dist/hooks/terse-config.d.ts.map +0 -1
  449. package/dist/hooks/terse-config.js +0 -130
  450. package/dist/hooks/terse-config.js.map +0 -1
  451. package/dist/hooks/terse-mode-tracker.d.ts +0 -78
  452. package/dist/hooks/terse-mode-tracker.d.ts.map +0 -1
  453. package/dist/hooks/terse-mode-tracker.js +0 -213
  454. package/dist/hooks/terse-mode-tracker.js.map +0 -1
@@ -1,619 +1,619 @@
1
- # Prepare Commit Message Hook
2
-
3
- This template provides guidance for implementing prepare-commit-msg git hooks that automatically generate or enhance commit messages.
4
-
5
- ## Purpose
6
-
7
- Prepare-commit-msg hooks run before the commit message editor opens to:
8
- - Pre-populate commit messages from branch names
9
- - Add issue/ticket references automatically
10
- - Insert commit templates
11
- - Add metadata (branch, author, timestamps)
12
- - Enforce commit message structure
13
-
14
- ## Agent Automation Commands
15
-
16
- When implementing or modifying prepare-commit-msg hooks:
17
-
18
- ### Standard Usage
19
- ```bash
20
- # Hook runs automatically before commit editor opens
21
- git commit
22
-
23
- # Skip hook if needed
24
- git commit --no-verify -m "message"
25
-
26
- # Use custom template
27
- git commit --template=.gitmessage
28
- ```
29
-
30
- ## Hook Implementation Patterns
31
-
32
- ### Node.js Implementation (Recommended)
33
-
34
- **Shell Wrapper** (`.git/hooks/prepare-commit-msg`):
35
- ```bash
36
- #!/bin/sh
37
-
38
- # Arguments:
39
- # $1 = commit message file
40
- # $2 = commit source (message, template, merge, squash, commit)
41
- # $3 = commit SHA (for amend or commit -c)
42
-
43
- # Find Node.js executable (cross-platform)
44
- NODE_PATH=""
45
- if command -v node >/dev/null 2>&1; then
46
- NODE_PATH="node"
47
- elif [ -f "/c/Program Files/nodejs/node.exe" ]; then
48
- NODE_PATH="/c/Program Files/nodejs/node.exe"
49
- elif [ -f "/usr/bin/node" ]; then
50
- NODE_PATH="/usr/bin/node"
51
- else
52
- echo "Error: Node.js not found"
53
- exit 1
54
- fi
55
-
56
- # Execute Node.js script
57
- "$NODE_PATH" "$(dirname "$0")/prepare-commit-msg.js" "$@"
58
- exit $?
59
- ```
60
-
61
- **Node.js Script** (`.git/hooks/prepare-commit-msg.js`):
62
- ```javascript
63
- #!/usr/bin/env node
64
-
65
- const { execSync } = require('child_process');
66
- const fs = require('fs');
67
-
68
- const [, , messageFile, source, sha] = process.argv;
69
-
70
- function getCurrentBranch() {
71
- return execSync('git rev-parse --abbrev-ref HEAD', { encoding: 'utf-8' }).trim();
72
- }
73
-
74
- function extractIssueNumber(branchName) {
75
- // Extract issue number from branch names like:
76
- // - feature/123-user-auth
77
- // - bugfix/456-memory-leak
78
- // - PROJ-789-api-update
79
- const patterns = [
80
- /\/(\d+)-/, // feature/123-name
81
- /\/([A-Z]+-\d+)-/, // feature/PROJ-123-name
82
- /#(\d+)/, // feature/#123
83
- ];
84
-
85
- for (const pattern of patterns) {
86
- const match = branchName.match(pattern);
87
- if (match) {
88
- return match[1];
89
- }
90
- }
91
-
92
- return null;
93
- }
94
-
95
- function extractScope(branchName) {
96
- // Extract scope from branch names like:
97
- // - feature/auth/login
98
- // - fix/api/validation
99
- const match = branchName.match(/^[^/]+\/([^/]+)\//);
100
- return match ? match[1] : null;
101
- }
102
-
103
- function getCommitType(branchName) {
104
- const branchTypes = {
105
- feature: 'feat',
106
- feat: 'feat',
107
- bugfix: 'fix',
108
- fix: 'fix',
109
- hotfix: 'fix',
110
- docs: 'docs',
111
- refactor: 'refactor',
112
- perf: 'perf',
113
- test: 'test',
114
- chore: 'chore',
115
- };
116
-
117
- for (const [key, type] of Object.entries(branchTypes)) {
118
- if (branchName.startsWith(key)) {
119
- return type;
120
- }
121
- }
122
-
123
- return null;
124
- }
125
-
126
- function main() {
127
- // Skip for merge, squash, or amend commits
128
- if (source === 'merge' || source === 'squash' || source === 'commit') {
129
- process.exit(0);
130
- }
131
-
132
- // Skip if message already provided via -m flag
133
- if (source === 'message') {
134
- process.exit(0);
135
- }
136
-
137
- const branch = getCurrentBranch();
138
- const currentMessage = fs.readFileSync(messageFile, 'utf-8');
139
-
140
- // Skip if message already has content (not default template)
141
- if (currentMessage.trim() && !currentMessage.startsWith('#')) {
142
- process.exit(0);
143
- }
144
-
145
- // Build enhanced commit message
146
- let newMessage = '';
147
-
148
- // Add conventional commit prefix if possible
149
- const commitType = getCommitType(branch);
150
- const scope = extractScope(branch);
151
-
152
- if (commitType) {
153
- newMessage += commitType;
154
- if (scope) {
155
- newMessage += `(${scope})`;
156
- }
157
- newMessage += ': ';
158
- }
159
-
160
- // Add placeholder for subject
161
- newMessage += '<subject>\n\n';
162
-
163
- // Add body template
164
- newMessage += '# Why (motivation for this change):\n';
165
- newMessage += '# - \n\n';
166
-
167
- newMessage += '# What (summary of changes):\n';
168
- newMessage += '# - \n\n';
169
-
170
- // Add issue reference if found
171
- const issueNumber = extractIssueNumber(branch);
172
- if (issueNumber) {
173
- newMessage += `# Refs #${issueNumber}\n`;
174
- }
175
-
176
- // Add commit message guidelines
177
- newMessage += '\n# Commit Message Guidelines:\n';
178
- newMessage += '# - Use imperative mood ("add" not "added" or "adds")\n';
179
- newMessage += '# - First line should be < 50 chars\n';
180
- newMessage += '# - Separate subject from body with blank line\n';
181
- newMessage += '# - Wrap body at 72 chars\n';
182
- newMessage += `# - Branch: ${branch}\n`;
183
-
184
- fs.writeFileSync(messageFile, newMessage);
185
- process.exit(0);
186
- }
187
-
188
- main();
189
- ```
190
-
191
- ### Shell-Only Implementation (Simple)
192
-
193
- **`.git/hooks/prepare-commit-msg`**:
194
- ```bash
195
- #!/bin/sh
196
-
197
- COMMIT_MSG_FILE=$1
198
- COMMIT_SOURCE=$2
199
- SHA=$3
200
-
201
- # Skip for merge commits
202
- if [ "$COMMIT_SOURCE" = "merge" ]; then
203
- exit 0
204
- fi
205
-
206
- # Skip if message already provided
207
- if [ "$COMMIT_SOURCE" = "message" ]; then
208
- exit 0
209
- fi
210
-
211
- # Get current branch
212
- BRANCH=$(git rev-parse --abbrev-ref HEAD)
213
-
214
- # Extract issue number from branch (e.g., feature/123-user-auth)
215
- ISSUE=$(echo "$BRANCH" | grep -oE '[0-9]+' | head -1)
216
-
217
- # Add issue reference if found
218
- if [ -n "$ISSUE" ]; then
219
- echo "" >> "$COMMIT_MSG_FILE"
220
- echo "Refs #$ISSUE" >> "$COMMIT_MSG_FILE"
221
- fi
222
-
223
- exit 0
224
- ```
225
-
226
- ## Best Practices
227
-
228
- ### ✅ DO Include in Prepare-Commit-Msg
229
-
230
- 1. **Issue References from Branch**
231
- ```javascript
232
- const issue = extractIssueNumber(branch);
233
- if (issue) {
234
- message += `\nRefs #${issue}`;
235
- }
236
- ```
237
-
238
- 2. **Conventional Commit Type**
239
- ```javascript
240
- const type = getCommitType(branch); // feat, fix, etc.
241
- if (type) {
242
- message = `${type}: ${message}`;
243
- }
244
- ```
245
-
246
- 3. **Scope from Branch**
247
- ```javascript
248
- const scope = extractScope(branch); // api, ui, auth
249
- if (scope) {
250
- message = `${type}(${scope}): ${message}`;
251
- }
252
- ```
253
-
254
- 4. **Commit Template**
255
- ```javascript
256
- message += '\n# Why:\n# - \n\n';
257
- message += '# What:\n# - \n';
258
- ```
259
-
260
- 5. **Helpful Guidelines**
261
- ```javascript
262
- message += '\n# Guidelines:\n';
263
- message += '# - Use imperative mood\n';
264
- message += '# - Keep first line < 50 chars\n';
265
- ```
266
-
267
- ### ❌ DON'T Include in Prepare-Commit-Msg
268
-
269
- 1. **Complete Messages** - Let developers write the description
270
- 2. **Validation** - Use commit-msg hook for validation
271
- 3. **External API Calls** - Keep hook fast
272
- 4. **Interactive Prompts** - Hook runs non-interactively
273
-
274
- ## Branch Naming Patterns
275
-
276
- ### Recommended Branch Naming
277
-
278
- **With Issue Numbers**:
279
- ```
280
- feature/123-user-authentication
281
- bugfix/456-memory-leak
282
- hotfix/789-critical-security
283
- docs/321-api-documentation
284
- ```
285
-
286
- **With Scope**:
287
- ```
288
- feature/auth/oauth-integration
289
- fix/api/validation-error
290
- refactor/ui/button-component
291
- ```
292
-
293
- **Jira/Linear Style**:
294
- ```
295
- feature/PROJ-123-user-login
296
- fix/PROJ-456-api-timeout
297
- ```
298
-
299
- ### Extraction Logic
300
-
301
- ```javascript
302
- function extractFromBranch(branch) {
303
- // Pattern 1: type/number-description
304
- let match = branch.match(/^([^/]+)\/(\d+)-(.+)$/);
305
- if (match) {
306
- return {
307
- type: mapType(match[1]), // feature -> feat
308
- issue: match[2], // 123
309
- description: match[3], // user-authentication
310
- };
311
- }
312
-
313
- // Pattern 2: type/scope/description
314
- match = branch.match(/^([^/]+)\/([^/]+)\/(.+)$/);
315
- if (match) {
316
- return {
317
- type: mapType(match[1]), // feature -> feat
318
- scope: match[2], // auth
319
- description: match[3], // oauth-integration
320
- };
321
- }
322
-
323
- // Pattern 3: type/PROJ-number-description
324
- match = branch.match(/^([^/]+)\/([A-Z]+-\d+)-(.+)$/);
325
- if (match) {
326
- return {
327
- type: mapType(match[1]), // feature -> feat
328
- issue: match[2], // PROJ-123
329
- description: match[3], // user-login
330
- };
331
- }
332
-
333
- return null;
334
- }
335
- ```
336
-
337
- ## Advanced Patterns
338
-
339
- ### Add Co-Authors from Git Config
340
-
341
- ```javascript
342
- function getTeamMembers() {
343
- // Read from .git/config or custom config file
344
- const config = fs.readFileSync('.git/config', 'utf-8');
345
- const members = [];
346
-
347
- const matches = config.matchAll(/co-author-(\w+) = (.+) <(.+)>/g);
348
- for (const match of matches) {
349
- members.push({ name: match[2], email: match[3] });
350
- }
351
-
352
- return members;
353
- }
354
-
355
- function addCoAuthors(message) {
356
- const members = getTeamMembers();
357
- if (members.length > 0) {
358
- message += '\n\n# Co-Authors (uncomment if applicable):\n';
359
- members.forEach(m => {
360
- message += `# Co-authored-by: ${m.name} <${m.email}>\n`;
361
- });
362
- }
363
- return message;
364
- }
365
- ```
366
-
367
- ### Add Related Files
368
-
369
- ```javascript
370
- function getStagedFiles() {
371
- const output = execSync('git diff --cached --name-only', { encoding: 'utf-8' });
372
- return output.trim().split('\n').filter(f => f);
373
- }
374
-
375
- function addFilesSummary(message) {
376
- const files = getStagedFiles();
377
- if (files.length > 0) {
378
- message += '\n# Files changed:\n';
379
- files.forEach(f => {
380
- message += `# ${f}\n`;
381
- });
382
- }
383
- return message;
384
- }
385
- ```
386
-
387
- ### Add Recent Commits Context
388
-
389
- ```javascript
390
- function getRecentCommits(count = 5) {
391
- const output = execSync(`git log -${count} --oneline`, { encoding: 'utf-8' });
392
- return output.trim().split('\n');
393
- }
394
-
395
- function addCommitContext(message) {
396
- const commits = getRecentCommits();
397
- message += '\n# Recent commits:\n';
398
- commits.forEach(c => {
399
- message += `# ${c}\n`;
400
- });
401
- return message;
402
- }
403
- ```
404
-
405
- ### Branch-Specific Templates
406
-
407
- ```javascript
408
- function getTemplate(branch) {
409
- if (branch === 'main' || branch === 'master') {
410
- return {
411
- requireIssue: true,
412
- requireBreakingChange: true,
413
- template: 'production',
414
- };
415
- }
416
-
417
- if (branch.startsWith('hotfix/')) {
418
- return {
419
- requireIssue: true,
420
- urgent: true,
421
- template: 'hotfix',
422
- };
423
- }
424
-
425
- if (branch.startsWith('feature/')) {
426
- return {
427
- requireIssue: false,
428
- template: 'feature',
429
- };
430
- }
431
-
432
- return { template: 'default' };
433
- }
434
- ```
435
-
436
- ## Commit Message Templates
437
-
438
- ### Feature Template
439
-
440
- ```
441
- feat(<scope>): <subject>
442
-
443
- ## Why
444
- - Motivation for this feature
445
- - Problem it solves
446
-
447
- ## What
448
- - Summary of implementation
449
- - Key changes made
450
-
451
- ## How to Test
452
- - Steps to verify functionality
453
-
454
- Refs #<issue>
455
- ```
456
-
457
- ### Bugfix Template
458
-
459
- ```
460
- fix(<scope>): <subject>
461
-
462
- ## Problem
463
- - Description of bug
464
- - Steps to reproduce
465
- - Expected vs actual behavior
466
-
467
- ## Solution
468
- - How bug was fixed
469
- - Root cause identified
470
-
471
- ## Testing
472
- - Verification steps
473
- - Regression testing done
474
-
475
- Fixes #<issue>
476
- ```
477
-
478
- ### Hotfix Template
479
-
480
- ```
481
- fix!: <critical-issue>
482
-
483
- CRITICAL HOTFIX
484
-
485
- ## Issue
486
- - Production problem description
487
- - Impact and severity
488
-
489
- ## Fix
490
- - Immediate solution applied
491
- - Temporary vs permanent fix
492
-
493
- ## Verification
494
- - Testing performed
495
- - Rollback plan
496
-
497
- Fixes #<issue>
498
- ```
499
-
500
- ## Troubleshooting
501
-
502
- ### Template Not Appearing
503
-
504
- **Causes**:
505
- 1. Hook permissions incorrect
506
- 2. Source type is 'message' (using -m flag)
507
- 3. Merge/squash commit
508
-
509
- **Solutions**:
510
- ```bash
511
- # Check permissions
512
- chmod +x .git/hooks/prepare-commit-msg
513
-
514
- # Test manually
515
- .git/hooks/prepare-commit-msg .git/COMMIT_EDITMSG template
516
-
517
- # Check source type in hook
518
- echo "Source: $2" >> /tmp/hook-debug.log
519
- ```
520
-
521
- ### Issue Number Not Extracted
522
-
523
- **Issue**: Branch name doesn't match regex
524
-
525
- **Solution**: Add more patterns:
526
- ```javascript
527
- const patterns = [
528
- /\/(\d+)-/, // feature/123-name
529
- /\/([A-Z]+-\d+)-/, // feature/PROJ-123-name
530
- /#(\d+)/, // feature/#123
531
- /^(\d+)-/, // 123-feature-name
532
- /\[(\d+)\]/, // feature-[123]-name
533
- /([A-Z]{2,}-\d+)/, // JIRA-123
534
- ];
535
- ```
536
-
537
- ### Template Overrides User Message
538
-
539
- **Issue**: Hook overwrites existing message
540
-
541
- **Solution**: Check if message already exists:
542
- ```javascript
543
- const currentMessage = fs.readFileSync(messageFile, 'utf-8');
544
-
545
- // Skip if message has content (not just comments)
546
- if (currentMessage.trim() && !currentMessage.startsWith('#')) {
547
- process.exit(0);
548
- }
549
- ```
550
-
551
- ## Integration with Tools
552
-
553
- ### Git Config Template
554
-
555
- ```bash
556
- # Set global commit template
557
- git config --global commit.template ~/.gitmessage
558
-
559
- # Create template file
560
- cat > ~/.gitmessage << 'EOF'
561
- # <type>(<scope>): <subject>
562
-
563
- # Why:
564
- # -
565
-
566
- # What:
567
- # -
568
-
569
- # Refs #
570
- EOF
571
- ```
572
-
573
- ### Commitizen Integration
574
-
575
- ```bash
576
- # Install commitizen
577
- npm install --save-dev commitizen cz-conventional-changelog
578
-
579
- # Configure
580
- echo '{"path": "cz-conventional-changelog"}' > .czrc
581
-
582
- # Use instead of git commit
583
- npx cz
584
- ```
585
-
586
- ## Integration with Rulebook
587
-
588
- If using `@hivehub/rulebook`, prepare-commit-msg hooks are automatically generated:
589
-
590
- ```bash
591
- # Initialize with hooks
592
- npx @hivehub/rulebook init
593
-
594
- # Configuration in .rulebook
595
- {
596
- "hooks": {
597
- "prepareCommitMsg": {
598
- "enabled": true,
599
- "extractIssue": true,
600
- "addTemplate": true,
601
- "addGuidelines": true
602
- }
603
- }
604
- }
605
- ```
606
-
607
- ## Common Pitfalls
608
-
609
- 1. **❌ Overwriting existing messages**: Check if message already exists
610
- 2. **❌ Slow execution**: Avoid external API calls
611
- 3. **❌ Complex regex**: Test branch name patterns thoroughly
612
- 4. **❌ No escape for merge commits**: Check source type
613
- 5. **❌ Not skipping -m commits**: Check if source is 'message'
614
-
615
- ## Related Templates
616
-
617
- - See `/.rulebook/specs/COMMIT_MSG.md` for commit message validation
618
- - See `/.rulebook/specs/GIT.md` for git workflow and branch naming
619
- - See `/.rulebook/specs/PRE_COMMIT.md` for pre-commit checks
1
+ # Prepare Commit Message Hook
2
+
3
+ This template provides guidance for implementing prepare-commit-msg git hooks that automatically generate or enhance commit messages.
4
+
5
+ ## Purpose
6
+
7
+ Prepare-commit-msg hooks run before the commit message editor opens to:
8
+ - Pre-populate commit messages from branch names
9
+ - Add issue/ticket references automatically
10
+ - Insert commit templates
11
+ - Add metadata (branch, author, timestamps)
12
+ - Enforce commit message structure
13
+
14
+ ## Agent Automation Commands
15
+
16
+ When implementing or modifying prepare-commit-msg hooks:
17
+
18
+ ### Standard Usage
19
+ ```bash
20
+ # Hook runs automatically before commit editor opens
21
+ git commit
22
+
23
+ # Skip hook if needed
24
+ git commit --no-verify -m "message"
25
+
26
+ # Use custom template
27
+ git commit --template=.gitmessage
28
+ ```
29
+
30
+ ## Hook Implementation Patterns
31
+
32
+ ### Node.js Implementation (Recommended)
33
+
34
+ **Shell Wrapper** (`.git/hooks/prepare-commit-msg`):
35
+ ```bash
36
+ #!/bin/sh
37
+
38
+ # Arguments:
39
+ # $1 = commit message file
40
+ # $2 = commit source (message, template, merge, squash, commit)
41
+ # $3 = commit SHA (for amend or commit -c)
42
+
43
+ # Find Node.js executable (cross-platform)
44
+ NODE_PATH=""
45
+ if command -v node >/dev/null 2>&1; then
46
+ NODE_PATH="node"
47
+ elif [ -f "/c/Program Files/nodejs/node.exe" ]; then
48
+ NODE_PATH="/c/Program Files/nodejs/node.exe"
49
+ elif [ -f "/usr/bin/node" ]; then
50
+ NODE_PATH="/usr/bin/node"
51
+ else
52
+ echo "Error: Node.js not found"
53
+ exit 1
54
+ fi
55
+
56
+ # Execute Node.js script
57
+ "$NODE_PATH" "$(dirname "$0")/prepare-commit-msg.js" "$@"
58
+ exit $?
59
+ ```
60
+
61
+ **Node.js Script** (`.git/hooks/prepare-commit-msg.js`):
62
+ ```javascript
63
+ #!/usr/bin/env node
64
+
65
+ const { execSync } = require('child_process');
66
+ const fs = require('fs');
67
+
68
+ const [, , messageFile, source, sha] = process.argv;
69
+
70
+ function getCurrentBranch() {
71
+ return execSync('git rev-parse --abbrev-ref HEAD', { encoding: 'utf-8' }).trim();
72
+ }
73
+
74
+ function extractIssueNumber(branchName) {
75
+ // Extract issue number from branch names like:
76
+ // - feature/123-user-auth
77
+ // - bugfix/456-memory-leak
78
+ // - PROJ-789-api-update
79
+ const patterns = [
80
+ /\/(\d+)-/, // feature/123-name
81
+ /\/([A-Z]+-\d+)-/, // feature/PROJ-123-name
82
+ /#(\d+)/, // feature/#123
83
+ ];
84
+
85
+ for (const pattern of patterns) {
86
+ const match = branchName.match(pattern);
87
+ if (match) {
88
+ return match[1];
89
+ }
90
+ }
91
+
92
+ return null;
93
+ }
94
+
95
+ function extractScope(branchName) {
96
+ // Extract scope from branch names like:
97
+ // - feature/auth/login
98
+ // - fix/api/validation
99
+ const match = branchName.match(/^[^/]+\/([^/]+)\//);
100
+ return match ? match[1] : null;
101
+ }
102
+
103
+ function getCommitType(branchName) {
104
+ const branchTypes = {
105
+ feature: 'feat',
106
+ feat: 'feat',
107
+ bugfix: 'fix',
108
+ fix: 'fix',
109
+ hotfix: 'fix',
110
+ docs: 'docs',
111
+ refactor: 'refactor',
112
+ perf: 'perf',
113
+ test: 'test',
114
+ chore: 'chore',
115
+ };
116
+
117
+ for (const [key, type] of Object.entries(branchTypes)) {
118
+ if (branchName.startsWith(key)) {
119
+ return type;
120
+ }
121
+ }
122
+
123
+ return null;
124
+ }
125
+
126
+ function main() {
127
+ // Skip for merge, squash, or amend commits
128
+ if (source === 'merge' || source === 'squash' || source === 'commit') {
129
+ process.exit(0);
130
+ }
131
+
132
+ // Skip if message already provided via -m flag
133
+ if (source === 'message') {
134
+ process.exit(0);
135
+ }
136
+
137
+ const branch = getCurrentBranch();
138
+ const currentMessage = fs.readFileSync(messageFile, 'utf-8');
139
+
140
+ // Skip if message already has content (not default template)
141
+ if (currentMessage.trim() && !currentMessage.startsWith('#')) {
142
+ process.exit(0);
143
+ }
144
+
145
+ // Build enhanced commit message
146
+ let newMessage = '';
147
+
148
+ // Add conventional commit prefix if possible
149
+ const commitType = getCommitType(branch);
150
+ const scope = extractScope(branch);
151
+
152
+ if (commitType) {
153
+ newMessage += commitType;
154
+ if (scope) {
155
+ newMessage += `(${scope})`;
156
+ }
157
+ newMessage += ': ';
158
+ }
159
+
160
+ // Add placeholder for subject
161
+ newMessage += '<subject>\n\n';
162
+
163
+ // Add body template
164
+ newMessage += '# Why (motivation for this change):\n';
165
+ newMessage += '# - \n\n';
166
+
167
+ newMessage += '# What (summary of changes):\n';
168
+ newMessage += '# - \n\n';
169
+
170
+ // Add issue reference if found
171
+ const issueNumber = extractIssueNumber(branch);
172
+ if (issueNumber) {
173
+ newMessage += `# Refs #${issueNumber}\n`;
174
+ }
175
+
176
+ // Add commit message guidelines
177
+ newMessage += '\n# Commit Message Guidelines:\n';
178
+ newMessage += '# - Use imperative mood ("add" not "added" or "adds")\n';
179
+ newMessage += '# - First line should be < 50 chars\n';
180
+ newMessage += '# - Separate subject from body with blank line\n';
181
+ newMessage += '# - Wrap body at 72 chars\n';
182
+ newMessage += `# - Branch: ${branch}\n`;
183
+
184
+ fs.writeFileSync(messageFile, newMessage);
185
+ process.exit(0);
186
+ }
187
+
188
+ main();
189
+ ```
190
+
191
+ ### Shell-Only Implementation (Simple)
192
+
193
+ **`.git/hooks/prepare-commit-msg`**:
194
+ ```bash
195
+ #!/bin/sh
196
+
197
+ COMMIT_MSG_FILE=$1
198
+ COMMIT_SOURCE=$2
199
+ SHA=$3
200
+
201
+ # Skip for merge commits
202
+ if [ "$COMMIT_SOURCE" = "merge" ]; then
203
+ exit 0
204
+ fi
205
+
206
+ # Skip if message already provided
207
+ if [ "$COMMIT_SOURCE" = "message" ]; then
208
+ exit 0
209
+ fi
210
+
211
+ # Get current branch
212
+ BRANCH=$(git rev-parse --abbrev-ref HEAD)
213
+
214
+ # Extract issue number from branch (e.g., feature/123-user-auth)
215
+ ISSUE=$(echo "$BRANCH" | grep -oE '[0-9]+' | head -1)
216
+
217
+ # Add issue reference if found
218
+ if [ -n "$ISSUE" ]; then
219
+ echo "" >> "$COMMIT_MSG_FILE"
220
+ echo "Refs #$ISSUE" >> "$COMMIT_MSG_FILE"
221
+ fi
222
+
223
+ exit 0
224
+ ```
225
+
226
+ ## Best Practices
227
+
228
+ ### ✅ DO Include in Prepare-Commit-Msg
229
+
230
+ 1. **Issue References from Branch**
231
+ ```javascript
232
+ const issue = extractIssueNumber(branch);
233
+ if (issue) {
234
+ message += `\nRefs #${issue}`;
235
+ }
236
+ ```
237
+
238
+ 2. **Conventional Commit Type**
239
+ ```javascript
240
+ const type = getCommitType(branch); // feat, fix, etc.
241
+ if (type) {
242
+ message = `${type}: ${message}`;
243
+ }
244
+ ```
245
+
246
+ 3. **Scope from Branch**
247
+ ```javascript
248
+ const scope = extractScope(branch); // api, ui, auth
249
+ if (scope) {
250
+ message = `${type}(${scope}): ${message}`;
251
+ }
252
+ ```
253
+
254
+ 4. **Commit Template**
255
+ ```javascript
256
+ message += '\n# Why:\n# - \n\n';
257
+ message += '# What:\n# - \n';
258
+ ```
259
+
260
+ 5. **Helpful Guidelines**
261
+ ```javascript
262
+ message += '\n# Guidelines:\n';
263
+ message += '# - Use imperative mood\n';
264
+ message += '# - Keep first line < 50 chars\n';
265
+ ```
266
+
267
+ ### ❌ DON'T Include in Prepare-Commit-Msg
268
+
269
+ 1. **Complete Messages** - Let developers write the description
270
+ 2. **Validation** - Use commit-msg hook for validation
271
+ 3. **External API Calls** - Keep hook fast
272
+ 4. **Interactive Prompts** - Hook runs non-interactively
273
+
274
+ ## Branch Naming Patterns
275
+
276
+ ### Recommended Branch Naming
277
+
278
+ **With Issue Numbers**:
279
+ ```
280
+ feature/123-user-authentication
281
+ bugfix/456-memory-leak
282
+ hotfix/789-critical-security
283
+ docs/321-api-documentation
284
+ ```
285
+
286
+ **With Scope**:
287
+ ```
288
+ feature/auth/oauth-integration
289
+ fix/api/validation-error
290
+ refactor/ui/button-component
291
+ ```
292
+
293
+ **Jira/Linear Style**:
294
+ ```
295
+ feature/PROJ-123-user-login
296
+ fix/PROJ-456-api-timeout
297
+ ```
298
+
299
+ ### Extraction Logic
300
+
301
+ ```javascript
302
+ function extractFromBranch(branch) {
303
+ // Pattern 1: type/number-description
304
+ let match = branch.match(/^([^/]+)\/(\d+)-(.+)$/);
305
+ if (match) {
306
+ return {
307
+ type: mapType(match[1]), // feature -> feat
308
+ issue: match[2], // 123
309
+ description: match[3], // user-authentication
310
+ };
311
+ }
312
+
313
+ // Pattern 2: type/scope/description
314
+ match = branch.match(/^([^/]+)\/([^/]+)\/(.+)$/);
315
+ if (match) {
316
+ return {
317
+ type: mapType(match[1]), // feature -> feat
318
+ scope: match[2], // auth
319
+ description: match[3], // oauth-integration
320
+ };
321
+ }
322
+
323
+ // Pattern 3: type/PROJ-number-description
324
+ match = branch.match(/^([^/]+)\/([A-Z]+-\d+)-(.+)$/);
325
+ if (match) {
326
+ return {
327
+ type: mapType(match[1]), // feature -> feat
328
+ issue: match[2], // PROJ-123
329
+ description: match[3], // user-login
330
+ };
331
+ }
332
+
333
+ return null;
334
+ }
335
+ ```
336
+
337
+ ## Advanced Patterns
338
+
339
+ ### Add Co-Authors from Git Config
340
+
341
+ ```javascript
342
+ function getTeamMembers() {
343
+ // Read from .git/config or custom config file
344
+ const config = fs.readFileSync('.git/config', 'utf-8');
345
+ const members = [];
346
+
347
+ const matches = config.matchAll(/co-author-(\w+) = (.+) <(.+)>/g);
348
+ for (const match of matches) {
349
+ members.push({ name: match[2], email: match[3] });
350
+ }
351
+
352
+ return members;
353
+ }
354
+
355
+ function addCoAuthors(message) {
356
+ const members = getTeamMembers();
357
+ if (members.length > 0) {
358
+ message += '\n\n# Co-Authors (uncomment if applicable):\n';
359
+ members.forEach(m => {
360
+ message += `# Co-authored-by: ${m.name} <${m.email}>\n`;
361
+ });
362
+ }
363
+ return message;
364
+ }
365
+ ```
366
+
367
+ ### Add Related Files
368
+
369
+ ```javascript
370
+ function getStagedFiles() {
371
+ const output = execSync('git diff --cached --name-only', { encoding: 'utf-8' });
372
+ return output.trim().split('\n').filter(f => f);
373
+ }
374
+
375
+ function addFilesSummary(message) {
376
+ const files = getStagedFiles();
377
+ if (files.length > 0) {
378
+ message += '\n# Files changed:\n';
379
+ files.forEach(f => {
380
+ message += `# ${f}\n`;
381
+ });
382
+ }
383
+ return message;
384
+ }
385
+ ```
386
+
387
+ ### Add Recent Commits Context
388
+
389
+ ```javascript
390
+ function getRecentCommits(count = 5) {
391
+ const output = execSync(`git log -${count} --oneline`, { encoding: 'utf-8' });
392
+ return output.trim().split('\n');
393
+ }
394
+
395
+ function addCommitContext(message) {
396
+ const commits = getRecentCommits();
397
+ message += '\n# Recent commits:\n';
398
+ commits.forEach(c => {
399
+ message += `# ${c}\n`;
400
+ });
401
+ return message;
402
+ }
403
+ ```
404
+
405
+ ### Branch-Specific Templates
406
+
407
+ ```javascript
408
+ function getTemplate(branch) {
409
+ if (branch === 'main' || branch === 'master') {
410
+ return {
411
+ requireIssue: true,
412
+ requireBreakingChange: true,
413
+ template: 'production',
414
+ };
415
+ }
416
+
417
+ if (branch.startsWith('hotfix/')) {
418
+ return {
419
+ requireIssue: true,
420
+ urgent: true,
421
+ template: 'hotfix',
422
+ };
423
+ }
424
+
425
+ if (branch.startsWith('feature/')) {
426
+ return {
427
+ requireIssue: false,
428
+ template: 'feature',
429
+ };
430
+ }
431
+
432
+ return { template: 'default' };
433
+ }
434
+ ```
435
+
436
+ ## Commit Message Templates
437
+
438
+ ### Feature Template
439
+
440
+ ```
441
+ feat(<scope>): <subject>
442
+
443
+ ## Why
444
+ - Motivation for this feature
445
+ - Problem it solves
446
+
447
+ ## What
448
+ - Summary of implementation
449
+ - Key changes made
450
+
451
+ ## How to Test
452
+ - Steps to verify functionality
453
+
454
+ Refs #<issue>
455
+ ```
456
+
457
+ ### Bugfix Template
458
+
459
+ ```
460
+ fix(<scope>): <subject>
461
+
462
+ ## Problem
463
+ - Description of bug
464
+ - Steps to reproduce
465
+ - Expected vs actual behavior
466
+
467
+ ## Solution
468
+ - How bug was fixed
469
+ - Root cause identified
470
+
471
+ ## Testing
472
+ - Verification steps
473
+ - Regression testing done
474
+
475
+ Fixes #<issue>
476
+ ```
477
+
478
+ ### Hotfix Template
479
+
480
+ ```
481
+ fix!: <critical-issue>
482
+
483
+ CRITICAL HOTFIX
484
+
485
+ ## Issue
486
+ - Production problem description
487
+ - Impact and severity
488
+
489
+ ## Fix
490
+ - Immediate solution applied
491
+ - Temporary vs permanent fix
492
+
493
+ ## Verification
494
+ - Testing performed
495
+ - Rollback plan
496
+
497
+ Fixes #<issue>
498
+ ```
499
+
500
+ ## Troubleshooting
501
+
502
+ ### Template Not Appearing
503
+
504
+ **Causes**:
505
+ 1. Hook permissions incorrect
506
+ 2. Source type is 'message' (using -m flag)
507
+ 3. Merge/squash commit
508
+
509
+ **Solutions**:
510
+ ```bash
511
+ # Check permissions
512
+ chmod +x .git/hooks/prepare-commit-msg
513
+
514
+ # Test manually
515
+ .git/hooks/prepare-commit-msg .git/COMMIT_EDITMSG template
516
+
517
+ # Check source type in hook
518
+ echo "Source: $2" >> /tmp/hook-debug.log
519
+ ```
520
+
521
+ ### Issue Number Not Extracted
522
+
523
+ **Issue**: Branch name doesn't match regex
524
+
525
+ **Solution**: Add more patterns:
526
+ ```javascript
527
+ const patterns = [
528
+ /\/(\d+)-/, // feature/123-name
529
+ /\/([A-Z]+-\d+)-/, // feature/PROJ-123-name
530
+ /#(\d+)/, // feature/#123
531
+ /^(\d+)-/, // 123-feature-name
532
+ /\[(\d+)\]/, // feature-[123]-name
533
+ /([A-Z]{2,}-\d+)/, // JIRA-123
534
+ ];
535
+ ```
536
+
537
+ ### Template Overrides User Message
538
+
539
+ **Issue**: Hook overwrites existing message
540
+
541
+ **Solution**: Check if message already exists:
542
+ ```javascript
543
+ const currentMessage = fs.readFileSync(messageFile, 'utf-8');
544
+
545
+ // Skip if message has content (not just comments)
546
+ if (currentMessage.trim() && !currentMessage.startsWith('#')) {
547
+ process.exit(0);
548
+ }
549
+ ```
550
+
551
+ ## Integration with Tools
552
+
553
+ ### Git Config Template
554
+
555
+ ```bash
556
+ # Set global commit template
557
+ git config --global commit.template ~/.gitmessage
558
+
559
+ # Create template file
560
+ cat > ~/.gitmessage << 'EOF'
561
+ # <type>(<scope>): <subject>
562
+
563
+ # Why:
564
+ # -
565
+
566
+ # What:
567
+ # -
568
+
569
+ # Refs #
570
+ EOF
571
+ ```
572
+
573
+ ### Commitizen Integration
574
+
575
+ ```bash
576
+ # Install commitizen
577
+ npm install --save-dev commitizen cz-conventional-changelog
578
+
579
+ # Configure
580
+ echo '{"path": "cz-conventional-changelog"}' > .czrc
581
+
582
+ # Use instead of git commit
583
+ npx cz
584
+ ```
585
+
586
+ ## Integration with Rulebook
587
+
588
+ If using `@hivehub/rulebook`, prepare-commit-msg hooks are automatically generated:
589
+
590
+ ```bash
591
+ # Initialize with hooks
592
+ npx @hivehub/rulebook init
593
+
594
+ # Configuration in .rulebook
595
+ {
596
+ "hooks": {
597
+ "prepareCommitMsg": {
598
+ "enabled": true,
599
+ "extractIssue": true,
600
+ "addTemplate": true,
601
+ "addGuidelines": true
602
+ }
603
+ }
604
+ }
605
+ ```
606
+
607
+ ## Common Pitfalls
608
+
609
+ 1. **❌ Overwriting existing messages**: Check if message already exists
610
+ 2. **❌ Slow execution**: Avoid external API calls
611
+ 3. **❌ Complex regex**: Test branch name patterns thoroughly
612
+ 4. **❌ No escape for merge commits**: Check source type
613
+ 5. **❌ Not skipping -m commits**: Check if source is 'message'
614
+
615
+ ## Related Templates
616
+
617
+ - See `/.rulebook/specs/COMMIT_MSG.md` for commit message validation
618
+ - See `/.rulebook/specs/GIT.md` for git workflow and branch naming
619
+ - See `/.rulebook/specs/PRE_COMMIT.md` for pre-commit checks