@hivehub/rulebook 4.1.0 → 4.2.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 (335) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +137 -1
  19. package/dist/cli/commands.d.ts +18 -6
  20. package/dist/cli/commands.d.ts.map +1 -1
  21. package/dist/cli/commands.js +727 -406
  22. package/dist/cli/commands.js.map +1 -1
  23. package/dist/core/claude-mcp.d.ts +4 -2
  24. package/dist/core/claude-mcp.d.ts.map +1 -1
  25. package/dist/core/claude-mcp.js +14 -9
  26. package/dist/core/claude-mcp.js.map +1 -1
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +13 -0
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  31. package/dist/core/indexer/background-indexer.js +26 -5
  32. package/dist/core/indexer/background-indexer.js.map +1 -1
  33. package/dist/core/indexer/file-parser.d.ts.map +1 -1
  34. package/dist/core/indexer/file-parser.js +1 -1
  35. package/dist/core/indexer/file-parser.js.map +1 -1
  36. package/dist/core/indexer/indexer-types.d.ts.map +1 -1
  37. package/dist/core/workspace/legacy-migrator.d.ts +29 -0
  38. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -0
  39. package/dist/core/workspace/legacy-migrator.js +142 -0
  40. package/dist/core/workspace/legacy-migrator.js.map +1 -0
  41. package/dist/core/workspace/project-worker.d.ts +49 -0
  42. package/dist/core/workspace/project-worker.d.ts.map +1 -0
  43. package/dist/core/workspace/project-worker.js +108 -0
  44. package/dist/core/workspace/project-worker.js.map +1 -0
  45. package/dist/core/workspace/workspace-manager.d.ts +90 -0
  46. package/dist/core/workspace/workspace-manager.d.ts.map +1 -0
  47. package/dist/core/workspace/workspace-manager.js +347 -0
  48. package/dist/core/workspace/workspace-manager.js.map +1 -0
  49. package/dist/core/workspace/workspace-types.d.ts +37 -0
  50. package/dist/core/workspace/workspace-types.d.ts.map +1 -0
  51. package/dist/core/workspace/workspace-types.js +8 -0
  52. package/dist/core/workspace/workspace-types.js.map +1 -0
  53. package/dist/index.js +43 -7
  54. package/dist/index.js.map +1 -1
  55. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  56. package/dist/mcp/rulebook-server.js +367 -100
  57. package/dist/mcp/rulebook-server.js.map +1 -1
  58. package/dist/memory/memory-manager.js +2 -2
  59. package/dist/memory/memory-manager.js.map +1 -1
  60. package/dist/memory/memory-search.js.map +1 -1
  61. package/dist/memory/memory-store.d.ts.map +1 -1
  62. package/dist/memory/memory-store.js +1 -1
  63. package/dist/memory/memory-store.js.map +1 -1
  64. package/dist/types.d.ts +1 -0
  65. package/dist/types.d.ts.map +1 -1
  66. package/package.json +22 -21
  67. package/templates/agents/implementer.md +35 -35
  68. package/templates/agents/researcher.md +34 -34
  69. package/templates/agents/team-lead.md +34 -34
  70. package/templates/agents/tester.md +42 -42
  71. package/templates/ci/rulebook-review.yml +26 -26
  72. package/templates/cli/AIDER.md +49 -49
  73. package/templates/cli/AMAZON_Q.md +25 -25
  74. package/templates/cli/AUGGIE.md +32 -32
  75. package/templates/cli/CLAUDE.md +117 -117
  76. package/templates/cli/CLINE.md +99 -99
  77. package/templates/cli/CODEBUDDY.md +20 -20
  78. package/templates/cli/CODEIUM.md +20 -20
  79. package/templates/cli/CODEX.md +21 -21
  80. package/templates/cli/CONTINUE.md +34 -34
  81. package/templates/cli/CURSOR_CLI.md +62 -62
  82. package/templates/cli/FACTORY.md +18 -18
  83. package/templates/cli/GEMINI.md +35 -35
  84. package/templates/cli/KILOCODE.md +18 -18
  85. package/templates/cli/OPENCODE.md +18 -18
  86. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  87. package/templates/commands/rulebook-memory-save.md +48 -48
  88. package/templates/commands/rulebook-memory-search.md +47 -47
  89. package/templates/commands/rulebook-task-apply.md +67 -67
  90. package/templates/commands/rulebook-task-archive.md +94 -94
  91. package/templates/commands/rulebook-task-create.md +93 -93
  92. package/templates/commands/rulebook-task-list.md +42 -42
  93. package/templates/commands/rulebook-task-show.md +52 -52
  94. package/templates/commands/rulebook-task-validate.md +53 -53
  95. package/templates/core/AGENTS_LEAN.md +25 -25
  96. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  97. package/templates/core/AGENT_AUTOMATION.md +288 -288
  98. package/templates/core/DAG.md +304 -304
  99. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  100. package/templates/core/MULTI_AGENT.md +74 -74
  101. package/templates/core/PLANS.md +28 -28
  102. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  103. package/templates/core/RALPH.md +471 -471
  104. package/templates/core/RULEBOOK.md +1935 -1935
  105. package/templates/core/WORKSPACE.md +69 -0
  106. package/templates/frameworks/ANGULAR.md +36 -36
  107. package/templates/frameworks/DJANGO.md +83 -83
  108. package/templates/frameworks/ELECTRON.md +147 -147
  109. package/templates/frameworks/FLASK.md +38 -38
  110. package/templates/frameworks/FLUTTER.md +55 -55
  111. package/templates/frameworks/JQUERY.md +32 -32
  112. package/templates/frameworks/LARAVEL.md +38 -38
  113. package/templates/frameworks/NESTJS.md +43 -43
  114. package/templates/frameworks/NEXTJS.md +127 -127
  115. package/templates/frameworks/NUXT.md +40 -40
  116. package/templates/frameworks/RAILS.md +66 -66
  117. package/templates/frameworks/REACT.md +38 -38
  118. package/templates/frameworks/REACT_NATIVE.md +47 -47
  119. package/templates/frameworks/SPRING.md +39 -39
  120. package/templates/frameworks/SYMFONY.md +36 -36
  121. package/templates/frameworks/VUE.md +36 -36
  122. package/templates/frameworks/ZEND.md +35 -35
  123. package/templates/git/CI_CD_PATTERNS.md +661 -661
  124. package/templates/git/GITHUB_ACTIONS.md +728 -728
  125. package/templates/git/GITLAB_CI.md +730 -730
  126. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  127. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  128. package/templates/hooks/COMMIT_MSG.md +530 -530
  129. package/templates/hooks/POST_CHECKOUT.md +546 -546
  130. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  131. package/templates/hooks/PRE_COMMIT.md +414 -414
  132. package/templates/hooks/PRE_PUSH.md +601 -601
  133. package/templates/ides/CONTINUE_RULES.md +16 -16
  134. package/templates/ides/COPILOT.md +37 -37
  135. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  136. package/templates/ides/CURSOR.md +43 -43
  137. package/templates/ides/GEMINI_RULES.md +17 -17
  138. package/templates/ides/JETBRAINS_AI.md +35 -35
  139. package/templates/ides/REPLIT.md +36 -36
  140. package/templates/ides/TABNINE.md +29 -29
  141. package/templates/ides/VSCODE.md +40 -40
  142. package/templates/ides/WINDSURF.md +36 -36
  143. package/templates/ides/WINDSURF_RULES.md +14 -14
  144. package/templates/ides/ZED.md +32 -32
  145. package/templates/ides/cursor-mdc/go.mdc +24 -24
  146. package/templates/ides/cursor-mdc/python.mdc +24 -24
  147. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  148. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  149. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  150. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  151. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  152. package/templates/languages/C.md +333 -333
  153. package/templates/languages/CPP.md +743 -743
  154. package/templates/languages/CSHARP.md +417 -417
  155. package/templates/languages/ELIXIR.md +454 -454
  156. package/templates/languages/ERLANG.md +361 -361
  157. package/templates/languages/GO.md +645 -645
  158. package/templates/languages/HASKELL.md +177 -177
  159. package/templates/languages/JAVA.md +607 -607
  160. package/templates/languages/JAVASCRIPT.md +631 -631
  161. package/templates/languages/JULIA.md +97 -97
  162. package/templates/languages/KOTLIN.md +511 -511
  163. package/templates/languages/LISP.md +100 -100
  164. package/templates/languages/LUA.md +74 -74
  165. package/templates/languages/OBJECTIVEC.md +90 -90
  166. package/templates/languages/PHP.md +416 -416
  167. package/templates/languages/PYTHON.md +682 -682
  168. package/templates/languages/RUBY.md +421 -421
  169. package/templates/languages/RUST.md +477 -477
  170. package/templates/languages/SAS.md +73 -73
  171. package/templates/languages/SCALA.md +348 -348
  172. package/templates/languages/SOLIDITY.md +580 -580
  173. package/templates/languages/SQL.md +137 -137
  174. package/templates/languages/SWIFT.md +466 -466
  175. package/templates/languages/TYPESCRIPT.md +591 -591
  176. package/templates/languages/ZIG.md +265 -265
  177. package/templates/modules/ATLASSIAN.md +255 -255
  178. package/templates/modules/CONTEXT7.md +54 -54
  179. package/templates/modules/FIGMA.md +267 -267
  180. package/templates/modules/GITHUB_MCP.md +64 -64
  181. package/templates/modules/GRAFANA.md +328 -328
  182. package/templates/modules/MEMORY.md +126 -126
  183. package/templates/modules/NOTION.md +247 -247
  184. package/templates/modules/PLAYWRIGHT.md +90 -90
  185. package/templates/modules/RULEBOOK_MCP.md +156 -156
  186. package/templates/modules/SERENA.md +337 -337
  187. package/templates/modules/SUPABASE.md +223 -223
  188. package/templates/modules/SYNAP.md +69 -69
  189. package/templates/modules/VECTORIZER.md +63 -63
  190. package/templates/modules/sequential-thinking.md +42 -42
  191. package/templates/ralph/ralph-history.bat +4 -4
  192. package/templates/ralph/ralph-history.sh +5 -5
  193. package/templates/ralph/ralph-init.bat +5 -5
  194. package/templates/ralph/ralph-init.sh +5 -5
  195. package/templates/ralph/ralph-pause.bat +5 -5
  196. package/templates/ralph/ralph-pause.sh +5 -5
  197. package/templates/ralph/ralph-run.bat +5 -5
  198. package/templates/ralph/ralph-run.sh +5 -5
  199. package/templates/ralph/ralph-status.bat +4 -4
  200. package/templates/ralph/ralph-status.sh +5 -5
  201. package/templates/services/AZURE_BLOB.md +184 -184
  202. package/templates/services/CASSANDRA.md +239 -239
  203. package/templates/services/DATADOG.md +26 -26
  204. package/templates/services/DOCKER.md +124 -124
  205. package/templates/services/DOCKER_COMPOSE.md +168 -168
  206. package/templates/services/DYNAMODB.md +308 -308
  207. package/templates/services/ELASTICSEARCH.md +347 -347
  208. package/templates/services/GCS.md +178 -178
  209. package/templates/services/HELM.md +194 -194
  210. package/templates/services/INFLUXDB.md +265 -265
  211. package/templates/services/KAFKA.md +341 -341
  212. package/templates/services/KUBERNETES.md +208 -208
  213. package/templates/services/MARIADB.md +183 -183
  214. package/templates/services/MEMCACHED.md +242 -242
  215. package/templates/services/MINIO.md +201 -201
  216. package/templates/services/MONGODB.md +268 -268
  217. package/templates/services/MYSQL.md +358 -358
  218. package/templates/services/NEO4J.md +247 -247
  219. package/templates/services/OPENTELEMETRY.md +25 -25
  220. package/templates/services/ORACLE.md +290 -290
  221. package/templates/services/PINO.md +24 -24
  222. package/templates/services/POSTGRESQL.md +326 -326
  223. package/templates/services/PROMETHEUS.md +33 -33
  224. package/templates/services/RABBITMQ.md +286 -286
  225. package/templates/services/REDIS.md +292 -292
  226. package/templates/services/S3.md +298 -298
  227. package/templates/services/SENTRY.md +23 -23
  228. package/templates/services/SQLITE.md +294 -294
  229. package/templates/services/SQLSERVER.md +294 -294
  230. package/templates/services/WINSTON.md +30 -30
  231. package/templates/skills/cli/aider/SKILL.md +59 -59
  232. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  233. package/templates/skills/cli/auggie/SKILL.md +42 -42
  234. package/templates/skills/cli/claude/SKILL.md +42 -42
  235. package/templates/skills/cli/cline/SKILL.md +42 -42
  236. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  237. package/templates/skills/cli/codeium/SKILL.md +30 -30
  238. package/templates/skills/cli/codex/SKILL.md +31 -31
  239. package/templates/skills/cli/continue/SKILL.md +44 -44
  240. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  241. package/templates/skills/cli/factory/SKILL.md +28 -28
  242. package/templates/skills/cli/gemini/SKILL.md +45 -45
  243. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  244. package/templates/skills/cli/opencode/SKILL.md +28 -28
  245. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  246. package/templates/skills/core/dag/SKILL.md +314 -314
  247. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  248. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  249. package/templates/skills/core/rulebook/SKILL.md +176 -176
  250. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  251. package/templates/skills/frameworks/django/SKILL.md +93 -93
  252. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  253. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  254. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  255. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  256. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  257. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  258. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  259. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  260. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  261. package/templates/skills/frameworks/react/SKILL.md +48 -48
  262. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  263. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  264. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  265. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  266. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  267. package/templates/skills/ides/copilot/SKILL.md +47 -47
  268. package/templates/skills/ides/cursor/SKILL.md +53 -53
  269. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  270. package/templates/skills/ides/replit/SKILL.md +46 -46
  271. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  272. package/templates/skills/ides/vscode/SKILL.md +50 -50
  273. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  274. package/templates/skills/ides/zed/SKILL.md +42 -42
  275. package/templates/skills/languages/c/SKILL.md +343 -343
  276. package/templates/skills/languages/cpp/SKILL.md +753 -753
  277. package/templates/skills/languages/csharp/SKILL.md +427 -427
  278. package/templates/skills/languages/elixir/SKILL.md +464 -464
  279. package/templates/skills/languages/erlang/SKILL.md +371 -371
  280. package/templates/skills/languages/go/SKILL.md +655 -655
  281. package/templates/skills/languages/haskell/SKILL.md +187 -187
  282. package/templates/skills/languages/java/SKILL.md +617 -617
  283. package/templates/skills/languages/javascript/SKILL.md +641 -641
  284. package/templates/skills/languages/julia/SKILL.md +107 -107
  285. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  286. package/templates/skills/languages/lisp/SKILL.md +110 -110
  287. package/templates/skills/languages/lua/SKILL.md +84 -84
  288. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  289. package/templates/skills/languages/php/SKILL.md +426 -426
  290. package/templates/skills/languages/python/SKILL.md +692 -692
  291. package/templates/skills/languages/ruby/SKILL.md +431 -431
  292. package/templates/skills/languages/rust/SKILL.md +487 -487
  293. package/templates/skills/languages/sas/SKILL.md +83 -83
  294. package/templates/skills/languages/scala/SKILL.md +358 -358
  295. package/templates/skills/languages/solidity/SKILL.md +590 -590
  296. package/templates/skills/languages/sql/SKILL.md +147 -147
  297. package/templates/skills/languages/swift/SKILL.md +476 -476
  298. package/templates/skills/languages/typescript/SKILL.md +302 -302
  299. package/templates/skills/languages/zig/SKILL.md +275 -275
  300. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  301. package/templates/skills/modules/context7/SKILL.md +64 -64
  302. package/templates/skills/modules/figma/SKILL.md +277 -277
  303. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  304. package/templates/skills/modules/grafana/SKILL.md +338 -338
  305. package/templates/skills/modules/memory/SKILL.md +73 -73
  306. package/templates/skills/modules/notion/SKILL.md +257 -257
  307. package/templates/skills/modules/playwright/SKILL.md +100 -100
  308. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  309. package/templates/skills/modules/serena/SKILL.md +347 -347
  310. package/templates/skills/modules/supabase/SKILL.md +233 -233
  311. package/templates/skills/modules/synap/SKILL.md +79 -79
  312. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  313. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  314. package/templates/skills/services/cassandra/SKILL.md +249 -249
  315. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  316. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  317. package/templates/skills/services/gcs/SKILL.md +188 -188
  318. package/templates/skills/services/influxdb/SKILL.md +275 -275
  319. package/templates/skills/services/kafka/SKILL.md +351 -351
  320. package/templates/skills/services/mariadb/SKILL.md +193 -193
  321. package/templates/skills/services/memcached/SKILL.md +252 -252
  322. package/templates/skills/services/minio/SKILL.md +211 -211
  323. package/templates/skills/services/mongodb/SKILL.md +278 -278
  324. package/templates/skills/services/mysql/SKILL.md +368 -368
  325. package/templates/skills/services/neo4j/SKILL.md +257 -257
  326. package/templates/skills/services/oracle/SKILL.md +300 -300
  327. package/templates/skills/services/postgresql/SKILL.md +336 -336
  328. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  329. package/templates/skills/services/redis/SKILL.md +302 -302
  330. package/templates/skills/services/s3/SKILL.md +308 -308
  331. package/templates/skills/services/sqlite/SKILL.md +304 -304
  332. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  333. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  334. package/templates/skills/workflows/ralph/install.sh +87 -87
  335. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -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
+