@dizzlkheinz/ynab-mcpb 0.18.4 → 0.19.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 (343) hide show
  1. package/CLAUDE.md +87 -8
  2. package/bin/ynab-mcp-server.cjs +2 -2
  3. package/bin/ynab-mcp-server.js +3 -3
  4. package/biome.json +39 -0
  5. package/dist/bundle/index.cjs +67 -67
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.js +27 -27
  8. package/dist/server/YNABMCPServer.d.ts +3 -4
  9. package/dist/server/YNABMCPServer.js +111 -116
  10. package/dist/server/budgetResolver.d.ts +6 -5
  11. package/dist/server/budgetResolver.js +46 -36
  12. package/dist/server/cacheKeys.js +6 -6
  13. package/dist/server/cacheManager.js +14 -11
  14. package/dist/server/completions.d.ts +2 -2
  15. package/dist/server/completions.js +20 -15
  16. package/dist/server/config.d.ts +10 -5
  17. package/dist/server/config.js +24 -7
  18. package/dist/server/deltaCache.d.ts +2 -2
  19. package/dist/server/deltaCache.js +22 -16
  20. package/dist/server/deltaCache.merge.d.ts +2 -2
  21. package/dist/server/diagnostics.d.ts +4 -4
  22. package/dist/server/diagnostics.js +38 -32
  23. package/dist/server/errorHandler.d.ts +5 -12
  24. package/dist/server/errorHandler.js +219 -217
  25. package/dist/server/prompts.d.ts +2 -2
  26. package/dist/server/prompts.js +45 -45
  27. package/dist/server/rateLimiter.js +4 -4
  28. package/dist/server/requestLogger.d.ts +1 -1
  29. package/dist/server/requestLogger.js +40 -35
  30. package/dist/server/resources.d.ts +3 -3
  31. package/dist/server/resources.js +55 -52
  32. package/dist/server/responseFormatter.js +6 -6
  33. package/dist/server/securityMiddleware.d.ts +2 -2
  34. package/dist/server/securityMiddleware.js +22 -20
  35. package/dist/server/serverKnowledgeStore.js +1 -1
  36. package/dist/server/toolRegistry.d.ts +3 -3
  37. package/dist/server/toolRegistry.js +47 -40
  38. package/dist/tools/__tests__/deltaTestUtils.d.ts +3 -3
  39. package/dist/tools/__tests__/deltaTestUtils.js +2 -2
  40. package/dist/tools/accountTools.d.ts +9 -8
  41. package/dist/tools/accountTools.js +47 -47
  42. package/dist/tools/adapters.d.ts +13 -8
  43. package/dist/tools/adapters.js +21 -11
  44. package/dist/tools/budgetTools.d.ts +8 -7
  45. package/dist/tools/budgetTools.js +22 -22
  46. package/dist/tools/categoryTools.d.ts +9 -8
  47. package/dist/tools/categoryTools.js +68 -59
  48. package/dist/tools/compareTransactions/formatter.d.ts +3 -3
  49. package/dist/tools/compareTransactions/formatter.js +9 -9
  50. package/dist/tools/compareTransactions/index.d.ts +6 -6
  51. package/dist/tools/compareTransactions/index.js +58 -43
  52. package/dist/tools/compareTransactions/matcher.d.ts +1 -1
  53. package/dist/tools/compareTransactions/matcher.js +28 -15
  54. package/dist/tools/compareTransactions/parser.d.ts +2 -2
  55. package/dist/tools/compareTransactions/parser.js +144 -138
  56. package/dist/tools/compareTransactions/types.d.ts +4 -4
  57. package/dist/tools/compareTransactions.d.ts +1 -1
  58. package/dist/tools/compareTransactions.js +1 -1
  59. package/dist/tools/deltaFetcher.d.ts +2 -2
  60. package/dist/tools/deltaFetcher.js +16 -15
  61. package/dist/tools/deltaSupport.d.ts +4 -4
  62. package/dist/tools/deltaSupport.js +35 -41
  63. package/dist/tools/exportTransactions.d.ts +5 -4
  64. package/dist/tools/exportTransactions.js +61 -59
  65. package/dist/tools/monthTools.d.ts +7 -6
  66. package/dist/tools/monthTools.js +31 -29
  67. package/dist/tools/payeeTools.d.ts +7 -6
  68. package/dist/tools/payeeTools.js +28 -28
  69. package/dist/tools/reconcileAdapter.d.ts +2 -2
  70. package/dist/tools/reconcileAdapter.js +19 -12
  71. package/dist/tools/reconciliation/analyzer.d.ts +4 -4
  72. package/dist/tools/reconciliation/analyzer.js +73 -59
  73. package/dist/tools/reconciliation/csvParser.d.ts +3 -3
  74. package/dist/tools/reconciliation/csvParser.js +128 -104
  75. package/dist/tools/reconciliation/executor.d.ts +4 -4
  76. package/dist/tools/reconciliation/executor.js +148 -109
  77. package/dist/tools/reconciliation/index.d.ts +10 -10
  78. package/dist/tools/reconciliation/index.js +96 -83
  79. package/dist/tools/reconciliation/matcher.d.ts +3 -3
  80. package/dist/tools/reconciliation/matcher.js +17 -16
  81. package/dist/tools/reconciliation/payeeNormalizer.js +19 -8
  82. package/dist/tools/reconciliation/recommendationEngine.d.ts +1 -1
  83. package/dist/tools/reconciliation/recommendationEngine.js +40 -40
  84. package/dist/tools/reconciliation/reportFormatter.d.ts +2 -2
  85. package/dist/tools/reconciliation/reportFormatter.js +59 -58
  86. package/dist/tools/reconciliation/signDetector.d.ts +1 -1
  87. package/dist/tools/reconciliation/types.d.ts +16 -16
  88. package/dist/tools/reconciliation/ynabAdapter.d.ts +2 -2
  89. package/dist/tools/schemas/common.d.ts +1 -1
  90. package/dist/tools/schemas/common.js +1 -1
  91. package/dist/tools/schemas/outputs/accountOutputs.d.ts +1 -1
  92. package/dist/tools/schemas/outputs/accountOutputs.js +24 -18
  93. package/dist/tools/schemas/outputs/budgetOutputs.d.ts +1 -1
  94. package/dist/tools/schemas/outputs/budgetOutputs.js +14 -11
  95. package/dist/tools/schemas/outputs/categoryOutputs.d.ts +1 -1
  96. package/dist/tools/schemas/outputs/categoryOutputs.js +49 -29
  97. package/dist/tools/schemas/outputs/comparisonOutputs.d.ts +1 -1
  98. package/dist/tools/schemas/outputs/comparisonOutputs.js +12 -12
  99. package/dist/tools/schemas/outputs/index.d.ts +14 -14
  100. package/dist/tools/schemas/outputs/index.js +14 -14
  101. package/dist/tools/schemas/outputs/monthOutputs.d.ts +1 -1
  102. package/dist/tools/schemas/outputs/monthOutputs.js +56 -41
  103. package/dist/tools/schemas/outputs/payeeOutputs.d.ts +1 -1
  104. package/dist/tools/schemas/outputs/payeeOutputs.js +10 -10
  105. package/dist/tools/schemas/outputs/reconciliationOutputs.d.ts +2 -2
  106. package/dist/tools/schemas/outputs/reconciliationOutputs.js +45 -45
  107. package/dist/tools/schemas/outputs/transactionMutationOutputs.d.ts +1 -1
  108. package/dist/tools/schemas/outputs/transactionMutationOutputs.js +28 -22
  109. package/dist/tools/schemas/outputs/transactionOutputs.d.ts +1 -1
  110. package/dist/tools/schemas/outputs/transactionOutputs.js +43 -35
  111. package/dist/tools/schemas/outputs/utilityOutputs.d.ts +1 -1
  112. package/dist/tools/schemas/outputs/utilityOutputs.js +5 -3
  113. package/dist/tools/schemas/shared/commonOutputs.d.ts +1 -1
  114. package/dist/tools/schemas/shared/commonOutputs.js +15 -9
  115. package/dist/tools/transactionReadTools.d.ts +11 -0
  116. package/dist/tools/transactionReadTools.js +202 -0
  117. package/dist/tools/transactionSchemas.d.ts +7 -7
  118. package/dist/tools/transactionSchemas.js +77 -57
  119. package/dist/tools/transactionTools.d.ts +6 -24
  120. package/dist/tools/transactionTools.js +7 -1499
  121. package/dist/tools/transactionUtils.d.ts +6 -6
  122. package/dist/tools/transactionUtils.js +78 -63
  123. package/dist/tools/transactionWriteTools.d.ts +20 -0
  124. package/dist/tools/transactionWriteTools.js +1342 -0
  125. package/dist/tools/utilityTools.d.ts +5 -4
  126. package/dist/tools/utilityTools.js +11 -11
  127. package/dist/types/index.d.ts +7 -7
  128. package/dist/types/index.js +6 -6
  129. package/dist/types/reconciliation.d.ts +1 -1
  130. package/dist/types/toolRegistration.d.ts +14 -12
  131. package/dist/utils/amountUtils.js +1 -1
  132. package/dist/utils/dateUtils.js +4 -4
  133. package/dist/utils/errors.d.ts +3 -3
  134. package/dist/utils/errors.js +4 -4
  135. package/dist/utils/money.d.ts +2 -2
  136. package/dist/utils/money.js +8 -8
  137. package/dist/utils/validationError.d.ts +1 -1
  138. package/dist/utils/validationError.js +1 -1
  139. package/docs/assets/examples/reconciliation-with-recommendations.json +66 -66
  140. package/docs/assets/schemas/reconciliation-v2.json +360 -336
  141. package/esbuild.config.mjs +53 -50
  142. package/meta.json +12548 -12548
  143. package/package.json +98 -111
  144. package/scripts/analyze-bundle.mjs +33 -30
  145. package/scripts/create-pr-description.js +169 -120
  146. package/scripts/run-all-tests.js +178 -169
  147. package/scripts/run-domain-integration-tests.js +28 -18
  148. package/scripts/run-generate-mcpb.js +19 -17
  149. package/scripts/run-throttled-integration-tests.js +92 -83
  150. package/scripts/test-delta-params.mjs +149 -120
  151. package/scripts/test-recommendations.ts +36 -32
  152. package/scripts/tmpTransaction.ts +80 -43
  153. package/scripts/validate-env.js +98 -91
  154. package/scripts/verify-build.js +78 -76
  155. package/src/__tests__/comprehensive.integration.test.ts +1281 -1154
  156. package/src/__tests__/performance.test.ts +723 -671
  157. package/src/__tests__/setup.ts +442 -395
  158. package/src/__tests__/smoke.e2e.test.ts +41 -39
  159. package/src/__tests__/testRunner.ts +314 -295
  160. package/src/__tests__/testUtils.ts +456 -364
  161. package/src/__tests__/tools/reconciliation/csvParser.integration.test.ts +109 -107
  162. package/src/__tests__/tools/reconciliation/real-world.integration.test.ts +41 -41
  163. package/src/index.ts +68 -59
  164. package/src/server/CLAUDE.md +480 -0
  165. package/src/server/YNABMCPServer.ts +821 -794
  166. package/src/server/__tests__/YNABMCPServer.integration.test.ts +929 -893
  167. package/src/server/__tests__/YNABMCPServer.test.ts +903 -899
  168. package/src/server/__tests__/budgetResolver.test.ts +466 -423
  169. package/src/server/__tests__/cacheManager.test.ts +891 -874
  170. package/src/server/__tests__/completions.integration.test.ts +115 -106
  171. package/src/server/__tests__/completions.test.ts +334 -313
  172. package/src/server/__tests__/config.test.ts +98 -86
  173. package/src/server/__tests__/deltaCache.merge.test.ts +774 -703
  174. package/src/server/__tests__/deltaCache.swr.test.ts +198 -153
  175. package/src/server/__tests__/deltaCache.test.ts +946 -759
  176. package/src/server/__tests__/diagnostics.test.ts +825 -792
  177. package/src/server/__tests__/errorHandler.integration.test.ts +512 -462
  178. package/src/server/__tests__/errorHandler.test.ts +402 -397
  179. package/src/server/__tests__/prompts.test.ts +424 -347
  180. package/src/server/__tests__/rateLimiter.test.ts +313 -309
  181. package/src/server/__tests__/requestLogger.test.ts +443 -403
  182. package/src/server/__tests__/resources.template.test.ts +196 -185
  183. package/src/server/__tests__/resources.test.ts +294 -288
  184. package/src/server/__tests__/security.integration.test.ts +487 -421
  185. package/src/server/__tests__/securityMiddleware.test.ts +519 -444
  186. package/src/server/__tests__/server-startup.integration.test.ts +509 -490
  187. package/src/server/__tests__/serverKnowledgeStore.test.ts +174 -173
  188. package/src/server/__tests__/toolRegistration.test.ts +239 -210
  189. package/src/server/__tests__/toolRegistry.test.ts +907 -845
  190. package/src/server/budgetResolver.ts +221 -181
  191. package/src/server/cacheKeys.ts +6 -6
  192. package/src/server/cacheManager.ts +498 -484
  193. package/src/server/completions.ts +267 -243
  194. package/src/server/config.ts +35 -14
  195. package/src/server/deltaCache.merge.ts +146 -128
  196. package/src/server/deltaCache.ts +352 -309
  197. package/src/server/diagnostics.ts +257 -242
  198. package/src/server/errorHandler.ts +747 -744
  199. package/src/server/prompts.ts +181 -176
  200. package/src/server/rateLimiter.ts +131 -129
  201. package/src/server/requestLogger.ts +350 -322
  202. package/src/server/resources.ts +442 -374
  203. package/src/server/responseFormatter.ts +41 -37
  204. package/src/server/securityMiddleware.ts +223 -205
  205. package/src/server/serverKnowledgeStore.ts +67 -67
  206. package/src/server/toolRegistry.ts +508 -474
  207. package/src/tools/CLAUDE.md +604 -0
  208. package/src/tools/__tests__/accountTools.delta.integration.test.ts +128 -111
  209. package/src/tools/__tests__/accountTools.integration.test.ts +129 -111
  210. package/src/tools/__tests__/accountTools.test.ts +685 -638
  211. package/src/tools/__tests__/adapters.test.ts +142 -108
  212. package/src/tools/__tests__/budgetTools.delta.integration.test.ts +73 -73
  213. package/src/tools/__tests__/budgetTools.integration.test.ts +132 -124
  214. package/src/tools/__tests__/budgetTools.test.ts +442 -413
  215. package/src/tools/__tests__/categoryTools.delta.integration.test.ts +76 -68
  216. package/src/tools/__tests__/categoryTools.integration.test.ts +314 -288
  217. package/src/tools/__tests__/categoryTools.test.ts +656 -625
  218. package/src/tools/__tests__/compareTransactions/formatter.test.ts +535 -462
  219. package/src/tools/__tests__/compareTransactions/index.test.ts +378 -358
  220. package/src/tools/__tests__/compareTransactions/matcher.test.ts +497 -398
  221. package/src/tools/__tests__/compareTransactions/parser.test.ts +765 -747
  222. package/src/tools/__tests__/compareTransactions.test.ts +352 -332
  223. package/src/tools/__tests__/compareTransactions.window.test.ts +150 -146
  224. package/src/tools/__tests__/deltaFetcher.scheduled.integration.test.ts +69 -65
  225. package/src/tools/__tests__/deltaFetcher.test.ts +325 -265
  226. package/src/tools/__tests__/deltaSupport.test.ts +211 -184
  227. package/src/tools/__tests__/deltaTestUtils.ts +37 -33
  228. package/src/tools/__tests__/exportTransactions.test.ts +205 -200
  229. package/src/tools/__tests__/monthTools.delta.integration.test.ts +68 -68
  230. package/src/tools/__tests__/monthTools.integration.test.ts +178 -166
  231. package/src/tools/__tests__/monthTools.test.ts +561 -512
  232. package/src/tools/__tests__/payeeTools.delta.integration.test.ts +68 -68
  233. package/src/tools/__tests__/payeeTools.integration.test.ts +158 -142
  234. package/src/tools/__tests__/payeeTools.test.ts +486 -434
  235. package/src/tools/__tests__/transactionSchemas.test.ts +1202 -1186
  236. package/src/tools/__tests__/transactionTools.integration.test.ts +875 -825
  237. package/src/tools/__tests__/transactionTools.test.ts +4923 -4366
  238. package/src/tools/__tests__/transactionUtils.test.ts +1004 -977
  239. package/src/tools/__tests__/utilityTools.integration.test.ts +32 -32
  240. package/src/tools/__tests__/utilityTools.test.ts +68 -58
  241. package/src/tools/accountTools.ts +293 -271
  242. package/src/tools/adapters.ts +120 -63
  243. package/src/tools/budgetTools.ts +121 -116
  244. package/src/tools/categoryTools.ts +379 -339
  245. package/src/tools/compareTransactions/formatter.ts +131 -119
  246. package/src/tools/compareTransactions/index.ts +249 -214
  247. package/src/tools/compareTransactions/matcher.ts +259 -209
  248. package/src/tools/compareTransactions/parser.ts +517 -487
  249. package/src/tools/compareTransactions/types.ts +38 -38
  250. package/src/tools/compareTransactions.ts +1 -1
  251. package/src/tools/deltaFetcher.ts +281 -260
  252. package/src/tools/deltaSupport.ts +264 -259
  253. package/src/tools/exportTransactions.ts +230 -218
  254. package/src/tools/monthTools.ts +180 -165
  255. package/src/tools/payeeTools.ts +152 -140
  256. package/src/tools/reconcileAdapter.ts +297 -252
  257. package/src/tools/reconciliation/CLAUDE.md +506 -0
  258. package/src/tools/reconciliation/__tests__/adapter.causes.test.ts +133 -124
  259. package/src/tools/reconciliation/__tests__/adapter.test.ts +249 -230
  260. package/src/tools/reconciliation/__tests__/analyzer.test.ts +408 -400
  261. package/src/tools/reconciliation/__tests__/csvParser.test.ts +71 -69
  262. package/src/tools/reconciliation/__tests__/executor.integration.test.ts +348 -323
  263. package/src/tools/reconciliation/__tests__/executor.progress.test.ts +503 -457
  264. package/src/tools/reconciliation/__tests__/executor.test.ts +898 -831
  265. package/src/tools/reconciliation/__tests__/matcher.test.ts +667 -663
  266. package/src/tools/reconciliation/__tests__/payeeNormalizer.test.ts +296 -276
  267. package/src/tools/reconciliation/__tests__/recommendationEngine.integration.test.ts +692 -624
  268. package/src/tools/reconciliation/__tests__/recommendationEngine.test.ts +1008 -989
  269. package/src/tools/reconciliation/__tests__/reconciliation.delta.integration.test.ts +187 -146
  270. package/src/tools/reconciliation/__tests__/reportFormatter.test.ts +583 -533
  271. package/src/tools/reconciliation/__tests__/scenarios/adapterCurrency.scenario.test.ts +75 -74
  272. package/src/tools/reconciliation/__tests__/scenarios/extremes.scenario.test.ts +70 -62
  273. package/src/tools/reconciliation/__tests__/scenarios/repeatAmount.scenario.test.ts +102 -88
  274. package/src/tools/reconciliation/__tests__/schemaUrl.test.ts +56 -55
  275. package/src/tools/reconciliation/__tests__/signDetector.test.ts +209 -206
  276. package/src/tools/reconciliation/__tests__/ynabAdapter.test.ts +66 -60
  277. package/src/tools/reconciliation/analyzer.ts +564 -504
  278. package/src/tools/reconciliation/csvParser.ts +656 -609
  279. package/src/tools/reconciliation/executor.ts +1290 -1128
  280. package/src/tools/reconciliation/index.ts +580 -528
  281. package/src/tools/reconciliation/matcher.ts +256 -240
  282. package/src/tools/reconciliation/payeeNormalizer.ts +92 -78
  283. package/src/tools/reconciliation/recommendationEngine.ts +357 -345
  284. package/src/tools/reconciliation/reportFormatter.ts +343 -307
  285. package/src/tools/reconciliation/signDetector.ts +89 -83
  286. package/src/tools/reconciliation/types.ts +164 -159
  287. package/src/tools/reconciliation/ynabAdapter.ts +17 -15
  288. package/src/tools/schemas/CLAUDE.md +546 -0
  289. package/src/tools/schemas/common.ts +1 -1
  290. package/src/tools/schemas/outputs/__tests__/accountOutputs.test.ts +410 -409
  291. package/src/tools/schemas/outputs/__tests__/budgetOutputs.test.ts +305 -299
  292. package/src/tools/schemas/outputs/__tests__/categoryOutputs.test.ts +431 -430
  293. package/src/tools/schemas/outputs/__tests__/comparisonOutputs.test.ts +510 -495
  294. package/src/tools/schemas/outputs/__tests__/dateValidation.test.ts +179 -153
  295. package/src/tools/schemas/outputs/__tests__/discrepancyDirection.test.ts +293 -254
  296. package/src/tools/schemas/outputs/__tests__/monthOutputs.test.ts +457 -457
  297. package/src/tools/schemas/outputs/__tests__/payeeOutputs.test.ts +362 -356
  298. package/src/tools/schemas/outputs/__tests__/reconciliationOutputs.test.ts +402 -399
  299. package/src/tools/schemas/outputs/__tests__/transactionMutationSchemas.test.ts +225 -211
  300. package/src/tools/schemas/outputs/__tests__/transactionOutputs.test.ts +457 -454
  301. package/src/tools/schemas/outputs/__tests__/utilityOutputs.test.ts +316 -315
  302. package/src/tools/schemas/outputs/accountOutputs.ts +40 -34
  303. package/src/tools/schemas/outputs/budgetOutputs.ts +24 -19
  304. package/src/tools/schemas/outputs/categoryOutputs.ts +76 -56
  305. package/src/tools/schemas/outputs/comparisonOutputs.ts +192 -169
  306. package/src/tools/schemas/outputs/index.ts +163 -163
  307. package/src/tools/schemas/outputs/monthOutputs.ts +95 -80
  308. package/src/tools/schemas/outputs/payeeOutputs.ts +18 -18
  309. package/src/tools/schemas/outputs/reconciliationOutputs.ts +386 -373
  310. package/src/tools/schemas/outputs/transactionMutationOutputs.ts +259 -231
  311. package/src/tools/schemas/outputs/transactionOutputs.ts +81 -71
  312. package/src/tools/schemas/outputs/utilityOutputs.ts +90 -84
  313. package/src/tools/schemas/shared/commonOutputs.ts +27 -19
  314. package/src/tools/toolCategories.ts +114 -114
  315. package/src/tools/transactionReadTools.ts +327 -0
  316. package/src/tools/transactionSchemas.ts +322 -291
  317. package/src/tools/transactionTools.ts +84 -2246
  318. package/src/tools/transactionUtils.ts +507 -422
  319. package/src/tools/transactionWriteTools.ts +2110 -0
  320. package/src/tools/utilityTools.ts +46 -41
  321. package/src/types/CLAUDE.md +477 -0
  322. package/src/types/__tests__/index.test.ts +51 -51
  323. package/src/types/index.ts +43 -39
  324. package/src/types/integration-tests.d.ts +26 -26
  325. package/src/types/reconciliation.ts +29 -29
  326. package/src/types/toolAnnotations.ts +30 -30
  327. package/src/types/toolRegistration.ts +43 -32
  328. package/src/utils/CLAUDE.md +508 -0
  329. package/src/utils/__tests__/dateUtils.test.ts +174 -168
  330. package/src/utils/__tests__/money.test.ts +193 -187
  331. package/src/utils/amountUtils.ts +5 -5
  332. package/src/utils/baseError.ts +5 -5
  333. package/src/utils/dateUtils.ts +29 -26
  334. package/src/utils/errors.ts +14 -14
  335. package/src/utils/money.ts +66 -52
  336. package/src/utils/validationError.ts +1 -1
  337. package/tsconfig.json +29 -29
  338. package/tsconfig.prod.json +16 -16
  339. package/vitest-reporters/split-json-reporter.ts +247 -204
  340. package/vitest.config.ts +99 -95
  341. package/.prettierignore +0 -10
  342. package/.prettierrc.json +0 -10
  343. package/eslint.config.js +0 -49
