@hivehub/rulebook 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) 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 +34 -0
  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 +717 -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 +27 -0
  31. package/dist/core/indexer/background-indexer.d.ts.map +1 -0
  32. package/dist/core/indexer/background-indexer.js +156 -0
  33. package/dist/core/indexer/background-indexer.js.map +1 -0
  34. package/dist/core/indexer/file-parser.d.ts +28 -0
  35. package/dist/core/indexer/file-parser.d.ts.map +1 -0
  36. package/dist/core/indexer/file-parser.js +171 -0
  37. package/dist/core/indexer/file-parser.js.map +1 -0
  38. package/dist/core/indexer/indexer-types.d.ts +35 -0
  39. package/dist/core/indexer/indexer-types.d.ts.map +1 -0
  40. package/dist/core/indexer/indexer-types.js +8 -0
  41. package/dist/core/indexer/indexer-types.js.map +1 -0
  42. package/dist/core/workspace/legacy-migrator.d.ts +29 -0
  43. package/dist/core/workspace/legacy-migrator.d.ts.map +1 -0
  44. package/dist/core/workspace/legacy-migrator.js +142 -0
  45. package/dist/core/workspace/legacy-migrator.js.map +1 -0
  46. package/dist/core/workspace/project-worker.d.ts +49 -0
  47. package/dist/core/workspace/project-worker.d.ts.map +1 -0
  48. package/dist/core/workspace/project-worker.js +108 -0
  49. package/dist/core/workspace/project-worker.js.map +1 -0
  50. package/dist/core/workspace/workspace-manager.d.ts +90 -0
  51. package/dist/core/workspace/workspace-manager.d.ts.map +1 -0
  52. package/dist/core/workspace/workspace-manager.js +337 -0
  53. package/dist/core/workspace/workspace-manager.js.map +1 -0
  54. package/dist/core/workspace/workspace-types.d.ts +37 -0
  55. package/dist/core/workspace/workspace-types.d.ts.map +1 -0
  56. package/dist/core/workspace/workspace-types.js +8 -0
  57. package/dist/core/workspace/workspace-types.js.map +1 -0
  58. package/dist/index.js +43 -7
  59. package/dist/index.js.map +1 -1
  60. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  61. package/dist/mcp/rulebook-server.js +450 -81
  62. package/dist/mcp/rulebook-server.js.map +1 -1
  63. package/dist/memory/memory-manager.d.ts +4 -1
  64. package/dist/memory/memory-manager.d.ts.map +1 -1
  65. package/dist/memory/memory-manager.js +33 -4
  66. package/dist/memory/memory-manager.js.map +1 -1
  67. package/dist/memory/memory-search.d.ts +2 -2
  68. package/dist/memory/memory-search.d.ts.map +1 -1
  69. package/dist/memory/memory-search.js +19 -0
  70. package/dist/memory/memory-search.js.map +1 -1
  71. package/dist/memory/memory-store.d.ts +13 -0
  72. package/dist/memory/memory-store.d.ts.map +1 -1
  73. package/dist/memory/memory-store.js +88 -1
  74. package/dist/memory/memory-store.js.map +1 -1
  75. package/dist/memory/memory-types.d.ts +15 -0
  76. package/dist/memory/memory-types.d.ts.map +1 -1
  77. package/dist/types.d.ts +1 -0
  78. package/dist/types.d.ts.map +1 -1
  79. package/package.json +22 -21
  80. package/templates/agents/implementer.md +35 -35
  81. package/templates/agents/researcher.md +34 -34
  82. package/templates/agents/team-lead.md +34 -34
  83. package/templates/agents/tester.md +42 -42
  84. package/templates/ci/rulebook-review.yml +26 -26
  85. package/templates/cli/AIDER.md +49 -49
  86. package/templates/cli/AMAZON_Q.md +25 -25
  87. package/templates/cli/AUGGIE.md +32 -32
  88. package/templates/cli/CLAUDE.md +117 -117
  89. package/templates/cli/CLINE.md +99 -99
  90. package/templates/cli/CODEBUDDY.md +20 -20
  91. package/templates/cli/CODEIUM.md +20 -20
  92. package/templates/cli/CODEX.md +21 -21
  93. package/templates/cli/CONTINUE.md +34 -34
  94. package/templates/cli/CURSOR_CLI.md +62 -62
  95. package/templates/cli/FACTORY.md +18 -18
  96. package/templates/cli/GEMINI.md +35 -35
  97. package/templates/cli/KILOCODE.md +18 -18
  98. package/templates/cli/OPENCODE.md +18 -18
  99. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  100. package/templates/commands/rulebook-memory-save.md +48 -48
  101. package/templates/commands/rulebook-memory-search.md +47 -47
  102. package/templates/commands/rulebook-task-apply.md +67 -67
  103. package/templates/commands/rulebook-task-archive.md +94 -70
  104. package/templates/commands/rulebook-task-create.md +93 -93
  105. package/templates/commands/rulebook-task-list.md +42 -42
  106. package/templates/commands/rulebook-task-show.md +52 -52
  107. package/templates/commands/rulebook-task-validate.md +53 -53
  108. package/templates/core/AGENTS_LEAN.md +25 -25
  109. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  110. package/templates/core/AGENT_AUTOMATION.md +288 -288
  111. package/templates/core/DAG.md +304 -304
  112. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  113. package/templates/core/MULTI_AGENT.md +74 -74
  114. package/templates/core/PLANS.md +28 -28
  115. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  116. package/templates/core/RALPH.md +471 -471
  117. package/templates/core/RULEBOOK.md +1935 -1893
  118. package/templates/core/WORKSPACE.md +69 -0
  119. package/templates/frameworks/ANGULAR.md +36 -36
  120. package/templates/frameworks/DJANGO.md +83 -83
  121. package/templates/frameworks/ELECTRON.md +147 -147
  122. package/templates/frameworks/FLASK.md +38 -38
  123. package/templates/frameworks/FLUTTER.md +55 -55
  124. package/templates/frameworks/JQUERY.md +32 -32
  125. package/templates/frameworks/LARAVEL.md +38 -38
  126. package/templates/frameworks/NESTJS.md +43 -43
  127. package/templates/frameworks/NEXTJS.md +127 -127
  128. package/templates/frameworks/NUXT.md +40 -40
  129. package/templates/frameworks/RAILS.md +66 -66
  130. package/templates/frameworks/REACT.md +38 -38
  131. package/templates/frameworks/REACT_NATIVE.md +47 -47
  132. package/templates/frameworks/SPRING.md +39 -39
  133. package/templates/frameworks/SYMFONY.md +36 -36
  134. package/templates/frameworks/VUE.md +36 -36
  135. package/templates/frameworks/ZEND.md +35 -35
  136. package/templates/git/CI_CD_PATTERNS.md +661 -661
  137. package/templates/git/GITHUB_ACTIONS.md +728 -728
  138. package/templates/git/GITLAB_CI.md +730 -730
  139. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  140. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  141. package/templates/hooks/COMMIT_MSG.md +530 -530
  142. package/templates/hooks/POST_CHECKOUT.md +546 -546
  143. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  144. package/templates/hooks/PRE_COMMIT.md +414 -414
  145. package/templates/hooks/PRE_PUSH.md +601 -601
  146. package/templates/ides/CONTINUE_RULES.md +16 -16
  147. package/templates/ides/COPILOT.md +37 -37
  148. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  149. package/templates/ides/CURSOR.md +43 -43
  150. package/templates/ides/GEMINI_RULES.md +17 -17
  151. package/templates/ides/JETBRAINS_AI.md +35 -35
  152. package/templates/ides/REPLIT.md +36 -36
  153. package/templates/ides/TABNINE.md +29 -29
  154. package/templates/ides/VSCODE.md +40 -40
  155. package/templates/ides/WINDSURF.md +36 -36
  156. package/templates/ides/WINDSURF_RULES.md +14 -14
  157. package/templates/ides/ZED.md +32 -32
  158. package/templates/ides/cursor-mdc/go.mdc +24 -24
  159. package/templates/ides/cursor-mdc/python.mdc +24 -24
  160. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  161. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  162. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  163. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  164. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  165. package/templates/languages/C.md +333 -333
  166. package/templates/languages/CPP.md +743 -743
  167. package/templates/languages/CSHARP.md +417 -417
  168. package/templates/languages/ELIXIR.md +454 -454
  169. package/templates/languages/ERLANG.md +361 -361
  170. package/templates/languages/GO.md +645 -645
  171. package/templates/languages/HASKELL.md +177 -177
  172. package/templates/languages/JAVA.md +607 -607
  173. package/templates/languages/JAVASCRIPT.md +631 -631
  174. package/templates/languages/JULIA.md +97 -97
  175. package/templates/languages/KOTLIN.md +511 -511
  176. package/templates/languages/LISP.md +100 -100
  177. package/templates/languages/LUA.md +74 -74
  178. package/templates/languages/OBJECTIVEC.md +90 -90
  179. package/templates/languages/PHP.md +416 -416
  180. package/templates/languages/PYTHON.md +682 -682
  181. package/templates/languages/RUBY.md +421 -421
  182. package/templates/languages/RUST.md +477 -477
  183. package/templates/languages/SAS.md +73 -73
  184. package/templates/languages/SCALA.md +348 -348
  185. package/templates/languages/SOLIDITY.md +580 -580
  186. package/templates/languages/SQL.md +137 -137
  187. package/templates/languages/SWIFT.md +466 -466
  188. package/templates/languages/TYPESCRIPT.md +591 -591
  189. package/templates/languages/ZIG.md +265 -265
  190. package/templates/modules/ATLASSIAN.md +255 -255
  191. package/templates/modules/CONTEXT7.md +54 -54
  192. package/templates/modules/FIGMA.md +267 -267
  193. package/templates/modules/GITHUB_MCP.md +64 -64
  194. package/templates/modules/GRAFANA.md +328 -328
  195. package/templates/modules/MEMORY.md +126 -126
  196. package/templates/modules/NOTION.md +247 -247
  197. package/templates/modules/PLAYWRIGHT.md +90 -90
  198. package/templates/modules/RULEBOOK_MCP.md +156 -156
  199. package/templates/modules/SERENA.md +337 -337
  200. package/templates/modules/SUPABASE.md +223 -223
  201. package/templates/modules/SYNAP.md +69 -69
  202. package/templates/modules/VECTORIZER.md +63 -63
  203. package/templates/modules/sequential-thinking.md +42 -42
  204. package/templates/ralph/ralph-history.bat +4 -4
  205. package/templates/ralph/ralph-history.sh +5 -5
  206. package/templates/ralph/ralph-init.bat +5 -5
  207. package/templates/ralph/ralph-init.sh +5 -5
  208. package/templates/ralph/ralph-pause.bat +5 -5
  209. package/templates/ralph/ralph-pause.sh +5 -5
  210. package/templates/ralph/ralph-run.bat +5 -5
  211. package/templates/ralph/ralph-run.sh +5 -5
  212. package/templates/ralph/ralph-status.bat +4 -4
  213. package/templates/ralph/ralph-status.sh +5 -5
  214. package/templates/services/AZURE_BLOB.md +184 -184
  215. package/templates/services/CASSANDRA.md +239 -239
  216. package/templates/services/DATADOG.md +26 -26
  217. package/templates/services/DOCKER.md +124 -124
  218. package/templates/services/DOCKER_COMPOSE.md +168 -168
  219. package/templates/services/DYNAMODB.md +308 -308
  220. package/templates/services/ELASTICSEARCH.md +347 -347
  221. package/templates/services/GCS.md +178 -178
  222. package/templates/services/HELM.md +194 -194
  223. package/templates/services/INFLUXDB.md +265 -265
  224. package/templates/services/KAFKA.md +341 -341
  225. package/templates/services/KUBERNETES.md +208 -208
  226. package/templates/services/MARIADB.md +183 -183
  227. package/templates/services/MEMCACHED.md +242 -242
  228. package/templates/services/MINIO.md +201 -201
  229. package/templates/services/MONGODB.md +268 -268
  230. package/templates/services/MYSQL.md +358 -358
  231. package/templates/services/NEO4J.md +247 -247
  232. package/templates/services/OPENTELEMETRY.md +25 -25
  233. package/templates/services/ORACLE.md +290 -290
  234. package/templates/services/PINO.md +24 -24
  235. package/templates/services/POSTGRESQL.md +326 -326
  236. package/templates/services/PROMETHEUS.md +33 -33
  237. package/templates/services/RABBITMQ.md +286 -286
  238. package/templates/services/REDIS.md +292 -292
  239. package/templates/services/S3.md +298 -298
  240. package/templates/services/SENTRY.md +23 -23
  241. package/templates/services/SQLITE.md +294 -294
  242. package/templates/services/SQLSERVER.md +294 -294
  243. package/templates/services/WINSTON.md +30 -30
  244. package/templates/skills/cli/aider/SKILL.md +59 -59
  245. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  246. package/templates/skills/cli/auggie/SKILL.md +42 -42
  247. package/templates/skills/cli/claude/SKILL.md +42 -42
  248. package/templates/skills/cli/cline/SKILL.md +42 -42
  249. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  250. package/templates/skills/cli/codeium/SKILL.md +30 -30
  251. package/templates/skills/cli/codex/SKILL.md +31 -31
  252. package/templates/skills/cli/continue/SKILL.md +44 -44
  253. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  254. package/templates/skills/cli/factory/SKILL.md +28 -28
  255. package/templates/skills/cli/gemini/SKILL.md +45 -45
  256. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  257. package/templates/skills/cli/opencode/SKILL.md +28 -28
  258. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  259. package/templates/skills/core/dag/SKILL.md +314 -314
  260. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  261. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  262. package/templates/skills/core/rulebook/SKILL.md +176 -176
  263. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  264. package/templates/skills/frameworks/django/SKILL.md +93 -93
  265. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  266. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  267. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  268. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  269. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  270. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  271. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  272. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  273. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  274. package/templates/skills/frameworks/react/SKILL.md +48 -48
  275. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  276. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  277. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  278. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  279. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  280. package/templates/skills/ides/copilot/SKILL.md +47 -47
  281. package/templates/skills/ides/cursor/SKILL.md +53 -53
  282. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  283. package/templates/skills/ides/replit/SKILL.md +46 -46
  284. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  285. package/templates/skills/ides/vscode/SKILL.md +50 -50
  286. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  287. package/templates/skills/ides/zed/SKILL.md +42 -42
  288. package/templates/skills/languages/c/SKILL.md +343 -343
  289. package/templates/skills/languages/cpp/SKILL.md +753 -753
  290. package/templates/skills/languages/csharp/SKILL.md +427 -427
  291. package/templates/skills/languages/elixir/SKILL.md +464 -464
  292. package/templates/skills/languages/erlang/SKILL.md +371 -371
  293. package/templates/skills/languages/go/SKILL.md +655 -655
  294. package/templates/skills/languages/haskell/SKILL.md +187 -187
  295. package/templates/skills/languages/java/SKILL.md +617 -617
  296. package/templates/skills/languages/javascript/SKILL.md +641 -641
  297. package/templates/skills/languages/julia/SKILL.md +107 -107
  298. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  299. package/templates/skills/languages/lisp/SKILL.md +110 -110
  300. package/templates/skills/languages/lua/SKILL.md +84 -84
  301. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  302. package/templates/skills/languages/php/SKILL.md +426 -426
  303. package/templates/skills/languages/python/SKILL.md +692 -692
  304. package/templates/skills/languages/ruby/SKILL.md +431 -431
  305. package/templates/skills/languages/rust/SKILL.md +487 -487
  306. package/templates/skills/languages/sas/SKILL.md +83 -83
  307. package/templates/skills/languages/scala/SKILL.md +358 -358
  308. package/templates/skills/languages/solidity/SKILL.md +590 -590
  309. package/templates/skills/languages/sql/SKILL.md +147 -147
  310. package/templates/skills/languages/swift/SKILL.md +476 -476
  311. package/templates/skills/languages/typescript/SKILL.md +302 -302
  312. package/templates/skills/languages/zig/SKILL.md +275 -275
  313. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  314. package/templates/skills/modules/context7/SKILL.md +64 -64
  315. package/templates/skills/modules/figma/SKILL.md +277 -277
  316. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  317. package/templates/skills/modules/grafana/SKILL.md +338 -338
  318. package/templates/skills/modules/memory/SKILL.md +73 -73
  319. package/templates/skills/modules/notion/SKILL.md +257 -257
  320. package/templates/skills/modules/playwright/SKILL.md +100 -100
  321. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  322. package/templates/skills/modules/serena/SKILL.md +347 -347
  323. package/templates/skills/modules/supabase/SKILL.md +233 -233
  324. package/templates/skills/modules/synap/SKILL.md +79 -79
  325. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  326. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  327. package/templates/skills/services/cassandra/SKILL.md +249 -249
  328. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  329. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  330. package/templates/skills/services/gcs/SKILL.md +188 -188
  331. package/templates/skills/services/influxdb/SKILL.md +275 -275
  332. package/templates/skills/services/kafka/SKILL.md +351 -351
  333. package/templates/skills/services/mariadb/SKILL.md +193 -193
  334. package/templates/skills/services/memcached/SKILL.md +252 -252
  335. package/templates/skills/services/minio/SKILL.md +211 -211
  336. package/templates/skills/services/mongodb/SKILL.md +278 -278
  337. package/templates/skills/services/mysql/SKILL.md +368 -368
  338. package/templates/skills/services/neo4j/SKILL.md +257 -257
  339. package/templates/skills/services/oracle/SKILL.md +300 -300
  340. package/templates/skills/services/postgresql/SKILL.md +336 -336
  341. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  342. package/templates/skills/services/redis/SKILL.md +302 -302
  343. package/templates/skills/services/s3/SKILL.md +308 -308
  344. package/templates/skills/services/sqlite/SKILL.md +304 -304
  345. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  346. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  347. package/templates/skills/workflows/ralph/install.sh +87 -87
  348. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,487 +1,487 @@
