@ontrails/warden 1.0.0-beta.13 → 1.0.0-beta.15

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 (474) hide show
  1. package/.turbo/turbo-lint.log +1 -1
  2. package/CHANGELOG.md +30 -0
  3. package/README.md +31 -20
  4. package/dist/cli.d.ts +19 -2
  5. package/dist/cli.d.ts.map +1 -1
  6. package/dist/cli.js +261 -64
  7. package/dist/cli.js.map +1 -1
  8. package/dist/draft.d.ts +5 -0
  9. package/dist/draft.d.ts.map +1 -0
  10. package/dist/draft.js +16 -0
  11. package/dist/draft.js.map +1 -0
  12. package/dist/drift.d.ts +10 -7
  13. package/dist/drift.d.ts.map +1 -1
  14. package/dist/drift.js +50 -16
  15. package/dist/drift.js.map +1 -1
  16. package/dist/formatters.d.ts +2 -1
  17. package/dist/formatters.d.ts.map +1 -1
  18. package/dist/formatters.js +15 -4
  19. package/dist/formatters.js.map +1 -1
  20. package/dist/index.d.ts +9 -17
  21. package/dist/index.d.ts.map +1 -1
  22. package/dist/index.js +10 -17
  23. package/dist/index.js.map +1 -1
  24. package/dist/rules/ast.d.ts +412 -7
  25. package/dist/rules/ast.d.ts.map +1 -1
  26. package/dist/rules/ast.js +1847 -102
  27. package/dist/rules/ast.js.map +1 -1
  28. package/dist/rules/circular-refs.d.ts +6 -0
  29. package/dist/rules/circular-refs.d.ts.map +1 -0
  30. package/dist/rules/circular-refs.js +83 -0
  31. package/dist/rules/circular-refs.js.map +1 -0
  32. package/dist/rules/context-no-surface-types.d.ts.map +1 -1
  33. package/dist/rules/context-no-surface-types.js +59 -3
  34. package/dist/rules/context-no-surface-types.js.map +1 -1
  35. package/dist/rules/contour-exists.d.ts +7 -0
  36. package/dist/rules/contour-exists.d.ts.map +1 -0
  37. package/dist/rules/contour-exists.js +113 -0
  38. package/dist/rules/contour-exists.js.map +1 -0
  39. package/dist/rules/contour-ids.d.ts +10 -0
  40. package/dist/rules/contour-ids.d.ts.map +1 -0
  41. package/dist/rules/contour-ids.js +12 -0
  42. package/dist/rules/contour-ids.js.map +1 -0
  43. package/dist/rules/cross-declarations.d.ts.map +1 -1
  44. package/dist/rules/cross-declarations.js +171 -57
  45. package/dist/rules/cross-declarations.js.map +1 -1
  46. package/dist/rules/dead-internal-trail.d.ts +3 -0
  47. package/dist/rules/dead-internal-trail.d.ts.map +1 -0
  48. package/dist/rules/dead-internal-trail.js +80 -0
  49. package/dist/rules/dead-internal-trail.js.map +1 -0
  50. package/dist/rules/draft-file-marking.d.ts +6 -0
  51. package/dist/rules/draft-file-marking.d.ts.map +1 -0
  52. package/dist/rules/draft-file-marking.js +87 -0
  53. package/dist/rules/draft-file-marking.js.map +1 -0
  54. package/dist/rules/draft-visible-debt.d.ts +12 -0
  55. package/dist/rules/draft-visible-debt.d.ts.map +1 -0
  56. package/dist/rules/draft-visible-debt.js +50 -0
  57. package/dist/rules/draft-visible-debt.js.map +1 -0
  58. package/dist/rules/error-mapping-completeness.d.ts +13 -0
  59. package/dist/rules/error-mapping-completeness.d.ts.map +1 -0
  60. package/dist/rules/error-mapping-completeness.js +160 -0
  61. package/dist/rules/error-mapping-completeness.js.map +1 -0
  62. package/dist/rules/example-valid.d.ts +6 -0
  63. package/dist/rules/example-valid.d.ts.map +1 -0
  64. package/dist/rules/example-valid.js +203 -0
  65. package/dist/rules/example-valid.js.map +1 -0
  66. package/dist/rules/fires-declarations.d.ts +16 -0
  67. package/dist/rules/fires-declarations.d.ts.map +1 -0
  68. package/dist/rules/fires-declarations.js +444 -0
  69. package/dist/rules/fires-declarations.js.map +1 -0
  70. package/dist/rules/implementation-returns-result.d.ts +9 -0
  71. package/dist/rules/implementation-returns-result.d.ts.map +1 -1
  72. package/dist/rules/implementation-returns-result.js +638 -76
  73. package/dist/rules/implementation-returns-result.js.map +1 -1
  74. package/dist/rules/incomplete-accessor-for-standard-op.d.ts +30 -0
  75. package/dist/rules/incomplete-accessor-for-standard-op.d.ts.map +1 -0
  76. package/dist/rules/incomplete-accessor-for-standard-op.js +226 -0
  77. package/dist/rules/incomplete-accessor-for-standard-op.js.map +1 -0
  78. package/dist/rules/incomplete-crud.d.ts +21 -0
  79. package/dist/rules/incomplete-crud.d.ts.map +1 -0
  80. package/dist/rules/incomplete-crud.js +368 -0
  81. package/dist/rules/incomplete-crud.js.map +1 -0
  82. package/dist/rules/index.d.ts +40 -7
  83. package/dist/rules/index.d.ts.map +1 -1
  84. package/dist/rules/index.js +91 -15
  85. package/dist/rules/index.js.map +1 -1
  86. package/dist/rules/intent-propagation.d.ts +3 -0
  87. package/dist/rules/intent-propagation.d.ts.map +1 -0
  88. package/dist/rules/intent-propagation.js +57 -0
  89. package/dist/rules/intent-propagation.js.map +1 -0
  90. package/dist/rules/missing-reconcile.d.ts +3 -0
  91. package/dist/rules/missing-reconcile.d.ts.map +1 -0
  92. package/dist/rules/missing-reconcile.js +44 -0
  93. package/dist/rules/missing-reconcile.js.map +1 -0
  94. package/dist/rules/missing-visibility.d.ts +3 -0
  95. package/dist/rules/missing-visibility.d.ts.map +1 -0
  96. package/dist/rules/missing-visibility.js +63 -0
  97. package/dist/rules/missing-visibility.js.map +1 -0
  98. package/dist/rules/no-direct-impl-in-route.d.ts.map +1 -1
  99. package/dist/rules/no-direct-impl-in-route.js +0 -3
  100. package/dist/rules/no-direct-impl-in-route.js.map +1 -1
  101. package/dist/rules/no-direct-implementation-call.js +1 -1
  102. package/dist/rules/no-direct-implementation-call.js.map +1 -1
  103. package/dist/rules/no-sync-result-assumption.d.ts.map +1 -1
  104. package/dist/rules/no-sync-result-assumption.js +870 -61
  105. package/dist/rules/no-sync-result-assumption.js.map +1 -1
  106. package/dist/rules/no-throw-in-detour-recover.d.ts +3 -0
  107. package/dist/rules/no-throw-in-detour-recover.d.ts.map +1 -0
  108. package/dist/rules/no-throw-in-detour-recover.js +147 -0
  109. package/dist/rules/no-throw-in-detour-recover.js.map +1 -0
  110. package/dist/rules/no-throw-in-detour-target.d.ts +4 -1
  111. package/dist/rules/no-throw-in-detour-target.d.ts.map +1 -1
  112. package/dist/rules/no-throw-in-detour-target.js +6 -3
  113. package/dist/rules/no-throw-in-detour-target.js.map +1 -1
  114. package/dist/rules/no-throw-in-implementation.d.ts +4 -2
  115. package/dist/rules/no-throw-in-implementation.d.ts.map +1 -1
  116. package/dist/rules/no-throw-in-implementation.js +6 -4
  117. package/dist/rules/no-throw-in-implementation.js.map +1 -1
  118. package/dist/rules/on-references-exist.d.ts +14 -0
  119. package/dist/rules/on-references-exist.d.ts.map +1 -0
  120. package/dist/rules/on-references-exist.js +109 -0
  121. package/dist/rules/on-references-exist.js.map +1 -0
  122. package/dist/rules/orphaned-signal.d.ts +3 -0
  123. package/dist/rules/orphaned-signal.d.ts.map +1 -0
  124. package/dist/rules/orphaned-signal.js +67 -0
  125. package/dist/rules/orphaned-signal.js.map +1 -0
  126. package/dist/rules/permit-governance.d.ts +3 -0
  127. package/dist/rules/permit-governance.d.ts.map +1 -0
  128. package/dist/rules/permit-governance.js +15 -0
  129. package/dist/rules/permit-governance.js.map +1 -0
  130. package/dist/rules/reference-exists.d.ts +6 -0
  131. package/dist/rules/reference-exists.d.ts.map +1 -0
  132. package/dist/rules/reference-exists.js +47 -0
  133. package/dist/rules/reference-exists.js.map +1 -0
  134. package/dist/rules/registry-names.d.ts +8 -0
  135. package/dist/rules/registry-names.d.ts.map +1 -0
  136. package/dist/rules/registry-names.js +83 -0
  137. package/dist/rules/registry-names.js.map +1 -0
  138. package/dist/rules/resource-declarations.d.ts +14 -0
  139. package/dist/rules/resource-declarations.d.ts.map +1 -0
  140. package/dist/rules/resource-declarations.js +413 -0
  141. package/dist/rules/resource-declarations.js.map +1 -0
  142. package/dist/rules/resource-exists.d.ts +6 -0
  143. package/dist/rules/resource-exists.d.ts.map +1 -0
  144. package/dist/rules/resource-exists.js +90 -0
  145. package/dist/rules/resource-exists.js.map +1 -0
  146. package/dist/rules/resource-id-grammar.d.ts +3 -0
  147. package/dist/rules/resource-id-grammar.d.ts.map +1 -0
  148. package/dist/rules/resource-id-grammar.js +39 -0
  149. package/dist/rules/resource-id-grammar.js.map +1 -0
  150. package/dist/rules/specs.d.ts.map +1 -1
  151. package/dist/rules/specs.js +5 -1
  152. package/dist/rules/specs.js.map +1 -1
  153. package/dist/rules/types.d.ts +53 -4
  154. package/dist/rules/types.d.ts.map +1 -1
  155. package/dist/rules/unreachable-detour-shadowing.d.ts +3 -0
  156. package/dist/rules/unreachable-detour-shadowing.d.ts.map +1 -0
  157. package/dist/rules/unreachable-detour-shadowing.js +202 -0
  158. package/dist/rules/unreachable-detour-shadowing.js.map +1 -0
  159. package/dist/rules/valid-describe-refs.d.ts.map +1 -1
  160. package/dist/rules/valid-describe-refs.js +132 -16
  161. package/dist/rules/valid-describe-refs.js.map +1 -1
  162. package/dist/rules/valid-detour-contract.d.ts +3 -0
  163. package/dist/rules/valid-detour-contract.d.ts.map +1 -0
  164. package/dist/rules/valid-detour-contract.js +47 -0
  165. package/dist/rules/valid-detour-contract.js.map +1 -0
  166. package/dist/rules/valid-detour-refs.d.ts.map +1 -1
  167. package/dist/rules/valid-detour-refs.js +73 -82
  168. package/dist/rules/valid-detour-refs.js.map +1 -1
  169. package/dist/rules/warden-export-symmetry.d.ts +7 -0
  170. package/dist/rules/warden-export-symmetry.d.ts.map +1 -0
  171. package/dist/rules/warden-export-symmetry.js +352 -0
  172. package/dist/rules/warden-export-symmetry.js.map +1 -0
  173. package/dist/rules/warden-rules-use-ast.d.ts +17 -0
  174. package/dist/rules/warden-rules-use-ast.d.ts.map +1 -0
  175. package/dist/rules/warden-rules-use-ast.js +778 -0
  176. package/dist/rules/warden-rules-use-ast.js.map +1 -0
  177. package/dist/trails/circular-refs.trail.d.ts +24 -0
  178. package/dist/trails/circular-refs.trail.d.ts.map +1 -0
  179. package/dist/trails/circular-refs.trail.js +29 -0
  180. package/dist/trails/circular-refs.trail.js.map +1 -0
  181. package/dist/trails/context-no-surface-types.trail.d.ts +2 -2
  182. package/dist/trails/context-no-surface-types.trail.d.ts.map +1 -1
  183. package/dist/trails/context-no-trailhead-types.trail.d.ts +2 -2
  184. package/dist/trails/context-no-trailhead-types.trail.d.ts.map +1 -1
  185. package/dist/trails/contour-exists.trail.d.ts +24 -0
  186. package/dist/trails/contour-exists.trail.d.ts.map +1 -0
  187. package/dist/trails/contour-exists.trail.js +21 -0
  188. package/dist/trails/contour-exists.trail.js.map +1 -0
  189. package/dist/trails/cross-declarations.trail.d.ts +2 -2
  190. package/dist/trails/cross-declarations.trail.d.ts.map +1 -1
  191. package/dist/trails/dead-internal-trail.trail.d.ts +24 -0
  192. package/dist/trails/dead-internal-trail.trail.d.ts.map +1 -0
  193. package/dist/trails/dead-internal-trail.trail.js +26 -0
  194. package/dist/trails/dead-internal-trail.trail.js.map +1 -0
  195. package/dist/trails/{provision-declarations.trail.d.ts → draft-file-marking.trail.d.ts} +3 -3
  196. package/dist/trails/draft-file-marking.trail.d.ts.map +1 -0
  197. package/dist/trails/draft-file-marking.trail.js +16 -0
  198. package/dist/trails/draft-file-marking.trail.js.map +1 -0
  199. package/dist/trails/draft-visible-debt.trail.d.ts +13 -0
  200. package/dist/trails/draft-visible-debt.trail.d.ts.map +1 -0
  201. package/dist/trails/draft-visible-debt.trail.js +16 -0
  202. package/dist/trails/draft-visible-debt.trail.js.map +1 -0
  203. package/dist/trails/error-mapping-completeness.trail.d.ts +13 -0
  204. package/dist/trails/error-mapping-completeness.trail.d.ts.map +1 -0
  205. package/dist/trails/error-mapping-completeness.trail.js +29 -0
  206. package/dist/trails/error-mapping-completeness.trail.js.map +1 -0
  207. package/dist/trails/{follow-declarations.trail.d.ts → example-valid.trail.d.ts} +3 -3
  208. package/dist/trails/example-valid.trail.d.ts.map +1 -0
  209. package/dist/trails/example-valid.trail.js +25 -0
  210. package/dist/trails/example-valid.trail.js.map +1 -0
  211. package/dist/trails/fires-declarations.trail.d.ts +13 -0
  212. package/dist/trails/fires-declarations.trail.d.ts.map +1 -0
  213. package/dist/trails/fires-declarations.trail.js +22 -0
  214. package/dist/trails/fires-declarations.trail.js.map +1 -0
  215. package/dist/trails/implementation-returns-result.trail.d.ts +2 -2
  216. package/dist/trails/implementation-returns-result.trail.d.ts.map +1 -1
  217. package/dist/trails/incomplete-accessor-for-standard-op.trail.d.ts +12 -0
  218. package/dist/trails/incomplete-accessor-for-standard-op.trail.d.ts.map +1 -0
  219. package/dist/trails/incomplete-accessor-for-standard-op.trail.js +60 -0
  220. package/dist/trails/incomplete-accessor-for-standard-op.trail.js.map +1 -0
  221. package/dist/trails/incomplete-crud.trail.d.ts +24 -0
  222. package/dist/trails/incomplete-crud.trail.d.ts.map +1 -0
  223. package/dist/trails/incomplete-crud.trail.js +39 -0
  224. package/dist/trails/incomplete-crud.trail.js.map +1 -0
  225. package/dist/trails/index.d.ts +29 -7
  226. package/dist/trails/index.d.ts.map +1 -1
  227. package/dist/trails/index.js +28 -6
  228. package/dist/trails/index.js.map +1 -1
  229. package/dist/trails/intent-propagation.trail.d.ts +24 -0
  230. package/dist/trails/intent-propagation.trail.d.ts.map +1 -0
  231. package/dist/trails/intent-propagation.trail.js +30 -0
  232. package/dist/trails/intent-propagation.trail.js.map +1 -0
  233. package/dist/trails/missing-reconcile.trail.d.ts +24 -0
  234. package/dist/trails/missing-reconcile.trail.d.ts.map +1 -0
  235. package/dist/trails/missing-reconcile.trail.js +33 -0
  236. package/dist/trails/missing-reconcile.trail.js.map +1 -0
  237. package/dist/trails/missing-visibility.trail.d.ts +24 -0
  238. package/dist/trails/missing-visibility.trail.d.ts.map +1 -0
  239. package/dist/trails/missing-visibility.trail.js +22 -0
  240. package/dist/trails/missing-visibility.trail.js.map +1 -0
  241. package/dist/trails/no-direct-impl-in-route.trail.d.ts +2 -2
  242. package/dist/trails/no-direct-impl-in-route.trail.d.ts.map +1 -1
  243. package/dist/trails/no-direct-implementation-call.trail.d.ts +2 -2
  244. package/dist/trails/no-direct-implementation-call.trail.d.ts.map +1 -1
  245. package/dist/trails/no-sync-result-assumption.trail.d.ts +2 -2
  246. package/dist/trails/no-sync-result-assumption.trail.d.ts.map +1 -1
  247. package/dist/trails/no-throw-in-detour-recover.trail.d.ts +13 -0
  248. package/dist/trails/no-throw-in-detour-recover.trail.d.ts.map +1 -0
  249. package/dist/trails/no-throw-in-detour-recover.trail.js +24 -0
  250. package/dist/trails/no-throw-in-detour-recover.trail.js.map +1 -0
  251. package/dist/trails/no-throw-in-detour-target.trail.d.ts +13 -3
  252. package/dist/trails/no-throw-in-detour-target.trail.d.ts.map +1 -1
  253. package/dist/trails/no-throw-in-implementation.trail.d.ts +2 -2
  254. package/dist/trails/no-throw-in-implementation.trail.d.ts.map +1 -1
  255. package/dist/trails/on-references-exist.trail.d.ts +24 -0
  256. package/dist/trails/on-references-exist.trail.d.ts.map +1 -0
  257. package/dist/trails/on-references-exist.trail.js +21 -0
  258. package/dist/trails/on-references-exist.trail.js.map +1 -0
  259. package/dist/trails/orphaned-signal.trail.d.ts +24 -0
  260. package/dist/trails/orphaned-signal.trail.d.ts.map +1 -0
  261. package/dist/trails/orphaned-signal.trail.js +36 -0
  262. package/dist/trails/orphaned-signal.trail.js.map +1 -0
  263. package/dist/trails/permit-governance.trail.d.ts +12 -0
  264. package/dist/trails/permit-governance.trail.d.ts.map +1 -0
  265. package/dist/trails/permit-governance.trail.js +47 -0
  266. package/dist/trails/permit-governance.trail.js.map +1 -0
  267. package/dist/trails/prefer-schema-inference.trail.d.ts +2 -2
  268. package/dist/trails/prefer-schema-inference.trail.d.ts.map +1 -1
  269. package/dist/trails/reference-exists.trail.d.ts +24 -0
  270. package/dist/trails/reference-exists.trail.d.ts.map +1 -0
  271. package/dist/trails/reference-exists.trail.js +25 -0
  272. package/dist/trails/reference-exists.trail.js.map +1 -0
  273. package/dist/trails/resource-declarations.trail.d.ts +13 -0
  274. package/dist/trails/resource-declarations.trail.d.ts.map +1 -0
  275. package/dist/trails/{provision-declarations.trail.js → resource-declarations.trail.js} +7 -7
  276. package/dist/trails/resource-declarations.trail.js.map +1 -0
  277. package/dist/trails/resource-exists.trail.d.ts +24 -0
  278. package/dist/trails/resource-exists.trail.d.ts.map +1 -0
  279. package/dist/trails/{provision-exists.trail.js → resource-exists.trail.js} +8 -8
  280. package/dist/trails/resource-exists.trail.js.map +1 -0
  281. package/dist/trails/resource-id-grammar.trail.d.ts +13 -0
  282. package/dist/trails/resource-id-grammar.trail.d.ts.map +1 -0
  283. package/dist/trails/resource-id-grammar.trail.js +38 -0
  284. package/dist/trails/resource-id-grammar.trail.js.map +1 -0
  285. package/dist/trails/run.d.ts +25 -9
  286. package/dist/trails/run.d.ts.map +1 -1
  287. package/dist/trails/run.js +63 -19
  288. package/dist/trails/run.js.map +1 -1
  289. package/dist/trails/schema.d.ts +28 -3
  290. package/dist/trails/schema.d.ts.map +1 -1
  291. package/dist/trails/schema.js +57 -4
  292. package/dist/trails/schema.js.map +1 -1
  293. package/dist/trails/unreachable-detour-shadowing.trail.d.ts +13 -0
  294. package/dist/trails/unreachable-detour-shadowing.trail.d.ts.map +1 -0
  295. package/dist/trails/unreachable-detour-shadowing.trail.js +44 -0
  296. package/dist/trails/unreachable-detour-shadowing.trail.js.map +1 -0
  297. package/dist/trails/valid-describe-refs.trail.d.ts +12 -3
  298. package/dist/trails/valid-describe-refs.trail.d.ts.map +1 -1
  299. package/dist/trails/valid-detour-contract.trail.d.ts +12 -0
  300. package/dist/trails/valid-detour-contract.trail.d.ts.map +1 -0
  301. package/dist/trails/valid-detour-contract.trail.js +66 -0
  302. package/dist/trails/valid-detour-contract.trail.js.map +1 -0
  303. package/dist/trails/valid-detour-refs.trail.d.ts +13 -3
  304. package/dist/trails/valid-detour-refs.trail.d.ts.map +1 -1
  305. package/dist/trails/warden-export-symmetry.trail.d.ts +13 -0
  306. package/dist/trails/warden-export-symmetry.trail.d.ts.map +1 -0
  307. package/dist/trails/warden-export-symmetry.trail.js +16 -0
  308. package/dist/trails/warden-export-symmetry.trail.js.map +1 -0
  309. package/dist/trails/warden-rules-use-ast.trail.d.ts +13 -0
  310. package/dist/trails/warden-rules-use-ast.trail.d.ts.map +1 -0
  311. package/dist/trails/warden-rules-use-ast.trail.js +41 -0
  312. package/dist/trails/warden-rules-use-ast.trail.js.map +1 -0
  313. package/dist/trails/wrap-rule.d.ts +16 -2
  314. package/dist/trails/wrap-rule.d.ts.map +1 -1
  315. package/dist/trails/wrap-rule.js +71 -11
  316. package/dist/trails/wrap-rule.js.map +1 -1
  317. package/package.json +7 -4
  318. package/src/__tests__/ast.test.ts +613 -0
  319. package/src/__tests__/circular-refs.test.ts +121 -0
  320. package/src/__tests__/cli.test.ts +360 -32
  321. package/src/__tests__/contour-exists.test.ts +203 -0
  322. package/src/__tests__/cross-declarations.test.ts +245 -0
  323. package/src/__tests__/dead-internal-trail.test.ts +81 -0
  324. package/src/__tests__/draft-rules-context.test.ts +150 -0
  325. package/src/__tests__/drift.test.ts +75 -5
  326. package/src/__tests__/error-mapping-completeness.test.ts +56 -0
  327. package/src/__tests__/example-valid.test.ts +101 -0
  328. package/src/__tests__/fires-declarations-param-destructure.test.ts +54 -0
  329. package/src/__tests__/fires-declarations.test.ts +652 -0
  330. package/src/__tests__/formatters.test.ts +2 -2
  331. package/src/__tests__/implementation-returns-result.test.ts +1016 -2
  332. package/src/__tests__/incomplete-accessor-for-standard-op.test.ts +337 -0
  333. package/src/__tests__/incomplete-crud.test.ts +498 -0
  334. package/src/__tests__/intent-propagation.test.ts +116 -0
  335. package/src/__tests__/missing-reconcile.test.ts +154 -0
  336. package/src/__tests__/missing-visibility.test.ts +108 -0
  337. package/src/__tests__/no-sync-result-assumption.test.ts +870 -39
  338. package/src/__tests__/no-throw-in-detour-recover.test.ts +93 -0
  339. package/src/__tests__/no-throw-in-implementation.test.ts +88 -0
  340. package/src/__tests__/on-references-exist.test.ts +151 -0
  341. package/src/__tests__/orphaned-signal.test.ts +137 -0
  342. package/src/__tests__/permit-governance.test.ts +66 -0
  343. package/src/__tests__/reference-exists.test.ts +281 -0
  344. package/src/__tests__/resource-declarations.test.ts +448 -0
  345. package/src/__tests__/resource-exists.test.ts +122 -0
  346. package/src/__tests__/resource-id-grammar.test.ts +50 -0
  347. package/src/__tests__/rules.test.ts +17 -77
  348. package/src/__tests__/topo-aware-rule.test.ts +257 -0
  349. package/src/__tests__/trails.test.ts +2 -2
  350. package/src/__tests__/unreachable-detour-shadowing.test.ts +128 -0
  351. package/src/__tests__/valid-describe-refs.test.ts +183 -0
  352. package/src/__tests__/valid-detour-contract.test.ts +86 -0
  353. package/src/__tests__/warden-export-symmetry.test.ts +251 -0
  354. package/src/__tests__/warden-rules-use-ast.test.ts +468 -0
  355. package/src/__tests__/wrap-rule.test.ts +3 -3
  356. package/src/cli.ts +458 -91
  357. package/src/draft.ts +22 -0
  358. package/src/drift.ts +63 -21
  359. package/src/formatters.ts +15 -4
  360. package/src/index.ts +62 -23
  361. package/src/rules/ast.ts +2715 -119
  362. package/src/rules/circular-refs.ts +154 -0
  363. package/src/rules/{context-no-trailhead-types.ts → context-no-surface-types.ts} +72 -12
  364. package/src/rules/contour-exists.ts +251 -0
  365. package/src/rules/contour-ids.ts +15 -0
  366. package/src/rules/cross-declarations.ts +277 -69
  367. package/src/rules/dead-internal-trail.ts +141 -0
  368. package/src/rules/draft-file-marking.ts +160 -0
  369. package/src/rules/draft-visible-debt.ts +87 -0
  370. package/src/rules/error-mapping-completeness.ts +273 -0
  371. package/src/rules/example-valid.ts +401 -0
  372. package/src/rules/fires-declarations.ts +609 -0
  373. package/src/rules/implementation-returns-result.ts +1042 -122
  374. package/src/rules/incomplete-accessor-for-standard-op.ts +315 -0
  375. package/src/rules/incomplete-crud.ts +579 -0
  376. package/src/rules/index.ts +95 -16
  377. package/src/rules/intent-propagation.ts +142 -0
  378. package/src/rules/missing-reconcile.ts +98 -0
  379. package/src/rules/missing-visibility.ts +110 -0
  380. package/src/rules/no-direct-impl-in-route.ts +0 -4
  381. package/src/rules/no-direct-implementation-call.ts +1 -1
  382. package/src/rules/no-sync-result-assumption.ts +1134 -96
  383. package/src/rules/no-throw-in-detour-recover.ts +225 -0
  384. package/src/rules/no-throw-in-implementation.ts +6 -4
  385. package/src/rules/on-references-exist.ts +194 -0
  386. package/src/rules/orphaned-signal.ts +150 -0
  387. package/src/rules/permit-governance.ts +25 -0
  388. package/src/rules/reference-exists.ts +98 -0
  389. package/src/rules/registry-names.ts +83 -0
  390. package/src/rules/{provision-declarations.ts → resource-declarations.ts} +208 -138
  391. package/src/rules/{provision-exists.ts → resource-exists.ts} +48 -51
  392. package/src/rules/resource-id-grammar.ts +65 -0
  393. package/src/rules/specs.ts +5 -1
  394. package/src/rules/types.ts +57 -4
  395. package/src/rules/unreachable-detour-shadowing.ts +375 -0
  396. package/src/rules/valid-describe-refs.ts +160 -32
  397. package/src/rules/valid-detour-contract.ts +78 -0
  398. package/src/rules/warden-export-symmetry.ts +533 -0
  399. package/src/rules/warden-rules-use-ast.ts +996 -0
  400. package/src/trails/circular-refs.trail.ts +29 -0
  401. package/src/trails/{context-no-trailhead-types.trail.ts → context-no-surface-types.trail.ts} +4 -4
  402. package/src/trails/contour-exists.trail.ts +21 -0
  403. package/src/trails/dead-internal-trail.trail.ts +26 -0
  404. package/src/trails/draft-file-marking.trail.ts +16 -0
  405. package/src/trails/draft-visible-debt.trail.ts +16 -0
  406. package/src/trails/error-mapping-completeness.trail.ts +29 -0
  407. package/src/trails/example-valid.trail.ts +25 -0
  408. package/src/trails/fires-declarations.trail.ts +22 -0
  409. package/src/trails/incomplete-accessor-for-standard-op.trail.ts +76 -0
  410. package/src/trails/incomplete-crud.trail.ts +39 -0
  411. package/src/trails/index.ts +40 -7
  412. package/src/trails/intent-propagation.trail.ts +30 -0
  413. package/src/trails/missing-reconcile.trail.ts +33 -0
  414. package/src/trails/missing-visibility.trail.ts +22 -0
  415. package/src/trails/no-throw-in-detour-recover.trail.ts +24 -0
  416. package/src/trails/on-references-exist.trail.ts +21 -0
  417. package/src/trails/orphaned-signal.trail.ts +36 -0
  418. package/src/trails/permit-governance.trail.ts +51 -0
  419. package/src/trails/reference-exists.trail.ts +25 -0
  420. package/src/trails/{provision-declarations.trail.ts → resource-declarations.trail.ts} +6 -6
  421. package/src/trails/{provision-exists.trail.ts → resource-exists.trail.ts} +7 -7
  422. package/src/trails/resource-id-grammar.trail.ts +39 -0
  423. package/src/trails/run.ts +121 -24
  424. package/src/trails/schema.ts +66 -4
  425. package/src/trails/unreachable-detour-shadowing.trail.ts +45 -0
  426. package/src/trails/valid-detour-contract.trail.ts +71 -0
  427. package/src/trails/warden-export-symmetry.trail.ts +16 -0
  428. package/src/trails/warden-rules-use-ast.trail.ts +45 -0
  429. package/src/trails/wrap-rule.ts +104 -12
  430. package/tsconfig.tests.json +10 -0
  431. package/tsconfig.tsbuildinfo +1 -1
  432. package/dist/rules/follow-declarations.d.ts +0 -13
  433. package/dist/rules/follow-declarations.d.ts.map +0 -1
  434. package/dist/rules/follow-declarations.js +0 -264
  435. package/dist/rules/follow-declarations.js.map +0 -1
  436. package/dist/rules/provision-declarations.d.ts +0 -14
  437. package/dist/rules/provision-declarations.d.ts.map +0 -1
  438. package/dist/rules/provision-declarations.js +0 -344
  439. package/dist/rules/provision-declarations.js.map +0 -1
  440. package/dist/rules/provision-exists.d.ts +0 -6
  441. package/dist/rules/provision-exists.d.ts.map +0 -1
  442. package/dist/rules/provision-exists.js +0 -89
  443. package/dist/rules/provision-exists.js.map +0 -1
  444. package/dist/rules/service-declarations.d.ts +0 -16
  445. package/dist/rules/service-declarations.d.ts.map +0 -1
  446. package/dist/rules/service-declarations.js +0 -346
  447. package/dist/rules/service-declarations.js.map +0 -1
  448. package/dist/rules/service-exists.d.ts +0 -8
  449. package/dist/rules/service-exists.d.ts.map +0 -1
  450. package/dist/rules/service-exists.js +0 -91
  451. package/dist/rules/service-exists.js.map +0 -1
  452. package/dist/trails/follow-declarations.trail.d.ts.map +0 -1
  453. package/dist/trails/follow-declarations.trail.js +0 -22
  454. package/dist/trails/follow-declarations.trail.js.map +0 -1
  455. package/dist/trails/provision-declarations.trail.d.ts.map +0 -1
  456. package/dist/trails/provision-declarations.trail.js.map +0 -1
  457. package/dist/trails/provision-exists.trail.d.ts +0 -15
  458. package/dist/trails/provision-exists.trail.d.ts.map +0 -1
  459. package/dist/trails/provision-exists.trail.js.map +0 -1
  460. package/dist/trails/service-declarations.trail.d.ts +0 -26
  461. package/dist/trails/service-declarations.trail.d.ts.map +0 -1
  462. package/dist/trails/service-declarations.trail.js +0 -27
  463. package/dist/trails/service-declarations.trail.js.map +0 -1
  464. package/dist/trails/service-exists.trail.d.ts +0 -32
  465. package/dist/trails/service-exists.trail.d.ts.map +0 -1
  466. package/dist/trails/service-exists.trail.js +0 -29
  467. package/dist/trails/service-exists.trail.js.map +0 -1
  468. package/src/__tests__/no-throw-in-detour-target.test.ts +0 -78
  469. package/src/__tests__/provision-declarations.test.ts +0 -318
  470. package/src/__tests__/provision-exists.test.ts +0 -122
  471. package/src/rules/no-throw-in-detour-target.ts +0 -150
  472. package/src/rules/valid-detour-refs.ts +0 -187
  473. package/src/trails/no-throw-in-detour-target.trail.ts +0 -20
  474. package/src/trails/valid-detour-refs.trail.ts +0 -24