@@ -4,148 +4,195 @@
4
4
  * Usage: node scripts/create-pr-description.js [options]
5
5
  */
6
6
 
7
- import fs from 'fs';
8
- import path from 'path';
9
- import { fileURLToPath } from 'url';
10
- import { execSync } from 'child_process';
7
+ import { execSync } from "node:child_process";
8
+ import fs from "node:fs";
9
+ import path from "node:path";
10
+ import { fileURLToPath } from "node:url";
11
11
 
12
12
  const __filename = fileURLToPath(import.meta.url);
13
13
  const __dirname = path.dirname(__filename);
14
14
 
15
15
  // Read the PR template
16
- const templatePath = path.join(__dirname, '..', '.github', 'pull_request_template.md');
17
- const template = fs.readFileSync(templatePath, 'utf-8');
16
+ const templatePath = path.join(
17
+ __dirname,
18
+ "..",
19
+ ".github",
20
+ "pull_request_template.md",
21
+ );
22
+ const template = fs.readFileSync(templatePath, "utf-8");
18
23
 
19
24
  // Function to detect the repository's default branch
20
25
  function getDefaultBranch() {
21
- try {
22
- // Try to get the default branch from origin/HEAD
23
- const defaultBranch = execSync('git symbolic-ref refs/remotes/origin/HEAD', {
24
- encoding: 'utf-8',
25
- })
26
- .trim()
27
- .replace('refs/remotes/origin/', '');
28
- return defaultBranch;
29
- } catch (err) {
30
- // Fallback: try common branch names
31
- try {
32
- execSync('git rev-parse --verify origin/main', { encoding: 'utf-8', stdio: 'ignore' });
33
- return 'main';
34
- } catch {
35
- try {
36
- execSync('git rev-parse --verify origin/master', { encoding: 'utf-8', stdio: 'ignore' });
37
- return 'master';
38
- } catch {
39
- console.warn('Could not detect default branch, using "main" as fallback');
40
- return 'main';
41
- }
42
- }
43
- }
26
+ try {
27
+ // Try to get the default branch from origin/HEAD
28
+ const defaultBranch = execSync(
29
+ "git symbolic-ref refs/remotes/origin/HEAD",
30
+ {
31
+ encoding: "utf-8",
32
+ },
33
+ )
34
+ .trim()
35
+ .replace("refs/remotes/origin/", "");
36
+ return defaultBranch;
37
+ } catch (err) {
38
+ // Fallback: try common branch names
39
+ try {
40
+ execSync("git rev-parse --verify origin/main", {
41
+ encoding: "utf-8",
42
+ stdio: "ignore",
43
+ });
44
+ return "main";
45
+ } catch {
46
+ try {
47
+ execSync("git rev-parse --verify origin/master", {
48
+ encoding: "utf-8",
49
+ stdio: "ignore",
50
+ });
51
+ return "master";
52
+ } catch {
53
+ console.warn(
54
+ 'Could not detect default branch, using "main" as fallback',
55
+ );
56
+ return "main";
57
+ }
58
+ }
59
+ }
44
60
  }
