@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,368 +1,368 @@
1
- ---
2
- name: "MySQL"
3
- description: "Use MySQL for relational data storage with high performance, replication, and wide ecosystem support."
4
- version: "1.0.0"
5
- category: "services"
6
- author: "Rulebook"
7
- tags: ["services", "database"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- MYSQL:START -->
12
- # MySQL Database Instructions
13
-
14
- **CRITICAL**: Use MySQL for relational data storage with high performance, replication, and wide ecosystem support.
15
-
16
- ## Core Features
17
-
18
- ### Connection
19
- ```typescript
20
- // Using mysql2 (Node.js)
21
- import mysql from 'mysql2/promise'
22
-
23
- const pool = mysql.createPool({
24
- host: process.env.DB_HOST,
25
- port: parseInt(process.env.DB_PORT || '3306'),
26
- database: process.env.DB_NAME,
27
- user: process.env.DB_USER,
28
- password: process.env.DB_PASSWORD,
29
- waitForConnections: true,
30
- connectionLimit: 10,
31
- queueLimit: 0,
32
- enableKeepAlive: true,
33
- keepAliveInitialDelay: 0,
34
- })
35
-
36
- // Using Prisma
37
- import { PrismaClient } from '@prisma/client'
38
- const prisma = new PrismaClient()
39
- ```
40
-
41
- ### Basic Queries
42
- ```typescript
43
- // SELECT
44
- const [rows] = await pool.execute('SELECT * FROM users WHERE id = ?', [userId])
45
- const users = rows as User[]
46
-
47
- // INSERT
48
- const [result] = await pool.execute(
49
- 'INSERT INTO users (name, email) VALUES (?, ?)',
50
- ['John Doe', 'john@example.com']
51
- )
52
- const insertId = (result as any).insertId
53
-
54
- // UPDATE
55
- const [result] = await pool.execute(
56
- 'UPDATE users SET name = ? WHERE id = ?',
57
- ['Jane Doe', userId]
58
- )
59
- const affectedRows = (result as any).affectedRows
60
-
61
- // DELETE
62
- const [result] = await pool.execute('DELETE FROM users WHERE id = ?', [userId])
63
- ```
64
-
65
- ### Transactions
66
- ```typescript
67
- const connection = await pool.getConnection()
68
- try {
69
- await connection.beginTransaction()
70
-
71
- await connection.execute('INSERT INTO accounts (user_id, balance) VALUES (?, ?)', [userId, 1000])
72
- await connection.execute('INSERT INTO transactions (account_id, amount) VALUES (?, ?)', [accountId, 1000])
73
-
74
- await connection.commit()
75
- } catch (error) {
76
- await connection.rollback()
77
- throw error
78
- } finally {
79
- connection.release()
80
- }
81
- ```
82
-
83
- ### Advanced Features
84
- ```typescript
85
- // JSON queries (MySQL 5.7+)
86
- const [rows] = await pool.execute(
87
- "SELECT * FROM products WHERE JSON_EXTRACT(metadata, '$.category') = ?",
88
- ['electronics']
89
- )
90
-
91
- // Full-text search
92
- const [rows] = await pool.execute(
93
- "SELECT * FROM articles WHERE MATCH(title, content) AGAINST(? IN NATURAL LANGUAGE MODE)",
94
- ['search term']
95
- )
96
-
97
- // Window functions (MySQL 8.0+)
98
- const [rows] = await pool.execute(`
99
- SELECT
100
- name,
101
- salary,
102
- ROW_NUMBER() OVER (PARTITION BY department ORDER BY salary DESC) as rank
103
- FROM employees
104
- `)
105
-
106
- // Common Table Expressions (CTE) (MySQL 8.0+)
107
- const [rows] = await pool.execute(`
108
- WITH RECURSIVE cte AS (
109
- SELECT id, name, parent_id FROM categories WHERE parent_id IS NULL
110
- UNION ALL
111
- SELECT c.id, c.name, c.parent_id FROM categories c
112
- INNER JOIN cte ON c.parent_id = cte.id
113
- )
114
- SELECT * FROM cte
115
- `)
116
- ```
117
-
118
- ## Common Patterns
119
-
120
- ### Connection Pooling
121
- ```typescript
122
- // Reuse connection pool
123
- let pool: mysql.Pool | null = null
124
-
125
- export function getPool(): mysql.Pool {
126
- if (!pool) {
127
- pool = mysql.createPool({
128
- // ... config
129
- })
130
-
131
- pool.on('connection', (connection) => {
132
- connection.query('SET SESSION sql_mode = "STRICT_TRANS_TABLES"')
133
- })
134
- }
135
- return pool
136
- }
137
-
138
- // Graceful shutdown
139
- process.on('SIGINT', async () => {
140
- if (pool) {
141
- await pool.end()
142
- }
143
- process.exit(0)
144
- })
145
- ```
146
-
147
- ### Prepared Statements
148
- ```typescript
149
- // Always use parameterized queries (?) to prevent SQL injection
150
- // ❌ WRONG
151
- await pool.execute(`SELECT * FROM users WHERE email = '${email}'`)
152
-
153
- // ✅ CORRECT
154
- await pool.execute('SELECT * FROM users WHERE email = ?', [email])
155
- ```
156
-
157
- ### Error Handling
158
- ```typescript
159
- try {
160
- const [rows] = await pool.execute('SELECT * FROM users WHERE id = ?', [userId])
161
- if ((rows as any[]).length === 0) {
162
- throw new Error('User not found')
163
- }
164
- return rows[0]
165
- } catch (error: any) {
166
- if (error.code === 'ER_DUP_ENTRY') {
167
- throw new Error('Duplicate entry')
168
- }
169
- if (error.code === 'ER_NO_REFERENCED_ROW_2') {
170
- throw new Error('Referenced record does not exist')
171
- }
172
- throw error
173
- }
174
- ```
175
-
176
- ### Migrations
177
- ```typescript
178
- // Using db-migrate
179
- import { migrate } from 'db-migrate'
180
-
181
- await migrate({
182
- config: {
183
- dev: {
184
- driver: 'mysql',
185
- database: process.env.DB_NAME,
186
- user: process.env.DB_USER,
187
- password: process.env.DB_PASSWORD,
188
- host: process.env.DB_HOST,
189
- }
190
- },
191
- env: 'dev',
192
- })
193
- ```
194
-
195
- ## Best Practices
196
-
197
- ✅ **DO:**
198
- - Use connection pooling (10-20 connections typically)
199
- - Always use parameterized queries (? placeholders)
200
- - Use transactions for multi-step operations
201
- - Create indexes on frequently queried columns
202
- - Use EXPLAIN to optimize queries
203
- - Enable query caching for read-heavy workloads
204
- - Use InnoDB engine (ACID compliance)
205
- - Set appropriate charset (utf8mb4 for full Unicode)
206
- - Monitor slow query log
207
- - Use prepared statements for repeated queries
208
-
209
- ❌ **DON'T:**
210
- - Use string concatenation for queries (SQL injection risk)
211
- - Create too many connections (exhaust pool)
212
- - Skip error handling
213
- - Ignore connection pool limits
214
- - Use SELECT * in production (specify columns)
215
- - Skip indexes on foreign keys
216
- - Hardcode connection strings
217
- - Use MyISAM engine (no transactions)
218
- - Ignore query performance
219
- - Use synchronous queries
220
-
221
- ## Configuration
222
-
223
- ### Environment Variables
224
- ```bash
225
- DB_HOST=localhost
226
- DB_PORT=3306
227
- DB_NAME=myapp
228
- DB_USER=myuser
229
- DB_PASSWORD=securepassword
230
- DATABASE_URL=mysql://user:password@host:port/database
231
- ```
232
-
233
- ### Docker Compose
234
- ```yaml
235
- services:
236
- mysql:
237
- image: mysql:8.0
238
- environment:
239
- MYSQL_DATABASE: myapp
240
- MYSQL_USER: myuser
241
- MYSQL_PASSWORD: securepassword
242
- MYSQL_ROOT_PASSWORD: rootpassword
243
- ports:
244
- - "3306:3306"
245
- volumes:
246
- - mysql_data:/var/lib/mysql
247
- command: --default-authentication-plugin=mysql_native_password
248
- healthcheck:
249
- test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
250
- interval: 10s
251
- timeout: 5s
252
- retries: 5
253
-
254
- volumes:
255
- mysql_data:
256
- ```
257
-
258
- ### Prisma Schema
259
- ```prisma
260
- datasource db {
261
- provider = "mysql"
262
- url = env("DATABASE_URL")
263
- }
264
-
265
- model User {
266
- id Int @id @default(autoincrement())
267
- email String @unique @db.VarChar(255)
268
- name String? @db.VarChar(255)
269
- createdAt DateTime @default(now()) @db.Timestamp(6)
270
- posts Post[]
271
- }
272
-
273
- model Post {
274
- id Int @id @default(autoincrement())
275
- title String @db.VarChar(255)
276
- content String? @db.Text
277
- authorId Int
278
- author User @relation(fields: [authorId], references: [id])
279
- createdAt DateTime @default(now()) @db.Timestamp(6)
280
-
281
- @@index([authorId, createdAt(sort: Desc)])
282
- }
283
- ```
284
-
285
- ## Performance Optimization
286
-
287
- ### Indexing
288
- ```sql
289
- -- Single column index
290
- CREATE INDEX idx_users_email ON users(email);
291
-
292
- -- Composite index
293
- CREATE INDEX idx_posts_author_created ON posts(author_id, created_at DESC);
294
-
295
- -- Full-text index
296
- CREATE FULLTEXT INDEX idx_articles_content ON articles(title, content);
297
-
298
- -- Prefix index (for long strings)
299
- CREATE INDEX idx_users_name_prefix ON users(name(10));
300
- ```
301
-
302
- ### Query Optimization
303
- ```typescript
304
- // Use LIMIT for pagination
305
- const [rows] = await pool.execute(
306
- 'SELECT * FROM posts ORDER BY created_at DESC LIMIT ? OFFSET ?',
307
- [limit, offset]
308
- )
309
-
310
- // Use EXISTS instead of COUNT
311
- const [rows] = await pool.execute(
312
- 'SELECT EXISTS(SELECT 1 FROM users WHERE email = ?) as exists',
313
- [email]
314
- )
315
-
316
- // Use JOIN instead of subqueries when possible
317
- const [rows] = await pool.execute(`
318
- SELECT u.*, COUNT(p.id) as post_count
319
- FROM users u
320
- LEFT JOIN posts p ON u.id = p.author_id
321
- GROUP BY u.id
322
- `)
323
- ```
324
-
325
- ## Integration with Development
326
-
327
- ### Testing
328
- ```typescript
329
- // Use test database
330
- const testPool = mysql.createPool({
331
- database: 'myapp_test',
332
- // ... config
333
- })
334
-
335
- // Clean up after tests
336
- afterEach(async () => {
337
- await testPool.execute('SET FOREIGN_KEY_CHECKS = 0')
338
- await testPool.execute('TRUNCATE TABLE users')
339
- await testPool.execute('TRUNCATE TABLE posts')
340
- await testPool.execute('SET FOREIGN_KEY_CHECKS = 1')
341
- })
342
-
343
- // Use transactions for test isolation
344
- beforeEach(async () => {
345
- const connection = await testPool.getConnection()
346
- await connection.beginTransaction()
347
- // Store connection for rollback
348
- })
349
-
350
- afterEach(async () => {
351
- // Rollback transaction
352
- })
353
- ```
354
-
355
- ### Health Checks
356
- ```typescript
357
- async function checkDatabaseHealth(): Promise<boolean> {
358
- try {
359
- const [rows] = await pool.execute('SELECT 1 as health')
360
- return (rows as any[]).length > 0
361
- } catch {
362
- return false
363
- }
364
- }
365
- ```
366
-
367
- <!-- MYSQL:END -->
368
-
1
+ ---
2
+ name: "MySQL"
3
+ description: "Use MySQL for relational data storage with high performance, replication, and wide ecosystem support."
4
+ version: "1.0.0"
5
+ category: "services"
6
+ author: "Rulebook"
7
+ tags: ["services", "database"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- MYSQL:START -->
12
+ # MySQL Database Instructions
13
+
14
+ **CRITICAL**: Use MySQL for relational data storage with high performance, replication, and wide ecosystem support.
15
+
16
+ ## Core Features
17
+
18
+ ### Connection
19
+ ```typescript
20
+ // Using mysql2 (Node.js)
21
+ import mysql from 'mysql2/promise'
22
+
23
+ const pool = mysql.createPool({
24
+ host: process.env.DB_HOST,
25
+ port: parseInt(process.env.DB_PORT || '3306'),
26
+ database: process.env.DB_NAME,
27
+ user: process.env.DB_USER,
28
+ password: process.env.DB_PASSWORD,
29
+ waitForConnections: true,
30
+ connectionLimit: 10,
31
+ queueLimit: 0,
32
+ enableKeepAlive: true,
33
+ keepAliveInitialDelay: 0,
34
+ })
35
+
36
+ // Using Prisma
37
+ import { PrismaClient } from '@prisma/client'
38
+ const prisma = new PrismaClient()
39
+ ```
40
+
41
+ ### Basic Queries
42
+ ```typescript
43
+ // SELECT
44
+ const [rows] = await pool.execute('SELECT * FROM users WHERE id = ?', [userId])
45
+ const users = rows as User[]
46
+
47
+ // INSERT
48
+ const [result] = await pool.execute(
49
+ 'INSERT INTO users (name, email) VALUES (?, ?)',
50
+ ['John Doe', 'john@example.com']
51
+ )
52
+ const insertId = (result as any).insertId
53
+
54
+ // UPDATE
55
+ const [result] = await pool.execute(
56
+ 'UPDATE users SET name = ? WHERE id = ?',
57
+ ['Jane Doe', userId]
58
+ )
59
+ const affectedRows = (result as any).affectedRows
60
+
61
+ // DELETE
62
+ const [result] = await pool.execute('DELETE FROM users WHERE id = ?', [userId])
63
+ ```
64
+
65
+ ### Transactions
66
+ ```typescript
67
+ const connection = await pool.getConnection()
68
+ try {
69
+ await connection.beginTransaction()
70
+
71
+ await connection.execute('INSERT INTO accounts (user_id, balance) VALUES (?, ?)', [userId, 1000])
72
+ await connection.execute('INSERT INTO transactions (account_id, amount) VALUES (?, ?)', [accountId, 1000])
73
+
74
+ await connection.commit()
75
+ } catch (error) {
76
+ await connection.rollback()
77
+ throw error
78
+ } finally {
79
+ connection.release()
80
+ }
81
+ ```
82
+
83
+ ### Advanced Features
84
+ ```typescript
85
+ // JSON queries (MySQL 5.7+)
86
+ const [rows] = await pool.execute(
87
+ "SELECT * FROM products WHERE JSON_EXTRACT(metadata, '$.category') = ?",
88
+ ['electronics']
89
+ )
90
+
91
+ // Full-text search
92
+ const [rows] = await pool.execute(
93
+ "SELECT * FROM articles WHERE MATCH(title, content) AGAINST(? IN NATURAL LANGUAGE MODE)",
94
+ ['search term']
95
+ )
96
+
97
+ // Window functions (MySQL 8.0+)
98
+ const [rows] = await pool.execute(`
99
+ SELECT
100
+ name,
101
+ salary,
102
+ ROW_NUMBER() OVER (PARTITION BY department ORDER BY salary DESC) as rank
103
+ FROM employees
104
+ `)
105
+
106
+ // Common Table Expressions (CTE) (MySQL 8.0+)
107
+ const [rows] = await pool.execute(`
108
+ WITH RECURSIVE cte AS (
109
+ SELECT id, name, parent_id FROM categories WHERE parent_id IS NULL
110
+ UNION ALL
111
+ SELECT c.id, c.name, c.parent_id FROM categories c
112
+ INNER JOIN cte ON c.parent_id = cte.id
113
+ )
114
+ SELECT * FROM cte
115
+ `)
116
+ ```
117
+
118
+ ## Common Patterns
119
+
120
+ ### Connection Pooling
121
+ ```typescript
122
+ // Reuse connection pool
123
+ let pool: mysql.Pool | null = null
124
+
125
+ export function getPool(): mysql.Pool {
126
+ if (!pool) {
127
+ pool = mysql.createPool({
128
+ // ... config
129
+ })
130
+
131
+ pool.on('connection', (connection) => {
132
+ connection.query('SET SESSION sql_mode = "STRICT_TRANS_TABLES"')
133
+ })
134
+ }
135
+ return pool
136
+ }
137
+
138
+ // Graceful shutdown
139
+ process.on('SIGINT', async () => {
140
+ if (pool) {
141
+ await pool.end()
142
+ }
143
+ process.exit(0)
144
+ })
145
+ ```
146
+
147
+ ### Prepared Statements
148
+ ```typescript
149
+ // Always use parameterized queries (?) to prevent SQL injection
150
+ // ❌ WRONG
151
+ await pool.execute(`SELECT * FROM users WHERE email = '${email}'`)
152
+
153
+ // ✅ CORRECT
154
+ await pool.execute('SELECT * FROM users WHERE email = ?', [email])
155
+ ```
156
+
157
+ ### Error Handling
158
+ ```typescript
159
+ try {
160
+ const [rows] = await pool.execute('SELECT * FROM users WHERE id = ?', [userId])
161
+ if ((rows as any[]).length === 0) {
162
+ throw new Error('User not found')
163
+ }
164
+ return rows[0]
165
+ } catch (error: any) {
166
+ if (error.code === 'ER_DUP_ENTRY') {
167
+ throw new Error('Duplicate entry')
168
+ }
169
+ if (error.code === 'ER_NO_REFERENCED_ROW_2') {
170
+ throw new Error('Referenced record does not exist')
171
+ }
172
+ throw error
173
+ }
174
+ ```
175
+
176
+ ### Migrations
177
+ ```typescript
178
+ // Using db-migrate
179
+ import { migrate } from 'db-migrate'
180
+
181
+ await migrate({
182
+ config: {
183
+ dev: {
184
+ driver: 'mysql',
185
+ database: process.env.DB_NAME,
186
+ user: process.env.DB_USER,
187
+ password: process.env.DB_PASSWORD,
188
+ host: process.env.DB_HOST,
189
+ }
190
+ },
191
+ env: 'dev',
192
+ })
193
+ ```
194
+
195
+ ## Best Practices
196
+
197
+ ✅ **DO:**
198
+ - Use connection pooling (10-20 connections typically)
199
+ - Always use parameterized queries (? placeholders)
200
+ - Use transactions for multi-step operations
201
+ - Create indexes on frequently queried columns
202
+ - Use EXPLAIN to optimize queries
203
+ - Enable query caching for read-heavy workloads
204
+ - Use InnoDB engine (ACID compliance)
205
+ - Set appropriate charset (utf8mb4 for full Unicode)
206
+ - Monitor slow query log
207
+ - Use prepared statements for repeated queries
208
+
209
+ ❌ **DON'T:**
210
+ - Use string concatenation for queries (SQL injection risk)
211
+ - Create too many connections (exhaust pool)
212
+ - Skip error handling
213
+ - Ignore connection pool limits
214
+ - Use SELECT * in production (specify columns)
215
+ - Skip indexes on foreign keys
216
+ - Hardcode connection strings
217
+ - Use MyISAM engine (no transactions)
218
+ - Ignore query performance
219
+ - Use synchronous queries
220
+
221
+ ## Configuration
222
+
223
+ ### Environment Variables
224
+ ```bash
225
+ DB_HOST=localhost
226
+ DB_PORT=3306
227
+ DB_NAME=myapp
228
+ DB_USER=myuser
229
+ DB_PASSWORD=securepassword
230
+ DATABASE_URL=mysql://user:password@host:port/database
231
+ ```
232
+
233
+ ### Docker Compose
234
+ ```yaml
235
+ services:
236
+ mysql:
237
+ image: mysql:8.0
238
+ environment:
239
+ MYSQL_DATABASE: myapp
240
+ MYSQL_USER: myuser
241
+ MYSQL_PASSWORD: securepassword
242
+ MYSQL_ROOT_PASSWORD: rootpassword
243
+ ports:
244
+ - "3306:3306"
245
+ volumes:
246
+ - mysql_data:/var/lib/mysql
247
+ command: --default-authentication-plugin=mysql_native_password
248
+ healthcheck:
249
+ test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
250
+ interval: 10s
251
+ timeout: 5s
252
+ retries: 5
253
+
254
+ volumes:
255
+ mysql_data:
256
+ ```
257
+
258
+ ### Prisma Schema
259
+ ```prisma
260
+ datasource db {
261
+ provider = "mysql"
262
+ url = env("DATABASE_URL")
263
+ }
264
+
265
+ model User {
266
+ id Int @id @default(autoincrement())
267
+ email String @unique @db.VarChar(255)
268
+ name String? @db.VarChar(255)
269
+ createdAt DateTime @default(now()) @db.Timestamp(6)
270
+ posts Post[]
271
+ }
272
+
273
+ model Post {
274
+ id Int @id @default(autoincrement())
275
+ title String @db.VarChar(255)
276
+ content String? @db.Text
277
+ authorId Int
278
+ author User @relation(fields: [authorId], references: [id])
279
+ createdAt DateTime @default(now()) @db.Timestamp(6)
280
+
281
+ @@index([authorId, createdAt(sort: Desc)])
282
+ }
283
+ ```
284
+
285
+ ## Performance Optimization
286
+
287
+ ### Indexing
288
+ ```sql
289
+ -- Single column index
290
+ CREATE INDEX idx_users_email ON users(email);
291
+
292
+ -- Composite index
293
+ CREATE INDEX idx_posts_author_created ON posts(author_id, created_at DESC);
294
+
295
+ -- Full-text index
296
+ CREATE FULLTEXT INDEX idx_articles_content ON articles(title, content);
297
+
298
+ -- Prefix index (for long strings)
299
+ CREATE INDEX idx_users_name_prefix ON users(name(10));
300
+ ```
301
+
302
+ ### Query Optimization
303
+ ```typescript
304
+ // Use LIMIT for pagination
305
+ const [rows] = await pool.execute(
306
+ 'SELECT * FROM posts ORDER BY created_at DESC LIMIT ? OFFSET ?',
307
+ [limit, offset]
308
+ )
309
+
310
+ // Use EXISTS instead of COUNT
311
+ const [rows] = await pool.execute(
312
+ 'SELECT EXISTS(SELECT 1 FROM users WHERE email = ?) as exists',
313
+ [email]
314
+ )
315
+
316
+ // Use JOIN instead of subqueries when possible
317
+ const [rows] = await pool.execute(`
318
+ SELECT u.*, COUNT(p.id) as post_count
319
+ FROM users u
320
+ LEFT JOIN posts p ON u.id = p.author_id
321
+ GROUP BY u.id
322
+ `)
323
+ ```
324
+
325
+ ## Integration with Development
326
+
327
+ ### Testing
328
+ ```typescript
329
+ // Use test database
330
+ const testPool = mysql.createPool({
331
+ database: 'myapp_test',
332
+ // ... config
333
+ })
334
+
335
+ // Clean up after tests
336
+ afterEach(async () => {
337
+ await testPool.execute('SET FOREIGN_KEY_CHECKS = 0')
338
+ await testPool.execute('TRUNCATE TABLE users')
339
+ await testPool.execute('TRUNCATE TABLE posts')
340
+ await testPool.execute('SET FOREIGN_KEY_CHECKS = 1')
341
+ })
342
+
343
+ // Use transactions for test isolation
344
+ beforeEach(async () => {
345
+ const connection = await testPool.getConnection()
346
+ await connection.beginTransaction()
347
+ // Store connection for rollback
348
+ })
349
+
350
+ afterEach(async () => {
351
+ // Rollback transaction
352
+ })
353
+ ```
354
+
355
+ ### Health Checks
356
+ ```typescript
357
+ async function checkDatabaseHealth(): Promise<boolean> {
358
+ try {
359
+ const [rows] = await pool.execute('SELECT 1 as health')
360
+ return (rows as any[]).length > 0
361
+ } catch {
362
+ return false
363
+ }
364
+ }
365
+ ```
366
+
367
+ <!-- MYSQL:END -->
368
+