@hivehub/rulebook 5.5.1 → 5.7.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 (342) hide show
  1. package/.claude/commands/rulebook-learn-capture.md +41 -48
  2. package/.claude/commands/rulebook-learn-list.md +13 -13
  3. package/README.md +332 -394
  4. package/dist/cli/commands/context-intelligence.d.ts +0 -1
  5. package/dist/cli/commands/context-intelligence.d.ts.map +1 -1
  6. package/dist/cli/commands/context-intelligence.js +12 -33
  7. package/dist/cli/commands/context-intelligence.js.map +1 -1
  8. package/dist/cli/commands/index.d.ts +4 -7
  9. package/dist/cli/commands/index.d.ts.map +1 -1
  10. package/dist/cli/commands/index.js +4 -7
  11. package/dist/cli/commands/index.js.map +1 -1
  12. package/dist/cli/commands/init.d.ts.map +1 -1
  13. package/dist/cli/commands/init.js +40 -81
  14. package/dist/cli/commands/init.js.map +1 -1
  15. package/dist/cli/commands/mcp.d.ts +0 -1
  16. package/dist/cli/commands/mcp.d.ts.map +1 -1
  17. package/dist/cli/commands/mcp.js +1 -7
  18. package/dist/cli/commands/mcp.js.map +1 -1
  19. package/dist/cli/commands/memory.d.ts +7 -1
  20. package/dist/cli/commands/memory.d.ts.map +1 -1
  21. package/dist/cli/commands/memory.js +51 -57
  22. package/dist/cli/commands/memory.js.map +1 -1
  23. package/dist/cli/commands/misc.d.ts +1 -15
  24. package/dist/cli/commands/misc.d.ts.map +1 -1
  25. package/dist/cli/commands/misc.js +36 -215
  26. package/dist/cli/commands/misc.js.map +1 -1
  27. package/dist/cli/commands/plans.d.ts +0 -6
  28. package/dist/cli/commands/plans.d.ts.map +1 -1
  29. package/dist/cli/commands/plans.js +9 -77
  30. package/dist/cli/commands/plans.js.map +1 -1
  31. package/dist/cli/commands/skills.js +6 -6
  32. package/dist/cli/commands/skills.js.map +1 -1
  33. package/dist/cli/commands/task.js +4 -4
  34. package/dist/cli/commands/task.js.map +1 -1
  35. package/dist/cli/commands/update.d.ts.map +1 -1
  36. package/dist/cli/commands/update.js +122 -52
  37. package/dist/cli/commands/update.js.map +1 -1
  38. package/dist/cli/prompts.d.ts.map +1 -1
  39. package/dist/cli/prompts.js +1 -78
  40. package/dist/cli/prompts.js.map +1 -1
  41. package/dist/core/claude/claude-mcp.d.ts +59 -0
  42. package/dist/core/claude/claude-mcp.d.ts.map +1 -0
  43. package/dist/core/claude/claude-mcp.js +220 -0
  44. package/dist/core/claude/claude-mcp.js.map +1 -0
  45. package/dist/core/claude/claude-md-generator.d.ts +52 -0
  46. package/dist/core/claude/claude-md-generator.d.ts.map +1 -0
  47. package/dist/core/claude/claude-md-generator.js +104 -0
  48. package/dist/core/claude/claude-md-generator.js.map +1 -0
  49. package/dist/core/claude/claude-settings-manager.d.ts +44 -0
  50. package/dist/core/claude/claude-settings-manager.d.ts.map +1 -0
  51. package/dist/core/claude/claude-settings-manager.js +194 -0
  52. package/dist/core/claude/claude-settings-manager.js.map +1 -0
  53. package/dist/core/claude-settings-manager.d.ts.map +1 -1
  54. package/dist/core/claude-settings-manager.js +9 -3
  55. package/dist/core/claude-settings-manager.js.map +1 -1
  56. package/dist/core/console/cli-bridge.d.ts +113 -0
  57. package/dist/core/console/cli-bridge.d.ts.map +1 -0
  58. package/dist/core/console/cli-bridge.js +1094 -0
  59. package/dist/core/console/cli-bridge.js.map +1 -0
  60. package/dist/core/detect/detector.d.ts +35 -0
  61. package/dist/core/detect/detector.d.ts.map +1 -0
  62. package/dist/core/detect/detector.js +541 -0
  63. package/dist/core/detect/detector.js.map +1 -0
  64. package/dist/core/docs/docs-generator.d.ts +9 -0
  65. package/dist/core/docs/docs-generator.d.ts.map +1 -0
  66. package/dist/core/docs/docs-generator.js +531 -0
  67. package/dist/core/docs/docs-generator.js.map +1 -0
  68. package/dist/core/docs/mcp-reference-generator.d.ts +13 -0
  69. package/dist/core/docs/mcp-reference-generator.d.ts.map +1 -0
  70. package/dist/core/docs/mcp-reference-generator.js +66 -0
  71. package/dist/core/docs/mcp-reference-generator.js.map +1 -0
  72. package/dist/core/generators/generator.d.ts +54 -0
  73. package/dist/core/generators/generator.d.ts.map +1 -0
  74. package/dist/core/generators/generator.js +1041 -0
  75. package/dist/core/generators/generator.js.map +1 -0
  76. package/dist/core/generators/gitignore-generator.d.ts +13 -0
  77. package/dist/core/generators/gitignore-generator.d.ts.map +1 -0
  78. package/dist/core/generators/gitignore-generator.js +307 -0
  79. package/dist/core/generators/gitignore-generator.js.map +1 -0
  80. package/dist/core/generators/minimal-scaffolder.d.ts +8 -0
  81. package/dist/core/generators/minimal-scaffolder.d.ts.map +1 -0
  82. package/dist/core/generators/minimal-scaffolder.js +51 -0
  83. package/dist/core/generators/minimal-scaffolder.js.map +1 -0
  84. package/dist/core/generators/rules-generator.d.ts +73 -0
  85. package/dist/core/generators/rules-generator.d.ts.map +1 -0
  86. package/dist/core/generators/rules-generator.js +202 -0
  87. package/dist/core/generators/rules-generator.js.map +1 -0
  88. package/dist/core/generators/workflow-generator.d.ts +15 -0
  89. package/dist/core/generators/workflow-generator.d.ts.map +1 -0
  90. package/dist/core/generators/workflow-generator.js +390 -0
  91. package/dist/core/generators/workflow-generator.js.map +1 -0
  92. package/dist/core/ide/multi-tool-generator.d.ts +59 -0
  93. package/dist/core/ide/multi-tool-generator.d.ts.map +1 -0
  94. package/dist/core/ide/multi-tool-generator.js +157 -0
  95. package/dist/core/ide/multi-tool-generator.js.map +1 -0
  96. package/dist/core/ide/opencode-generator.d.ts +72 -0
  97. package/dist/core/ide/opencode-generator.d.ts.map +1 -0
  98. package/dist/core/ide/opencode-generator.js +450 -0
  99. package/dist/core/ide/opencode-generator.js.map +1 -0
  100. package/dist/core/merger.d.ts +1 -1
  101. package/dist/core/merger.d.ts.map +1 -1
  102. package/dist/core/merger.js +5 -5
  103. package/dist/core/merger.js.map +1 -1
  104. package/dist/core/migrator.d.ts +0 -1
  105. package/dist/core/migrator.d.ts.map +1 -1
  106. package/dist/core/migrator.js +4 -29
  107. package/dist/core/migrator.js.map +1 -1
  108. package/dist/core/quality/coverage-checker.d.ts +14 -0
  109. package/dist/core/quality/coverage-checker.d.ts.map +1 -0
  110. package/dist/core/quality/coverage-checker.js +176 -0
  111. package/dist/core/quality/coverage-checker.js.map +1 -0
  112. package/dist/core/quality/dependency-checker.d.ts +21 -0
  113. package/dist/core/quality/dependency-checker.d.ts.map +1 -0
  114. package/dist/core/quality/dependency-checker.js +247 -0
  115. package/dist/core/quality/dependency-checker.js.map +1 -0
  116. package/dist/core/quality/doctor.d.ts +19 -0
  117. package/dist/core/quality/doctor.d.ts.map +1 -0
  118. package/dist/core/quality/doctor.js +163 -0
  119. package/dist/core/quality/doctor.js.map +1 -0
  120. package/dist/core/quality/validator.d.ts +21 -0
  121. package/dist/core/quality/validator.d.ts.map +1 -0
  122. package/dist/core/quality/validator.js +177 -0
  123. package/dist/core/quality/validator.js.map +1 -0
  124. package/dist/core/ralph-scripts.d.ts.map +1 -1
  125. package/dist/core/ralph-scripts.js +7 -6
  126. package/dist/core/ralph-scripts.js.map +1 -1
  127. package/dist/core/skills/skills-manager.d.ts +126 -0
  128. package/dist/core/skills/skills-manager.d.ts.map +1 -0
  129. package/dist/core/skills/skills-manager.js +630 -0
  130. package/dist/core/skills/skills-manager.js.map +1 -0
  131. package/dist/core/state/config-manager.d.ts +86 -0
  132. package/dist/core/state/config-manager.d.ts.map +1 -0
  133. package/dist/core/state/config-manager.js +562 -0
  134. package/dist/core/state/config-manager.js.map +1 -0
  135. package/dist/core/state/override-manager.d.ts +23 -0
  136. package/dist/core/state/override-manager.d.ts.map +1 -0
  137. package/dist/core/state/override-manager.js +82 -0
  138. package/dist/core/state/override-manager.js.map +1 -0
  139. package/dist/core/state/state-writer.d.ts +34 -0
  140. package/dist/core/state/state-writer.d.ts.map +1 -0
  141. package/dist/core/state/state-writer.js +78 -0
  142. package/dist/core/state/state-writer.js.map +1 -0
  143. package/dist/core/state/version-bumper.d.ts +19 -0
  144. package/dist/core/state/version-bumper.d.ts.map +1 -0
  145. package/dist/core/state/version-bumper.js +180 -0
  146. package/dist/core/state/version-bumper.js.map +1 -0
  147. package/dist/core/tasks/decision-manager.d.ts +25 -0
  148. package/dist/core/tasks/decision-manager.d.ts.map +1 -0
  149. package/dist/core/tasks/decision-manager.js +183 -0
  150. package/dist/core/tasks/decision-manager.js.map +1 -0
  151. package/dist/core/tasks/knowledge-manager.d.ts +24 -0
  152. package/dist/core/tasks/knowledge-manager.d.ts.map +1 -0
  153. package/dist/core/tasks/knowledge-manager.js +173 -0
  154. package/dist/core/tasks/knowledge-manager.js.map +1 -0
  155. package/dist/core/tasks/learn-manager.d.ts +27 -0
  156. package/dist/core/tasks/learn-manager.d.ts.map +1 -0
  157. package/dist/core/tasks/learn-manager.js +121 -0
  158. package/dist/core/tasks/learn-manager.js.map +1 -0
  159. package/dist/core/tasks/plans-manager.d.ts +46 -0
  160. package/dist/core/tasks/plans-manager.d.ts.map +1 -0
  161. package/dist/core/tasks/plans-manager.js +158 -0
  162. package/dist/core/tasks/plans-manager.js.map +1 -0
  163. package/dist/core/tasks/task-manager.d.ts +127 -0
  164. package/dist/core/tasks/task-manager.d.ts.map +1 -0
  165. package/dist/core/tasks/task-manager.js +607 -0
  166. package/dist/core/tasks/task-manager.js.map +1 -0
  167. package/dist/core/workspace/project-worker.d.ts +6 -6
  168. package/dist/core/workspace/project-worker.d.ts.map +1 -1
  169. package/dist/core/workspace/project-worker.js +6 -6
  170. package/dist/core/workspace/project-worker.js.map +1 -1
  171. package/dist/index.d.ts +1 -1
  172. package/dist/index.d.ts.map +1 -1
  173. package/dist/index.js +19 -176
  174. package/dist/index.js.map +1 -1
  175. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  176. package/dist/mcp/rulebook-server.js +16 -960
  177. package/dist/mcp/rulebook-server.js.map +1 -1
  178. package/dist/memory/file-search.d.ts +43 -0
  179. package/dist/memory/file-search.d.ts.map +1 -0
  180. package/dist/memory/file-search.js +228 -0
  181. package/dist/memory/file-search.js.map +1 -0
  182. package/dist/memory/file-store.d.ts +99 -0
  183. package/dist/memory/file-store.d.ts.map +1 -0
  184. package/dist/memory/file-store.js +615 -0
  185. package/dist/memory/file-store.js.map +1 -0
  186. package/dist/memory/legacy-migrator.d.ts +27 -0
  187. package/dist/memory/legacy-migrator.d.ts.map +1 -0
  188. package/dist/memory/legacy-migrator.js +185 -0
  189. package/dist/memory/legacy-migrator.js.map +1 -0
  190. package/dist/memory/memory-manager.d.ts +25 -24
  191. package/dist/memory/memory-manager.d.ts.map +1 -1
  192. package/dist/memory/memory-manager.js +97 -140
  193. package/dist/memory/memory-manager.js.map +1 -1
  194. package/dist/memory/memory-types.d.ts +1 -1
  195. package/dist/memory/memory-types.d.ts.map +1 -1
  196. package/dist/types.d.ts +8 -119
  197. package/dist/types.d.ts.map +1 -1
  198. package/dist/utils/file-system.d.ts +22 -0
  199. package/dist/utils/file-system.d.ts.map +1 -1
  200. package/dist/utils/file-system.js +31 -0
  201. package/dist/utils/file-system.js.map +1 -1
  202. package/dist/utils/git-hooks.d.ts.map +1 -1
  203. package/dist/utils/git-hooks.js +3 -2
  204. package/dist/utils/git-hooks.js.map +1 -1
  205. package/package.json +2 -6
  206. package/templates/agents/context-intelligence.md +50 -52
  207. package/templates/cli/OPENCODE.md +85 -18
  208. package/templates/commands/rulebook-learn-capture.md +41 -48
  209. package/templates/commands/rulebook-learn-list.md +13 -13
  210. package/templates/core/AGENTS_LEAN.md +0 -14
  211. package/templates/hooks/check-context-and-handoff.sh +74 -76
  212. package/templates/hooks/enforce-pre-tool.sh +70 -0
  213. package/templates/hooks/enforce-team-for-background-agents.sh +55 -55
  214. package/templates/hooks/on-compact-reinject.sh +34 -34
  215. package/templates/hooks/resume-from-handoff.sh +61 -61
  216. package/templates/hooks/terse-activate.sh +197 -197
  217. package/templates/hooks/terse-mode-tracker.sh +190 -187
  218. package/templates/ides/OPENCODE.md +63 -0
  219. package/templates/skills/cli/opencode/SKILL.md +82 -28
  220. package/.claude/commands/ralph-config.md +0 -112
  221. package/.claude/commands/ralph-history.md +0 -110
  222. package/.claude/commands/ralph-init.md +0 -72
  223. package/.claude/commands/ralph-pause-resume.md +0 -105
  224. package/.claude/commands/ralph-run.md +0 -101
  225. package/.claude/commands/ralph-status.md +0 -76
  226. package/templates/core/RALPH.md +0 -471
  227. package/templates/frameworks/ANGULAR.md +0 -36
  228. package/templates/frameworks/DJANGO.md +0 -83
  229. package/templates/frameworks/ELECTRON.md +0 -147
  230. package/templates/frameworks/FLASK.md +0 -38
  231. package/templates/frameworks/FLUTTER.md +0 -55
  232. package/templates/frameworks/JQUERY.md +0 -32
  233. package/templates/frameworks/LARAVEL.md +0 -38
  234. package/templates/frameworks/NESTJS.md +0 -43
  235. package/templates/frameworks/NEXTJS.md +0 -127
  236. package/templates/frameworks/NUXT.md +0 -40
  237. package/templates/frameworks/RAILS.md +0 -66
  238. package/templates/frameworks/REACT.md +0 -38
  239. package/templates/frameworks/REACT_NATIVE.md +0 -47
  240. package/templates/frameworks/SPRING.md +0 -39
  241. package/templates/frameworks/SYMFONY.md +0 -36
  242. package/templates/frameworks/VUE.md +0 -36
  243. package/templates/frameworks/ZEND.md +0 -35
  244. package/templates/hooks/enforce-mcp-for-tasks.sh +0 -31
  245. package/templates/hooks/enforce-no-deferred.sh +0 -21
  246. package/templates/hooks/enforce-no-shortcuts.sh +0 -31
  247. package/templates/ides/COPILOT.md +0 -37
  248. package/templates/ides/CURSOR.md +0 -43
  249. package/templates/ides/JETBRAINS_AI.md +0 -35
  250. package/templates/ides/REPLIT.md +0 -36
  251. package/templates/ides/TABNINE.md +0 -29
  252. package/templates/ides/VSCODE.md +0 -40
  253. package/templates/ides/WINDSURF.md +0 -36
  254. package/templates/ides/ZED.md +0 -32
  255. package/templates/ides/cursor-mdc/go.mdc +0 -24
  256. package/templates/ides/cursor-mdc/python.mdc +0 -24
  257. package/templates/ides/cursor-mdc/quality.mdc +0 -25
  258. package/templates/ides/cursor-mdc/ralph.mdc +0 -39
  259. package/templates/ides/cursor-mdc/rulebook.mdc +0 -38
  260. package/templates/ides/cursor-mdc/rust.mdc +0 -24
  261. package/templates/ides/cursor-mdc/typescript.mdc +0 -25
  262. package/templates/ralph/ralph-history.bat +0 -4
  263. package/templates/ralph/ralph-history.sh +0 -5
  264. package/templates/ralph/ralph-init.bat +0 -5
  265. package/templates/ralph/ralph-init.sh +0 -5
  266. package/templates/ralph/ralph-pause.bat +0 -5
  267. package/templates/ralph/ralph-pause.sh +0 -5
  268. package/templates/ralph/ralph-run.bat +0 -5
  269. package/templates/ralph/ralph-run.sh +0 -5
  270. package/templates/ralph/ralph-status.bat +0 -4
  271. package/templates/ralph/ralph-status.sh +0 -5
  272. package/templates/services/AZURE_BLOB.md +0 -184
  273. package/templates/services/CASSANDRA.md +0 -239
  274. package/templates/services/DATADOG.md +0 -26
  275. package/templates/services/DOCKER.md +0 -124
  276. package/templates/services/DOCKER_COMPOSE.md +0 -168
  277. package/templates/services/DYNAMODB.md +0 -308
  278. package/templates/services/ELASTICSEARCH.md +0 -347
  279. package/templates/services/GCS.md +0 -178
  280. package/templates/services/HELM.md +0 -194
  281. package/templates/services/INFLUXDB.md +0 -265
  282. package/templates/services/KAFKA.md +0 -341
  283. package/templates/services/KUBERNETES.md +0 -208
  284. package/templates/services/MARIADB.md +0 -183
  285. package/templates/services/MEMCACHED.md +0 -242
  286. package/templates/services/MINIO.md +0 -201
  287. package/templates/services/MONGODB.md +0 -268
  288. package/templates/services/MYSQL.md +0 -358
  289. package/templates/services/NEO4J.md +0 -247
  290. package/templates/services/OPENTELEMETRY.md +0 -25
  291. package/templates/services/ORACLE.md +0 -290
  292. package/templates/services/PINO.md +0 -24
  293. package/templates/services/POSTGRESQL.md +0 -326
  294. package/templates/services/PROMETHEUS.md +0 -33
  295. package/templates/services/RABBITMQ.md +0 -286
  296. package/templates/services/REDIS.md +0 -292
  297. package/templates/services/S3.md +0 -298
  298. package/templates/services/SENTRY.md +0 -23
  299. package/templates/services/SQLITE.md +0 -294
  300. package/templates/services/SQLSERVER.md +0 -294
  301. package/templates/services/WINSTON.md +0 -30
  302. package/templates/skills/frameworks/angular/SKILL.md +0 -46
  303. package/templates/skills/frameworks/django/SKILL.md +0 -93
  304. package/templates/skills/frameworks/electron/SKILL.md +0 -157
  305. package/templates/skills/frameworks/flask/SKILL.md +0 -48
  306. package/templates/skills/frameworks/flutter/SKILL.md +0 -65
  307. package/templates/skills/frameworks/jquery/SKILL.md +0 -42
  308. package/templates/skills/frameworks/laravel/SKILL.md +0 -48
  309. package/templates/skills/frameworks/nestjs/SKILL.md +0 -53
  310. package/templates/skills/frameworks/nextjs/SKILL.md +0 -137
  311. package/templates/skills/frameworks/nuxt/SKILL.md +0 -50
  312. package/templates/skills/frameworks/rails/SKILL.md +0 -76
  313. package/templates/skills/frameworks/react/SKILL.md +0 -48
  314. package/templates/skills/frameworks/react-native/SKILL.md +0 -57
  315. package/templates/skills/frameworks/spring/SKILL.md +0 -49
  316. package/templates/skills/frameworks/symfony/SKILL.md +0 -46
  317. package/templates/skills/frameworks/vue/SKILL.md +0 -46
  318. package/templates/skills/frameworks/zend/SKILL.md +0 -45
  319. package/templates/skills/services/azure-blob/SKILL.md +0 -194
  320. package/templates/skills/services/cassandra/SKILL.md +0 -249
  321. package/templates/skills/services/dynamodb/SKILL.md +0 -318
  322. package/templates/skills/services/elasticsearch/SKILL.md +0 -357
  323. package/templates/skills/services/gcs/SKILL.md +0 -188
  324. package/templates/skills/services/influxdb/SKILL.md +0 -275
  325. package/templates/skills/services/kafka/SKILL.md +0 -351
  326. package/templates/skills/services/mariadb/SKILL.md +0 -193
  327. package/templates/skills/services/memcached/SKILL.md +0 -252
  328. package/templates/skills/services/minio/SKILL.md +0 -211
  329. package/templates/skills/services/mongodb/SKILL.md +0 -278
  330. package/templates/skills/services/mysql/SKILL.md +0 -368
  331. package/templates/skills/services/neo4j/SKILL.md +0 -257
  332. package/templates/skills/services/oracle/SKILL.md +0 -300
  333. package/templates/skills/services/postgresql/SKILL.md +0 -336
  334. package/templates/skills/services/rabbitmq/SKILL.md +0 -296
  335. package/templates/skills/services/redis/SKILL.md +0 -302
  336. package/templates/skills/services/s3/SKILL.md +0 -308
  337. package/templates/skills/services/sqlite/SKILL.md +0 -304
  338. package/templates/skills/services/sqlserver/SKILL.md +0 -304
  339. package/templates/skills/workflows/ralph/SETUP.md +0 -228
  340. package/templates/skills/workflows/ralph/SKILL.md +0 -309
  341. package/templates/skills/workflows/ralph/install.sh +0 -87
  342. package/templates/skills/workflows/ralph/manifest.json +0 -158
