@hivehub/rulebook 5.8.1 → 6.0.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 (514) hide show
  1. package/README.md +86 -216
  2. package/dist/cli/commands/claude.d.ts.map +1 -1
  3. package/dist/cli/commands/claude.js +10 -4
  4. package/dist/cli/commands/claude.js.map +1 -1
  5. package/dist/cli/commands/context-intelligence.d.ts.map +1 -1
  6. package/dist/cli/commands/context-intelligence.js.map +1 -1
  7. package/dist/cli/commands/index.d.ts +1 -2
  8. package/dist/cli/commands/index.d.ts.map +1 -1
  9. package/dist/cli/commands/index.js +1 -2
  10. package/dist/cli/commands/index.js.map +1 -1
  11. package/dist/cli/commands/init.d.ts.map +1 -1
  12. package/dist/cli/commands/init.js +16 -91
  13. package/dist/cli/commands/init.js.map +1 -1
  14. package/dist/cli/commands/mcp.d.ts.map +1 -1
  15. package/dist/cli/commands/mcp.js.map +1 -1
  16. package/dist/cli/commands/misc.d.ts +0 -1
  17. package/dist/cli/commands/misc.d.ts.map +1 -1
  18. package/dist/cli/commands/misc.js +0 -76
  19. package/dist/cli/commands/misc.js.map +1 -1
  20. package/dist/cli/commands/plans.d.ts.map +1 -1
  21. package/dist/cli/commands/plans.js.map +1 -1
  22. package/dist/cli/commands/skills.d.ts.map +1 -1
  23. package/dist/cli/commands/skills.js +6 -2
  24. package/dist/cli/commands/skills.js.map +1 -1
  25. package/dist/cli/commands/task.d.ts.map +1 -1
  26. package/dist/cli/commands/task.js +3 -1
  27. package/dist/cli/commands/task.js.map +1 -1
  28. package/dist/cli/commands/update.d.ts +7 -0
  29. package/dist/cli/commands/update.d.ts.map +1 -1
  30. package/dist/cli/commands/update.js +61 -165
  31. package/dist/cli/commands/update.js.map +1 -1
  32. package/dist/cli/commands/workspace.d.ts.map +1 -1
  33. package/dist/cli/commands/workspace.js +4 -3
  34. package/dist/cli/commands/workspace.js.map +1 -1
  35. package/dist/cli/prompts.d.ts.map +1 -1
  36. package/dist/cli/prompts.js +0 -40
  37. package/dist/cli/prompts.js.map +1 -1
  38. package/dist/core/claude/claude-mcp.d.ts.map +1 -1
  39. package/dist/core/claude/claude-mcp.js +1 -1
  40. package/dist/core/claude/claude-mcp.js.map +1 -1
  41. package/dist/core/claude/claude-md-generator.d.ts.map +1 -1
  42. package/dist/core/claude/claude-md-generator.js.map +1 -1
  43. package/dist/core/claude/claude-settings-manager.d.ts.map +1 -1
  44. package/dist/core/claude/claude-settings-manager.js +9 -6
  45. package/dist/core/claude/claude-settings-manager.js.map +1 -1
  46. package/dist/core/custom-templates.d.ts.map +1 -1
  47. package/dist/core/custom-templates.js.map +1 -1
  48. package/dist/core/detect/detector.d.ts +0 -28
  49. package/dist/core/detect/detector.d.ts.map +1 -1
  50. package/dist/core/detect/detector.js +5 -84
  51. package/dist/core/detect/detector.js.map +1 -1
  52. package/dist/core/detect/library-registry.d.ts.map +1 -1
  53. package/dist/core/detect/library-registry.js.map +1 -1
  54. package/dist/core/docs/docs-generator.d.ts.map +1 -1
  55. package/dist/core/docs/docs-generator.js.map +1 -1
  56. package/dist/core/docs/mcp-reference-generator.d.ts.map +1 -1
  57. package/dist/core/docs/mcp-reference-generator.js.map +1 -1
  58. package/dist/core/generators/generator.d.ts.map +1 -1
  59. package/dist/core/generators/generator.js +0 -72
  60. package/dist/core/generators/generator.js.map +1 -1
  61. package/dist/core/generators/gitignore-generator.d.ts.map +1 -1
  62. package/dist/core/generators/gitignore-generator.js +12 -1
  63. package/dist/core/generators/gitignore-generator.js.map +1 -1
  64. package/dist/core/generators/minimal-scaffolder.d.ts.map +1 -1
  65. package/dist/core/generators/minimal-scaffolder.js.map +1 -1
  66. package/dist/core/generators/rules-generator.d.ts.map +1 -1
  67. package/dist/core/generators/rules-generator.js.map +1 -1
  68. package/dist/core/generators/workflow-generator.d.ts +0 -10
  69. package/dist/core/generators/workflow-generator.d.ts.map +1 -1
  70. package/dist/core/generators/workflow-generator.js +0 -307
  71. package/dist/core/generators/workflow-generator.js.map +1 -1
  72. package/dist/core/logger.d.ts.map +1 -1
  73. package/dist/core/logger.js.map +1 -1
  74. package/dist/core/merger.d.ts.map +1 -1
  75. package/dist/core/merger.js.map +1 -1
  76. package/dist/core/migrator.d.ts.map +1 -1
  77. package/dist/core/migrator.js +2 -1
  78. package/dist/core/migrator.js.map +1 -1
  79. package/dist/core/quality/coverage-checker.d.ts.map +1 -1
  80. package/dist/core/quality/coverage-checker.js.map +1 -1
  81. package/dist/core/quality/dependency-checker.d.ts.map +1 -1
  82. package/dist/core/quality/dependency-checker.js +3 -1
  83. package/dist/core/quality/dependency-checker.js.map +1 -1
  84. package/dist/core/quality/doctor.d.ts.map +1 -1
  85. package/dist/core/quality/doctor.js.map +1 -1
  86. package/dist/core/quality/validator.d.ts.map +1 -1
  87. package/dist/core/quality/validator.js.map +1 -1
  88. package/dist/core/rule-engine.d.ts +5 -21
  89. package/dist/core/rule-engine.d.ts.map +1 -1
  90. package/dist/core/rule-engine.js +9 -191
  91. package/dist/core/rule-engine.js.map +1 -1
  92. package/dist/core/skills/skills-manager.d.ts.map +1 -1
  93. package/dist/core/skills/skills-manager.js.map +1 -1
  94. package/dist/core/state/config-manager.d.ts.map +1 -1
  95. package/dist/core/state/config-manager.js +6 -50
  96. package/dist/core/state/config-manager.js.map +1 -1
  97. package/dist/core/state/override-manager.js.map +1 -1
  98. package/dist/core/state/state-writer.d.ts.map +1 -1
  99. package/dist/core/state/state-writer.js.map +1 -1
  100. package/dist/core/state/version-bumper.d.ts.map +1 -1
  101. package/dist/core/state/version-bumper.js.map +1 -1
  102. package/dist/core/tasks/decision-manager.d.ts.map +1 -1
  103. package/dist/core/tasks/decision-manager.js +6 -1
  104. package/dist/core/tasks/decision-manager.js.map +1 -1
  105. package/dist/core/tasks/knowledge-manager.d.ts.map +1 -1
  106. package/dist/core/tasks/knowledge-manager.js.map +1 -1
  107. package/dist/core/tasks/learn-manager.d.ts.map +1 -1
  108. package/dist/core/tasks/learn-manager.js.map +1 -1
  109. package/dist/core/tasks/plans-manager.d.ts.map +1 -1
  110. package/dist/core/tasks/plans-manager.js.map +1 -1
  111. package/dist/core/tasks/task-manager.d.ts.map +1 -1
  112. package/dist/core/tasks/task-manager.js.map +1 -1
  113. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -1
  114. package/dist/core/workspace/legacy-migrator.js.map +1 -1
  115. package/dist/core/workspace/project-worker.d.ts +0 -4
  116. package/dist/core/workspace/project-worker.d.ts.map +1 -1
  117. package/dist/core/workspace/project-worker.js +0 -28
  118. package/dist/core/workspace/project-worker.js.map +1 -1
  119. package/dist/core/workspace/workspace-manager.d.ts +0 -11
  120. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  121. package/dist/core/workspace/workspace-manager.js +6 -30
  122. package/dist/core/workspace/workspace-manager.js.map +1 -1
  123. package/dist/core/workspace/workspace-types.d.ts +0 -1
  124. package/dist/core/workspace/workspace-types.d.ts.map +1 -1
  125. package/dist/hooks/safe-flag-io.js.map +1 -1
  126. package/dist/index.d.ts +1 -1
  127. package/dist/index.d.ts.map +1 -1
  128. package/dist/index.js +3 -82
  129. package/dist/index.js.map +1 -1
  130. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  131. package/dist/mcp/rulebook-server.js +55 -1634
  132. package/dist/mcp/rulebook-server.js.map +1 -1
  133. package/dist/mcp/tools/context.d.ts +23 -0
  134. package/dist/mcp/tools/context.d.ts.map +1 -0
  135. package/dist/mcp/tools/context.js +2 -0
  136. package/dist/mcp/tools/context.js.map +1 -0
  137. package/dist/mcp/tools/decision-tools.d.ts +5 -0
  138. package/dist/mcp/tools/decision-tools.d.ts.map +1 -0
  139. package/dist/mcp/tools/decision-tools.js +220 -0
  140. package/dist/mcp/tools/decision-tools.js.map +1 -0
  141. package/dist/mcp/tools/knowledge-tools.d.ts +5 -0
  142. package/dist/mcp/tools/knowledge-tools.d.ts.map +1 -0
  143. package/dist/mcp/tools/knowledge-tools.js +157 -0
  144. package/dist/mcp/tools/knowledge-tools.js.map +1 -0
  145. package/dist/mcp/tools/learn-tools.d.ts +5 -0
  146. package/dist/mcp/tools/learn-tools.d.ts.map +1 -0
  147. package/dist/mcp/tools/learn-tools.js +150 -0
  148. package/dist/mcp/tools/learn-tools.js.map +1 -0
  149. package/dist/mcp/tools/rules-tools.d.ts +4 -0
  150. package/dist/mcp/tools/rules-tools.d.ts.map +1 -0
  151. package/dist/mcp/tools/rules-tools.js +47 -0
  152. package/dist/mcp/tools/rules-tools.js.map +1 -0
  153. package/dist/mcp/tools/skill-tools.d.ts +5 -0
  154. package/dist/mcp/tools/skill-tools.d.ts.map +1 -0
  155. package/dist/mcp/tools/skill-tools.js +330 -0
  156. package/dist/mcp/tools/skill-tools.js.map +1 -0
  157. package/dist/mcp/tools/task-tools.d.ts +5 -0
  158. package/dist/mcp/tools/task-tools.d.ts.map +1 -0
  159. package/dist/mcp/tools/task-tools.js +185 -0
  160. package/dist/mcp/tools/task-tools.js.map +1 -0
  161. package/dist/mcp/tools/workspace-tools.d.ts +6 -0
  162. package/dist/mcp/tools/workspace-tools.d.ts.map +1 -0
  163. package/dist/mcp/tools/workspace-tools.js +118 -0
  164. package/dist/mcp/tools/workspace-tools.js.map +1 -0
  165. package/dist/types.d.ts +1 -46
  166. package/dist/types.d.ts.map +1 -1
  167. package/dist/utils/file-system.d.ts.map +1 -1
  168. package/dist/utils/file-system.js.map +1 -1
  169. package/dist/utils/git-hooks.d.ts.map +1 -1
  170. package/dist/utils/git-hooks.js.map +1 -1
  171. package/dist/utils/gitignore.d.ts.map +1 -1
  172. package/dist/utils/gitignore.js.map +1 -1
  173. package/dist/utils/rulesignore.d.ts.map +1 -1
  174. package/dist/utils/rulesignore.js.map +1 -1
  175. package/package.json +25 -27
  176. package/templates/agents/architect.md +51 -51
  177. package/templates/agents/build-engineer.md +36 -36
  178. package/templates/agents/code-reviewer.md +47 -47
  179. package/templates/agents/docs-writer.md +38 -38
  180. package/templates/agents/implementer.md +42 -42
  181. package/templates/agents/performance-engineer.md +49 -49
  182. package/templates/agents/researcher.md +38 -38
  183. package/templates/agents/security-reviewer.md +40 -40
  184. package/templates/agents/team-lead.md +37 -37
  185. package/templates/agents/tester.md +48 -48
  186. package/templates/ci/rulebook-review.yml +26 -26
  187. package/templates/claude-workflows/review-fanout.js +2 -2
  188. package/templates/claude-workflows/rulebook-driver.js +16 -4
  189. package/templates/cli/CLAUDE.md +102 -117
  190. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  191. package/templates/commands/rulebook-decision-create.md +55 -55
  192. package/templates/commands/rulebook-decision-list.md +15 -15
  193. package/templates/commands/rulebook-knowledge-add.md +41 -41
  194. package/templates/commands/rulebook-knowledge-list.md +15 -15
  195. package/templates/commands/rulebook-learn-capture.md +1 -2
  196. package/templates/commands/rulebook-task-apply.md +67 -67
  197. package/templates/commands/rulebook-task-archive.md +94 -94
  198. package/templates/commands/rulebook-task-create.md +93 -93
  199. package/templates/commands/rulebook-task-list.md +42 -42
  200. package/templates/commands/rulebook-task-show.md +52 -52
  201. package/templates/commands/rulebook-task-validate.md +53 -53
  202. package/templates/compact-context/_default.md +23 -23
  203. package/templates/compact-context/cpp.md +26 -26
  204. package/templates/compact-context/go.md +26 -26
  205. package/templates/compact-context/python.md +26 -26
  206. package/templates/compact-context/rust.md +28 -28
  207. package/templates/compact-context/typescript.md +29 -29
  208. package/templates/core/AGENTS_LEAN.md +4 -9
  209. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  210. package/templates/core/AGENT_AUTOMATION.md +273 -296
  211. package/templates/core/CLAUDE_MD_v2.md +85 -90
  212. package/templates/core/DAG.md +304 -304
  213. package/templates/core/DECISIONS.md +38 -38
  214. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  215. package/templates/core/KNOWLEDGE.md +49 -49
  216. package/templates/core/MULTI_AGENT.md +74 -74
  217. package/templates/core/PLANS.md +28 -28
  218. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  219. package/templates/core/RULEBOOK.md +1936 -1947
  220. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  221. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  222. package/templates/core/WORKSPACE.md +4 -8
  223. package/templates/git/CI_CD_PATTERNS.md +661 -661
  224. package/templates/git/GITHUB_ACTIONS.md +728 -728
  225. package/templates/git/GITLAB_CI.md +730 -730
  226. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  227. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  228. package/templates/hooks/COMMIT_MSG.md +530 -530
  229. package/templates/hooks/POST_CHECKOUT.md +546 -546
  230. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  231. package/templates/hooks/PRE_COMMIT.md +414 -414
  232. package/templates/hooks/PRE_PUSH.md +601 -601
  233. package/templates/hooks/enforce-pre-tool.sh +26 -9
  234. package/templates/hooks/update-check.ps1 +84 -84
  235. package/templates/hooks/update-check.sh +45 -21
  236. package/templates/languages/C.md +333 -333
  237. package/templates/languages/CPP.md +743 -743
  238. package/templates/languages/CSHARP.md +417 -417
  239. package/templates/languages/ELIXIR.md +454 -454
  240. package/templates/languages/ERLANG.md +361 -361
  241. package/templates/languages/GO.md +645 -645
  242. package/templates/languages/HASKELL.md +177 -177
  243. package/templates/languages/JAVA.md +607 -607
  244. package/templates/languages/JAVASCRIPT.md +631 -631
  245. package/templates/languages/JULIA.md +97 -97
  246. package/templates/languages/KOTLIN.md +511 -511
  247. package/templates/languages/LISP.md +100 -100
  248. package/templates/languages/LUA.md +74 -74
  249. package/templates/languages/OBJECTIVEC.md +90 -90
  250. package/templates/languages/PHP.md +416 -416
  251. package/templates/languages/PYTHON.md +682 -682
  252. package/templates/languages/RUBY.md +421 -421
  253. package/templates/languages/RUST.md +477 -477
  254. package/templates/languages/SAS.md +73 -73
  255. package/templates/languages/SCALA.md +348 -348
  256. package/templates/languages/SOLIDITY.md +580 -580
  257. package/templates/languages/SQL.md +137 -137
  258. package/templates/languages/SWIFT.md +466 -466
  259. package/templates/languages/TYPESCRIPT.md +591 -591
  260. package/templates/languages/ZIG.md +265 -265
  261. package/templates/modules/CONTEXT7.md +54 -54
  262. package/templates/modules/GITHUB_MCP.md +64 -64
  263. package/templates/modules/PLAYWRIGHT.md +90 -90
  264. package/templates/modules/RULEBOOK_MCP.md +208 -208
  265. package/templates/modules/SERENA.md +337 -337
  266. package/templates/modules/SUPABASE.md +223 -223
  267. package/templates/modules/SYNAP.md +69 -69
  268. package/templates/modules/VECTORIZER.md +63 -63
  269. package/templates/modules/sequential-thinking.md +42 -42
  270. package/templates/rules/consult-analysis-before-implementing.md +21 -23
  271. package/templates/rules/cpp.md +46 -46
  272. package/templates/rules/csharp.md +44 -44
  273. package/templates/rules/diagnostic-first.md +39 -39
  274. package/templates/rules/fail-twice-escalate.md +46 -46
  275. package/templates/rules/follow-task-sequence.md +36 -36
  276. package/templates/rules/git-safety.md +29 -29
  277. package/templates/rules/go.md +40 -40
  278. package/templates/rules/incremental-implementation.md +56 -56
  279. package/templates/rules/incremental-tests.md +29 -29
  280. package/templates/rules/java.md +43 -43
  281. package/templates/rules/javascript.md +39 -39
  282. package/templates/rules/knowledge-base-usage.md +41 -41
  283. package/templates/rules/multi-agent-teams.md +75 -75
  284. package/templates/rules/no-deferred.md +31 -31
  285. package/templates/rules/no-shortcuts.md +30 -30
  286. package/templates/rules/python.md +43 -43
  287. package/templates/rules/research-first.md +30 -30
  288. package/templates/rules/respect-handoff-trigger.md +41 -41
  289. package/templates/rules/rust.md +40 -40
  290. package/templates/rules/sequential-editing.md +21 -21
  291. package/templates/rules/session-workflow.md +24 -24
  292. package/templates/rules/task-decomposition.md +32 -32
  293. package/templates/rules/typescript.md +40 -40
  294. package/templates/skills/cli/claude/SKILL.md +42 -42
  295. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  296. package/templates/skills/core/dag/SKILL.md +314 -314
  297. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  298. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  299. package/templates/skills/core/rulebook/SKILL.md +176 -176
  300. package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
  301. package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
  302. package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
  303. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  304. package/templates/skills/dev/analysis/SKILL.md +19 -19
  305. package/templates/skills/dev/api-design/SKILL.md +15 -15
  306. package/templates/skills/dev/architect/SKILL.md +17 -17
  307. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  308. package/templates/skills/dev/db-design/SKILL.md +15 -15
  309. package/templates/skills/dev/debug/SKILL.md +16 -16
  310. package/templates/skills/dev/deploy/SKILL.md +17 -17
  311. package/templates/skills/dev/docs/SKILL.md +17 -17
  312. package/templates/skills/dev/handoff/SKILL.md +27 -27
  313. package/templates/skills/dev/migrate/SKILL.md +15 -15
  314. package/templates/skills/dev/perf/SKILL.md +17 -17
  315. package/templates/skills/dev/refactor/SKILL.md +17 -17
  316. package/templates/skills/dev/research/SKILL.md +14 -14
  317. package/templates/skills/dev/review/SKILL.md +18 -18
  318. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  319. package/templates/skills/languages/c/SKILL.md +343 -343
  320. package/templates/skills/languages/cpp/SKILL.md +753 -753
  321. package/templates/skills/languages/csharp/SKILL.md +427 -427
  322. package/templates/skills/languages/elixir/SKILL.md +464 -464
  323. package/templates/skills/languages/erlang/SKILL.md +371 -371
  324. package/templates/skills/languages/go/SKILL.md +655 -655
  325. package/templates/skills/languages/haskell/SKILL.md +187 -187
  326. package/templates/skills/languages/java/SKILL.md +617 -617
  327. package/templates/skills/languages/javascript/SKILL.md +641 -641
  328. package/templates/skills/languages/julia/SKILL.md +107 -107
  329. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  330. package/templates/skills/languages/lisp/SKILL.md +110 -110
  331. package/templates/skills/languages/lua/SKILL.md +84 -84
  332. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  333. package/templates/skills/languages/php/SKILL.md +426 -426
  334. package/templates/skills/languages/python/SKILL.md +692 -692
  335. package/templates/skills/languages/ruby/SKILL.md +431 -431
  336. package/templates/skills/languages/rust/SKILL.md +487 -487
  337. package/templates/skills/languages/sas/SKILL.md +83 -83
  338. package/templates/skills/languages/scala/SKILL.md +358 -358
  339. package/templates/skills/languages/solidity/SKILL.md +590 -590
  340. package/templates/skills/languages/sql/SKILL.md +147 -147
  341. package/templates/skills/languages/swift/SKILL.md +476 -476
  342. package/templates/skills/languages/typescript/SKILL.md +302 -302
  343. package/templates/skills/languages/zig/SKILL.md +275 -275
  344. package/templates/skills/modules/context7/SKILL.md +64 -64
  345. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  346. package/templates/skills/modules/playwright/SKILL.md +100 -100
  347. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  348. package/templates/skills/modules/serena/SKILL.md +347 -347
  349. package/templates/skills/modules/supabase/SKILL.md +233 -233
  350. package/templates/skills/modules/synap/SKILL.md +79 -79
  351. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  352. package/.claude/commands/analysis.md +0 -35
  353. package/.claude/commands/continue.md +0 -33
  354. package/.claude/commands/rulebook-decision-create.md +0 -55
  355. package/.claude/commands/rulebook-decision-list.md +0 -15
  356. package/.claude/commands/rulebook-knowledge-add.md +0 -41
  357. package/.claude/commands/rulebook-knowledge-list.md +0 -15
  358. package/.claude/commands/rulebook-learn-capture.md +0 -41
  359. package/.claude/commands/rulebook-learn-list.md +0 -13
  360. package/.claude/commands/rulebook-memory-save.md +0 -48
  361. package/.claude/commands/rulebook-memory-search.md +0 -47
  362. package/.claude/commands/rulebook-task-apply.md +0 -67
  363. package/.claude/commands/rulebook-task-archive.md +0 -94
  364. package/.claude/commands/rulebook-task-create.md +0 -93
  365. package/.claude/commands/rulebook-task-list.md +0 -42
  366. package/.claude/commands/rulebook-task-show.md +0 -52
  367. package/.claude/commands/rulebook-task-validate.md +0 -53
  368. package/.claude-plugin/marketplace.json +0 -28
  369. package/.claude-plugin/plugin.json +0 -8
  370. package/dist/agents/claude-code.d.ts +0 -69
  371. package/dist/agents/claude-code.d.ts.map +0 -1
  372. package/dist/agents/claude-code.js +0 -180
  373. package/dist/agents/claude-code.js.map +0 -1
  374. package/dist/agents/cursor-agent.d.ts +0 -184
  375. package/dist/agents/cursor-agent.d.ts.map +0 -1
  376. package/dist/agents/cursor-agent.js +0 -299
  377. package/dist/agents/cursor-agent.js.map +0 -1
  378. package/dist/agents/gemini-cli.d.ts +0 -69
  379. package/dist/agents/gemini-cli.d.ts.map +0 -1
  380. package/dist/agents/gemini-cli.js +0 -180
  381. package/dist/agents/gemini-cli.js.map +0 -1
  382. package/dist/cli/commands/memory.d.ts +0 -30
  383. package/dist/cli/commands/memory.d.ts.map +0 -1
  384. package/dist/cli/commands/memory.js +0 -259
  385. package/dist/cli/commands/memory.js.map +0 -1
  386. package/dist/core/console/cli-bridge.d.ts +0 -113
  387. package/dist/core/console/cli-bridge.d.ts.map +0 -1
  388. package/dist/core/console/cli-bridge.js +0 -1094
  389. package/dist/core/console/cli-bridge.js.map +0 -1
  390. package/dist/core/ide/multi-tool-generator.d.ts +0 -59
  391. package/dist/core/ide/multi-tool-generator.d.ts.map +0 -1
  392. package/dist/core/ide/multi-tool-generator.js +0 -157
  393. package/dist/core/ide/multi-tool-generator.js.map +0 -1
  394. package/dist/core/ide/opencode-generator.d.ts +0 -72
  395. package/dist/core/ide/opencode-generator.d.ts.map +0 -1
  396. package/dist/core/ide/opencode-generator.js +0 -450
  397. package/dist/core/ide/opencode-generator.js.map +0 -1
  398. package/dist/core/indexer/background-indexer.d.ts +0 -35
  399. package/dist/core/indexer/background-indexer.d.ts.map +0 -1
  400. package/dist/core/indexer/background-indexer.js +0 -267
  401. package/dist/core/indexer/background-indexer.js.map +0 -1
  402. package/dist/core/indexer/file-parser.d.ts +0 -28
  403. package/dist/core/indexer/file-parser.d.ts.map +0 -1
  404. package/dist/core/indexer/file-parser.js +0 -171
  405. package/dist/core/indexer/file-parser.js.map +0 -1
  406. package/dist/core/indexer/indexer-types.d.ts +0 -37
  407. package/dist/core/indexer/indexer-types.d.ts.map +0 -1
  408. package/dist/core/indexer/indexer-types.js +0 -8
  409. package/dist/core/indexer/indexer-types.js.map +0 -1
  410. package/dist/memory/file-search.d.ts +0 -43
  411. package/dist/memory/file-search.d.ts.map +0 -1
  412. package/dist/memory/file-search.js +0 -228
  413. package/dist/memory/file-search.js.map +0 -1
  414. package/dist/memory/file-store.d.ts +0 -99
  415. package/dist/memory/file-store.d.ts.map +0 -1
  416. package/dist/memory/file-store.js +0 -615
  417. package/dist/memory/file-store.js.map +0 -1
  418. package/dist/memory/legacy-migrator.d.ts +0 -27
  419. package/dist/memory/legacy-migrator.d.ts.map +0 -1
  420. package/dist/memory/legacy-migrator.js +0 -185
  421. package/dist/memory/legacy-migrator.js.map +0 -1
  422. package/dist/memory/memory-hooks.d.ts +0 -48
  423. package/dist/memory/memory-hooks.d.ts.map +0 -1
  424. package/dist/memory/memory-hooks.js +0 -248
  425. package/dist/memory/memory-hooks.js.map +0 -1
  426. package/dist/memory/memory-manager.d.ts +0 -65
  427. package/dist/memory/memory-manager.d.ts.map +0 -1
  428. package/dist/memory/memory-manager.js +0 -223
  429. package/dist/memory/memory-manager.js.map +0 -1
  430. package/dist/memory/memory-types.d.ts +0 -85
  431. package/dist/memory/memory-types.d.ts.map +0 -1
  432. package/dist/memory/memory-types.js +0 -7
  433. package/dist/memory/memory-types.js.map +0 -1
  434. package/templates/agents/accessibility-reviewer.md +0 -43
  435. package/templates/agents/api-designer.md +0 -42
  436. package/templates/agents/compiler/codegen-debugger.md +0 -34
  437. package/templates/agents/compiler/stdlib-engineer.md +0 -28
  438. package/templates/agents/compiler/test-coverage-guardian.md +0 -31
  439. package/templates/agents/context-intelligence.md +0 -50
  440. package/templates/agents/database-architect.md +0 -41
  441. package/templates/agents/devops-engineer.md +0 -42
  442. package/templates/agents/game-engine/cpp-core-expert.md +0 -35
  443. package/templates/agents/game-engine/render-engineer.md +0 -22
  444. package/templates/agents/game-engine/shader-engineer.md +0 -38
  445. package/templates/agents/game-engine/systems-integration.md +0 -43
  446. package/templates/agents/generic/code-reviewer.md +0 -41
  447. package/templates/agents/generic/docs-writer.md +0 -25
  448. package/templates/agents/generic/project-manager.md +0 -36
  449. package/templates/agents/generic/researcher.md +0 -34
  450. package/templates/agents/generic/test-engineer.md +0 -41
  451. package/templates/agents/i18n-engineer.md +0 -42
  452. package/templates/agents/migration-engineer.md +0 -42
  453. package/templates/agents/mobile/platform-specialist.md +0 -22
  454. package/templates/agents/mobile/ui-engineer.md +0 -22
  455. package/templates/agents/project-manager.md +0 -217
  456. package/templates/agents/refactoring-agent.md +0 -41
  457. package/templates/agents/ux-reviewer.md +0 -43
  458. package/templates/agents/web-app/api-designer.md +0 -22
  459. package/templates/agents/web-app/backend-engineer.md +0 -30
  460. package/templates/agents/web-app/database-engineer.md +0 -22
  461. package/templates/agents/web-app/frontend-engineer.md +0 -29
  462. package/templates/agents/web-app/security-reviewer.md +0 -32
  463. package/templates/cli/AIDER.md +0 -49
  464. package/templates/cli/AMAZON_Q.md +0 -25
  465. package/templates/cli/AUGGIE.md +0 -32
  466. package/templates/cli/CLINE.md +0 -99
  467. package/templates/cli/CODEBUDDY.md +0 -20
  468. package/templates/cli/CODEIUM.md +0 -20
  469. package/templates/cli/CODEX.md +0 -21
  470. package/templates/cli/CONTINUE.md +0 -34
  471. package/templates/cli/CURSOR_CLI.md +0 -62
  472. package/templates/cli/FACTORY.md +0 -18
  473. package/templates/cli/GEMINI.md +0 -35
  474. package/templates/cli/KILOCODE.md +0 -18
  475. package/templates/cli/OPENCODE.md +0 -85
  476. package/templates/cli/gemini-extension.json +0 -77
  477. package/templates/commands/rulebook-memory-save.md +0 -48
  478. package/templates/commands/rulebook-memory-search.md +0 -47
  479. package/templates/ides/CONTINUE_RULES.md +0 -16
  480. package/templates/ides/COPILOT_INSTRUCTIONS.md +0 -23
  481. package/templates/ides/GEMINI_RULES.md +0 -17
  482. package/templates/ides/OPENCODE.md +0 -63
  483. package/templates/ides/WINDSURF_RULES.md +0 -14
  484. package/templates/modules/ATLASSIAN.md +0 -255
  485. package/templates/modules/FIGMA.md +0 -267
  486. package/templates/modules/GRAFANA.md +0 -328
  487. package/templates/modules/MEMORY.md +0 -126
  488. package/templates/modules/NOTION.md +0 -247
  489. package/templates/skills/cli/aider/SKILL.md +0 -59
  490. package/templates/skills/cli/amazon-q/SKILL.md +0 -35
  491. package/templates/skills/cli/auggie/SKILL.md +0 -42
  492. package/templates/skills/cli/cline/SKILL.md +0 -42
  493. package/templates/skills/cli/codebuddy/SKILL.md +0 -30
  494. package/templates/skills/cli/codeium/SKILL.md +0 -30
  495. package/templates/skills/cli/codex/SKILL.md +0 -31
  496. package/templates/skills/cli/continue/SKILL.md +0 -44
  497. package/templates/skills/cli/cursor-cli/SKILL.md +0 -38
  498. package/templates/skills/cli/factory/SKILL.md +0 -28
  499. package/templates/skills/cli/gemini/SKILL.md +0 -45
  500. package/templates/skills/cli/kilocode/SKILL.md +0 -28
  501. package/templates/skills/cli/opencode/SKILL.md +0 -82
  502. package/templates/skills/ides/copilot/SKILL.md +0 -47
  503. package/templates/skills/ides/cursor/SKILL.md +0 -53
  504. package/templates/skills/ides/jetbrains-ai/SKILL.md +0 -45
  505. package/templates/skills/ides/replit/SKILL.md +0 -46
  506. package/templates/skills/ides/tabnine/SKILL.md +0 -39
  507. package/templates/skills/ides/vscode/SKILL.md +0 -50
  508. package/templates/skills/ides/windsurf/SKILL.md +0 -46
  509. package/templates/skills/ides/zed/SKILL.md +0 -42
  510. package/templates/skills/modules/atlassian/SKILL.md +0 -265
  511. package/templates/skills/modules/figma/SKILL.md +0 -277
  512. package/templates/skills/modules/grafana/SKILL.md +0 -338
  513. package/templates/skills/modules/memory/SKILL.md +0 -73
  514. package/templates/skills/modules/notion/SKILL.md +0 -257