@@ -1,29 +0,0 @@
1
- import { provisionExists } from '../rules/service-exists.js';
2
- import { wrapRule } from './wrap-rule.js';
3
- export const provisionExistsTrail = wrapRule({
4
- examples: [
5
- {
6
- expected: { diagnostics: [] },
7
- input: {
8
- filePath: 'clean.ts',
9
- knownProvisionIds: ['db.main'],
10
- knownTrailIds: ['entity.show'],
11
- sourceCode: `const db = provision("db.main", {
12
- create: () => Result.ok({ source: "factory" }),
13
- });
14
-
15
- trail("entity.show", {
16
- provisions: [db],
17
- blaze: async (_input, ctx) => {
18
- return Result.ok(db.from(ctx));
19
- }
20
- })`,
21
- },
22
- name: 'Declared provisions resolve to known project provisions',
23
- },
24
- ],
25
- rule: provisionExists,
26
- });
27
- /** Backward-compatible alias while the migration is in flight. */
28
- export const serviceExistsTrail = provisionExistsTrail;
29
- //# sourceMappingURL=service-exists.trail.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"service-exists.trail.js","sourceRoot":"","sources":["../../src/trails/service-exists.trail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC3C,QAAQ,EAAE;QACR;YACE,QAAQ,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;YAC7B,KAAK,EAAE;gBACL,QAAQ,EAAE,UAAU;gBACpB,iBAAiB,EAAE,CAAC,SAAS,CAAC;gBAC9B,aAAa,EAAE,CAAC,aAAa,CAAC;gBAC9B,UAAU,EAAE;;;;;;;;;GASjB;aACI;YACD,IAAI,EAAE,yDAAyD;SAChE;KACF;IACD,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC;AAEH,kEAAkE;AAClE,MAAM,CAAC,MAAM,kBAAkB,GAAG,oBAAoB,CAAC"}
@@ -1,78 +0,0 @@
1
- import { describe, expect, test } from 'bun:test';
2
-
3
- import { noThrowInDetourTarget } from '../rules/no-throw-in-detour-target.js';
4
-
5
- const TEST_FILE = 'test.ts';
6
-
7
- describe('no-throw-in-detour-target', () => {
8
- test('flags throw inside a detour target implementation', () => {
9
- const code = `
10
- trail("entity.show", {
11
- detours: { NotFoundError: ["entity.fallback"] },
12
- blaze: async (input, ctx) => Result.ok({ id: "123" })
13
- })
14
-
15
- trail("entity.fallback", {
16
- blaze: async (input, ctx) => {
17
- throw new Error("boom");
18
- }
19
- })`;
20
-
21
- const diagnostics = noThrowInDetourTarget.check(code, TEST_FILE);
22
-
23
- expect(diagnostics.length).toBe(1);
24
- expect(diagnostics[0]?.rule).toBe('no-throw-in-detour-target');
25
- expect(diagnostics[0]?.severity).toBe('error');
26
- });
27
-
28
- test('allows throw in implementations that are not detour targets', () => {
29
- const code = `
30
- trail("entity.show", {
31
- blaze: async (input, ctx) => {
32
- throw new Error("boom");
33
- }
34
- })`;
35
-
36
- const diagnostics = noThrowInDetourTarget.check(code, TEST_FILE);
37
-
38
- expect(diagnostics.length).toBe(0);
39
- });
40
-
41
- test('flags concise detour target implementations that throw inline', () => {
42
- const code = `
43
- trail("entity.show", {
44
- detours: { NotFoundError: ["entity.fallback"] },
45
- blaze: async (input, ctx) => Result.ok({ id: "123" })
46
- })
47
-
48
- trail("entity.fallback", {
49
- blaze: async (input, ctx) => { throw new Error("boom"); }
50
- })`;
51
-
52
- const diagnostics = noThrowInDetourTarget.check(code, TEST_FILE);
53
-
54
- expect(diagnostics.length).toBe(1);
55
- expect(diagnostics[0]?.message).toContain('entity.fallback');
56
- });
57
-
58
- test('uses project context when the detour target is defined in another file', () => {
59
- const code = `
60
- trail("entity.fallback", {
61
- blaze: async (input, ctx) => {
62
- throw new Error("boom");
63
- }
64
- })`;
65
-
66
- const diagnostics = noThrowInDetourTarget.checkWithContext(
67
- code,
68
- TEST_FILE,
69
- {
70
- detourTargetTrailIds: new Set(['entity.fallback']),
71
- knownTrailIds: new Set(['entity.show', 'entity.fallback']),
72
- }
73
- );
74
-
75
- expect(diagnostics).toHaveLength(1);
76
- expect(diagnostics[0]?.rule).toBe('no-throw-in-detour-target');
77
- });
78
- });
@@ -1,318 +0,0 @@
1
- import { describe, expect, test } from 'bun:test';
2
-
3
- import { provisionDeclarations } from '../rules/provision-declarations.js';
4
-
5
- const TEST_FILE = 'test.ts';
6
-
7
- describe('provision-declarations', () => {
8
- describe('clean cases', () => {
9
- test('declared provisions match provision.from(ctx) usage', () => {
10
- const code = `
11
- import { Result, provision, trail } from '@ontrails/core';
12
-
13
- const db = provision('db.main', {
14
- create: () => Result.ok({ source: 'factory' }),
15
- });
16
-
17
- trail('entity.show', {
18
- provisions: [db],
19
- blaze: async (_input, ctx) => {
20
- return Result.ok({ source: db.from(ctx).source });
21
- },
22
- });
23
- `;
24
-
25
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
26
-
27
- expect(diagnostics.length).toBe(0);
28
- });
29
-
30
- test('local helper named provision() is not treated as ctx lookup', () => {
31
- const code = `
32
- import { Result, provision, trail } from '@ontrails/core';
33
-
34
- const db = provision('db.main', {
35
- create: () => Result.ok({ source: 'factory' }),
36
- });
37
-
38
- trail('entity.show', {
39
- provisions: [db],
40
- blaze: async (_input, ctx) => {
41
- const provision = (id: string) => id;
42
- return Result.ok({
43
- resolved: provision('db.main'),
44
- source: db.from(ctx).source,
45
- });
46
- },
47
- });
48
- `;
49
-
50
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
51
-
52
- expect(diagnostics.length).toBe(0);
53
- });
54
-
55
- test('declared provisions match ctx.provision() usage', () => {
56
- const code = `
57
- import { Result, provision, trail } from '@ontrails/core';
58
-
59
- const db = provision('db.main', {
60
- create: () => Result.ok({ source: 'factory' }),
61
- });
62
-
63
- trail('entity.show', {
64
- provisions: [db],
65
- blaze: async (_input, ctx) => {
66
- const resolved = ctx.provision('db.main');
67
- return Result.ok(resolved);
68
- },
69
- });
70
- `;
71
-
72
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
73
-
74
- expect(diagnostics.length).toBe(0);
75
- });
76
-
77
- test('recognizes destructured provision() calls', () => {
78
- const code = `
79
- import { Result, provision, trail } from '@ontrails/core';
80
-
81
- const db = provision('db.main', {
82
- create: () => Result.ok({ source: 'factory' }),
83
- });
84
-
85
- trail('entity.show', {
86
- provisions: [db],
87
- blaze: async (_input, ctx) => {
88
- const { provision } = ctx;
89
- return Result.ok(provision('db.main'));
90
- },
91
- });
92
- `;
93
-
94
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
95
-
96
- expect(diagnostics.length).toBe(0);
97
- });
98
-
99
- test('recognizes ctx.provision(db) lookups by declared provision object', () => {
100
- const code = `
101
- import { Result, provision, trail } from '@ontrails/core';
102
-
103
- const db = provision('db.main', {
104
- create: () => Result.ok({ source: 'factory' }),
105
- });
106
-
107
- trail('entity.show', {
108
- provisions: [db],
109
- blaze: async (_input, ctx) => {
110
- return Result.ok(ctx.provision(db));
111
- },
112
- });
113
- `;
114
-
115
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
116
-
117
- expect(diagnostics.length).toBe(0);
118
- });
119
- });
120
-
121
- describe('error cases', () => {
122
- test('provision.from(ctx) without a declaration produces an error', () => {
123
- const code = `
124
- import { Result, provision, trail } from '@ontrails/core';
125
-
126
- const db = provision('db.main', {
127
- create: () => Result.ok({ source: 'factory' }),
128
- });
129
-
130
- trail('entity.show', {
131
- blaze: async (_input, ctx) => {
132
- return Result.ok({ source: db.from(ctx).source });
133
- },
134
- });
135
- `;
136
-
137
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
138
-
139
- expect(diagnostics.length).toBe(1);
140
- expect(diagnostics[0]?.severity).toBe('error');
141
- expect(diagnostics[0]?.rule).toBe('provision-declarations');
142
- expect(diagnostics[0]?.message).toContain('db.from(ctx)');
143
- expect(diagnostics[0]?.message).toContain('not declared in provisions');
144
- });
145
-
146
- test('ctx.provision() without a declaration produces an error', () => {
147
- const code = `
148
- trail('entity.show', {
149
- blaze: async (_input, ctx) => {
150
- return Result.ok(ctx.provision('db.main'));
151
- },
152
- });
153
- `;
154
-
155
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
156
-
157
- expect(diagnostics.length).toBe(1);
158
- expect(diagnostics[0]?.severity).toBe('error');
159
- expect(diagnostics[0]?.message).toContain("ctx.provision('db.main')");
160
- });
161
-
162
- test('unresolved imported provision declarations do not suppress lookup diagnostics', () => {
163
- const code = `
164
- import { Result, trail } from '@ontrails/core';
165
- import { db } from './provisions';
166
-
167
- // const db = provision('db.main', {
168
- // create: () => Result.ok({ source: 'factory' }),
169
- // });
170
-
171
- trail('entity.show', {
172
- provisions: [db],
173
- blaze: async (_input, ctx) => {
174
- return Result.ok(ctx.provision('db.main'));
175
- },
176
- });
177
- `;
178
-
179
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
180
-
181
- expect(diagnostics.length).toBe(1);
182
- expect(diagnostics[0]?.severity).toBe('error');
183
- expect(diagnostics[0]?.message).toContain("ctx.provision('db.main')");
184
- });
185
-
186
- test('ctx.provision(db) without a declaration produces an error', () => {
187
- const code = `
188
- import { Result, provision, trail } from '@ontrails/core';
189
-
190
- const db = provision('db.main', {
191
- create: () => Result.ok({ source: 'factory' }),
192
- });
193
-
194
- trail('entity.show', {
195
- blaze: async (_input, ctx) => {
196
- return Result.ok(ctx.provision(db));
197
- },
198
- });
199
- `;
200
-
201
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
202
-
203
- expect(diagnostics.length).toBe(1);
204
- expect(diagnostics[0]?.severity).toBe('error');
205
- expect(diagnostics[0]?.message).toContain('ctx.provision(db)');
206
- });
207
- });
208
-
209
- describe('warn cases', () => {
210
- test('declared but unused provision produces a warning', () => {
211
- const code = `
212
- import { Result, provision, trail } from '@ontrails/core';
213
-
214
- const db = provision('db.main', {
215
- create: () => Result.ok({ source: 'factory' }),
216
- });
217
-
218
- trail('entity.show', {
219
- provisions: [db],
220
- blaze: async () => {
221
- return Result.ok({ ok: true });
222
- },
223
- });
224
- `;
225
-
226
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
227
-
228
- expect(diagnostics.length).toBe(1);
229
- expect(diagnostics[0]?.severity).toBe('warn');
230
- expect(diagnostics[0]?.rule).toBe('provision-declarations');
231
- expect(diagnostics[0]?.message).toContain("'db' declared in provisions");
232
- expect(diagnostics[0]?.message).toContain('never used');
233
- });
234
- });
235
-
236
- describe('single-object overload', () => {
237
- test('recognizes trail({ id, provisions, blaze }) form', () => {
238
- const code = `
239
- import { Result, provision, trail } from '@ontrails/core';
240
-
241
- const db = provision('db.main', {
242
- create: () => Result.ok({ source: 'factory' }),
243
- });
244
-
245
- trail({
246
- id: 'entity.show',
247
- provisions: [db],
248
- blaze: async (_input, ctx) => {
249
- return Result.ok({ source: db.from(ctx).source });
250
- },
251
- });
252
- `;
253
-
254
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
255
-
256
- expect(diagnostics.length).toBe(0);
257
- });
258
- });
259
-
260
- describe('context parameter naming', () => {
261
- test('recognizes database.from(context) when second param is named context', () => {
262
- const code = `
263
- import { Result, provision, trail } from '@ontrails/core';
264
-
265
- const database = provision('db.main', {
266
- create: () => Result.ok({ source: 'factory' }),
267
- });
268
-
269
- trail('entity.show', {
270
- provisions: [database],
271
- blaze: async (_input, context) => {
272
- return Result.ok(database.from(context));
273
- },
274
- });
275
- `;
276
-
277
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
278
-
279
- expect(diagnostics.length).toBe(0);
280
- });
281
- });
282
-
283
- describe('nested run false positives', () => {
284
- test('meta.run does not trigger false positives', () => {
285
- const code = `
286
- import { Result, provision, trail } from '@ontrails/core';
287
-
288
- const db = provision('db.main', {
289
- create: () => Result.ok({ source: 'factory' }),
290
- });
291
-
292
- trail('entity.show', {
293
- provisions: [db],
294
- meta: { blaze: async () => ctx.provision('phantom') },
295
- blaze: async (_input, ctx) => {
296
- return Result.ok(db.from(ctx));
297
- },
298
- });
299
- `;
300
-
301
- const diagnostics = provisionDeclarations.check(code, TEST_FILE);
302
-
303
- expect(diagnostics.length).toBe(0);
304
- });
305
- });
306
-
307
- test('skips test files', () => {
308
- const code = `
309
- trail('entity.show', {
310
- blaze: async (_input, ctx) => {
311
- return Result.ok(ctx.provision('db.main'));
312
- },
313
- });
314
- `;
315
-
316
- expect(provisionDeclarations.check(code, 'entity.test.ts')).toEqual([]);
317
- });
318
- });
@@ -1,122 +0,0 @@
1
- import { describe, expect, test } from 'bun:test';
2
-
3
- import { provisionExists } from '../rules/provision-exists.js';
4
-
5
- const TEST_FILE = 'entity.ts';
6
-
7
- describe('provision-exists', () => {
8
- test('passes when a locally declared provision exists', () => {
9
- const code = `
10
- import { Result, provision, trail } from '@ontrails/core';
11
- import type { Provision } from '@ontrails/core';
12
-
13
- const db: Provision<{ source: string }> = provision('db.main', {
14
- create: () => Result.ok({ source: 'factory' }),
15
- });
16
-
17
- trail('entity.show', {
18
- provisions: [db],
19
- blaze: async (_input, ctx) => Result.ok(db.from(ctx)),
20
- });
21
- `;
22
-
23
- expect(provisionExists.check(code, TEST_FILE)).toEqual([]);
24
- });
25
-
26
- test('ignores commented-out provision declarations when resolving local ids', () => {
27
- const code = `
28
- import { Result, trail } from '@ontrails/core';
29
-
30
- trail('entity.show', {
31
- provisions: ['db.main'],
32
- blaze: async (_input, ctx) => Result.ok(ctx.provision('db.main')),
33
- });
34
-
35
- // const db = provision('db.main', {
36
- // create: () => Result.ok({ source: 'factory' }),
37
- // });
38
- `;
39
-
40
- const diagnostics = provisionExists.check(code, TEST_FILE);
41
-
42
- expect(diagnostics).toHaveLength(1);
43
- expect(diagnostics[0]?.rule).toBe('provision-exists');
44
- expect(diagnostics[0]?.message).toContain('db.main');
45
- });
46
-
47
- test('flags a declared provision missing from project context', () => {
48
- const code = `
49
- import { Result, provision, trail } from '@ontrails/core';
50
-
51
- const db = provision('db.main', {
52
- create: () => Result.ok({ source: 'factory' }),
53
- });
54
-
55
- trail('entity.show', {
56
- provisions: [db],
57
- blaze: async (_input, ctx) => Result.ok(db.from(ctx)),
58
- });
59
- `;
60
-
61
- const diagnostics = provisionExists.checkWithContext(code, TEST_FILE, {
62
- knownProvisionIds: new Set(['db.other']),
63
- knownTrailIds: new Set(['entity.show']),
64
- });
65
-
66
- expect(diagnostics).toHaveLength(1);
67
- expect(diagnostics[0]?.rule).toBe('provision-exists');
68
- expect(diagnostics[0]?.message).toContain('db.main');
69
- });
70
-
71
- test('passes when project context includes the declared provision', () => {
72
- const code = `
73
- import { Result, provision, trail } from '@ontrails/core';
74
-
75
- const db = provision('db.main', {
76
- create: () => Result.ok({ source: 'factory' }),
77
- });
78
-
79
- trail('entity.show', {
80
- provisions: [db],
81
- blaze: async (_input, ctx) => Result.ok(db.from(ctx)),
82
- });
83
- `;
84
-
85
- const diagnostics = provisionExists.checkWithContext(code, TEST_FILE, {
86
- knownProvisionIds: new Set(['db.main']),
87
- knownTrailIds: new Set(['entity.show']),
88
- });
89
-
90
- expect(diagnostics).toEqual([]);
91
- });
92
-
93
- test('skips unresolved imported provisions instead of guessing', () => {
94
- const code = `
95
- import { trail } from '@ontrails/core';
96
- import { db } from './provisions';
97
-
98
- trail('entity.show', {
99
- provisions: [db],
100
- blaze: async (_input, ctx) => Result.ok(db.from(ctx)),
101
- });
102
- `;
103
-
104
- expect(
105
- provisionExists.checkWithContext(code, TEST_FILE, {
106
- knownProvisionIds: new Set(['db.main']),
107
- knownTrailIds: new Set(['entity.show']),
108
- })
109
- ).toEqual([]);
110
- });
111
-
112
- test('skips test files', () => {
113
- const code = `
114
- trail('entity.show', {
115
- provisions: ['db.main'],
116
- blaze: async (_input, ctx) => Result.ok(ctx.provision('db.main')),
117
- });
118
- `;
119
-
120
- expect(provisionExists.check(code, 'entity.test.ts')).toEqual([]);
121
- });
122
- });
@@ -1,150 +0,0 @@
1
- /**
2
- * Flags throws in implementations that are used as detour targets.
3
- *
4
- * Uses AST parsing for accurate detection of detour target IDs and
5
- * throw statements within those trail implementations.
6
- */
7
-
8
- import {
9
- findBlazeBodies,
10
- findTrailDefinitions,
11
- offsetToLine,
12
- parse,
13
- walk,
14
- } from './ast.js';
15
- import { isTestFile } from './scan.js';
16
- import type {
17
- ProjectAwareWardenRule,
18
- ProjectContext,
19
- WardenDiagnostic,
20
- } from './types.js';
21
-
22
- interface AstNode {
23
- readonly type: string;
24
- readonly start: number;
25
- readonly end: number;
26
- readonly [key: string]: unknown;
27
- }
28
-
29
- /** Collect all trail IDs referenced as detour targets in the AST. */
30
- const collectDetourTargets = (ast: AstNode): ReadonlySet<string> => {
31
- const targets = new Set<string>();
32
-
33
- walk(ast, (node) => {
34
- if (
35
- node.type !== 'Property' ||
36
- node.key?.name !== 'detours' ||
37
- !node.value
38
- ) {
39
- return;
40
- }
41
-
42
- walk(node.value as AstNode, (inner) => {
43
- if (inner.type === 'Literal' || inner.type === 'StringLiteral') {
44
- const { value } = inner as unknown as { value?: unknown };
45
- if (typeof value === 'string' && value.includes('.')) {
46
- targets.add(value);
47
- }
48
- }
49
- });
50
- });
51
-
52
- return targets;
53
- };
54
-
55
- /** Find throws in implementation bodies of targeted trails. */
56
- const findThrowsInTargetedTrails = (
57
- ast: AstNode,
58
- sourceCode: string,
59
- filePath: string,
60
- detourTargets: ReadonlySet<string>
61
- ): WardenDiagnostic[] => {
62
- const diagnostics: WardenDiagnostic[] = [];
63
-
64
- for (const def of findTrailDefinitions(ast)) {
65
- if (!detourTargets.has(def.id)) {
66
- continue;
67
- }
68
-
69
- for (const body of findBlazeBodies(def.config as AstNode)) {
70
- walk(body, (node) => {
71
- if (node.type === 'ThrowStatement') {
72
- diagnostics.push({
73
- filePath,
74
- line: offsetToLine(sourceCode, node.start),
75
- message: `Trail "${def.id}" is a detour target and must not throw. Use Result.err() instead.`,
76
- rule: 'no-throw-in-detour-target',
77
- severity: 'error',
78
- });
79
- }
80
- });
81
- }
82
- }
83
-
84
- return diagnostics;
85
- };
86
-
87
- const checkThrowInDetourTargets = (
88
- sourceCode: string,
89
- filePath: string,
90
- detourTargets: ReadonlySet<string>
91
- ): readonly WardenDiagnostic[] => {
92
- if (isTestFile(filePath)) {
93
- return [];
94
- }
95
-
96
- const ast = parse(filePath, sourceCode);
97
- if (!ast) {
98
- return [];
99
- }
100
-
101
- return findThrowsInTargetedTrails(
102
- ast as AstNode,
103
- sourceCode,
104
- filePath,
105
- detourTargets
106
- );
107
- };
108
-
109
- /**
110
- * Flags throws in implementations that are used as detour targets.
111
- */
112
- export const noThrowInDetourTarget: ProjectAwareWardenRule = {
113
- check(sourceCode: string, filePath: string): readonly WardenDiagnostic[] {
114
- const ast = parse(filePath, sourceCode);
115
- if (!ast) {
116
- return [];
117
- }
118
- return checkThrowInDetourTargets(
119
- sourceCode,
120
- filePath,
121
- collectDetourTargets(ast as AstNode)
122
- );
123
- },
124
- checkWithContext(
125
- sourceCode: string,
126
- filePath: string,
127
- context: ProjectContext
128
- ): readonly WardenDiagnostic[] {
129
- if (context.detourTargetTrailIds) {
130
- return checkThrowInDetourTargets(
131
- sourceCode,
132
- filePath,
133
- context.detourTargetTrailIds
134
- );
135
- }
136
- const ast = parse(filePath, sourceCode);
137
- if (!ast) {
138
- return [];
139
- }
140
- return checkThrowInDetourTargets(
141
- sourceCode,
142
- filePath,
143
- collectDetourTargets(ast as AstNode)
144
- );
145
- },
146
- description:
147
- 'Disallow throw statements inside implementations that are referenced as detour targets.',
148
- name: 'no-throw-in-detour-target',
149
- severity: 'error',
150
- };