@@ -1,257 +0,0 @@
1
- ---
2
- name: "Neo4j"
3
- description: "Use Neo4j for graph data modeling, relationship traversal, and complex connected data queries."
4
- version: "1.0.0"
5
- category: "services"
6
- author: "Rulebook"
7
- tags: ["services", "database"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- NEO4J:START -->
12
- # Neo4j Graph Database Instructions
13
-
14
- **CRITICAL**: Use Neo4j for graph data modeling, relationship traversal, and complex connected data queries.
15
-
16
- ## Core Features
17
-
18
- ### Connection
19
- ```typescript
20
- // Using neo4j-driver
21
- import neo4j from 'neo4j-driver'
22
-
23
- const driver = neo4j.driver(
24
- process.env.NEO4J_URI || 'bolt://localhost:7687',
25
- neo4j.auth.basic(
26
- process.env.NEO4J_USER || 'neo4j',
27
- process.env.NEO4J_PASSWORD || 'password'
28
- ),
29
- {
30
- maxConnectionLifetime: 3 * 60 * 60 * 1000, // 3 hours
31
- maxConnectionPoolSize: 50,
32
- connectionAcquisitionTimeout: 2 * 60 * 1000, // 2 minutes
33
- }
34
- )
35
-
36
- const session = driver.session()
37
- ```
38
-
39
- ### Basic Operations
40
- ```typescript
41
- // Create node
42
- const result = await session.run(
43
- 'CREATE (u:User {id: $id, name: $name, email: $email}) RETURN u',
44
- { id: '1', name: 'John Doe', email: 'john@example.com' }
45
- )
46
-
47
- // Create relationship
48
- await session.run(
49
- 'MATCH (u:User {id: $userId}), (p:Post {id: $postId}) CREATE (u)-[:CREATED]->(p)',
50
- { userId: '1', postId: '1' }
51
- )
52
-
53
- // Find nodes
54
- const result = await session.run(
55
- 'MATCH (u:User {email: $email}) RETURN u',
56
- { email: 'john@example.com' }
57
- )
58
- const user = result.records[0]?.get('u')
59
-
60
- // Update node
61
- await session.run(
62
- 'MATCH (u:User {id: $id}) SET u.name = $name, u.updatedAt = $updatedAt',
63
- { id: '1', name: 'Jane Doe', updatedAt: new Date().toISOString() }
64
- )
65
-
66
- // Delete node and relationships
67
- await session.run(
68
- 'MATCH (u:User {id: $id}) DETACH DELETE u',
69
- { id: '1' }
70
- )
71
- ```
72
-
73
- ### Advanced Queries
74
- ```typescript
75
- // Find relationships
76
- const result = await session.run(`
77
- MATCH (u:User)-[r:FOLLOWS]->(f:User)
78
- WHERE u.id = $userId
79
- RETURN f, r.createdAt
80
- ORDER BY r.createdAt DESC
81
- LIMIT 10
82
- `, { userId: '1' })
83
-
84
- // Shortest path
85
- const result = await session.run(`
86
- MATCH path = shortestPath(
87
- (start:User {id: $startId})-[*]-(end:User {id: $endId})
88
- )
89
- RETURN path, length(path) as distance
90
- `, { startId: '1', endId: '2' })
91
-
92
- // Pattern matching
93
- const result = await session.run(`
94
- MATCH (u:User)-[:CREATED]->(p:Post)-[:TAGGED_WITH]->(t:Tag)
95
- WHERE t.name = $tagName
96
- RETURN u, count(p) as postCount
97
- ORDER BY postCount DESC
98
- `, { tagName: 'javascript' })
99
-
100
- // Aggregations
101
- const result = await session.run(`
102
- MATCH (u:User)-[:FOLLOWS]->(f:User)
103
- RETURN u.id, count(f) as followerCount
104
- ORDER BY followerCount DESC
105
- LIMIT 10
106
- `)
107
- ```
108
-
109
- ## Common Patterns
110
-
111
- ### User Recommendations
112
- ```typescript
113
- async function getRecommendedUsers(userId: string) {
114
- const result = await session.run(`
115
- MATCH (u:User {id: $userId})-[:FOLLOWS]->(f:User)-[:FOLLOWS]->(recommended:User)
116
- WHERE NOT (u)-[:FOLLOWS]->(recommended) AND u <> recommended
117
- RETURN recommended, count(recommended) as mutualFollowers
118
- ORDER BY mutualFollowers DESC
119
- LIMIT 10
120
- `, { userId })
121
-
122
- return result.records.map(record => ({
123
- user: record.get('recommended').properties,
124
- score: record.get('mutualFollowers').toNumber(),
125
- }))
126
- }
127
- ```
128
-
129
- ### Graph Traversal
130
- ```typescript
131
- async function findConnections(userId: string, depth: number) {
132
- const result = await session.run(`
133
- MATCH path = (start:User {id: $userId})-[*1..${depth}]-(connected:User)
134
- RETURN connected, length(path) as distance
135
- ORDER BY distance
136
- `, { userId })
137
-
138
- return result.records.map(record => ({
139
- user: record.get('connected').properties,
140
- distance: record.get('distance').toNumber(),
141
- }))
142
- }
143
- ```
144
-
145
- ### Transaction
146
- ```typescript
147
- const session = driver.session()
148
- const tx = session.beginTransaction()
149
-
150
- try {
151
- await tx.run('CREATE (u:User {id: $id, name: $name})', { id: '1', name: 'John' })
152
- await tx.run('CREATE (p:Post {id: $id, title: $title})', { id: '1', title: 'Post 1' })
153
- await tx.run(
154
- 'MATCH (u:User {id: $userId}), (p:Post {id: $postId}) CREATE (u)-[:CREATED]->(p)',
155
- { userId: '1', postId: '1' }
156
- )
157
- await tx.commit()
158
- } catch (error) {
159
- await tx.rollback()
160
- throw error
161
- } finally {
162
- await session.close()
163
- }
164
- ```
165
-
166
- ## Best Practices
167
-
168
- ✅ **DO:**
169
- - Use parameterized queries ($param)
170
- - Create indexes on frequently queried properties
171
- - Use appropriate relationship types
172
- - Batch operations when possible
173
- - Close sessions after use
174
- - Use transactions for multi-step operations
175
- - Monitor query performance
176
- - Use appropriate data types
177
- - Implement connection pooling
178
- - Use labels effectively
179
-
180
- ❌ **DON'T:**
181
- - Use string concatenation for queries (injection risk)
182
- - Create too many relationships per node
183
- - Skip error handling
184
- - Ignore query performance
185
- - Hardcode connection strings
186
- - Store large properties (use external storage)
187
- - Skip indexes on lookup properties
188
- - Ignore transaction boundaries
189
- - Use synchronous operations
190
- - Store sensitive data without encryption
191
-
192
- ## Configuration
193
-
194
- ### Environment Variables
195
- ```bash
196
- NEO4J_URI=bolt://localhost:7687
197
- NEO4J_URI=neo4j+s://cluster.example.com:7687 # SSL
198
- NEO4J_USER=neo4j
199
- NEO4J_PASSWORD=securepassword
200
- ```
201
-
202
- ### Docker Compose
203
- ```yaml
204
- services:
205
- neo4j:
206
- image: neo4j:5
207
- ports:
208
- - "7474:7474" # HTTP
209
- - "7687:7687" # Bolt
210
- environment:
211
- NEO4J_AUTH: neo4j/securepassword
212
- NEO4J_PLUGINS: '["apoc"]'
213
- volumes:
214
- - neo4j_data:/data
215
- - neo4j_logs:/logs
216
- healthcheck:
217
- test: ["CMD", "cypher-shell", "-u", "neo4j", "-p", "securepassword", "RETURN 1"]
218
- interval: 10s
219
- timeout: 5s
220
- retries: 5
221
-
222
- volumes:
223
- neo4j_data:
224
- neo4j_logs:
225
- ```
226
-
227
- ## Integration with Development
228
-
229
- ### Testing
230
- ```typescript
231
- // Use test database
232
- const testDriver = neo4j.driver('bolt://localhost:7688', neo4j.auth.basic('neo4j', 'test'))
233
-
234
- // Clean up after tests
235
- afterEach(async () => {
236
- const session = testDriver.session()
237
- await session.run('MATCH (n) DETACH DELETE n')
238
- await session.close()
239
- })
240
- ```
241
-
242
- ### Health Checks
243
- ```typescript
244
- async function checkNeo4jHealth(): Promise<boolean> {
245
- try {
246
- const session = driver.session()
247
- const result = await session.run('RETURN 1 as health')
248
- await session.close()
249
- return result.records.length > 0
250
- } catch {
251
- return false
252
- }
253
- }
254
- ```
255
-
256
- <!-- NEO4J:END -->
257
-
@@ -1,300 +0,0 @@
1
- ---
2
- name: "Oracle"
3
- description: "Use Oracle Database for enterprise relational data storage with advanced features, high availability, and comprehensive tooling."
4
- version: "1.0.0"
5
- category: "services"
6
- author: "Rulebook"
7
- tags: ["services", "database"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- ORACLE:START -->
12
- # Oracle Database Instructions
13
-
14
- **CRITICAL**: Use Oracle Database for enterprise relational data storage with advanced features, high availability, and comprehensive tooling.
15
-
16
- ## Core Features
17
-
18
- ### Connection
19
- ```typescript
20
- // Using oracledb
21
- import oracledb from 'oracledb'
22
-
23
- oracledb.outFormat = oracledb.OUT_FORMAT_OBJECT
24
- oracledb.autoCommit = false
25
-
26
- const connection = await oracledb.getConnection({
27
- user: process.env.DB_USER || 'system',
28
- password: process.env.DB_PASSWORD,
29
- connectString: `${process.env.DB_HOST || 'localhost'}:${process.env.DB_PORT || '1521'}/${process.env.DB_SERVICE || 'XE'}`,
30
- })
31
-
32
- // Connection pool
33
- const pool = await oracledb.createPool({
34
- user: process.env.DB_USER,
35
- password: process.env.DB_PASSWORD,
36
- connectString: `${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_SERVICE}`,
37
- poolMin: 2,
38
- poolMax: 10,
39
- poolIncrement: 1,
40
- poolTimeout: 60,
41
- })
42
- ```
43
-
44
- ### Basic Queries
45
- ```typescript
46
- // SELECT
47
- const result = await connection.execute(
48
- 'SELECT * FROM Users WHERE Id = :id',
49
- { id: userId }
50
- )
51
- const users = result.rows
52
-
53
- // INSERT with RETURNING
54
- const result = await connection.execute(
55
- `INSERT INTO Users (Name, Email)
56
- VALUES (:name, :email)
57
- RETURNING Id INTO :id`,
58
- {
59
- name: 'John Doe',
60
- email: 'john@example.com',
61
- id: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
62
- }
63
- )
64
- const newId = result.outBinds.id[0]
65
-
66
- // UPDATE
67
- const result = await connection.execute(
68
- 'UPDATE Users SET Name = :name WHERE Id = :id',
69
- {
70
- name: 'Jane Doe',
71
- id: userId,
72
- }
73
- )
74
-
75
- // DELETE
76
- await connection.execute(
77
- 'DELETE FROM Users WHERE Id = :id',
78
- { id: userId }
79
- )
80
- ```
81
-
82
- ### Transactions
83
- ```typescript
84
- const connection = await pool.getConnection()
85
-
86
- try {
87
- await connection.execute(
88
- 'INSERT INTO Accounts (UserId, Balance) VALUES (:userId, :balance)',
89
- { userId, balance: 1000 }
90
- )
91
-
92
- await connection.execute(
93
- 'INSERT INTO Transactions (AccountId, Amount) VALUES (:accountId, :amount)',
94
- { accountId, amount: 1000 }
95
- )
96
-
97
- await connection.commit()
98
- } catch (error) {
99
- await connection.rollback()
100
- throw error
101
- } finally {
102
- await connection.close()
103
- }
104
- ```
105
-
106
- ### Advanced Features
107
- ```typescript
108
- // PL/SQL procedures
109
- const result = await connection.execute(
110
- `BEGIN
111
- sp_GetUserDetails(:userId, :userData);
112
- END;`,
113
- {
114
- userId,
115
- userData: { type: oracledb.CURSOR, dir: oracledb.BIND_OUT },
116
- }
117
- )
118
-
119
- // JSON operations (Oracle 12c+)
120
- const result = await connection.execute(
121
- `SELECT
122
- Id,
123
- Name,
124
- JSON_VALUE(Metadata, '$.category') AS Category
125
- FROM Products
126
- WHERE JSON_VALUE(Metadata, '$.category') = :category`,
127
- { category: 'electronics' }
128
- )
129
-
130
- // Full-text search (Oracle Text)
131
- const result = await connection.execute(
132
- `SELECT * FROM Articles
133
- WHERE CONTAINS(Content, :searchTerm, 1) > 0`,
134
- { searchTerm: 'search term' }
135
- )
136
-
137
- // Window functions
138
- const result = await connection.execute(
139
- `SELECT
140
- Name,
141
- Salary,
142
- ROW_NUMBER() OVER (PARTITION BY DepartmentId ORDER BY Salary DESC) AS Rank
143
- FROM Employees`
144
- )
145
- ```
146
-
147
- ## Common Patterns
148
-
149
- ### Connection Pooling
150
- ```typescript
151
- let pool: oracledb.Pool | null = null
152
-
153
- export async function getPool(): Promise<oracledb.Pool> {
154
- if (!pool) {
155
- pool = await oracledb.createPool({
156
- // ... config
157
- })
158
- }
159
- return pool
160
- }
161
-
162
- // Graceful shutdown
163
- process.on('SIGINT', async () => {
164
- if (pool) {
165
- await pool.close()
166
- }
167
- process.exit(0)
168
- })
169
- ```
170
-
171
- ### Parameterized Queries
172
- ```typescript
173
- // Always use bind variables (:param) to prevent SQL injection
174
- // ❌ WRONG
175
- await connection.execute(`SELECT * FROM Users WHERE Email = '${email}'`)
176
-
177
- // ✅ CORRECT
178
- await connection.execute(
179
- 'SELECT * FROM Users WHERE Email = :email',
180
- { email }
181
- )
182
- ```
183
-
184
- ### Error Handling
185
- ```typescript
186
- try {
187
- const result = await connection.execute(
188
- 'SELECT * FROM Users WHERE Id = :id',
189
- { id: userId }
190
- )
191
-
192
- if (result.rows.length === 0) {
193
- throw new Error('User not found')
194
- }
195
- return result.rows[0]
196
- } catch (error: any) {
197
- if (error.errorNum === 1) { // Unique constraint violation
198
- throw new Error('Duplicate entry')
199
- }
200
- if (error.errorNum === 2291) { // Foreign key constraint violation
201
- throw new Error('Referenced record does not exist')
202
- }
203
- throw error
204
- }
205
- ```
206
-
207
- ## Best Practices
208
-
209
- ✅ **DO:**
210
- - Use connection pooling (2-10 connections typically)
211
- - Always use bind variables (:param)
212
- - Use transactions for multi-step operations
213
- - Create indexes on frequently queried columns
214
- - Use appropriate data types
215
- - Enable connection retry logic
216
- - Use PL/SQL for complex operations
217
- - Monitor connection pool usage
218
- - Use appropriate fetch array sizes
219
- - Implement proper error handling
220
-
221
- ❌ **DON'T:**
222
- - Use string concatenation for queries (SQL injection risk)
223
- - Create too many connections
224
- - Skip error handling
225
- - Ignore connection pool limits
226
- - Use SELECT * in production
227
- - Skip indexes on foreign keys
228
- - Hardcode connection strings
229
- - Skip transaction management
230
- - Ignore query performance
231
- - Use synchronous operations
232
-
233
- ## Configuration
234
-
235
- ### Environment Variables
236
- ```bash
237
- DB_HOST=localhost
238
- DB_PORT=1521
239
- DB_SERVICE=XE
240
- DB_USER=system
241
- DB_PASSWORD=securepassword
242
- ```
243
-
244
- ### Docker Compose
245
- ```yaml
246
- services:
247
- oracle:
248
- image: container-registry.oracle.com/database/express:21.3.0-xe
249
- ports:
250
- - "1521:1521"
251
- - "5500:5500" # Enterprise Manager
252
- environment:
253
- ORACLE_PWD: securepassword
254
- volumes:
255
- - oracle_data:/opt/oracle/oradata
256
- healthcheck:
257
- test: ["CMD-SHELL", "sqlplus -S system/securepassword@localhost:1521/XE <<< 'SELECT 1 FROM DUAL;' || exit 1"]
258
- interval: 30s
259
- timeout: 10s
260
- retries: 5
261
-
262
- volumes:
263
- oracle_data:
264
- ```
265
-
266
- ## Integration with Development
267
-
268
- ### Testing
269
- ```typescript
270
- // Use test database
271
- const testPool = await oracledb.createPool({
272
- connectString: 'localhost:1521/TEST',
273
- // ... config
274
- })
275
-
276
- // Clean up after tests
277
- afterEach(async () => {
278
- const connection = await testPool.getConnection()
279
- await connection.execute('DELETE FROM Users')
280
- await connection.execute('DELETE FROM Posts')
281
- await connection.close()
282
- })
283
- ```
284
-
285
- ### Health Checks
286
- ```typescript
287
- async function checkDatabaseHealth(): Promise<boolean> {
288
- try {
289
- const connection = await pool.getConnection()
290
- const result = await connection.execute('SELECT 1 FROM DUAL')
291
- await connection.close()
292
- return result.rows.length > 0
293
- } catch {
294
- return false
295
- }
296
- }
297
- ```
298
-
299
- <!-- ORACLE:END -->
300
-