45
61
 
46
62
  // Read package.json for version info
47
63
  const packageJson = JSON.parse(
48
- fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8'),
64
+ fs.readFileSync(path.join(__dirname, "..", "package.json"), "utf-8"),
49
65
  );
50
66
 
51
67
  // Read CHANGELOG.md if it exists
52
- let changelogEntries = '';
68
+ let changelogEntries = "";
53
69
  try {
54
- const changelog = fs.readFileSync(path.join(__dirname, '..', 'CHANGELOG.md'), 'utf-8');
55
- // Extract the latest version entries
56
- const latestSection = changelog.split('##')[1];
57
- changelogEntries = latestSection ? `## Latest Changes\n\n${latestSection}` : '';
70
+ const changelog = fs.readFileSync(
71
+ path.join(__dirname, "..", "CHANGELOG.md"),
72
+ "utf-8",
73
+ );
74
+ // Extract the latest version entries
75
+ const latestSection = changelog.split("##")[1];
76
+ changelogEntries = latestSection
77
+ ? `## Latest Changes\n\n${latestSection}`
78
+ : "";
58
79
  } catch (err) {
59
- // No changelog
80
+ // No changelog
60
81
  }
61
82
 
62
83
  // Detect the default branch
63
84
  const defaultBranch = getDefaultBranch();