1
- ---
2
- name: "Rust"
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
- <!-- RUST:START -->
12
- # Rust 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
- cargo fmt --all -- --check # Format check
21
- cargo clippy --workspace --all-targets --all-features -- -D warnings # Lint
22
- cargo test --workspace --all-features # All tests (100% pass)
23
- cargo build --release # Build verification
24
- cargo llvm-cov --all # Coverage (95%+ required)
25
-
26
- # Security audit:
27
- cargo audit # Vulnerability scan
28
- cargo outdated # Check outdated deps
29
- ```
30
-
31
- ## Rust Edition and Toolchain
32
-
33
- **CRITICAL**: Always use Rust Edition 2024 with nightly toolchain.
34
-
35
- - **Edition**: 2024
36
- - **Toolchain**: nightly 1.85+
37
- - **Update**: Run `rustup update nightly` regularly
38
-
39
- ### Formatting
40
-
41
- - Use `rustfmt` with nightly toolchain
42
- - Configuration in `rustfmt.toml` or `.rustfmt.toml`
43
- - Always format before committing: `cargo +nightly fmt --all`
44
- - CI must check formatting: `cargo +nightly fmt --all -- --check`
45
-
46
- ### Linting
47
-
48
- - Use `clippy` with `-D warnings` (warnings as errors)
49
- - Fix all clippy warnings before committing
50
- - Acceptable exceptions must be documented with `#[allow(clippy::...)]` and justification
51
- - CI must enforce clippy: `cargo clippy --workspace -- -D warnings`
52
-
53
- ### Testing
54
-
55
- - **Location**: Tests in `/tests` directory for integration tests
56
- - **Unit Tests**: In same file as implementation with `#[cfg(test)]`
57
- - **Coverage**: Must meet project threshold (default 95%)
58
- - **Tools**: Use `cargo-nextest` for faster test execution
59
- - **Async**: Use `tokio::test` for async tests with Tokio runtime
60
-
61
- Example test structure:
62
- ```rust
63
- #[cfg(test)]
64
- mod tests {
65
- use super::*;
66
-
67
- #[test]
68
- fn test_feature() {
69
- // Test implementation
70
- }
71
-
72
- #[tokio::test]
73
- async fn test_async_feature() {
74
- // Async test implementation
75
- }
76
- }
77
- ```
78
-
79
- ### Test Categories: S2S and Slow Tests
80
-
81
- **CRITICAL**: Tests must be categorized based on execution time and dependencies.
82
-
83
- #### Test Time Limits
84
-
85
- - **Fast Tests**: Must complete in ≤ 10-20 seconds
86
- - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
87
- - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
88
-
89
- #### S2S (Server-to-Server) Tests
90
-
91
- **Tests that require active servers, databases, or external services must be isolated using Cargo features.**
92
-
93
- **Implementation**:
94
-
95
- 1. **Create `s2s` feature in `Cargo.toml`**:
96
- ```toml
97
- [features]
98
- default = []
99
- s2s = [] # Enable server-to-server tests
100
- ```
101
-
102
- 2. **Mark S2S tests with feature flag**:
103
- ```rust
104
- #[cfg(test)]
105
- mod tests {
106
- use super::*;
107
-
108
- // Regular fast test (always runs)
109
- #[test]
110
- fn test_local_computation() {
111
- // Fast test, no external dependencies
112
- }
113
-
114
- // S2S test (only runs with --features s2s)
115
- #[cfg(feature = "s2s")]
116
- #[tokio::test]
117
- async fn test_database_connection() {
118
- // Requires active database server
119
- let db = connect_to_database().await?;
120
- // ... test implementation
121
- }
122
-
123
- #[cfg(feature = "s2s")]
124
- #[tokio::test]
125
- async fn test_api_integration() {
126
- // Requires active API server
127
- let client = create_api_client().await?;
128
- // ... test implementation
129
- }
130
- }
131
- ```
132
-
133
- 3. **Run tests**:
134
- ```bash
135
- # Regular tests (excludes S2S)
136
- cargo test
137
-
138
- # Include S2S tests (requires active servers)
139
- cargo test --features s2s
140
-
141
- # CI/CD: Run S2S tests only when servers are available
142
- cargo test --features s2s --test-args '--test-threads=1'
143
- ```
144
-
145
- #### Slow Tests
146
-
147
- **Tests that take > 10-20 seconds must be marked and run separately.**
148
-
149
- **Implementation**:
150
-
151
- 1. **Create `slow` feature in `Cargo.toml`**:
152
- ```toml
153
- [features]
154
- default = []
155
- slow = [] # Enable slow tests
156
- ```
157
-
158
- 2. **Mark slow tests**:
159
- ```rust
160
- #[cfg(test)]
161
- mod tests {
162
- use super::*;
163
-
164
- // Fast test (always runs)
165
- #[test]
166
- fn test_quick_operation() {
167
- // Completes in < 1 second
168
- }
169
-
170
- // Slow test (only runs with --features slow)
171
- #[cfg(feature = "slow")]
172
- #[test]
173
- fn test_heavy_computation() {
174
- // Takes 30+ seconds
175
- // Heavy processing, large dataset, etc.
176
- }
177
-
178
- #[cfg(feature = "slow")]
179
- #[tokio::test]
180
- async fn test_large_file_processing() {
181
- // Processes large files, takes > 20 seconds
182
- }
183
- }
184
- ```
185
-
186
- 3. **Run tests**:
187
- ```bash
188
- # Regular tests (excludes slow)
189
- cargo test
190
-
191
- # Include slow tests
192
- cargo test --features slow
193
-
194
- # Run both S2S and slow tests
195
- cargo test --features s2s,slow
196
- ```
197
-
198
- #### Best Practices
199
-
200
- - ✅ **Always run fast tests** in CI/CD by default
201
- - ✅ **Isolate S2S tests** - never run them in standard test suite
202
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
203
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
204
- - ✅ **Use timeouts** - Set appropriate timeouts for S2S tests: `tokio::time::timeout(Duration::from_secs(30), test_fn).await?`
205
- - ❌ **Never mix** fast and slow/S2S tests in same test run
206
- - ❌ **Never require** external services for standard test suite
207
- - ❌ **Never exceed** 10-20 seconds for regular tests
208
-
209
- ## Async Programming
210
-
211
- **CRITICAL**: Follow Tokio best practices for async code.
212
-
213
- - **Runtime**: Use Tokio for async runtime
214
- - **Blocking**: Never block in async context - use `spawn_blocking` for CPU-intensive tasks
215
- - **Channels**: Use `tokio::sync::mpsc` or `tokio::sync::broadcast` for async communication
216
- - **Timeouts**: Always set timeouts for network operations: `tokio::time::timeout`
217
-
218
- Example:
219
- ```rust
220
- use tokio::time::{timeout, Duration};
221
-
222
- async fn fetch_data() -> Result<Data, Error> {
223
- timeout(Duration::from_secs(30), async {
224
- // Network operation
225
- }).await?
226
- }
227
- ```
228
-
229
- ## Dependency Management
230
-
231
- **CRITICAL**: Always verify latest versions before adding dependencies.
232
-
233
- ### Before Adding Any Dependency
234
-
235
- 1. **Check Context7 for latest version**:
236
- - Use MCP Context7 tool if available
237
- - Search for the crate documentation
238
- - Verify the latest stable version
239
- - Review breaking changes and migration guides
240
-
241
- 2. **Example Workflow**:
242
- ```
243
- Adding tokio → Check crates.io and docs.rs
244
- Adding serde → Verify latest version with security updates
245
- Adding axum → Check for breaking changes in latest version
246
- ```
247
-
248
- 3. **Document Version Choice**:
249
- - Note why specific version chosen in `Cargo.toml` comments
250
- - Document any compatibility constraints
251
- - Update CHANGELOG.md with new dependencies
252
-
253
- ### Dependency Guidelines
254
-
255
- - ✅ Use latest stable versions
256
- - ✅ Check for security advisories: `cargo audit`
257
- - ✅ Prefer well-maintained crates (active development, good documentation)
258
- - ✅ Minimize dependency count
259
- - ✅ Use workspace dependencies for monorepos
260
- - ❌ Don't use outdated versions without justification
261
- - ❌ Don't add dependencies without checking latest version
262
-
263
- ## Codespell Configuration
264
-
265
- **CRITICAL**: Use codespell to catch typos in code and documentation.
266
-
267
- Install: `pip install 'codespell[toml]'`
268
-
269
- Configuration in `pyproject.toml`:
270
- ```toml
271
- [tool.codespell]
272
- skip = "*.lock,*.json,target,node_modules,.git"
273
- ignore-words-list = "crate,ser,deser"
274
- ```
275
-
276
- Or run with flags:
277
- ```bash
278
- codespell \
279
- --skip="*.lock,*.json,target,node_modules,.git" \
280
- --ignore-words-list="crate,ser,deser"
281
- ```
282
-
283
- ## Error Handling
284
-
285
- - Use `Result<T, E>` for recoverable errors
286
- - Use `thiserror` for custom error types
287
- - Use `anyhow` for application-level error handling
288
- - Document error conditions in function docs
289
- - Never use `unwrap()` or `expect()` in production code without justification
290
-
291
- Example:
292
- ```rust
293
- use thiserror::Error;
294
-
295
- #[derive(Error, Debug)]
296
- pub enum MyError {
297
- #[error("IO error: {0}")]
298
- Io(#[from] std::io::Error),
299
-
300
- #[error("Invalid input: {0}")]
301
- InvalidInput(String),
302
- }
303
-
304
- pub fn process_data(input: &str) -> Result<Data, MyError> {
305
- // Implementation
306
- }
307
- ```
308
-
309
- ## Documentation
310
-
311
- - **Public APIs**: Must have doc comments (`///`)
312
- - **Examples**: Include examples in doc comments
313
- - **Modules**: Document module purpose with `//!`
314
- - **Unsafe**: Always document safety requirements for `unsafe` code
315
- - **Run doctests**: `cargo test --doc`
316
-
317
- Example:
318
- ```rust
319
- /// Processes the input data and returns a result.
320
- ///
321
- /// # Arguments
322
- ///
323
- /// * `input` - The input string to process
324
- ///
325
- /// # Examples
326
- ///
327
- /// ```
328
- /// use mylib::process;
329
- /// let result = process("hello");
330
- /// assert_eq!(result, "HELLO");
331
- /// ```
332
- ///
333
- /// # Errors
334
- ///
335
- /// Returns `MyError::InvalidInput` if input is empty.
336
- pub fn process(input: &str) -> Result<String, MyError> {
337
- // Implementation
338
- }
339
- ```
340
-
341
- ## Project Structure
342
-
343
- ```
344
- project/
345
- ├── Cargo.toml # Package manifest
346
- ├── Cargo.lock # Dependency lock file (commit this)
347
- ├── README.md # Project overview (allowed in root)
348
- ├── CHANGELOG.md # Version history (allowed in root)
349
- ├── AGENTS.md # AI assistant rules (allowed in root)
350
- ├── LICENSE # Project license (allowed in root)
351
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
352
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
353
- ├── SECURITY.md # Security policy (allowed in root)
354
- ├── src/
355
- │ ├── lib.rs # Library root (for libraries)
356
- │ ├── main.rs # Binary root (for applications)
357
- │ └── ...
358
- ├── tests/ # Integration tests
359
- ├── examples/ # Example code
360
- ├── benches/ # Benchmarks
361
- └── docs/ # Project documentation
362
- ```
363
-
364
- ## CI/CD Requirements
365
-
366
- Must include GitHub Actions workflows for:
367
-
368
- 1. **Testing** (`rust-test.yml`):
369
- - Test on ubuntu-latest, windows-latest, macos-latest
370
- - Use `cargo-nextest` for fast test execution
371
- - Upload test results
372
-
373
- 2. **Linting** (`rust-lint.yml`):
374
- - Format check: `cargo +nightly fmt --all -- --check`
375
- - Clippy: `cargo clippy --workspace -- -D warnings`
376
- - All targets: `cargo clippy --workspace --all-targets -- -D warnings`
377
-
378
- 3. **Codespell** (`codespell.yml`):
379
- - Check for typos in code and documentation
380
- - Fail on errors
381
-
382
- ## Crate Publication
383
-
384
- ### Publishing to crates.io
385
-
386
- **Prerequisites:**
387
- 1. Create account at https://crates.io
388
- 2. Generate API token: `cargo login`
389
- 3. Add `CARGO_TOKEN` to GitHub repository secrets
390
-
391
- **Cargo.toml Configuration:**
392
-
393
- ```toml
394
- [package]
395
- name = "your-crate-name"
396
- version = "1.0.0"
397
- edition = "2024"
398
- authors = ["Your Name <your.email@example.com>"]
399
- license = "MIT OR Apache-2.0"
400
- description = "A short description of your crate"
401
- documentation = "https://docs.rs/your-crate-name"
402
- homepage = "https://github.com/your-org/your-crate-name"
403
- repository = "https://github.com/your-org/your-crate-name"
404
- readme = "README.md"
405
- keywords = ["your", "keywords", "here"]
406
- categories = ["category"]
407
- exclude = [
408
- ".github/",
409
- "tests/",
410
- "benches/",
411
- "examples/",
412
- "*.sh",
413
- ]
414
-
415
- [package.metadata.docs.rs]
416
- all-features = true
417
- rustdoc-args = ["--cfg", "docsrs"]
418
- ```
419
-
420
- **Publishing Workflow:**
421
-
422
- 1. Update version in Cargo.toml
423
- 2. Update CHANGELOG.md
424
- 3. Run quality checks:
425
- ```bash
426
- cargo fmt --all
427
- cargo clippy --workspace --all-targets -- -D warnings
428
- cargo test --all-features
429
- cargo doc --no-deps --all-features
430
- ```
431
- 4. Create git tag: `git tag v1.0.0 && git push --tags`
432
- 5. GitHub Actions automatically publishes to crates.io
433
- 6. Or manual publish: `cargo publish`
434
-
435
- **Publishing Checklist:**
436
-
437
- - ✅ All tests passing (`cargo test --all-features`)
438
- - ✅ No clippy warnings (`cargo clippy -- -D warnings`)
439
- - ✅ Code formatted (`cargo fmt --all -- --check`)
440
- - ✅ Documentation builds (`cargo doc --no-deps`)
441
- - ✅ Version updated in Cargo.toml
442
- - ✅ CHANGELOG.md updated
443
- - ✅ README.md up to date
444
- - ✅ LICENSE file present
445
- - ✅ Package size < 10MB (check with `cargo package --list`)
446
- - ✅ Verify with `cargo publish --dry-run`
447
-
448
- **Semantic Versioning:**
449
-
450
- Follow [SemVer](https://semver.org/) strictly:
451
- - **MAJOR**: Breaking API changes
452
- - **MINOR**: New features (backwards compatible)
453
- - **PATCH**: Bug fixes (backwards compatible)
454
-
455
- **Documentation:**
456
-
457
- - Use `///` for public API documentation
458
- - Include examples in doc comments
459
- - Use `#![deny(missing_docs)]` for libraries
460
- - Test documentation examples with `cargo test --doc`
461
-
462
- ```rust
463
- /// Processes the input data and returns a result.
464
- ///
465
- /// # Arguments
466
- ///
467
- /// * `input` - The input string to process
468
- ///
469
- /// # Examples
470
- ///
471
- /// ```
472
- /// use your_crate::process;
473
- ///
474
- /// let result = process("hello");
475
- /// assert_eq!(result, "HELLO");
476
- /// ```
477
- ///
478
- /// # Errors
479
- ///
480
- /// Returns an error if the input is empty.
481
- pub fn process(input: &str) -> Result<String, Error> {
482
- // Implementation
483
- }
484
- ```
485
-
486
- <!-- RUST:END -->
487
-
1
+ ---
2
+ name: "Rust"
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
+ <!-- RUST:START -->
12
+ # Rust 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
+ cargo fmt --all -- --check # Format check
21
+ cargo clippy --workspace --all-targets --all-features -- -D warnings # Lint
22
+ cargo test --workspace --all-features # All tests (100% pass)
23
+ cargo build --release # Build verification
24
+ cargo llvm-cov --all # Coverage (95%+ required)
25
+
26
+ # Security audit:
27
+ cargo audit # Vulnerability scan
28
+ cargo outdated # Check outdated deps
29
+ ```
30
+
31
+ ## Rust Edition and Toolchain
32
+
33
+ **CRITICAL**: Always use Rust Edition 2024 with nightly toolchain.
34
+
35
+ - **Edition**: 2024
36
+ - **Toolchain**: nightly 1.85+
37
+ - **Update**: Run `rustup update nightly` regularly
38
+
39
+ ### Formatting
40
+
41
+ - Use `rustfmt` with nightly toolchain
42
+ - Configuration in `rustfmt.toml` or `.rustfmt.toml`
43
+ - Always format before committing: `cargo +nightly fmt --all`
44
+ - CI must check formatting: `cargo +nightly fmt --all -- --check`
45
+
46
+ ### Linting
47
+
48
+ - Use `clippy` with `-D warnings` (warnings as errors)
49
+ - Fix all clippy warnings before committing
50
+ - Acceptable exceptions must be documented with `#[allow(clippy::...)]` and justification
51
+ - CI must enforce clippy: `cargo clippy --workspace -- -D warnings`
52
+
53
+ ### Testing
54
+
55
+ - **Location**: Tests in `/tests` directory for integration tests
56
+ - **Unit Tests**: In same file as implementation with `#[cfg(test)]`
57
+ - **Coverage**: Must meet project threshold (default 95%)
58
+ - **Tools**: Use `cargo-nextest` for faster test execution
59
+ - **Async**: Use `tokio::test` for async tests with Tokio runtime
60
+
61
+ Example test structure:
62
+ ```rust
63
+ #[cfg(test)]
64
+ mod tests {
65
+ use super::*;
66
+
67
+ #[test]
68
+ fn test_feature() {
69
+ // Test implementation
70
+ }
71
+
72
+ #[tokio::test]
73
+ async fn test_async_feature() {
74
+ // Async test implementation
75
+ }
76
+ }
77
+ ```
78
+
79
+ ### Test Categories: S2S and Slow Tests
80
+
81
+ **CRITICAL**: Tests must be categorized based on execution time and dependencies.
82
+
83
+ #### Test Time Limits
84
+
85
+ - **Fast Tests**: Must complete in ≤ 10-20 seconds
86
+ - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
87
+ - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
88
+
89
+ #### S2S (Server-to-Server) Tests
90
+
91
+ **Tests that require active servers, databases, or external services must be isolated using Cargo features.**
92
+
93
+ **Implementation**:
94
+
95
+ 1. **Create `s2s` feature in `Cargo.toml`**:
96
+ ```toml
97
+ [features]
98
+ default = []
99
+ s2s = [] # Enable server-to-server tests
100
+ ```
101
+
102
+ 2. **Mark S2S tests with feature flag**:
103
+ ```rust
104
+ #[cfg(test)]
105
+ mod tests {
106
+ use super::*;
107
+
108
+ // Regular fast test (always runs)
109
+ #[test]
110
+ fn test_local_computation() {
111
+ // Fast test, no external dependencies
112
+ }
113
+
114
+ // S2S test (only runs with --features s2s)
115
+ #[cfg(feature = "s2s")]
116
+ #[tokio::test]
117
+ async fn test_database_connection() {
118
+ // Requires active database server
119
+ let db = connect_to_database().await?;
120
+ // ... test implementation
121
+ }
122
+
123
+ #[cfg(feature = "s2s")]
124
+ #[tokio::test]
125
+ async fn test_api_integration() {
126
+ // Requires active API server
127
+ let client = create_api_client().await?;
128
+ // ... test implementation
129
+ }
130
+ }
131
+ ```
132
+
133
+ 3. **Run tests**:
134
+ ```bash
135
+ # Regular tests (excludes S2S)
136
+ cargo test
137
+
138
+ # Include S2S tests (requires active servers)
139
+ cargo test --features s2s
140
+
141
+ # CI/CD: Run S2S tests only when servers are available
142
+ cargo test --features s2s --test-args '--test-threads=1'
143
+ ```
144
+
145
+ #### Slow Tests
146
+
147
+ **Tests that take > 10-20 seconds must be marked and run separately.**
148
+
149
+ **Implementation**:
150
+
151
+ 1. **Create `slow` feature in `Cargo.toml`**:
152
+ ```toml
153
+ [features]
154
+ default = []
155
+ slow = [] # Enable slow tests
156
+ ```
157
+
158
+ 2. **Mark slow tests**:
159
+ ```rust
160
+ #[cfg(test)]
161
+ mod tests {
162
+ use super::*;
163
+
164
+ // Fast test (always runs)
165
+ #[test]
166
+ fn test_quick_operation() {
167
+ // Completes in < 1 second
168
+ }
169
+
170
+ // Slow test (only runs with --features slow)
171
+ #[cfg(feature = "slow")]
172
+ #[test]
173
+ fn test_heavy_computation() {
174
+ // Takes 30+ seconds
175
+ // Heavy processing, large dataset, etc.
176
+ }
177
+
178
+ #[cfg(feature = "slow")]
179
+ #[tokio::test]
180
+ async fn test_large_file_processing() {
181
+ // Processes large files, takes > 20 seconds
182
+ }
183
+ }
184
+ ```
185
+
186
+ 3. **Run tests**:
187
+ ```bash
188
+ # Regular tests (excludes slow)
189
+ cargo test
190
+
191
+ # Include slow tests
192
+ cargo test --features slow
193
+
194
+ # Run both S2S and slow tests
195
+ cargo test --features s2s,slow
196
+ ```
197
+
198
+ #### Best Practices
199
+
200
+ - ✅ **Always run fast tests** in CI/CD by default
201
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
202
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
203
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
204
+ - ✅ **Use timeouts** - Set appropriate timeouts for S2S tests: `tokio::time::timeout(Duration::from_secs(30), test_fn).await?`
205
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
206
+ - ❌ **Never require** external services for standard test suite
207
+ - ❌ **Never exceed** 10-20 seconds for regular tests
208
+
209
+ ## Async Programming
210
+
211
+ **CRITICAL**: Follow Tokio best practices for async code.
212
+
213
+ - **Runtime**: Use Tokio for async runtime
214
+ - **Blocking**: Never block in async context - use `spawn_blocking` for CPU-intensive tasks
215
+ - **Channels**: Use `tokio::sync::mpsc` or `tokio::sync::broadcast` for async communication
216
+ - **Timeouts**: Always set timeouts for network operations: `tokio::time::timeout`
217
+
218
+ Example:
219
+ ```rust
220
+ use tokio::time::{timeout, Duration};
221
+
222
+ async fn fetch_data() -> Result<Data, Error> {
223
+ timeout(Duration::from_secs(30), async {
224
+ // Network operation
225
+ }).await?
226
+ }
227
+ ```
228
+
229
+ ## Dependency Management
230
+
231
+ **CRITICAL**: Always verify latest versions before adding dependencies.
232
+
233
+ ### Before Adding Any Dependency
234
+
235
+ 1. **Check Context7 for latest version**:
236
+ - Use MCP Context7 tool if available
237
+ - Search for the crate documentation
238
+ - Verify the latest stable version
239
+ - Review breaking changes and migration guides
240
+
241
+ 2. **Example Workflow**:
242
+ ```
243
+ Adding tokio → Check crates.io and docs.rs
244
+ Adding serde → Verify latest version with security updates
245
+ Adding axum → Check for breaking changes in latest version
246
+ ```
247
+
248
+ 3. **Document Version Choice**:
249
+ - Note why specific version chosen in `Cargo.toml` comments
250
+ - Document any compatibility constraints
251
+ - Update CHANGELOG.md with new dependencies
252
+
253
+ ### Dependency Guidelines
254
+
255
+ - ✅ Use latest stable versions
256
+ - ✅ Check for security advisories: `cargo audit`
257
+ - ✅ Prefer well-maintained crates (active development, good documentation)
258
+ - ✅ Minimize dependency count
259
+ - ✅ Use workspace dependencies for monorepos
260
+ - ❌ Don't use outdated versions without justification
261
+ - ❌ Don't add dependencies without checking latest version
262
+
263
+ ## Codespell Configuration
264
+
265
+ **CRITICAL**: Use codespell to catch typos in code and documentation.
266
+
267
+ Install: `pip install 'codespell[toml]'`
268
+
269
+ Configuration in `pyproject.toml`:
270
+ ```toml
271
+ [tool.codespell]
272
+ skip = "*.lock,*.json,target,node_modules,.git"
273
+ ignore-words-list = "crate,ser,deser"
274
+ ```
275
+
276
+ Or run with flags:
277
+ ```bash
278
+ codespell \
279
+ --skip="*.lock,*.json,target,node_modules,.git" \
280
+ --ignore-words-list="crate,ser,deser"
281
+ ```
282
+
283
+ ## Error Handling
284
+
285
+ - Use `Result<T, E>` for recoverable errors
286
+ - Use `thiserror` for custom error types
287
+ - Use `anyhow` for application-level error handling
288
+ - Document error conditions in function docs
289
+ - Never use `unwrap()` or `expect()` in production code without justification
290
+
291
+ Example:
292
+ ```rust
293
+ use thiserror::Error;
294
+
295
+ #[derive(Error, Debug)]
296
+ pub enum MyError {
297
+ #[error("IO error: {0}")]
298
+ Io(#[from] std::io::Error),
299
+
300
+ #[error("Invalid input: {0}")]
301
+ InvalidInput(String),
302
+ }
303
+
304
+ pub fn process_data(input: &str) -> Result<Data, MyError> {
305
+ // Implementation
306
+ }
307
+ ```
308
+
309
+ ## Documentation
310
+
311
+ - **Public APIs**: Must have doc comments (`///`)
312
+ - **Examples**: Include examples in doc comments
313
+ - **Modules**: Document module purpose with `//!`
314
+ - **Unsafe**: Always document safety requirements for `unsafe` code
315
+ - **Run doctests**: `cargo test --doc`
316
+
317
+ Example:
318
+ ```rust
319
+ /// Processes the input data and returns a result.
320
+ ///
321
+ /// # Arguments
322
+ ///
323
+ /// * `input` - The input string to process
324
+ ///
325
+ /// # Examples
326
+ ///
327
+ /// ```
328
+ /// use mylib::process;
329
+ /// let result = process("hello");
330
+ /// assert_eq!(result, "HELLO");
331
+ /// ```
332
+ ///
333
+ /// # Errors
334
+ ///
335
+ /// Returns `MyError::InvalidInput` if input is empty.
336
+ pub fn process(input: &str) -> Result<String, MyError> {
337
+ // Implementation
338
+ }
339
+ ```
340
+
341
+ ## Project Structure
342
+
343
+ ```
344
+ project/
345
+ ├── Cargo.toml # Package manifest
346
+ ├── Cargo.lock # Dependency lock file (commit this)
347
+ ├── README.md # Project overview (allowed in root)
348
+ ├── CHANGELOG.md # Version history (allowed in root)
349
+ ├── AGENTS.md # AI assistant rules (allowed in root)
350
+ ├── LICENSE # Project license (allowed in root)
351
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
352
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
353
+ ├── SECURITY.md # Security policy (allowed in root)
354
+ ├── src/
355
+ │ ├── lib.rs # Library root (for libraries)
356
+ │ ├── main.rs # Binary root (for applications)
357
+ │ └── ...
358
+ ├── tests/ # Integration tests
359
+ ├── examples/ # Example code
360
+ ├── benches/ # Benchmarks
361
+ └── docs/ # Project documentation
362
+ ```
363
+
364
+ ## CI/CD Requirements
365
+
366
+ Must include GitHub Actions workflows for:
367
+
368
+ 1. **Testing** (`rust-test.yml`):
369
+ - Test on ubuntu-latest, windows-latest, macos-latest
370
+ - Use `cargo-nextest` for fast test execution
371
+ - Upload test results
372
+
373
+ 2. **Linting** (`rust-lint.yml`):
374
+ - Format check: `cargo +nightly fmt --all -- --check`
375
+ - Clippy: `cargo clippy --workspace -- -D warnings`
376
+ - All targets: `cargo clippy --workspace --all-targets -- -D warnings`
377
+
378
+ 3. **Codespell** (`codespell.yml`):
379
+ - Check for typos in code and documentation
380
+ - Fail on errors
381
+
382
+ ## Crate Publication
383
+
384
+ ### Publishing to crates.io
385
+
386
+ **Prerequisites:**
387
+ 1. Create account at https://crates.io
388
+ 2. Generate API token: `cargo login`
389
+ 3. Add `CARGO_TOKEN` to GitHub repository secrets
390
+
391
+ **Cargo.toml Configuration:**
392
+
393
+ ```toml
394
+ [package]
395
+ name = "your-crate-name"
396
+ version = "1.0.0"
397
+ edition = "2024"
398
+ authors = ["Your Name <your.email@example.com>"]
399
+ license = "MIT OR Apache-2.0"
400
+ description = "A short description of your crate"
401
+ documentation = "https://docs.rs/your-crate-name"
402
+ homepage = "https://github.com/your-org/your-crate-name"
403
+ repository = "https://github.com/your-org/your-crate-name"
404
+ readme = "README.md"
405
+ keywords = ["your", "keywords", "here"]
406
+ categories = ["category"]
407
+ exclude = [
408
+ ".github/",
409
+ "tests/",
410
+ "benches/",
411
+ "examples/",
412
+ "*.sh",
413
+ ]
414
+
415
+ [package.metadata.docs.rs]
416
+ all-features = true
417
+ rustdoc-args = ["--cfg", "docsrs"]
418
+ ```
419
+
420
+ **Publishing Workflow:**
421
+
422
+ 1. Update version in Cargo.toml
423
+ 2. Update CHANGELOG.md
424
+ 3. Run quality checks:
425
+ ```bash
426
+ cargo fmt --all
427
+ cargo clippy --workspace --all-targets -- -D warnings
428
+ cargo test --all-features
429
+ cargo doc --no-deps --all-features
430
+ ```
431
+ 4. Create git tag: `git tag v1.0.0 && git push --tags`
432
+ 5. GitHub Actions automatically publishes to crates.io
433
+ 6. Or manual publish: `cargo publish`
434
+
435
+ **Publishing Checklist:**
436
+
437
+ - ✅ All tests passing (`cargo test --all-features`)
438
+ - ✅ No clippy warnings (`cargo clippy -- -D warnings`)
439
+ - ✅ Code formatted (`cargo fmt --all -- --check`)
440
+ - ✅ Documentation builds (`cargo doc --no-deps`)
441
+ - ✅ Version updated in Cargo.toml
442
+ - ✅ CHANGELOG.md updated
443
+ - ✅ README.md up to date
444
+ - ✅ LICENSE file present
445
+ - ✅ Package size < 10MB (check with `cargo package --list`)
446
+ - ✅ Verify with `cargo publish --dry-run`
447
+
448
+ **Semantic Versioning:**
449
+
450
+ Follow [SemVer](https://semver.org/) strictly:
451
+ - **MAJOR**: Breaking API changes
452
+ - **MINOR**: New features (backwards compatible)
453
+ - **PATCH**: Bug fixes (backwards compatible)
454
+
455
+ **Documentation:**
456
+
457
+ - Use `///` for public API documentation
458
+ - Include examples in doc comments
459
+ - Use `#![deny(missing_docs)]` for libraries
460
+ - Test documentation examples with `cargo test --doc`
461
+
462
+ ```rust
463
+ /// Processes the input data and returns a result.
464
+ ///
465
+ /// # Arguments
466
+ ///
467
+ /// * `input` - The input string to process
468
+ ///
469
+ /// # Examples
470
+ ///
471
+ /// ```
472
+ /// use your_crate::process;
473
+ ///
474
+ /// let result = process("hello");
475
+ /// assert_eq!(result, "HELLO");
476
+ /// ```
477
+ ///
478
+ /// # Errors
479
+ ///
480
+ /// Returns an error if the input is empty.
481
+ pub fn process(input: &str) -> Result<String, Error> {
482
+ // Implementation
483
+ }
484
+ ```
485
+
486
+ <!-- RUST:END -->
487
+