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