64
85
 
65
86
  // Get git info
66
- let commitMessages = '';
87
+ let commitMessages = "";
67
88
  try {
68
- const branch = execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
69
-
70
- // Get commit messages since branching from default branch
71
- const commits = execSync(`git log ${defaultBranch}..${branch} --pretty=format:"- %s"`, {
72
- encoding: 'utf-8',
73
- }).trim();
74
-
75
- if (commits) {
76
- commitMessages = `## Commits\n\n${commits}\n\n`;
77
- }
89
+ const branch = execSync("git branch --show-current", {
90
+ encoding: "utf-8",
91
+ }).trim();
92
+
93
+ // Get commit messages since branching from default branch
94
+ const commits = execSync(
95
+ `git log ${defaultBranch}..${branch} --pretty=format:"- %s"`,
96
+ {
97
+ encoding: "utf-8",
98
+ },
99
+ ).trim();
100
+
101
+ if (commits) {
102
+ commitMessages = `## Commits\n\n${commits}\n\n`;
103
+ }
78
104
  } catch (err) {
79
- console.warn('Could not get git commit info');
105
+ console.warn("Could not get git commit info");
80
106
  }
81
107
 
82
108
  // Get file change stats
83
- let changeStats = '';
109
+ let changeStats = "";
84
110
  try {
85
- const stats = execSync(`git diff --shortstat ${defaultBranch}...HEAD`, {
86
- encoding: 'utf-8',
87
- }).trim();
111
+ const stats = execSync(`git diff --shortstat ${defaultBranch}...HEAD`, {
112
+ encoding: "utf-8",
113
+ }).trim();
88
114
 
89
- if (stats) {
90
- changeStats = `**Changes**: ${stats}\n\n`;
91
- }
115
+ if (stats) {
116
+ changeStats = `**Changes**: ${stats}\n\n`;
117
+ }
92
118
  } catch (err) {
93
- console.warn('Could not get change stats');
119
+ console.warn("Could not get change stats");
94
120
  }