@@ -1,464 +1,464 @@
1
- ---
2
- name: "Elixir"
3
- description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
- version: "1.0.0"
5
- category: "languages"
6
- author: "Rulebook"
7
- tags: ["languages", "language"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- ELIXIR:START -->
12
- # Elixir Project Rules
13
-
14
- ## Agent Automation Commands
15
-
16
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
-
18
- ```bash
19
- # Complete quality check sequence:
20
- mix format --check-formatted # Format check
21
- mix credo --strict # Linting
22
- mix dialyzer # Type checking
23
- mix test # All tests (100% pass)
24
- mix test --cover # Coverage (95%+ required)
25
- mix compile --warnings-as-errors # Build
26
-
27
- # Security audit:
28
- mix hex.audit # Vulnerability scan
29
- mix hex.outdated # Check outdated deps
30
- ```
31
-
32
- ## Elixir Configuration
33
-
34
- **CRITICAL**: Use Elixir 1.16+ with OTP 26+.
35
-
36
- - **Version**: Elixir 1.16+
37
- - **OTP**: 26+
38
- - **Formatter**: Built-in `mix format`
39
- - **Linter**: Credo
40
- - **Type Checker**: Dialyzer
41
-
42
- ### mix.exs Requirements
43
-
44
- ```elixir
45
- defmodule YourProject.MixProject do
46
- use Mix.Project
47
-
48
- def project do
49
- [
50
- app: :your_project,
51
- version: "1.0.0",
52
- elixir: "~> 1.16",
53
- start_permanent: Mix.env() == :prod,
54
- deps: deps(),
55
-
56
- # Documentation
57
- name: "Your Project",
58
- source_url: "https://github.com/your-org/your-project",
59
- docs: [
60
- main: "readme",
61
- extras: ["README.md", "CHANGELOG.md"]
62
- ],
63
-
64
- # Testing
65
- test_coverage: [tool: ExCoveralls],
66
- preferred_cli_env: [
67
- coveralls: :test,
68
- "coveralls.detail": :test,
69
- "coveralls.post": :test,
70
- "coveralls.html": :test
71
- ],
72
-
73
- # Dialyzer
74
- dialyzer: [
75
- plt_add_apps: [:mix, :ex_unit],
76
- plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
77
- flags: [:error_handling, :underspecs]
78
- ]
79
- ]
80
- end
81
-
82
- def application do
83
- [
84
- extra_applications: [:logger],
85
- mod: {YourProject.Application, []}
86
- ]
87
- end
88
-
89
- defp deps do
90
- [
91
- # Development & Testing
92
- {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
93
- {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
94
- {:excoveralls, "~> 0.18", only: :test},
95
- {:ex_doc, "~> 0.31", only: :dev, runtime: false}
96
- ]
97
- end
98
- end
99
- ```
100
-
101
- ## Code Quality Standards
102
-
103
- ### Mandatory Quality Checks
104
-
105
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
106
-
107
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
108
-
109
- ```bash
110
- # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
111
-
112
- # 1. Format check (matches workflow - use --check-formatted!)
113
- mix format --check-formatted
114
-
115
- # 2. Lint (MUST pass with no warnings - matches workflow)
116
- mix credo --strict
117
-
118
- # 3. Type check with Dialyzer (matches workflow)
119
- mix dialyzer
120
-
121
- # 4. Run all tests (MUST pass 100% - matches workflow)
122
- mix test --cover
123
-
124
- # 5. Check coverage (MUST meet threshold)
125
- mix test --cover --export-coverage default
126
- mix test.coverage
127
-
128
- # If ANY fails: ❌ DO NOT COMMIT - Fix first!
129
- ```
130
-
131
- **If ANY of these fail, you MUST fix the issues before committing.**
132
-
133
- **Why This Matters:**
134
- - CI/CD failures happen when local commands differ from workflows
135
- - Example: Using `mix format` locally but `mix format --check-formatted` in CI = failure
136
- - Example: Missing `--cover` flag = CI coverage failures
137
-
138
- ### Formatting
139
-
140
- - Use built-in `mix format`
141
- - Configuration in `.formatter.exs`
142
- - Format before committing: `mix format`
143
-
144
- Example `.formatter.exs`:
145
- ```elixir
146
- [
147
- inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
148
- line_length: 100
149
- ]
150
- ```
151
-
152
- ### Linting
153
-
154
- - Use Credo for code analysis
155
- - Configuration in `.credo.exs`
156
- - Must pass strict mode: `mix credo --strict`
157
-
158
- Example `.credo.exs`:
159
- ```elixir
160
- %{
161
- configs: [
162
- %{
163
- name: "default",
164
- files: %{
165
- included: ["lib/", "test/"],
166
- excluded: [~r"/_build/", ~r"/deps/"]
167
- },
168
- strict: true,
169
- color: true,
170
- checks: %{
171
- enabled: [
172
- {Credo.Check.Readability.ModuleDoc, []},
173
- {Credo.Check.Design.AliasUsage, priority: :low}
174
- ]
175
- }
176
- }
177
- ]
178
- }
179
- ```
180
-
181
- ### Testing
182
-
183
- - **Framework**: ExUnit (built-in)
184
- - **Location**: `test/` directory
185
- - **Coverage**: ExCoveralls
186
- - **Coverage Threshold**: 95%+
187
-
188
- Example test structure:
189
- ```elixir
190
- defmodule YourProject.MyModuleTest do
191
- use ExUnit.Case, async: true
192
-
193
- doctest YourProject.MyModule
194
-
195
- describe "function_name/1" do
196
- test "handles valid input" do
197
- assert YourProject.MyModule.function_name("input") == {:ok, "result"}
198
- end
199
-
200
- test "returns error for invalid input" do
201
- assert YourProject.MyModule.function_name("") == {:error, :invalid_input}
202
- end
203
- end
204
- end
205
- ```
206
-
207
- ### Type Specifications
208
-
209
- - Use `@spec` for all public functions
210
- - Use `@type` for custom types
211
- - Run Dialyzer regularly
212
-
213
- Example:
214
- ```elixir
215
- defmodule YourProject.MyModule do
216
- @moduledoc """
217
- Documentation for MyModule.
218
- """
219
-
220
- @type result :: {:ok, String.t()} | {:error, atom()}
221
-
222
- @spec process(String.t()) :: result()
223
- def process(input) when is_binary(input) and input != "" do
224
- {:ok, String.upcase(input)}
225
- end
226
-
227
- def process(_), do: {:error, :invalid_input}
228
- end
229
- ```
230
-
231
- ## Documentation
232
-
233
- - Use `@moduledoc` for module documentation
234
- - Use `@doc` for function documentation
235
- - Include examples with doctests
236
- - Generate docs with `mix docs`
237
-
238
- Example:
239
- ```elixir
240
- defmodule YourProject.MyModule do
241
- @moduledoc """
242
- Provides functionality for processing data.
243
-
244
- ## Examples
245
-
246
- iex> YourProject.MyModule.process("hello")
247
- {:ok, "HELLO"}
248
- """
249
-
250
- @doc """
251
- Processes the input string.
252
-
253
- Returns `{:ok, result}` on success or `{:error, reason}` on failure.
254
-
255
- ## Examples
256
-
257
- iex> YourProject.MyModule.process("test")
258
- {:ok, "TEST"}
259
-
260
- iex> YourProject.MyModule.process("")
261
- {:error, :invalid_input}
262
- """
263
- @spec process(String.t()) :: {:ok, String.t()} | {:error, atom()}
264
- def process(input) when is_binary(input) and input != "" do
265
- {:ok, String.upcase(input)}
266
- end
267
-
268
- def process(_), do: {:error, :invalid_input}
269
- end
270
- ```
271
-
272
- ## Project Structure
273
-
274
- ```
275
- project/
276
- ├── mix.exs # Project configuration
277
- ├── .formatter.exs # Formatter configuration
278
- ├── .credo.exs # Credo configuration
279
- ├── README.md # Project overview (allowed in root)
280
- ├── CHANGELOG.md # Version history (allowed in root)
281
- ├── LICENSE # Project license (allowed in root)
282
- ├── lib/
283
- │ ├── your_project.ex # Main module
284
- │ └── your_project/
285
- │ ├── application.ex # OTP application
286
- │ └── ...
287
- ├── test/
288
- │ ├── test_helper.exs # Test configuration
289
- │ └── your_project/
290
- │ └── ...
291
- ├── config/
292
- │ ├── config.exs # General config
293
- │ ├── dev.exs # Development config
294
- │ ├── test.exs # Test config
295
- │ └── prod.exs # Production config
296
- ├── priv/ # Private assets
297
- └── docs/ # Project documentation
298
- ```
299
-
300
- ## Error Handling
301
-
302
- - Use tagged tuples: `{:ok, value}` and `{:error, reason}`
303
- - Use `with` for multiple operations
304
- - Create custom error modules when needed
305
-
306
- Example:
307
- ```elixir
308
- defmodule YourProject.Errors do
309
- defmodule ValidationError do
310
- defexception [:message, :field]
311
- end
312
- end
313
-
314
- defmodule YourProject.MyModule do
315
- alias YourProject.Errors.ValidationError
316
-
317
- def validate(data) do
318
- with {:ok, cleaned} <- clean_data(data),
319
- {:ok, validated} <- check_format(cleaned) do
320
- {:ok, validated}
321
- else
322
- {:error, :empty} ->
323
- raise ValidationError, message: "Data cannot be empty", field: :data
324
-
325
- {:error, reason} ->
326
- {:error, reason}
327
- end
328
- end
329
- end
330
- ```
331
-
332
- ## OTP Best Practices
333
-
334
- - Use Supervisors for fault tolerance
335
- - Implement GenServers for stateful processes
336
- - Use Task for concurrent operations
337
-
338
- Example Supervisor:
339
- ```elixir
340
- defmodule YourProject.Application do
341
- use Application
342
-
343
- @impl true
344
- def start(_type, _args) do
345
- children = [
346
- {YourProject.MyWorker, []},
347
- {Task.Supervisor, name: YourProject.TaskSupervisor}
348
- ]
349
-
350
- opts = [strategy: :one_for_one, name: YourProject.Supervisor]
351
- Supervisor.start_link(children, opts)
352
- end
353
- end
354
- ```
355
-
356
- ## CI/CD Requirements
357
-
358
- Must include GitHub Actions workflows for:
359
-
360
- 1. **Testing** (`elixir-test.yml`):
361
- - Test on ubuntu-latest
362
- - Test on Elixir 1.16, 1.17
363
- - Test on OTP 26, 27
364
- - Upload coverage reports
365
-
366
- 2. **Linting** (`elixir-lint.yml`):
367
- - Format check: `mix format --check-formatted`
368
- - Credo: `mix credo --strict`
369
- - Dialyzer: `mix dialyzer`
370
-
371
- ## Package Publication
372
-
373
- ### Publishing to Hex.pm
374
-
375
- **Prerequisites:**
376
- 1. Create account at https://hex.pm
377
- 2. Generate API key: `mix hex.user auth`
378
- 3. Add `HEX_API_KEY` to GitHub repository secrets
379
-
380
- **mix.exs Configuration:**
381
-
382
- ```elixir
383
- def project do
384
- [
385
- app: :your_package,
386
- version: "1.0.0",
387
- elixir: "~> 1.16",
388
- description: "A short description of your package",
389
- package: package(),
390
- docs: docs()
391
- ]
392
- end
393
-
394
- defp package do
395
- [
396
- name: :your_package,
397
- files: ~w(lib .formatter.exs mix.exs README.md LICENSE CHANGELOG.md),
398
- licenses: ["MIT"],
399
- links: %{
400
- "GitHub" => "https://github.com/your-org/your-package",
401
- "Changelog" => "https://github.com/your-org/your-package/blob/main/CHANGELOG.md"
402
- },
403
- maintainers: ["Your Name"]
404
- ]
405
- end
406
-
407
- defp docs do
408
- [
409
- main: "readme",
410
- extras: ["README.md", "CHANGELOG.md"],
411
- source_url: "https://github.com/your-org/your-package"
412
- ]
413
- end
414
- ```
415
-
416
- **Publishing Workflow:**
417
-
418
- 1. Update version in mix.exs
419
- 2. Update CHANGELOG.md
420
- 3. Run quality checks:
421
- ```bash
422
- mix format
423
- mix credo --strict
424
- mix dialyzer
425
- mix test
426
- mix coveralls
427
- ```
428
-
429
- 4. Build docs: `mix docs`
430
- 5. Build package: `mix hex.build`
431
- 6. Create git tag: `git tag v1.0.0 && git push --tags`
432
- 7. GitHub Actions automatically publishes to Hex
433
- 8. Or manual publish: `mix hex.publish`
434
-
435
- **Publishing Checklist:**
436
-
437
- - ✅ All tests passing (`mix test`)
438
- - ✅ Coverage meets threshold (`mix coveralls`)
439
- - ✅ Credo passes strict mode (`mix credo --strict`)
440
- - ✅ Dialyzer passes (`mix dialyzer`)
441
- - ✅ Code formatted (`mix format --check-formatted`)
442
- - ✅ Version updated in mix.exs
443
- - ✅ CHANGELOG.md updated
444
- - ✅ README.md up to date
445
- - ✅ LICENSE file present
446
- - ✅ Documentation builds (`mix docs`)
447
- - ✅ Package metadata complete in mix.exs
448
- - ✅ Verify with `mix hex.build`
449
-
450
- **Semantic Versioning:**
451
-
452
- Follow [SemVer](https://semver.org/):
453
- - **MAJOR**: Breaking API changes
454
- - **MINOR**: New features (backwards compatible)
455
- - **PATCH**: Bug fixes (backwards compatible)
456
-
457
- **Documentation:**
458
-
459
- HexDocs automatically generates documentation from your code:
460
- - Published at: `https://hexdocs.pm/your_package`
461
- - Updated automatically when publishing to Hex
462
-
463
- <!-- ELIXIR:END -->
464
-
1
+ ---
2
+ name: "Elixir"
3
+ description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
+ version: "1.0.0"
5
+ category: "languages"
6
+ author: "Rulebook"
7
+ tags: ["languages", "language"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- ELIXIR:START -->
12
+ # Elixir Project Rules
13
+
14
+ ## Agent Automation Commands
15
+
16
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
+
18
+ ```bash
19
+ # Complete quality check sequence:
20
+ mix format --check-formatted # Format check
21
+ mix credo --strict # Linting
22
+ mix dialyzer # Type checking
23
+ mix test # All tests (100% pass)
24
+ mix test --cover # Coverage (95%+ required)
25
+ mix compile --warnings-as-errors # Build
26
+
27
+ # Security audit:
28
+ mix hex.audit # Vulnerability scan
29
+ mix hex.outdated # Check outdated deps
30
+ ```
31
+
32
+ ## Elixir Configuration
33
+
34
+ **CRITICAL**: Use Elixir 1.16+ with OTP 26+.
35
+
36
+ - **Version**: Elixir 1.16+
37
+ - **OTP**: 26+
38
+ - **Formatter**: Built-in `mix format`
39
+ - **Linter**: Credo
40
+ - **Type Checker**: Dialyzer
41
+
42
+ ### mix.exs Requirements
43
+
44
+ ```elixir
45
+ defmodule YourProject.MixProject do
46
+ use Mix.Project
47
+
48
+ def project do
49
+ [
50
+ app: :your_project,
51
+ version: "1.0.0",
52
+ elixir: "~> 1.16",
53
+ start_permanent: Mix.env() == :prod,
54
+ deps: deps(),
55
+
56
+ # Documentation
57
+ name: "Your Project",
58
+ source_url: "https://github.com/your-org/your-project",
59
+ docs: [
60
+ main: "readme",
61
+ extras: ["README.md", "CHANGELOG.md"]
62
+ ],
63
+
64
+ # Testing
65
+ test_coverage: [tool: ExCoveralls],
66
+ preferred_cli_env: [
67
+ coveralls: :test,
68
+ "coveralls.detail": :test,
69
+ "coveralls.post": :test,
70
+ "coveralls.html": :test
71
+ ],
72
+
73
+ # Dialyzer
74
+ dialyzer: [
75
+ plt_add_apps: [:mix, :ex_unit],
76
+ plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
77
+ flags: [:error_handling, :underspecs]
78
+ ]
79
+ ]
80
+ end
81
+
82
+ def application do
83
+ [
84
+ extra_applications: [:logger],
85
+ mod: {YourProject.Application, []}
86
+ ]
87
+ end
88
+
89
+ defp deps do
90
+ [
91
+ # Development & Testing
92
+ {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
93
+ {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
94
+ {:excoveralls, "~> 0.18", only: :test},
95
+ {:ex_doc, "~> 0.31", only: :dev, runtime: false}
96
+ ]
97
+ end
98
+ end
99
+ ```
100
+
101
+ ## Code Quality Standards
102
+
103
+ ### Mandatory Quality Checks
104
+
105
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
106
+
107
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
108
+
109
+ ```bash
110
+ # Pre-Commit Checklist (MUST match .github/workflows/*.yml)
111
+
112
+ # 1. Format check (matches workflow - use --check-formatted!)
113
+ mix format --check-formatted
114
+
115
+ # 2. Lint (MUST pass with no warnings - matches workflow)
116
+ mix credo --strict
117
+
118
+ # 3. Type check with Dialyzer (matches workflow)
119
+ mix dialyzer
120
+
121
+ # 4. Run all tests (MUST pass 100% - matches workflow)
122
+ mix test --cover
123
+
124
+ # 5. Check coverage (MUST meet threshold)
125
+ mix test --cover --export-coverage default
126
+ mix test.coverage
127
+
128
+ # If ANY fails: ❌ DO NOT COMMIT - Fix first!
129
+ ```
130
+
131
+ **If ANY of these fail, you MUST fix the issues before committing.**
132
+
133
+ **Why This Matters:**
134
+ - CI/CD failures happen when local commands differ from workflows
135
+ - Example: Using `mix format` locally but `mix format --check-formatted` in CI = failure
136
+ - Example: Missing `--cover` flag = CI coverage failures
137
+
138
+ ### Formatting
139
+
140
+ - Use built-in `mix format`
141
+ - Configuration in `.formatter.exs`
142
+ - Format before committing: `mix format`
143
+
144
+ Example `.formatter.exs`:
145
+ ```elixir
146
+ [
147
+ inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
148
+ line_length: 100
149
+ ]
150
+ ```
151
+
152
+ ### Linting
153
+
154
+ - Use Credo for code analysis
155
+ - Configuration in `.credo.exs`
156
+ - Must pass strict mode: `mix credo --strict`
157
+
158
+ Example `.credo.exs`:
159
+ ```elixir
160
+ %{
161
+ configs: [
162
+ %{
163
+ name: "default",
164
+ files: %{
165
+ included: ["lib/", "test/"],
166
+ excluded: [~r"/_build/", ~r"/deps/"]
167
+ },
168
+ strict: true,
169
+ color: true,
170
+ checks: %{
171
+ enabled: [
172
+ {Credo.Check.Readability.ModuleDoc, []},
173
+ {Credo.Check.Design.AliasUsage, priority: :low}
174
+ ]
175
+ }
176
+ }
177
+ ]
178
+ }
179
+ ```
180
+
181
+ ### Testing
182
+
183
+ - **Framework**: ExUnit (built-in)
184
+ - **Location**: `test/` directory
185
+ - **Coverage**: ExCoveralls
186
+ - **Coverage Threshold**: 95%+
187
+
188
+ Example test structure:
189
+ ```elixir
190
+ defmodule YourProject.MyModuleTest do
191
+ use ExUnit.Case, async: true
192
+
193
+ doctest YourProject.MyModule
194
+
195
+ describe "function_name/1" do
196
+ test "handles valid input" do
197
+ assert YourProject.MyModule.function_name("input") == {:ok, "result"}
198
+ end
199
+
200
+ test "returns error for invalid input" do
201
+ assert YourProject.MyModule.function_name("") == {:error, :invalid_input}
202
+ end
203
+ end
204
+ end
205
+ ```
206
+
207
+ ### Type Specifications
208
+
209
+ - Use `@spec` for all public functions
210
+ - Use `@type` for custom types
211
+ - Run Dialyzer regularly
212
+
213
+ Example:
214
+ ```elixir
215
+ defmodule YourProject.MyModule do
216
+ @moduledoc """
217
+ Documentation for MyModule.
218
+ """
219
+
220
+ @type result :: {:ok, String.t()} | {:error, atom()}
221
+
222
+ @spec process(String.t()) :: result()
223
+ def process(input) when is_binary(input) and input != "" do
224
+ {:ok, String.upcase(input)}
225
+ end
226
+
227
+ def process(_), do: {:error, :invalid_input}
228
+ end
229
+ ```
230
+
231
+ ## Documentation
232
+
233
+ - Use `@moduledoc` for module documentation
234
+ - Use `@doc` for function documentation
235
+ - Include examples with doctests
236
+ - Generate docs with `mix docs`
237
+
238
+ Example:
239
+ ```elixir
240
+ defmodule YourProject.MyModule do
241
+ @moduledoc """
242
+ Provides functionality for processing data.
243
+
244
+ ## Examples
245
+
246
+ iex> YourProject.MyModule.process("hello")
247
+ {:ok, "HELLO"}
248
+ """
249
+
250
+ @doc """
251
+ Processes the input string.
252
+
253
+ Returns `{:ok, result}` on success or `{:error, reason}` on failure.
254
+
255
+ ## Examples
256
+
257
+ iex> YourProject.MyModule.process("test")
258
+ {:ok, "TEST"}
259
+
260
+ iex> YourProject.MyModule.process("")
261
+ {:error, :invalid_input}
262
+ """
263
+ @spec process(String.t()) :: {:ok, String.t()} | {:error, atom()}
264
+ def process(input) when is_binary(input) and input != "" do
265
+ {:ok, String.upcase(input)}
266
+ end
267
+
268
+ def process(_), do: {:error, :invalid_input}
269
+ end
270
+ ```
271
+
272
+ ## Project Structure
273
+
274
+ ```
275
+ project/
276
+ ├── mix.exs # Project configuration
277
+ ├── .formatter.exs # Formatter configuration
278
+ ├── .credo.exs # Credo configuration
279
+ ├── README.md # Project overview (allowed in root)
280
+ ├── CHANGELOG.md # Version history (allowed in root)
281
+ ├── LICENSE # Project license (allowed in root)
282
+ ├── lib/
283
+ │ ├── your_project.ex # Main module
284
+ │ └── your_project/
285
+ │ ├── application.ex # OTP application
286
+ │ └── ...
287
+ ├── test/
288
+ │ ├── test_helper.exs # Test configuration
289
+ │ └── your_project/
290
+ │ └── ...
291
+ ├── config/
292
+ │ ├── config.exs # General config
293
+ │ ├── dev.exs # Development config
294
+ │ ├── test.exs # Test config
295
+ │ └── prod.exs # Production config
296
+ ├── priv/ # Private assets
297
+ └── docs/ # Project documentation
298
+ ```
299
+
300
+ ## Error Handling
301
+
302
+ - Use tagged tuples: `{:ok, value}` and `{:error, reason}`
303
+ - Use `with` for multiple operations
304
+ - Create custom error modules when needed
305
+
306
+ Example:
307
+ ```elixir
308
+ defmodule YourProject.Errors do
309
+ defmodule ValidationError do
310
+ defexception [:message, :field]
311
+ end
312
+ end
313
+
314
+ defmodule YourProject.MyModule do
315
+ alias YourProject.Errors.ValidationError
316
+
317
+ def validate(data) do
318
+ with {:ok, cleaned} <- clean_data(data),
319
+ {:ok, validated} <- check_format(cleaned) do
320
+ {:ok, validated}
321
+ else
322
+ {:error, :empty} ->
323
+ raise ValidationError, message: "Data cannot be empty", field: :data
324
+
325
+ {:error, reason} ->
326
+ {:error, reason}
327
+ end
328
+ end
329
+ end
330
+ ```
331
+
332
+ ## OTP Best Practices
333
+
334
+ - Use Supervisors for fault tolerance
335
+ - Implement GenServers for stateful processes
336
+ - Use Task for concurrent operations
337
+
338
+ Example Supervisor:
339
+ ```elixir
340
+ defmodule YourProject.Application do
341
+ use Application
342
+
343
+ @impl true
344
+ def start(_type, _args) do
345
+ children = [
346
+ {YourProject.MyWorker, []},
347
+ {Task.Supervisor, name: YourProject.TaskSupervisor}
348
+ ]
349
+
350
+ opts = [strategy: :one_for_one, name: YourProject.Supervisor]
351
+ Supervisor.start_link(children, opts)
352
+ end
353
+ end
354
+ ```
355
+
356
+ ## CI/CD Requirements
357
+
358
+ Must include GitHub Actions workflows for:
359
+
360
+ 1. **Testing** (`elixir-test.yml`):
361
+ - Test on ubuntu-latest
362
+ - Test on Elixir 1.16, 1.17
363
+ - Test on OTP 26, 27
364
+ - Upload coverage reports
365
+
366
+ 2. **Linting** (`elixir-lint.yml`):
367
+ - Format check: `mix format --check-formatted`
368
+ - Credo: `mix credo --strict`
369
+ - Dialyzer: `mix dialyzer`
370
+
371
+ ## Package Publication
372
+
373
+ ### Publishing to Hex.pm
374
+
375
+ **Prerequisites:**
376
+ 1. Create account at https://hex.pm
377
+ 2. Generate API key: `mix hex.user auth`
378
+ 3. Add `HEX_API_KEY` to GitHub repository secrets
379
+
380
+ **mix.exs Configuration:**
381
+
382
+ ```elixir
383
+ def project do
384
+ [
385
+ app: :your_package,
386
+ version: "1.0.0",
387
+ elixir: "~> 1.16",
388
+ description: "A short description of your package",
389
+ package: package(),
390
+ docs: docs()
391
+ ]
392
+ end
393
+
394
+ defp package do
395
+ [
396
+ name: :your_package,
397
+ files: ~w(lib .formatter.exs mix.exs README.md LICENSE CHANGELOG.md),
398
+ licenses: ["MIT"],
399
+ links: %{
400
+ "GitHub" => "https://github.com/your-org/your-package",
401
+ "Changelog" => "https://github.com/your-org/your-package/blob/main/CHANGELOG.md"
402
+ },
403
+ maintainers: ["Your Name"]
404
+ ]
405
+ end
406
+
407
+ defp docs do
408
+ [
409
+ main: "readme",
410
+ extras: ["README.md", "CHANGELOG.md"],
411
+ source_url: "https://github.com/your-org/your-package"
412
+ ]
413
+ end
414
+ ```
415
+
416
+ **Publishing Workflow:**
417
+
418
+ 1. Update version in mix.exs
419
+ 2. Update CHANGELOG.md
420
+ 3. Run quality checks:
421
+ ```bash
422
+ mix format
423
+ mix credo --strict
424
+ mix dialyzer
425
+ mix test
426
+ mix coveralls
427
+ ```
428
+
429
+ 4. Build docs: `mix docs`
430
+ 5. Build package: `mix hex.build`
431
+ 6. Create git tag: `git tag v1.0.0 && git push --tags`
432
+ 7. GitHub Actions automatically publishes to Hex
433
+ 8. Or manual publish: `mix hex.publish`
434
+
435
+ **Publishing Checklist:**
436
+
437
+ - ✅ All tests passing (`mix test`)
438
+ - ✅ Coverage meets threshold (`mix coveralls`)
439
+ - ✅ Credo passes strict mode (`mix credo --strict`)
440
+ - ✅ Dialyzer passes (`mix dialyzer`)
441
+ - ✅ Code formatted (`mix format --check-formatted`)
442
+ - ✅ Version updated in mix.exs
443
+ - ✅ CHANGELOG.md updated
444
+ - ✅ README.md up to date
445
+ - ✅ LICENSE file present
446
+ - ✅ Documentation builds (`mix docs`)
447
+ - ✅ Package metadata complete in mix.exs
448
+ - ✅ Verify with `mix hex.build`
449
+
450
+ **Semantic Versioning:**
451
+
452
+ Follow [SemVer](https://semver.org/):
453
+ - **MAJOR**: Breaking API changes
454
+ - **MINOR**: New features (backwards compatible)
455
+ - **PATCH**: Bug fixes (backwards compatible)
456
+
457
+ **Documentation:**
458
+
459
+ HexDocs automatically generates documentation from your code:
460
+ - Published at: `https://hexdocs.pm/your_package`
461
+ - Updated automatically when publishing to Hex
462
+
463
+ <!-- ELIXIR:END -->
464
+