@hivehub/rulebook 1.2.0

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