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