@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,290 +0,0 @@
1
- <!-- ORACLE:START -->
2
- # Oracle Database Instructions
3
-
4
- **CRITICAL**: Use Oracle Database for enterprise relational data storage with advanced features, high availability, and comprehensive tooling.
5
-
6
- ## Core Features
7
-
8
- ### Connection
9
- ```typescript
10
- // Using oracledb
11
- import oracledb from 'oracledb'
12
-
13
- oracledb.outFormat = oracledb.OUT_FORMAT_OBJECT
14
- oracledb.autoCommit = false
15
-
16
- const connection = await oracledb.getConnection({
17
- user: process.env.DB_USER || 'system',
18
- password: process.env.DB_PASSWORD,
19
- connectString: `${process.env.DB_HOST || 'localhost'}:${process.env.DB_PORT || '1521'}/${process.env.DB_SERVICE || 'XE'}`,
20
- })
21
-
22
- // Connection pool
23
- const pool = await oracledb.createPool({
24
- user: process.env.DB_USER,
25
- password: process.env.DB_PASSWORD,
26
- connectString: `${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_SERVICE}`,
27
- poolMin: 2,
28
- poolMax: 10,
29
- poolIncrement: 1,
30
- poolTimeout: 60,
31
- })
32
- ```
33
-
34
- ### Basic Queries
35
- ```typescript
36
- // SELECT
37
- const result = await connection.execute(
38
- 'SELECT * FROM Users WHERE Id = :id',
39
- { id: userId }
40
- )
41
- const users = result.rows
42
-
43
- // INSERT with RETURNING
44
- const result = await connection.execute(
45
- `INSERT INTO Users (Name, Email)
46
- VALUES (:name, :email)
47
- RETURNING Id INTO :id`,
48
- {
49
- name: 'John Doe',
50
- email: 'john@example.com',
51
- id: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
52
- }
53
- )
54
- const newId = result.outBinds.id[0]
55
-
56
- // UPDATE
57
- const result = await connection.execute(
58
- 'UPDATE Users SET Name = :name WHERE Id = :id',
59
- {
60
- name: 'Jane Doe',
61
- id: userId,
62
- }
63
- )
64
-
65
- // DELETE
66
- await connection.execute(
67
- 'DELETE FROM Users WHERE Id = :id',
68
- { id: userId }
69
- )
70
- ```
71
-
72
- ### Transactions
73
- ```typescript
74
- const connection = await pool.getConnection()
75
-
76
- try {
77
- await connection.execute(
78
- 'INSERT INTO Accounts (UserId, Balance) VALUES (:userId, :balance)',
79
- { userId, balance: 1000 }
80
- )
81
-
82
- await connection.execute(
83
- 'INSERT INTO Transactions (AccountId, Amount) VALUES (:accountId, :amount)',
84
- { accountId, amount: 1000 }
85
- )
86
-
87
- await connection.commit()
88
- } catch (error) {
89
- await connection.rollback()
90
- throw error
91
- } finally {
92
- await connection.close()
93
- }
94
- ```
95
-
96
- ### Advanced Features
97
- ```typescript
98
- // PL/SQL procedures
99
- const result = await connection.execute(
100
- `BEGIN
101
- sp_GetUserDetails(:userId, :userData);
102
- END;`,
103
- {
104
- userId,
105
- userData: { type: oracledb.CURSOR, dir: oracledb.BIND_OUT },
106
- }
107
- )
108
-
109
- // JSON operations (Oracle 12c+)
110
- const result = await connection.execute(
111
- `SELECT
112
- Id,
113
- Name,
114
- JSON_VALUE(Metadata, '$.category') AS Category
115
- FROM Products
116
- WHERE JSON_VALUE(Metadata, '$.category') = :category`,
117
- { category: 'electronics' }
118
- )
119
-
120
- // Full-text search (Oracle Text)
121
- const result = await connection.execute(
122
- `SELECT * FROM Articles
123
- WHERE CONTAINS(Content, :searchTerm, 1) > 0`,
124
- { searchTerm: 'search term' }
125
- )
126
-
127
- // Window functions
128
- const result = await connection.execute(
129
- `SELECT
130
- Name,
131
- Salary,
132
- ROW_NUMBER() OVER (PARTITION BY DepartmentId ORDER BY Salary DESC) AS Rank
133
- FROM Employees`
134
- )
135
- ```
136
-
137
- ## Common Patterns
138
-
139
- ### Connection Pooling
140
- ```typescript
141
- let pool: oracledb.Pool | null = null
142
-
143
- export async function getPool(): Promise<oracledb.Pool> {
144
- if (!pool) {
145
- pool = await oracledb.createPool({
146
- // ... config
147
- })
148
- }
149
- return pool
150
- }
151
-
152
- // Graceful shutdown
153
- process.on('SIGINT', async () => {
154
- if (pool) {
155
- await pool.close()
156
- }
157
- process.exit(0)
158
- })
159
- ```
160
-
161
- ### Parameterized Queries
162
- ```typescript
163
- // Always use bind variables (:param) to prevent SQL injection
164
- // ❌ WRONG
165
- await connection.execute(`SELECT * FROM Users WHERE Email = '${email}'`)
166
-
167
- // ✅ CORRECT
168
- await connection.execute(
169
- 'SELECT * FROM Users WHERE Email = :email',
170
- { email }
171
- )
172
- ```
173
-
174
- ### Error Handling
175
- ```typescript
176
- try {
177
- const result = await connection.execute(
178
- 'SELECT * FROM Users WHERE Id = :id',
179
- { id: userId }
180
- )
181
-
182
- if (result.rows.length === 0) {
183
- throw new Error('User not found')
184
- }
185
- return result.rows[0]
186
- } catch (error: any) {
187
- if (error.errorNum === 1) { // Unique constraint violation
188
- throw new Error('Duplicate entry')
189
- }
190
- if (error.errorNum === 2291) { // Foreign key constraint violation
191
- throw new Error('Referenced record does not exist')
192
- }
193
- throw error
194
- }
195
- ```
196
-
197
- ## Best Practices
198
-
199
- ✅ **DO:**
200
- - Use connection pooling (2-10 connections typically)
201
- - Always use bind variables (:param)
202
- - Use transactions for multi-step operations
203
- - Create indexes on frequently queried columns
204
- - Use appropriate data types
205
- - Enable connection retry logic
206
- - Use PL/SQL for complex operations
207
- - Monitor connection pool usage
208
- - Use appropriate fetch array sizes
209
- - Implement proper error handling
210
-
211
- ❌ **DON'T:**
212
- - Use string concatenation for queries (SQL injection risk)
213
- - Create too many connections
214
- - Skip error handling
215
- - Ignore connection pool limits
216
- - Use SELECT * in production
217
- - Skip indexes on foreign keys
218
- - Hardcode connection strings
219
- - Skip transaction management
220
- - Ignore query performance
221
- - Use synchronous operations
222
-
223
- ## Configuration
224
-
225
- ### Environment Variables
226
- ```bash
227
- DB_HOST=localhost
228
- DB_PORT=1521
229
- DB_SERVICE=XE
230
- DB_USER=system
231
- DB_PASSWORD=securepassword
232
- ```
233
-
234
- ### Docker Compose
235
- ```yaml
236
- services:
237
- oracle:
238
- image: container-registry.oracle.com/database/express:21.3.0-xe
239
- ports:
240
- - "1521:1521"
241
- - "5500:5500" # Enterprise Manager
242
- environment:
243
- ORACLE_PWD: securepassword
244
- volumes:
245
- - oracle_data:/opt/oracle/oradata
246
- healthcheck:
247
- test: ["CMD-SHELL", "sqlplus -S system/securepassword@localhost:1521/XE <<< 'SELECT 1 FROM DUAL;' || exit 1"]
248
- interval: 30s
249
- timeout: 10s
250
- retries: 5
251
-
252
- volumes:
253
- oracle_data:
254
- ```
255
-
256
- ## Integration with Development
257
-
258
- ### Testing
259
- ```typescript
260
- // Use test database
261
- const testPool = await oracledb.createPool({
262
- connectString: 'localhost:1521/TEST',
263
- // ... config
264
- })
265
-
266
- // Clean up after tests
267
- afterEach(async () => {
268
- const connection = await testPool.getConnection()
269
- await connection.execute('DELETE FROM Users')
270
- await connection.execute('DELETE FROM Posts')
271
- await connection.close()
272
- })
273
- ```
274
-
275
- ### Health Checks
276
- ```typescript
277
- async function checkDatabaseHealth(): Promise<boolean> {
278
- try {
279
- const connection = await pool.getConnection()
280
- const result = await connection.execute('SELECT 1 FROM DUAL')
281
- await connection.close()
282
- return result.rows.length > 0
283
- } catch {
284
- return false
285
- }
286
- }
287
- ```
288
-
289
- <!-- ORACLE:END -->
290
-
@@ -1,24 +0,0 @@
1
- <!-- PINO:START -->
2
- # Pino — Structured Logging
3
-
4
- ## Configuration
5
- - Create singleton logger instance: `const logger = pino({ level: process.env.LOG_LEVEL || 'info' })`
6
- - Use child loggers for request context: `req.log = logger.child({ requestId: req.id })`
7
- - Configure pretty print for development only: `transport: { target: 'pino-pretty' }` (only when `NODE_ENV !== 'production'`)
8
-
9
- ## Log Levels
10
- - `error`: Unexpected errors requiring immediate attention
11
- - `warn`: Recoverable errors, deprecated usage, approaching limits
12
- - `info`: Significant state changes, important business events
13
- - `debug`: Detailed flow for troubleshooting (disabled in production)
14
- - `trace`: High-frequency diagnostic data (never in production)
15
-
16
- ## Structured Fields
17
- - Always include: `{ service, version, requestId, userId }` in request context
18
- - Never log: passwords, tokens, credit cards, PII fields
19
- - Log all outgoing HTTP calls with: `{ method, url, statusCode, duration }`
20
-
21
- ## Performance
22
- - Avoid `JSON.stringify()` in log calls — pino handles serialization
23
- - Use `logger.isLevelEnabled('debug')` before expensive debug computations
24
- <!-- PINO:END -->
@@ -1,326 +0,0 @@
1
- <!-- POSTGRESQL:START -->
2
- # PostgreSQL Database Instructions
3
-
4
- **CRITICAL**: Use PostgreSQL for relational data storage with ACID compliance, transactions, and advanced features.
5
-
6
- ## Core Features
7
-
8
- ### Connection
9
- ```typescript
10
- // Using pg (Node.js)
11
- import { Pool } from 'pg'
12
- const pool = new Pool({
13
- host: process.env.DB_HOST,
14
- port: parseInt(process.env.DB_PORT || '5432'),
15
- database: process.env.DB_NAME,
16
- user: process.env.DB_USER,
17
- password: process.env.DB_PASSWORD,
18
- ssl: process.env.NODE_ENV === 'production' ? { rejectUnauthorized: false } : false,
19
- max: 20,
20
- idleTimeoutMillis: 30000,
21
- connectionTimeoutMillis: 2000,
22
- })
23
-
24
- // Using Prisma
25
- import { PrismaClient } from '@prisma/client'
26
- const prisma = new PrismaClient()
27
- ```
28
-
29
- ### Basic Queries
30
- ```typescript
31
- // SELECT
32
- const result = await pool.query('SELECT * FROM users WHERE id = $1', [userId])
33
- const users = result.rows
34
-
35
- // INSERT
36
- const result = await pool.query(
37
- 'INSERT INTO users (name, email) VALUES ($1, $2) RETURNING *',
38
- ['John Doe', 'john@example.com']
39
- )
40
- const newUser = result.rows[0]
41
-
42
- // UPDATE
43
- const result = await pool.query(
44
- 'UPDATE users SET name = $1 WHERE id = $2 RETURNING *',
45
- ['Jane Doe', userId]
46
- )
47
-
48
- // DELETE
49
- await pool.query('DELETE FROM users WHERE id = $1', [userId])
50
- ```
51
-
52
- ### Transactions
53
- ```typescript
54
- const client = await pool.connect()
55
- try {
56
- await client.query('BEGIN')
57
-
58
- await client.query('INSERT INTO accounts (user_id, balance) VALUES ($1, $2)', [userId, 1000])
59
- await client.query('INSERT INTO transactions (account_id, amount) VALUES ($1, $2)', [accountId, 1000])
60
-
61
- await client.query('COMMIT')
62
- } catch (error) {
63
- await client.query('ROLLBACK')
64
- throw error
65
- } finally {
66
- client.release()
67
- }
68
- ```
69
-
70
- ### Advanced Features
71
- ```typescript
72
- // JSONB queries
73
- await pool.query(
74
- 'SELECT * FROM products WHERE metadata @> $1',
75
- [JSON.stringify({ category: 'electronics' })]
76
- )
77
-
78
- // Full-text search
79
- await pool.query(
80
- "SELECT * FROM articles WHERE to_tsvector('english', content) @@ to_tsquery('english', $1)",
81
- ['search term']
82
- )
83
-
84
- // Array operations
85
- await pool.query('SELECT * FROM posts WHERE tags && $1', [['javascript', 'typescript']])
86
-
87
- // Window functions
88
- await pool.query(`
89
- SELECT
90
- name,
91
- salary,
92
- ROW_NUMBER() OVER (PARTITION BY department ORDER BY salary DESC) as rank
93
- FROM employees
94
- `)
95
- ```
96
-
97
- ## Common Patterns
98
-
99
- ### Connection Pooling
100
- ```typescript
101
- // Reuse connection pool
102
- let pool: Pool | null = null
103
-
104
- export function getPool(): Pool {
105
- if (!pool) {
106
- pool = new Pool({
107
- // ... config
108
- })
109
-
110
- pool.on('error', (err) => {
111
- console.error('Unexpected error on idle client', err)
112
- process.exit(-1)
113
- })
114
- }
115
- return pool
116
- }
117
-
118
- // Graceful shutdown
119
- process.on('SIGINT', async () => {
120
- if (pool) {
121
- await pool.end()
122
- }
123
- process.exit(0)
124
- })
125
- ```
126
-
127
- ### Prepared Statements
128
- ```typescript
129
- // Always use parameterized queries to prevent SQL injection
130
- // ❌ WRONG
131
- await pool.query(`SELECT * FROM users WHERE email = '${email}'`)
132
-
133
- // ✅ CORRECT
134
- await pool.query('SELECT * FROM users WHERE email = $1', [email])
135
- ```
136
-
137
- ### Error Handling
138
- ```typescript
139
- try {
140
- const result = await pool.query('SELECT * FROM users WHERE id = $1', [userId])
141
- if (result.rows.length === 0) {
142
- throw new Error('User not found')
143
- }
144
- return result.rows[0]
145
- } catch (error) {
146
- if (error.code === '23505') { // Unique violation
147
- throw new Error('Duplicate entry')
148
- }
149
- if (error.code === '23503') { // Foreign key violation
150
- throw new Error('Referenced record does not exist')
151
- }
152
- throw error
153
- }
154
- ```
155
-
156
- ### Migrations
157
- ```typescript
158
- // Using node-pg-migrate
159
- import { migrate } from 'node-pg-migrate'
160
-
161
- await migrate({
162
- databaseUrl: process.env.DATABASE_URL,
163
- dir: 'migrations',
164
- direction: 'up',
165
- migrationsTable: 'pgmigrations',
166
- dryRun: false,
167
- })
168
- ```
169
-
170
- ## Best Practices
171
-
172
- ✅ **DO:**
173
- - Use connection pooling (max 20-30 connections)
174
- - Always use parameterized queries ($1, $2, etc.)
175
- - Use transactions for multi-step operations
176
- - Create indexes on frequently queried columns
177
- - Use EXPLAIN ANALYZE to optimize queries
178
- - Enable connection pooling (PgBouncer for production)
179
- - Use SSL in production
180
- - Set appropriate connection timeouts
181
- - Monitor connection pool usage
182
- - Use prepared statements for repeated queries
183
-
184
- ❌ **DON'T:**
185
- - Use string concatenation for queries (SQL injection risk)
186
- - Create too many connections (exhaust pool)
187
- - Skip error handling
188
- - Ignore connection pool limits
189
- - Use SELECT * in production (specify columns)
190
- - Skip indexes on foreign keys
191
- - Hardcode connection strings
192
- - Skip SSL in production
193
- - Ignore query performance
194
- - Use synchronous queries
195
-
196
- ## Configuration
197
-
198
- ### Environment Variables
199
- ```bash
200
- DB_HOST=localhost
201
- DB_PORT=5432
202
- DB_NAME=myapp
203
- DB_USER=myuser
204
- DB_PASSWORD=securepassword
205
- DATABASE_URL=postgresql://user:password@host:port/database
206
- ```
207
-
208
- ### Docker Compose
209
- ```yaml
210
- services:
211
- postgres:
212
- image: postgres:16-alpine
213
- environment:
214
- POSTGRES_DB: myapp
215
- POSTGRES_USER: myuser
216
- POSTGRES_PASSWORD: securepassword
217
- ports:
218
- - "5432:5432"
219
- volumes:
220
- - postgres_data:/var/lib/postgresql/data
221
- healthcheck:
222
- test: ["CMD-SHELL", "pg_isready -U myuser"]
223
- interval: 10s
224
- timeout: 5s
225
- retries: 5
226
-
227
- volumes:
228
- postgres_data:
229
- ```
230
-
231
- ### Prisma Schema
232
- ```prisma
233
- datasource db {
234
- provider = "postgresql"
235
- url = env("DATABASE_URL")
236
- }
237
-
238
- model User {
239
- id Int @id @default(autoincrement())
240
- email String @unique
241
- name String?
242
- createdAt DateTime @default(now())
243
- posts Post[]
244
- }
245
-
246
- model Post {
247
- id Int @id @default(autoincrement())
248
- title String
249
- content String?
250
- authorId Int
251
- author User @relation(fields: [authorId], references: [id])
252
- createdAt DateTime @default(now())
253
- }
254
- ```
255
-
256
- ## Performance Optimization
257
-
258
- ### Indexing
259
- ```sql
260
- -- Single column index
261
- CREATE INDEX idx_users_email ON users(email);
262
-
263
- -- Composite index
264
- CREATE INDEX idx_posts_author_created ON posts(author_id, created_at DESC);
265
-
266
- -- Partial index
267
- CREATE INDEX idx_active_users ON users(email) WHERE active = true;
268
-
269
- -- GIN index for JSONB
270
- CREATE INDEX idx_products_metadata ON products USING GIN(metadata);
271
- ```
272
-
273
- ### Query Optimization
274
- ```typescript
275
- // Use LIMIT and OFFSET for pagination
276
- const result = await pool.query(
277
- 'SELECT * FROM posts ORDER BY created_at DESC LIMIT $1 OFFSET $2',
278
- [limit, offset]
279
- )
280
-
281
- // Use EXISTS instead of COUNT for existence checks
282
- const result = await pool.query(
283
- 'SELECT EXISTS(SELECT 1 FROM users WHERE email = $1)',
284
- [email]
285
- )
286
- ```
287
-
288
- ## Integration with Development
289
-
290
- ### Testing
291
- ```typescript
292
- // Use test database
293
- const testPool = new Pool({
294
- database: 'myapp_test',
295
- // ... config
296
- })
297
-
298
- // Clean up after tests
299
- afterEach(async () => {
300
- await testPool.query('TRUNCATE TABLE users, posts CASCADE')
301
- })
302
-
303
- // Use transactions for test isolation
304
- beforeEach(async () => {
305
- await testPool.query('BEGIN')
306
- })
307
-
308
- afterEach(async () => {
309
- await testPool.query('ROLLBACK')
310
- })
311
- ```
312
-
313
- ### Health Checks
314
- ```typescript
315
- async function checkDatabaseHealth(): Promise<boolean> {
316
- try {
317
- const result = await pool.query('SELECT 1')
318
- return result.rows.length > 0
319
- } catch {
320
- return false
321
- }
322
- }
323
- ```
324
-
325
- <!-- POSTGRESQL:END -->
326
-
@@ -1,33 +0,0 @@
1
- <!-- PROMETHEUS:START -->
2
- # Prometheus — Metrics
3
-
4
- ## Setup
5
- ```typescript
6
- import { Registry, collectDefaultMetrics } from 'prom-client';
7
- const registry = new Registry();
8
- collectDefaultMetrics({ register: registry });
9
- ```
10
-
11
- Expose metrics endpoint:
12
- ```typescript
13
- app.get('/metrics', async (req, res) => {
14
- res.set('Content-Type', registry.contentType);
15
- res.end(await registry.metrics());
16
- });
17
- ```
18
-
19
- ## Metric Types
20
- - **Counter**: Monotonically increasing values (`http_requests_total`)
21
- - **Gauge**: Values that go up and down (`active_connections`, memory usage)
22
- - **Histogram**: Duration/size distributions (`http_request_duration_seconds`)
23
- - **Summary**: Percentile calculations (use Histogram instead when possible)
24
-
25
- ## Naming Conventions
26
- - Format: `<namespace>_<metric_name>_<unit>` (e.g., `app_http_request_duration_seconds`)
27
- - Use `_total` suffix for counters
28
- - Include all relevant labels: `{ method, route, status_code }`
29
-
30
- ## Alerting
31
- - Define recording rules for frequently queried expressions
32
- - Set alert thresholds: error rate > 5%, p99 latency > 2s, memory > 80%
33
- <!-- PROMETHEUS:END -->