95
121
 
96
122
  // Get previous version from default branch
97
123
  function getPreviousVersion() {
98
- try {
99
- // Try to get package.json from default branch
100
- const previousPackageJson = execSync(`git show origin/${defaultBranch}:package.json`, {
101
- encoding: 'utf-8',
102
- });
103
- const previousPkg = JSON.parse(previousPackageJson);
104
- return previousPkg.version;
105
- } catch (err) {
106
- // Fallback: try to get the latest git tag
107
- try {
108
- const latestTag = execSync('git describe --tags --abbrev=0', {
109
- encoding: 'utf-8',
110
- }).trim();
111
- // Remove 'v' prefix if present
112
- return latestTag.replace(/^v/, '');
113
- } catch {
114
- // Fallback: try to get tags sorted by version
115
- try {
116
- const tags = execSync('git tag --sort=-v:refname', {
117
- encoding: 'utf-8',
118
- }).trim();
119
- const latestTag = tags.split('\n')[0];
120
- if (latestTag) {
121
- return latestTag.replace(/^v/, '');
122
- }
123
- } catch {
124
- console.warn('Could not determine previous version, using current version as fallback');
125
- return packageJson.version;
126
- }
127
- }
128
- }
129
- return packageJson.version;
124
+ try {
125
+ // Try to get package.json from default branch
126
+ const previousPackageJson = execSync(
127
+ `git show origin/${defaultBranch}:package.json`,
128
+ {
129
+ encoding: "utf-8",
130
+ },
131
+ );
132
+ const previousPkg = JSON.parse(previousPackageJson);
133
+ return previousPkg.version;
134
+ } catch (err) {
135
+ // Fallback: try to get the latest git tag
136
+ try {
137
+ const latestTag = execSync("git describe --tags --abbrev=0", {
138
+ encoding: "utf-8",
139
+ }).trim();
140
+ // Remove 'v' prefix if present
141
+ return latestTag.replace(/^v/, "");
142
+ } catch {
143
+ // Fallback: try to get tags sorted by version
144
+ try {
145
+ const tags = execSync("git tag --sort=-v:refname", {
146
+ encoding: "utf-8",
147
+ }).trim();
148
+ const latestTag = tags.split("\n")[0];
149
+ if (latestTag) {
150
+ return latestTag.replace(/^v/, "");
151
+ }
152
+ } catch {
153
+ console.warn(
154
+ "Could not determine previous version, using current version as fallback",
155
+ );
156
+ return packageJson.version;
157
+ }
158
+ }
159
+ }
160
+ return packageJson.version;
130
161
  }
131
162
 
132
163
  // Smart defaults based on branch name and commits
133
164
  function detectChangeType(branchName, commits) {
134
- const name = branchName.toLowerCase();
135
- const commitText = commits.toLowerCase();
136
-
137
- if (name.includes('major') || commitText.includes('breaking') || commitText.includes('major:')) {
138
- return 'Major';
139
- } else if (name.includes('minor') || name.includes('feature') || name.includes('feat')) {
140
- return 'Minor';
141
- } else if (name.includes('patch') || name.includes('fix') || name.includes('hotfix')) {
142
- return 'Patch';
143
- }
144
-
145
- return 'Unknown';
165
+ const name = branchName.toLowerCase();
166
+ const commitText = commits.toLowerCase();
167
+
168
+ if (
169
+ name.includes("major") ||
170
+ commitText.includes("breaking") ||
171
+ commitText.includes("major:")
172
+ ) {
173
+ return "Major";
174
+ }
175
+ if (
176
+ name.includes("minor") ||
177
+ name.includes("feature") ||
178
+ name.includes("feat")
179
+ ) {
180
+ return "Minor";
181
+ }
182
+ if (
183
+ name.includes("patch") ||
184
+ name.includes("fix") ||
185
+ name.includes("hotfix")
186
+ ) {
187
+ return "Patch";
188
+ }
189
+
190
+ return "Unknown";
146
191
  }
147
192
 
148
- const branch = execSync('git branch --show-current', { encoding: 'utf-8' }).trim();
193
+ const branch = execSync("git branch --show-current", {
194
+ encoding: "utf-8",
195
+ }).trim();
149
196
  const changeType = detectChangeType(branch, commitMessages);
150
197
 
151
198
  // Build the description
@@ -153,51 +200,53 @@ let description = template;
153
200
 
154
201
  // Add summary if we have commits
155
202
  if (commitMessages) {
156
- const summarySection = commitMessages.split('\n').slice(0, 5).join('\n');
157
- description = description.replace(
158
- 'Describe the change and its motivation.',
159
- `Describe the change and its motivation.\n\n${summarySection}`,
160
- );
203
+ const summarySection = commitMessages.split("\n").slice(0, 5).join("\n");
204
+ description = description.replace(
205
+ "Describe the change and its motivation.",
206
+ `Describe the change and its motivation.\n\n${summarySection}`,
207
+ );
161
208
  }
162
209
 
163
210
  // Pre-check the type of change if we detected it
164
- if (changeType === 'Major') {
165
- description = description.replace('- [ ] Major', '- [x] Major');
166
- } else if (changeType === 'Minor') {
167
- description = description.replace('- [ ] Minor', '- [x] Minor');
168
- } else if (changeType === 'Patch') {
169
- description = description.replace('- [ ] Patch', '- [x] Patch');
211
+ if (changeType === "Major") {
212
+ description = description.replace("- [ ] Major", "- [x] Major");
213
+ } else if (changeType === "Minor") {
214
+ description = description.replace("- [ ] Minor", "- [x] Minor");
215
+ } else if (changeType === "Patch") {
216
+ description = description.replace("- [ ] Patch", "- [x] Patch");
170
217
  }
171
218
 
172
219
  // Add version info
173
220
  const currentVersion = packageJson.version;
174
221
  const previousVersion = getPreviousVersion();
175
222
  description = description.replace(
176
- '`X.Y.Z` → `X.Y.Z`',
177
- `\`${previousVersion}\` → \`${currentVersion}\``,
223
+ "`X.Y.Z` → `X.Y.Z`",
224
+ `\`${previousVersion}\` → \`${currentVersion}\``,
178
225
  );
179
226
 
180
227
  // Add changelog entries if available
181
228
  if (changelogEntries) {
182
- description += `\n\n---\n\n${changelogEntries}`;
229
+ description += `\n\n---\n\n${changelogEntries}`;
183
230
  }
184
231
 
185
232
  // Add change stats if available
186
233
  if (changeStats) {
187
- description += `\n\n${changeStats}`;
234
+ description += `\n\n${changeStats}`;
188
235
  }
189
236
 
190
237
  // Add commit history
191
238
  if (commitMessages) {
192
- description += `\n${commitMessages}`;
239
+ description += `\n${commitMessages}`;
193
240
  }
194
241
 
195
242
  // Output the description
196
243
  console.log(description);
197
244
 
198
245
  // Optionally write to file
199
- const outputPath = path.join(__dirname, '..', '.pr-description.md');
246
+ const outputPath = path.join(__dirname, "..", ".pr-description.md");
200
247
  fs.writeFileSync(outputPath, description);
201
248
  console.error(`\n✅ PR description written to: ${outputPath}`);
202
- console.error('\nTo create PR with this description:');
203
- console.error(` gh pr create --body-file .pr-description.md --title "Your PR title"`);
249
+ console.error("\nTo create PR with this description:");
250
+ console.error(
251
+ ` gh pr create --body-file .pr-description.md --title "Your PR title"`,
252
+ );