@shivaedev/quality 0.56.0 → 0.57.1

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 (459) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +63 -4
  3. package/biome/plugins/effect-test-bodies.grit +1 -1
  4. package/dist/{rules/suppressions → adapters}/biome/configs.d.ts +2 -2
  5. package/dist/adapters/biome/configs.d.ts.map +1 -0
  6. package/dist/{rules/suppressions → adapters}/biome/configs.js +2 -2
  7. package/dist/adapters/biome/configs.js.map +1 -0
  8. package/dist/adapters/biome/presetConfig.d.ts +21 -0
  9. package/dist/adapters/biome/presetConfig.d.ts.map +1 -0
  10. package/dist/adapters/biome/presetConfig.js +32 -0
  11. package/dist/adapters/biome/presetConfig.js.map +1 -0
  12. package/dist/adapters/biome/relocateConfig.d.ts.map +1 -0
  13. package/dist/adapters/biome/relocateConfig.js.map +1 -0
  14. package/dist/adapters/biome/resolvePackage.d.ts.map +1 -0
  15. package/dist/adapters/biome/resolvePackage.js.map +1 -0
  16. package/dist/adapters/biome/rootConfig.d.ts +9 -0
  17. package/dist/adapters/biome/rootConfig.d.ts.map +1 -0
  18. package/dist/adapters/biome/rootConfig.js +11 -0
  19. package/dist/adapters/biome/rootConfig.js.map +1 -0
  20. package/dist/adapters/biome/run.js +1 -1
  21. package/dist/adapters/biome/run.js.map +1 -1
  22. package/dist/adapters/biome/syntaxOf.d.ts +3 -0
  23. package/dist/adapters/biome/syntaxOf.d.ts.map +1 -0
  24. package/dist/adapters/biome/syntaxOf.js +11 -0
  25. package/dist/adapters/biome/syntaxOf.js.map +1 -0
  26. package/dist/adapters/biome/withExceptionConfig.d.ts +8 -0
  27. package/dist/adapters/biome/withExceptionConfig.d.ts.map +1 -0
  28. package/dist/adapters/biome/withExceptionConfig.js +38 -0
  29. package/dist/adapters/biome/withExceptionConfig.js.map +1 -0
  30. package/dist/adapters/changeKeyApi.d.ts +4 -0
  31. package/dist/adapters/changeKeyApi.d.ts.map +1 -0
  32. package/dist/adapters/changeKeyApi.js +58 -0
  33. package/dist/adapters/changeKeyApi.js.map +1 -0
  34. package/dist/adapters/changeKeyFindings.d.ts +4 -0
  35. package/dist/adapters/changeKeyFindings.d.ts.map +1 -0
  36. package/dist/adapters/changeKeyFindings.js +87 -0
  37. package/dist/adapters/changeKeyFindings.js.map +1 -0
  38. package/dist/adapters/changeKeyLiterals.d.ts +3 -0
  39. package/dist/adapters/changeKeyLiterals.d.ts.map +1 -0
  40. package/dist/adapters/changeKeyLiterals.js +56 -0
  41. package/dist/adapters/changeKeyLiterals.js.map +1 -0
  42. package/dist/adapters/executable.d.ts +3 -0
  43. package/dist/adapters/executable.d.ts.map +1 -0
  44. package/dist/adapters/executable.js +14 -0
  45. package/dist/adapters/executable.js.map +1 -0
  46. package/dist/adapters/ignore.d.ts +10 -0
  47. package/dist/adapters/ignore.d.ts.map +1 -0
  48. package/dist/adapters/ignore.js +10 -0
  49. package/dist/adapters/ignore.js.map +1 -0
  50. package/dist/adapters/imports/fakeReferences.d.ts +14 -0
  51. package/dist/adapters/imports/fakeReferences.d.ts.map +1 -0
  52. package/dist/adapters/imports/fakeReferences.js +103 -0
  53. package/dist/adapters/imports/fakeReferences.js.map +1 -0
  54. package/dist/adapters/imports/fakeTargets.d.ts +13 -0
  55. package/dist/adapters/imports/fakeTargets.d.ts.map +1 -0
  56. package/dist/adapters/imports/fakeTargets.js +14 -0
  57. package/dist/adapters/imports/fakeTargets.js.map +1 -0
  58. package/dist/adapters/outsideImportFindings.d.ts +5 -0
  59. package/dist/adapters/outsideImportFindings.d.ts.map +1 -0
  60. package/dist/adapters/outsideImportFindings.js +78 -0
  61. package/dist/adapters/outsideImportFindings.js.map +1 -0
  62. package/dist/adapters/queueReadoutFindings.d.ts +8 -0
  63. package/dist/adapters/queueReadoutFindings.d.ts.map +1 -0
  64. package/dist/adapters/queueReadoutFindings.js +30 -0
  65. package/dist/adapters/queueReadoutFindings.js.map +1 -0
  66. package/dist/adapters/queueTestingOrigin.d.ts +5 -0
  67. package/dist/adapters/queueTestingOrigin.d.ts.map +1 -0
  68. package/dist/adapters/queueTestingOrigin.js +95 -0
  69. package/dist/adapters/queueTestingOrigin.js.map +1 -0
  70. package/dist/adapters/readConfig.d.ts +7 -0
  71. package/dist/adapters/readConfig.d.ts.map +1 -0
  72. package/dist/adapters/readConfig.js +40 -0
  73. package/dist/adapters/readConfig.js.map +1 -0
  74. package/dist/adapters/serviceIdFindings.d.ts +4 -0
  75. package/dist/adapters/serviceIdFindings.d.ts.map +1 -0
  76. package/dist/adapters/serviceIdFindings.js +65 -0
  77. package/dist/adapters/serviceIdFindings.js.map +1 -0
  78. package/dist/adapters/sharedErrorFindings.d.ts +4 -0
  79. package/dist/adapters/sharedErrorFindings.d.ts.map +1 -0
  80. package/dist/adapters/sharedErrorFindings.js +71 -0
  81. package/dist/adapters/sharedErrorFindings.js.map +1 -0
  82. package/dist/adapters/sharedErrorModules.d.ts +7 -0
  83. package/dist/adapters/sharedErrorModules.d.ts.map +1 -0
  84. package/dist/adapters/sharedErrorModules.js +66 -0
  85. package/dist/adapters/sharedErrorModules.js.map +1 -0
  86. package/dist/adapters/testProjects.d.ts.map +1 -1
  87. package/dist/adapters/testProjects.js +18 -2
  88. package/dist/adapters/testProjects.js.map +1 -1
  89. package/dist/appTestConfig.d.ts +1 -1
  90. package/dist/appTestConfig.d.ts.map +1 -1
  91. package/dist/appTestConfig.js.map +1 -1
  92. package/dist/baseline/cleanupMergeFiles.d.ts.map +1 -1
  93. package/dist/baseline/cleanupMergeFiles.js +3 -2
  94. package/dist/baseline/cleanupMergeFiles.js.map +1 -1
  95. package/dist/baseline/shards.d.ts.map +1 -1
  96. package/dist/baseline/shards.js +4 -2
  97. package/dist/baseline/shards.js.map +1 -1
  98. package/dist/biome/exceptionConfig.d.ts +0 -7
  99. package/dist/biome/exceptionConfig.d.ts.map +1 -1
  100. package/dist/biome/exceptionConfig.js +0 -36
  101. package/dist/biome/exceptionConfig.js.map +1 -1
  102. package/dist/biome/recognizeDiagnostics.d.ts.map +1 -1
  103. package/dist/biome/recognizeDiagnostics.js +2 -1
  104. package/dist/biome/recognizeDiagnostics.js.map +1 -1
  105. package/dist/biome/recommendedRules.d.ts.map +1 -1
  106. package/dist/biome/recommendedRules.js +3 -2
  107. package/dist/biome/recommendedRules.js.map +1 -1
  108. package/dist/biome/report.d.ts.map +1 -1
  109. package/dist/biome/report.js +3 -2
  110. package/dist/biome/report.js.map +1 -1
  111. package/dist/biome/syntax.d.ts +0 -1
  112. package/dist/biome/syntax.d.ts.map +1 -1
  113. package/dist/biome/syntax.js +0 -9
  114. package/dist/biome/syntax.js.map +1 -1
  115. package/dist/biome/withoutEntryPointImports.d.ts +32 -2
  116. package/dist/biome/withoutEntryPointImports.d.ts.map +1 -1
  117. package/dist/biome/withoutEntryPointImports.js +12 -10
  118. package/dist/biome/withoutEntryPointImports.js.map +1 -1
  119. package/dist/cli/baseline.d.ts.map +1 -1
  120. package/dist/cli/baseline.js +3 -2
  121. package/dist/cli/baseline.js.map +1 -1
  122. package/dist/cli/fix.d.ts.map +1 -1
  123. package/dist/cli/fix.js +3 -2
  124. package/dist/cli/fix.js.map +1 -1
  125. package/dist/cli/fixRule.d.ts.map +1 -1
  126. package/dist/cli/fixRule.js +4 -3
  127. package/dist/cli/fixRule.js.map +1 -1
  128. package/dist/cli/lint.d.ts.map +1 -1
  129. package/dist/cli/lint.js +2 -2
  130. package/dist/cli/lint.js.map +1 -1
  131. package/dist/cli/migrateBaseline.d.ts.map +1 -1
  132. package/dist/cli/migrateBaseline.js +3 -2
  133. package/dist/cli/migrateBaseline.js.map +1 -1
  134. package/dist/cli/migrateExceptions.d.ts.map +1 -1
  135. package/dist/cli/migrateExceptions.js +3 -2
  136. package/dist/cli/migrateExceptions.js.map +1 -1
  137. package/dist/config/globs.d.ts.map +1 -1
  138. package/dist/config/globs.js +1 -5
  139. package/dist/config/globs.js.map +1 -1
  140. package/dist/config/load.d.ts +2 -2
  141. package/dist/config/load.d.ts.map +1 -1
  142. package/dist/config/load.js +6 -36
  143. package/dist/config/load.js.map +1 -1
  144. package/dist/domEnvironment.config.js +1 -1
  145. package/dist/domEnvironment.config.js.map +1 -1
  146. package/dist/engine/session.d.ts.map +1 -1
  147. package/dist/engine/session.js +3 -2
  148. package/dist/engine/session.js.map +1 -1
  149. package/dist/exceptions/biomeFindings.d.ts +1 -1
  150. package/dist/exceptions/biomeFindings.d.ts.map +1 -1
  151. package/dist/exceptions/biomeFindings.js +10 -6
  152. package/dist/exceptions/biomeFindings.js.map +1 -1
  153. package/dist/hooks/install.d.ts.map +1 -1
  154. package/dist/hooks/install.js +4 -2
  155. package/dist/hooks/install.js.map +1 -1
  156. package/dist/hooks/location.d.ts.map +1 -1
  157. package/dist/hooks/location.js +3 -2
  158. package/dist/hooks/location.js.map +1 -1
  159. package/dist/hooks/preCommit.d.ts.map +1 -1
  160. package/dist/hooks/preCommit.js +3 -2
  161. package/dist/hooks/preCommit.js.map +1 -1
  162. package/dist/hooks/setup.d.ts.map +1 -1
  163. package/dist/hooks/setup.js +3 -2
  164. package/dist/hooks/setup.js.map +1 -1
  165. package/dist/hooks/status.d.ts.map +1 -1
  166. package/dist/hooks/status.js +5 -15
  167. package/dist/hooks/status.js.map +1 -1
  168. package/dist/hooks/uninstall.d.ts.map +1 -1
  169. package/dist/hooks/uninstall.js +3 -2
  170. package/dist/hooks/uninstall.js.map +1 -1
  171. package/dist/inventory/collect.js +2 -2
  172. package/dist/inventory/collect.js.map +1 -1
  173. package/dist/inventory/filesystem.d.ts.map +1 -1
  174. package/dist/inventory/filesystem.js +3 -2
  175. package/dist/inventory/filesystem.js.map +1 -1
  176. package/dist/inventory/ignoreScope.d.ts +2 -2
  177. package/dist/inventory/ignoreScope.d.ts.map +1 -1
  178. package/dist/inventory/ignoreScope.js +2 -2
  179. package/dist/inventory/ignoreScope.js.map +1 -1
  180. package/dist/inventory/shadcnFolders.d.ts.map +1 -1
  181. package/dist/inventory/shadcnFolders.js +4 -2
  182. package/dist/inventory/shadcnFolders.js.map +1 -1
  183. package/dist/inventory/trackedPaths.d.ts.map +1 -1
  184. package/dist/inventory/trackedPaths.js +4 -2
  185. package/dist/inventory/trackedPaths.js.map +1 -1
  186. package/dist/naming/packageLayout.d.ts +2 -1
  187. package/dist/naming/packageLayout.d.ts.map +1 -1
  188. package/dist/naming/packageLayout.js +4 -6
  189. package/dist/naming/packageLayout.js.map +1 -1
  190. package/dist/naming/testName.d.ts +1 -1
  191. package/dist/naming/testName.d.ts.map +1 -1
  192. package/dist/naming/testName.js +1 -1
  193. package/dist/naming/testName.js.map +1 -1
  194. package/dist/rules/biome.d.ts +1 -8
  195. package/dist/rules/biome.d.ts.map +1 -1
  196. package/dist/rules/biome.js +6 -15
  197. package/dist/rules/biome.js.map +1 -1
  198. package/dist/rules/builtIn.d.ts +2 -2
  199. package/dist/rules/builtIn.d.ts.map +1 -1
  200. package/dist/rules/builtIn.js +12 -0
  201. package/dist/rules/builtIn.js.map +1 -1
  202. package/dist/rules/effect/adapterImports.d.ts +2 -0
  203. package/dist/rules/effect/adapterImports.d.ts.map +1 -0
  204. package/dist/rules/effect/adapterImports.js +9 -0
  205. package/dist/rules/effect/adapterImports.js.map +1 -0
  206. package/dist/rules/effect/program.d.ts +1 -1
  207. package/dist/rules/effect/program.d.ts.map +1 -1
  208. package/dist/rules/effect/program.js +2 -2
  209. package/dist/rules/effect/program.js.map +1 -1
  210. package/dist/rules/effect/serviceIds.d.ts +2 -0
  211. package/dist/rules/effect/serviceIds.d.ts.map +1 -0
  212. package/dist/rules/effect/serviceIds.js +9 -0
  213. package/dist/rules/effect/serviceIds.js.map +1 -0
  214. package/dist/rules/effect/sharedErrorClasses.d.ts +2 -0
  215. package/dist/rules/effect/sharedErrorClasses.d.ts.map +1 -0
  216. package/dist/rules/effect/sharedErrorClasses.js +9 -0
  217. package/dist/rules/effect/sharedErrorClasses.js.map +1 -0
  218. package/dist/rules/files/folderNames.d.ts.map +1 -1
  219. package/dist/rules/files/folderNames.js +7 -7
  220. package/dist/rules/files/folderNames.js.map +1 -1
  221. package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
  222. package/dist/rules/files/namedAfterExport.js +6 -6
  223. package/dist/rules/files/namedAfterExport.js.map +1 -1
  224. package/dist/rules/files/otherNames.d.ts.map +1 -1
  225. package/dist/rules/files/otherNames.js +7 -7
  226. package/dist/rules/files/otherNames.js.map +1 -1
  227. package/dist/rules/files/packageImports.d.ts +2 -1
  228. package/dist/rules/files/packageImports.d.ts.map +1 -1
  229. package/dist/rules/files/packageImports.js +4 -3
  230. package/dist/rules/files/packageImports.js.map +1 -1
  231. package/dist/rules/files/stylesheetImporters.d.ts +2 -1
  232. package/dist/rules/files/stylesheetImporters.d.ts.map +1 -1
  233. package/dist/rules/files/stylesheetImporters.js +5 -4
  234. package/dist/rules/files/stylesheetImporters.js.map +1 -1
  235. package/dist/rules/imports/manifest.d.ts.map +1 -1
  236. package/dist/rules/imports/manifest.js +9 -6
  237. package/dist/rules/imports/manifest.js.map +1 -1
  238. package/dist/rules/manifestsApplication.d.ts.map +1 -1
  239. package/dist/rules/manifestsApplication.js +22 -22
  240. package/dist/rules/manifestsApplication.js.map +1 -1
  241. package/dist/rules/manifestsExportsShape.d.ts.map +1 -1
  242. package/dist/rules/manifestsExportsShape.js +32 -8
  243. package/dist/rules/manifestsExportsShape.js.map +1 -1
  244. package/dist/rules/manifestsSorted.d.ts.map +1 -1
  245. package/dist/rules/manifestsSorted.js +6 -5
  246. package/dist/rules/manifestsSorted.js.map +1 -1
  247. package/dist/rules/manifestsSourceFirst.d.ts.map +1 -1
  248. package/dist/rules/manifestsSourceFirst.js +6 -5
  249. package/dist/rules/manifestsSourceFirst.js.map +1 -1
  250. package/dist/rules/stories/adapterOnlyFakes.d.ts +2 -0
  251. package/dist/rules/stories/adapterOnlyFakes.d.ts.map +1 -0
  252. package/dist/rules/stories/adapterOnlyFakes.js +63 -0
  253. package/dist/rules/stories/adapterOnlyFakes.js.map +1 -0
  254. package/dist/rules/stories/fakeImplementation.d.ts +4 -0
  255. package/dist/rules/stories/fakeImplementation.d.ts.map +1 -0
  256. package/dist/rules/stories/fakeImplementation.js +22 -0
  257. package/dist/rules/stories/fakeImplementation.js.map +1 -0
  258. package/dist/rules/stories/fakeReplacements.d.ts +4 -0
  259. package/dist/rules/stories/fakeReplacements.d.ts.map +1 -0
  260. package/dist/rules/stories/fakeReplacements.js +71 -0
  261. package/dist/rules/stories/fakeReplacements.js.map +1 -0
  262. package/dist/rules/stories/importOrigin.js +2 -2
  263. package/dist/rules/stories/importOrigin.js.map +1 -1
  264. package/dist/rules/stories/importedChangeKeys.d.ts +2 -0
  265. package/dist/rules/stories/importedChangeKeys.d.ts.map +1 -0
  266. package/dist/rules/stories/importedChangeKeys.js +9 -0
  267. package/dist/rules/stories/importedChangeKeys.js.map +1 -0
  268. package/dist/rules/stories/pureNetImport.d.ts +4 -0
  269. package/dist/rules/stories/pureNetImport.d.ts.map +1 -0
  270. package/dist/rules/stories/pureNetImport.js +23 -0
  271. package/dist/rules/stories/pureNetImport.js.map +1 -0
  272. package/dist/rules/stories/queueReadouts.d.ts +2 -0
  273. package/dist/rules/stories/queueReadouts.d.ts.map +1 -0
  274. package/dist/rules/stories/queueReadouts.js +9 -0
  275. package/dist/rules/stories/queueReadouts.js.map +1 -0
  276. package/dist/rules/stories/unitTests.d.ts.map +1 -1
  277. package/dist/rules/stories/unitTests.js +4 -3
  278. package/dist/rules/stories/unitTests.js.map +1 -1
  279. package/dist/rules/suppressions/biome/weakenings.d.ts +1 -1
  280. package/dist/rules/suppressions/biome/weakenings.d.ts.map +1 -1
  281. package/dist/rules/suppressions/biomeOverrides.d.ts.map +1 -1
  282. package/dist/rules/suppressions/biomeOverrides.js +5 -5
  283. package/dist/rules/suppressions/biomeOverrides.js.map +1 -1
  284. package/dist/rules/suppressions/biomeRecommended.d.ts +1 -1
  285. package/dist/rules/suppressions/biomeRecommended.d.ts.map +1 -1
  286. package/dist/rules/suppressions/biomeRecommended.js +12 -30
  287. package/dist/rules/suppressions/biomeRecommended.js.map +1 -1
  288. package/dist/rules/suppressions/noIgnoreDeprecations.d.ts.map +1 -1
  289. package/dist/rules/suppressions/noIgnoreDeprecations.js +3 -2
  290. package/dist/rules/suppressions/noIgnoreDeprecations.js.map +1 -1
  291. package/dist/rules/test-names/colocated.js +2 -2
  292. package/dist/rules/test-names/colocated.js.map +1 -1
  293. package/dist/rules/test-names/follow.js +4 -4
  294. package/dist/rules/test-names/follow.js.map +1 -1
  295. package/dist/testing/adapters/assertThat.d.ts +5 -0
  296. package/dist/testing/adapters/assertThat.d.ts.map +1 -0
  297. package/dist/testing/adapters/assertThat.js +9 -0
  298. package/dist/testing/adapters/assertThat.js.map +1 -0
  299. package/dist/testing/adapters/cli.d.ts +21 -0
  300. package/dist/testing/adapters/cli.d.ts.map +1 -0
  301. package/dist/testing/adapters/cli.js +85 -0
  302. package/dist/testing/adapters/cli.js.map +1 -0
  303. package/dist/testing/adapters/git.d.ts +14 -0
  304. package/dist/testing/adapters/git.d.ts.map +1 -0
  305. package/dist/testing/adapters/git.js +52 -0
  306. package/dist/testing/adapters/git.js.map +1 -0
  307. package/dist/testing/adapters/hookPath.d.ts +2 -0
  308. package/dist/testing/adapters/hookPath.d.ts.map +1 -0
  309. package/dist/testing/adapters/hookPath.js +6 -0
  310. package/dist/testing/adapters/hookPath.js.map +1 -0
  311. package/dist/testing/adapters/hookRepository.d.ts +25 -0
  312. package/dist/testing/adapters/hookRepository.d.ts.map +1 -0
  313. package/dist/testing/adapters/hookRepository.js +96 -0
  314. package/dist/testing/adapters/hookRepository.js.map +1 -0
  315. package/dist/testing/adapters/imports.d.ts +5 -0
  316. package/dist/testing/adapters/imports.d.ts.map +1 -0
  317. package/dist/testing/adapters/imports.js +29 -0
  318. package/dist/testing/adapters/imports.js.map +1 -0
  319. package/dist/testing/adapters/packageExports.d.ts +15 -0
  320. package/dist/testing/adapters/packageExports.d.ts.map +1 -0
  321. package/dist/testing/adapters/packageExports.js +29 -0
  322. package/dist/testing/adapters/packageExports.js.map +1 -0
  323. package/dist/testing/adapters/qualityTree.d.ts +4 -0
  324. package/dist/testing/adapters/qualityTree.d.ts.map +1 -0
  325. package/dist/testing/adapters/qualityTree.js +21 -0
  326. package/dist/testing/adapters/qualityTree.js.map +1 -0
  327. package/dist/testing/adapters/run.d.ts +4 -0
  328. package/dist/testing/adapters/run.d.ts.map +1 -0
  329. package/dist/testing/adapters/run.js +6 -0
  330. package/dist/testing/adapters/run.js.map +1 -0
  331. package/dist/testing/adapters/storySpecFiles.d.ts +7 -0
  332. package/dist/testing/adapters/storySpecFiles.d.ts.map +1 -0
  333. package/dist/testing/adapters/storySpecFiles.js +48 -0
  334. package/dist/testing/adapters/storySpecFiles.js.map +1 -0
  335. package/dist/testing/adapters/tree.d.ts +13 -0
  336. package/dist/testing/adapters/tree.d.ts.map +1 -0
  337. package/dist/testing/adapters/tree.js +42 -0
  338. package/dist/testing/adapters/tree.js.map +1 -0
  339. package/dist/testing/adapters/writePackageExports.d.ts +2 -0
  340. package/dist/testing/adapters/writePackageExports.d.ts.map +1 -0
  341. package/dist/testing/adapters/writePackageExports.js +9 -0
  342. package/dist/testing/adapters/writePackageExports.js.map +1 -0
  343. package/dist/testing/ruleStory.d.ts +28 -0
  344. package/dist/testing/ruleStory.d.ts.map +1 -0
  345. package/dist/testing/ruleStory.js +115 -0
  346. package/dist/testing/ruleStory.js.map +1 -0
  347. package/dist/unitIoGuard.config.js +1 -1
  348. package/dist/unitIoGuard.config.js.map +1 -1
  349. package/package.json +8 -2
  350. package/src/{rules/suppressions → adapters}/biome/configs.ts +2 -2
  351. package/src/adapters/biome/presetConfig.ts +34 -0
  352. package/src/adapters/biome/rootConfig.ts +19 -0
  353. package/src/adapters/biome/run.ts +1 -1
  354. package/src/adapters/biome/syntaxOf.ts +12 -0
  355. package/src/adapters/biome/withExceptionConfig.ts +45 -0
  356. package/src/adapters/changeKeyApi.ts +62 -0
  357. package/src/adapters/changeKeyFindings.ts +96 -0
  358. package/src/adapters/changeKeyLiterals.ts +60 -0
  359. package/src/adapters/executable.ts +14 -0
  360. package/src/adapters/ignore.ts +16 -0
  361. package/src/adapters/imports/fakeReferences.ts +115 -0
  362. package/src/adapters/imports/fakeTargets.ts +21 -0
  363. package/src/adapters/outsideImportFindings.ts +98 -0
  364. package/src/adapters/queueReadoutFindings.ts +37 -0
  365. package/src/adapters/queueTestingOrigin.ts +113 -0
  366. package/src/adapters/readConfig.ts +42 -0
  367. package/src/adapters/serviceIdFindings.ts +80 -0
  368. package/src/adapters/sharedErrorFindings.ts +84 -0
  369. package/src/adapters/sharedErrorModules.ts +81 -0
  370. package/src/adapters/testProjects.ts +18 -2
  371. package/src/appTestConfig.ts +1 -1
  372. package/src/baseline/cleanupMergeFiles.ts +4 -2
  373. package/src/baseline/shards.ts +6 -2
  374. package/src/biome/exceptionConfig.ts +0 -43
  375. package/src/biome/recognizeDiagnostics.ts +2 -1
  376. package/src/biome/recommendedRules.ts +4 -2
  377. package/src/biome/report.ts +4 -2
  378. package/src/biome/syntax.ts +0 -10
  379. package/src/biome/withoutEntryPointImports.ts +15 -10
  380. package/src/cli/baseline.ts +4 -2
  381. package/src/cli/fix.ts +4 -2
  382. package/src/cli/fixRule.ts +5 -3
  383. package/src/cli/lint.ts +3 -2
  384. package/src/cli/migrateBaseline.ts +4 -2
  385. package/src/cli/migrateExceptions.ts +4 -2
  386. package/src/config/globs.ts +1 -6
  387. package/src/config/load.ts +8 -38
  388. package/src/domEnvironment.config.ts +1 -1
  389. package/src/engine/session.ts +4 -2
  390. package/src/exceptions/biomeFindings.ts +11 -10
  391. package/src/hooks/install.ts +6 -2
  392. package/src/hooks/location.ts +4 -2
  393. package/src/hooks/preCommit.ts +4 -2
  394. package/src/hooks/setup.ts +4 -2
  395. package/src/hooks/status.ts +7 -15
  396. package/src/hooks/uninstall.ts +4 -2
  397. package/src/inventory/collect.ts +2 -2
  398. package/src/inventory/filesystem.ts +4 -2
  399. package/src/inventory/ignoreScope.ts +3 -3
  400. package/src/inventory/shadcnFolders.ts +6 -2
  401. package/src/inventory/trackedPaths.ts +6 -2
  402. package/src/naming/packageLayout.ts +14 -7
  403. package/src/naming/testName.ts +1 -1
  404. package/src/rules/biome.ts +6 -23
  405. package/src/rules/builtIn.ts +12 -0
  406. package/src/rules/effect/adapterImports.ts +10 -0
  407. package/src/rules/effect/program.ts +2 -2
  408. package/src/rules/effect/serviceIds.ts +10 -0
  409. package/src/rules/effect/sharedErrorClasses.ts +10 -0
  410. package/src/rules/files/folderNames.ts +19 -18
  411. package/src/rules/files/namedAfterExport.ts +10 -9
  412. package/src/rules/files/otherNames.ts +17 -16
  413. package/src/rules/files/packageImports.ts +14 -4
  414. package/src/rules/files/stylesheetImporters.ts +13 -6
  415. package/src/rules/imports/manifest.ts +14 -8
  416. package/src/rules/manifestsApplication.ts +44 -33
  417. package/src/rules/manifestsExportsShape.ts +45 -15
  418. package/src/rules/manifestsSorted.ts +16 -11
  419. package/src/rules/manifestsSourceFirst.ts +22 -17
  420. package/src/rules/stories/adapterOnlyFakes.ts +66 -0
  421. package/src/rules/stories/fakeImplementation.ts +23 -0
  422. package/src/rules/stories/fakeReplacements.ts +74 -0
  423. package/src/rules/stories/importOrigin.ts +2 -2
  424. package/src/rules/stories/importedChangeKeys.ts +10 -0
  425. package/src/rules/stories/pureNetImport.ts +29 -0
  426. package/src/rules/stories/queueReadouts.ts +9 -0
  427. package/src/rules/stories/unitTests.ts +6 -3
  428. package/src/rules/suppressions/biome/weakenings.ts +1 -1
  429. package/src/rules/suppressions/biomeOverrides.ts +17 -16
  430. package/src/rules/suppressions/biomeRecommended.ts +13 -32
  431. package/src/rules/suppressions/noIgnoreDeprecations.ts +4 -2
  432. package/src/rules/test-names/colocated.ts +2 -2
  433. package/src/rules/test-names/follow.ts +4 -4
  434. package/src/testing/adapters/assertThat.ts +12 -0
  435. package/src/testing/adapters/cli.ts +105 -0
  436. package/src/testing/adapters/git.ts +62 -0
  437. package/src/testing/adapters/hookPath.ts +6 -0
  438. package/src/testing/adapters/hookRepository.ts +134 -0
  439. package/src/testing/adapters/imports.ts +35 -0
  440. package/src/testing/adapters/packageExports.ts +37 -0
  441. package/src/testing/adapters/qualityTree.ts +26 -0
  442. package/src/testing/adapters/run.ts +7 -0
  443. package/src/testing/adapters/storySpecFiles.ts +54 -0
  444. package/src/testing/adapters/tree.ts +55 -0
  445. package/src/testing/adapters/writePackageExports.ts +9 -0
  446. package/src/testing/ruleStory.ts +139 -0
  447. package/src/unitIoGuard.config.ts +1 -1
  448. package/dist/biome/relocateConfig.d.ts.map +0 -1
  449. package/dist/biome/relocateConfig.js.map +0 -1
  450. package/dist/rules/suppressions/biome/configs.d.ts.map +0 -1
  451. package/dist/rules/suppressions/biome/configs.js.map +0 -1
  452. package/dist/rules/suppressions/biome/resolvePackage.d.ts.map +0 -1
  453. package/dist/rules/suppressions/biome/resolvePackage.js.map +0 -1
  454. /package/dist/{biome → adapters/biome}/relocateConfig.d.ts +0 -0
  455. /package/dist/{biome → adapters/biome}/relocateConfig.js +0 -0
  456. /package/dist/{rules/suppressions → adapters}/biome/resolvePackage.d.ts +0 -0
  457. /package/dist/{rules/suppressions → adapters}/biome/resolvePackage.js +0 -0
  458. /package/src/{biome → adapters/biome}/relocateConfig.ts +0 -0
  459. /package/src/{rules/suppressions → adapters}/biome/resolvePackage.ts +0 -0
@@ -0,0 +1,62 @@
1
+ import ts from "typescript";
2
+ import { unwrapped } from "#rules/stories/syntax.ts";
3
+
4
+ export type ChangeKeyApi = "name" | "keys" | "mutation";
5
+
6
+ function declaredApi(declaration: ts.Declaration, name: string): ChangeKeyApi | undefined {
7
+ const path = declaration.getSourceFile().fileName.replaceAll("\\", "/");
8
+ if (/\/(?:@shivaedev\/)?sql\/(?:src|dist)\/transact\.(?:d\.)?ts$/u.test(path) && name === "invalidateOnCommit") {
9
+ return "keys";
10
+ }
11
+ if (/\/(?:@shivaedev\/)?changes\/(?:src|dist)\/keys\.(?:d\.)?ts$/u.test(path)) {
12
+ if (["recordKey", "collectionInvalidationKeys"].includes(name)) {
13
+ return "name";
14
+ }
15
+ return ["invalidationKeys", "readKeys"].includes(name) ? "keys" : undefined;
16
+ }
17
+ if (/\/effect\/(?:src|dist(?:\/dts)?)\/reactivity\/Reactivity\.(?:d\.)?ts$/u.test(path)) {
18
+ if (["invalidate", "invalidateUnsafe"].includes(name)) {
19
+ return "keys";
20
+ }
21
+ if (name === "mutation") {
22
+ return ts.isPropertySignature(declaration) ? "keys" : "mutation";
23
+ }
24
+ }
25
+ return undefined;
26
+ }
27
+
28
+ function reference(value: ts.Expression): ts.Node {
29
+ if (ts.isPropertyAccessExpression(value)) {
30
+ return value.name;
31
+ }
32
+ return ts.isElementAccessExpression(value) ? value.argumentExpression : value;
33
+ }
34
+
35
+ export function changeKeyApi(checker: ts.TypeChecker, expression: ts.Expression, seen = new Set<ts.Symbol>()): ChangeKeyApi | undefined {
36
+ const value = unwrapped(expression);
37
+ const member = reference(value);
38
+ let symbol = checker.getSymbolAtLocation(member);
39
+ if (symbol === undefined) {
40
+ return undefined;
41
+ }
42
+ if ((symbol.flags & ts.SymbolFlags.Alias) !== 0) {
43
+ symbol = checker.getAliasedSymbol(symbol);
44
+ }
45
+ if (seen.has(symbol)) {
46
+ return undefined;
47
+ }
48
+ seen.add(symbol);
49
+ for (const declaration of symbol.declarations ?? []) {
50
+ const api = declaredApi(declaration, symbol.name);
51
+ if (api !== undefined) {
52
+ return api;
53
+ }
54
+ if (ts.isVariableDeclaration(declaration) && declaration.initializer !== undefined) {
55
+ const aliased = changeKeyApi(checker, declaration.initializer, seen);
56
+ if (aliased !== undefined) {
57
+ return aliased;
58
+ }
59
+ }
60
+ }
61
+ return undefined;
62
+ }
@@ -0,0 +1,96 @@
1
+ import { join } from "node:path";
2
+ import { Effect } from "effect";
3
+ import ts from "typescript";
4
+ import { changeKeyApi } from "#adapters/changeKeyApi.ts";
5
+ import type { Finding, RuleInputs, SourceFile } from "#rule.ts";
6
+ import { effectProgram } from "#rules/effect/program.ts";
7
+ import { parse } from "#rules/parse.ts";
8
+ import { importBindings } from "#rules/stories/importBindings.ts";
9
+ import { memberName, nodesWhere, unwrapped } from "#rules/stories/syntax.ts";
10
+ import { changeKeyLiterals } from "./changeKeyLiterals.ts";
11
+
12
+ const APIS = new Set([
13
+ "invalidateOnCommit",
14
+ "invalidate",
15
+ "invalidateUnsafe",
16
+ "mutation",
17
+ "recordKey",
18
+ "collectionInvalidationKeys",
19
+ "invalidationKeys",
20
+ "readKeys",
21
+ ]);
22
+
23
+ function aliasesIn(source: ts.SourceFile): ReadonlySet<string> {
24
+ const aliases = new Set([...importBindings(source)].filter(([, binding]) => APIS.has(binding.imported)).map(([name]) => name));
25
+ for (const node of nodesWhere(source, ts.isVariableDeclaration)) {
26
+ if (!(ts.isVariableDeclaration(node) && ts.isIdentifier(node.name)) || node.initializer === undefined) {
27
+ continue;
28
+ }
29
+ const value = unwrapped(node.initializer);
30
+ if ((ts.isIdentifier(value) && aliases.has(value.text)) || APIS.has(memberName(value) ?? "")) {
31
+ aliases.add(node.name.text);
32
+ }
33
+ }
34
+ return aliases;
35
+ }
36
+
37
+ function candidate(node: ts.Node, aliases: ReadonlySet<string>): node is ts.CallExpression {
38
+ if (!(ts.isCallExpression(node) && node.arguments.some((argument) => changeKeyLiterals(argument).length > 0))) {
39
+ return false;
40
+ }
41
+ const callee = unwrapped(node.expression);
42
+ const name = ts.isIdentifier(callee) ? callee.text : memberName(callee);
43
+ return APIS.has(name ?? "") || (ts.isIdentifier(callee) && aliases.has(callee.text));
44
+ }
45
+
46
+ function hasCandidates(file: SourceFile): boolean {
47
+ const source = parse(file);
48
+ if (source === undefined) {
49
+ return false;
50
+ }
51
+ const aliases = aliasesIn(source);
52
+ return nodesWhere(source, (node) => candidate(node, aliases)).length > 0;
53
+ }
54
+
55
+ function findingsIn(inputs: RuleInputs): readonly Finding[] {
56
+ const program = effectProgram(inputs);
57
+ const checker = program.getTypeChecker();
58
+ return inputs.sources.flatMap((file) => {
59
+ const source = program.getSourceFile(join(inputs.root, file.path));
60
+ if (source === undefined) {
61
+ return [];
62
+ }
63
+ const aliases = aliasesIn(source);
64
+ return nodesWhere(source, (node) => candidate(node, aliases)).flatMap((node): readonly Finding[] => {
65
+ if (!ts.isCallExpression(node)) {
66
+ return [];
67
+ }
68
+ const api = changeKeyApi(checker, node.expression);
69
+ const argument = node.arguments[api === "mutation" && node.arguments.length > 1 ? 1 : 0];
70
+ return api === undefined || argument === undefined
71
+ ? []
72
+ : changeKeyLiterals(argument, api === "name").map((literal) => ({
73
+ file: file.path,
74
+ line: source.getLineAndCharacterOfPosition(literal.getStart(source)).line + 1,
75
+ message:
76
+ "Names a change collection or bucket with a literal. Import its owner's declaration and use its name, list, item or bucket key instead.",
77
+ }));
78
+ });
79
+ });
80
+ }
81
+
82
+ export const changeKeyFindings = Effect.fn("ChangeKeys.changeKeyFindings")((inputs: RuleInputs) =>
83
+ Effect.sync(() => {
84
+ const groups = new Map<string, RuleInputs["sources"][number][]>();
85
+ for (const source of inputs.sources) {
86
+ if (!hasCandidates(source)) {
87
+ continue;
88
+ }
89
+ const group = /^(?:packages|examples)\/[^/]+/u.exec(source.path)?.[0] ?? ".";
90
+ const sources = groups.get(group) ?? [];
91
+ sources.push(source);
92
+ groups.set(group, sources);
93
+ }
94
+ return [...groups.values()].flatMap((sources) => findingsIn({ ...inputs, sources }));
95
+ }),
96
+ );
@@ -0,0 +1,60 @@
1
+ import ts from "typescript";
2
+ import { unwrapped } from "#rules/stories/syntax.ts";
3
+
4
+ function literal(node: ts.Expression): readonly ts.Node[] {
5
+ const value = unwrapped(node);
6
+ return ts.isStringLiteralLike(value) ? [value] : [];
7
+ }
8
+
9
+ function propertyName(name: ts.PropertyName): string | undefined {
10
+ return ts.isIdentifier(name) || ts.isStringLiteralLike(name) ? name.text : undefined;
11
+ }
12
+
13
+ function typedKey(node: ts.ObjectLiteralExpression): boolean {
14
+ return node.properties.some((property) => {
15
+ if (!ts.isPropertyAssignment(property) || propertyName(property.name) !== "_tag") {
16
+ return false;
17
+ }
18
+ const tag = unwrapped(property.initializer);
19
+ return ts.isStringLiteralLike(tag) && ["List", "Item", "Bucket"].includes(tag.text);
20
+ });
21
+ }
22
+
23
+ function keyObject(node: ts.ObjectLiteralExpression, record: boolean): readonly ts.Node[] {
24
+ const typed = typedKey(node);
25
+ if (!(typed || record)) {
26
+ return [];
27
+ }
28
+ return node.properties.flatMap((property) => {
29
+ if (ts.isShorthandPropertyAssignment(property)) {
30
+ return [property.name];
31
+ }
32
+ if (ts.isSpreadAssignment(property)) {
33
+ return changeKeyLiterals(property.expression);
34
+ }
35
+ if (!ts.isPropertyAssignment(property)) {
36
+ return [];
37
+ }
38
+ if (typed) {
39
+ return ["collection", "field"].includes(propertyName(property.name) ?? "") ? literal(property.initializer) : [];
40
+ }
41
+ return ts.isComputedPropertyName(property.name) ? literal(property.name.expression) : [property.name];
42
+ });
43
+ }
44
+
45
+ export function changeKeyLiterals(expression: ts.Expression, nameOnly = false, record = true): readonly ts.Node[] {
46
+ const value = unwrapped(expression);
47
+ if (ts.isConditionalExpression(value)) {
48
+ return [...changeKeyLiterals(value.whenTrue, nameOnly, record), ...changeKeyLiterals(value.whenFalse, nameOnly, record)];
49
+ }
50
+ if (nameOnly || ts.isStringLiteralLike(value)) {
51
+ return literal(value);
52
+ }
53
+ if (ts.isArrayLiteralExpression(value)) {
54
+ return value.elements.flatMap((element) => changeKeyLiterals(element, false, false));
55
+ }
56
+ if (ts.isObjectLiteralExpression(value)) {
57
+ return keyObject(value, record);
58
+ }
59
+ return ts.isSpreadElement(value) ? changeKeyLiterals(value.expression, nameOnly, record) : [];
60
+ }
@@ -0,0 +1,14 @@
1
+ import { constants } from "node:fs";
2
+ import { access, realpath } from "node:fs/promises";
3
+ import { Effect } from "effect";
4
+ import { FilesystemFailure } from "#inventory/filesystem.ts";
5
+
6
+ export function executable(file: string): Effect.Effect<string | undefined> {
7
+ return Effect.tryPromise({
8
+ catch: (cause) => new FilesystemFailure({ message: String(cause), path: file }),
9
+ try: async () => {
10
+ await access(file, constants.X_OK);
11
+ return realpath(file);
12
+ },
13
+ }).pipe(Effect.match({ onFailure: () => undefined, onSuccess: (path) => path }));
14
+ }
@@ -0,0 +1,16 @@
1
+ import ignore from "ignore";
2
+
3
+ export interface IgnoreMatcher {
4
+ readonly ignores: (path: string) => boolean;
5
+ readonly test: (path: string) => { readonly ignored: boolean; readonly unignored: boolean };
6
+ }
7
+
8
+ export function ignorePatterns(patterns: string | readonly string[]): IgnoreMatcher {
9
+ const rules = ignore().add(typeof patterns === "string" ? patterns : [...patterns]);
10
+ return { ignores: (path) => rules.ignores(path), test: (path) => rules.test(path) };
11
+ }
12
+
13
+ export function matchesIgnorePattern(file: string, glob: string): boolean {
14
+ const result = ignorePatterns([glob]).test(file);
15
+ return result.ignored || result.unignored;
16
+ }
@@ -0,0 +1,115 @@
1
+ import { join, relative } from "node:path";
2
+ import ts from "typescript";
3
+ import { isTestCode } from "#naming/testName.ts";
4
+ import { memberName, unwrapped } from "#rules/stories/syntax.ts";
5
+
6
+ export interface FakeReference {
7
+ readonly module: string;
8
+ readonly names: readonly string[];
9
+ }
10
+
11
+ function imported(node: ts.Node): FakeReference | undefined {
12
+ if (ts.isImportSpecifier(node)) {
13
+ const declaration = node.parent.parent.parent;
14
+ return ts.isStringLiteral(declaration.moduleSpecifier)
15
+ ? { module: declaration.moduleSpecifier.text, names: [(node.propertyName ?? node.name).text] }
16
+ : undefined;
17
+ }
18
+ if (ts.isNamespaceImport(node) || ts.isImportClause(node)) {
19
+ const declaration = ts.isNamespaceImport(node) ? node.parent.parent : node.parent;
20
+ return ts.isStringLiteral(declaration.moduleSpecifier)
21
+ ? { module: declaration.moduleSpecifier.text, names: ts.isImportClause(node) ? ["default"] : [] }
22
+ : undefined;
23
+ }
24
+ return undefined;
25
+ }
26
+
27
+ export function fakeReferences(program: ts.Program, root: string) {
28
+ const checker = program.getTypeChecker();
29
+ function declarationOf(node: ts.Node): ts.Declaration | undefined {
30
+ const symbol = checker.getSymbolAtLocation(node);
31
+ return (symbol !== undefined && symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol)?.declarations?.[0];
32
+ }
33
+ function initializer(node: ts.Node): ts.Expression | undefined {
34
+ const declared = declarationOf(node);
35
+ return declared !== undefined && ts.isVariableDeclaration(declared) ? declared.initializer : undefined;
36
+ }
37
+ function concreteService(node: ts.Expression): boolean {
38
+ const value = initializer(node);
39
+ return (
40
+ value !== undefined
41
+ && ts.isCallExpression(value)
42
+ && memberName(value.expression) === undefined
43
+ && reference(value.expression)?.names.includes("defineService") === true
44
+ );
45
+ }
46
+ function reference(expression: ts.Expression, seen = new Set<ts.Node>()): FakeReference | undefined {
47
+ const node = unwrapped(expression);
48
+ if (seen.has(node)) {
49
+ return undefined;
50
+ }
51
+ seen.add(node);
52
+ if (ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node)) {
53
+ const base = reference(node.expression, seen);
54
+ const name = memberName(node);
55
+ return base === undefined || name === undefined ? undefined : { ...base, names: [...base.names, name] };
56
+ }
57
+ return binding(node, seen);
58
+ }
59
+
60
+ function binding(node: ts.Node, seen: Set<ts.Node>): FakeReference | undefined {
61
+ const symbol = checker.getSymbolAtLocation(node);
62
+ for (const declared of symbol?.declarations ?? []) {
63
+ const importedName = imported(declared);
64
+ if (importedName !== undefined) {
65
+ return importedName;
66
+ }
67
+ if (ts.isVariableDeclaration(declared) && declared.initializer !== undefined) {
68
+ return reference(declared.initializer, seen);
69
+ }
70
+ }
71
+ return symbol === undefined && ts.isIdentifier(node) && node.text === "vi" ? { module: "vitest", names: ["vi"] } : undefined;
72
+ }
73
+
74
+ function ownedPath(file: string | undefined, includeTests: boolean): string | undefined {
75
+ const local = file === undefined ? undefined : relative(root, file);
76
+ if (local === undefined || local.startsWith("../") || local.includes("/node_modules/")) {
77
+ return undefined;
78
+ }
79
+ return !isTestCode(local) || includeTests ? local : undefined;
80
+ }
81
+
82
+ function owner(expression: ts.Expression, importedTests = false): string | undefined {
83
+ const node = unwrapped(expression);
84
+ let symbol = checker.getSymbolAtLocation(node);
85
+ const aliased = symbol !== undefined && (symbol.flags & ts.SymbolFlags.Alias) !== 0;
86
+ if (symbol !== undefined && aliased) {
87
+ symbol = checker.getAliasedSymbol(symbol);
88
+ }
89
+ const path = symbol?.declarations?.[0]?.getSourceFile().fileName;
90
+ const local = ownedPath(path, importedTests && aliased);
91
+ if (local !== undefined) {
92
+ return local;
93
+ }
94
+ if (ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node)) {
95
+ return owner(node.expression, importedTests);
96
+ }
97
+ const declaration = symbol?.valueDeclaration;
98
+ return declaration !== undefined && ts.isVariableDeclaration(declaration) && declaration.initializer !== undefined
99
+ ? owner(declaration.initializer, importedTests)
100
+ : undefined;
101
+ }
102
+ return { concreteService, initializer, owner, reference, source: (path: string) => program.getSourceFile(join(root, path)) };
103
+ }
104
+
105
+ export function fakeApi(reference: FakeReference | undefined): string | undefined {
106
+ if (reference === undefined) {
107
+ return undefined;
108
+ }
109
+ const { module, names } = reference;
110
+ if ((module === "vitest" || module === "@effect/vitest") && names[0] === "vi" && names.length === 2) {
111
+ return `vi.${names[1]}`;
112
+ }
113
+ const path = module.startsWith("effect/") ? [module.slice("effect/".length), ...names] : names;
114
+ return (module === "effect" || module.startsWith("effect/")) && path.length === 2 ? path.join(".") : undefined;
115
+ }
@@ -0,0 +1,21 @@
1
+ import { realpathSync } from "node:fs";
2
+ import { join } from "node:path";
3
+ import type { RuleInputs } from "#rule.ts";
4
+ import { projectsFor } from "./projects.ts";
5
+ import { resolveImport } from "./resolve.ts";
6
+
7
+ export interface FakeModule {
8
+ readonly file: string;
9
+ readonly line: number;
10
+ readonly specifier: string;
11
+ }
12
+
13
+ export function fakeTargets(inputs: RuleInputs, modules: readonly FakeModule[]) {
14
+ const root = realpathSync(inputs.root);
15
+ const projectOf = projectsFor(root);
16
+ return modules.flatMap((module) => {
17
+ const from = join(root, module.file);
18
+ const target = resolveImport(root, () => false, { ...module, kind: "import", type: false }, from, projectOf(from));
19
+ return target?.kind === "file" ? [{ ...module, target: target.path }] : [];
20
+ });
21
+ }
@@ -0,0 +1,98 @@
1
+ import { Effect } from "effect";
2
+ import ts from "typescript";
3
+ import type { ImportAnalysisFailure } from "#adapters/ImportCompiler.ts";
4
+ import { readPackageManifest } from "#adapters/manifestInventory.ts";
5
+ import { importGraph } from "#imports/graph.ts";
6
+ import { packageNameOf } from "#imports/packageName.ts";
7
+ import { packageOf } from "#imports/workspace.ts";
8
+ import type { Finding, RuleInputs } from "#rule.ts";
9
+ import { parse } from "#rules/parse.ts";
10
+
11
+ function onlyInlineTypes(statement: ts.Statement): boolean {
12
+ if (ts.isImportDeclaration(statement)) {
13
+ const clause = statement.importClause;
14
+ const bindings = clause?.namedBindings;
15
+ return (
16
+ clause?.name === undefined
17
+ && bindings !== undefined
18
+ && ts.isNamedImports(bindings)
19
+ && bindings.elements.length > 0
20
+ && bindings.elements.every((item) => item.isTypeOnly)
21
+ );
22
+ }
23
+ const exports = ts.isExportDeclaration(statement) ? statement.exportClause : undefined;
24
+ return exports !== undefined && ts.isNamedExports(exports) && exports.elements.length > 0 && exports.elements.every((item) => item.isTypeOnly);
25
+ }
26
+
27
+ function inlineTypes(inputs: RuleInputs): ReadonlySet<string> {
28
+ const sites = new Set<string>();
29
+ for (const file of inputs.sources) {
30
+ const source = parse(file);
31
+ if (source === undefined) {
32
+ continue;
33
+ }
34
+ for (const statement of source.statements.filter(onlyInlineTypes)) {
35
+ sites.add(`${file.path}:${source.getLineAndCharacterOfPosition(statement.getStart(source)).line + 1}`);
36
+ }
37
+ }
38
+ return sites;
39
+ }
40
+
41
+ function exempt(path: string, name: string): boolean {
42
+ return (
43
+ /(?:^|\/)(?:adapters|test-support)\//u.test(path)
44
+ || name === "effect"
45
+ || name.startsWith("@effect/")
46
+ || name.startsWith("@shivaedev/")
47
+ || ((name === "react" || name === "react-dom") && /(?:^|\/)client\//u.test(path))
48
+ );
49
+ }
50
+
51
+ export const outsideImportFindings = Effect.fn("Imports.outsideImportFindings")(function* (
52
+ inputs: RuleInputs,
53
+ ): Effect.fn.Return<readonly Finding[], ImportAnalysisFailure> {
54
+ const graph = yield* importGraph(inputs);
55
+ const owners = [...graph.packages.map((owner) => owner.directory), "."];
56
+ const runtime = new Map(
57
+ yield* Effect.forEach(
58
+ owners,
59
+ (directory) =>
60
+ Effect.gen(function* () {
61
+ const manifest = yield* Effect.promise(() => readPackageManifest(inputs.readText, `${directory}/package.json`));
62
+ return [
63
+ directory,
64
+ new Set(Object.keys({ ...manifest?.dependencies, ...manifest?.peerDependencies, ...manifest?.optionalDependencies })),
65
+ ] as const;
66
+ }),
67
+ { concurrency: "unbounded" },
68
+ ),
69
+ );
70
+ const types = inlineTypes(inputs);
71
+ const workspace = new Set(graph.packages.map((owner) => owner.name));
72
+ const sites = [
73
+ ...graph.edges.flatMap((edge) => (edge.to.kind === "external" ? [{ ...edge, name: edge.to.package }] : [])),
74
+ ...graph.unresolved
75
+ .filter((edge) => edge.missing === undefined && !/^[.#/]/u.test(edge.specifier))
76
+ .map((edge) => ({ ...edge, name: packageNameOf(edge.specifier) })),
77
+ ];
78
+ return sites.flatMap((site) => {
79
+ const directory = packageOf(graph.packages, site.from)?.directory ?? ".";
80
+ if (
81
+ workspace.has(site.name)
82
+ || site.type
83
+ || site.kind !== "import"
84
+ || types.has(`${site.from}:${site.line}`)
85
+ || exempt(site.from, site.name)
86
+ || !(site.name.startsWith("node:") || runtime.get(directory)?.has(site.name))
87
+ ) {
88
+ return [];
89
+ }
90
+ return [
91
+ {
92
+ file: site.from,
93
+ line: site.line,
94
+ message: `Imports outside library "${site.specifier}" as a value. Move the integration into an adapters/ folder and expose Effect values; use import type for types.`,
95
+ },
96
+ ];
97
+ });
98
+ });
@@ -0,0 +1,37 @@
1
+ import { join } from "node:path";
2
+ import { Effect } from "effect";
3
+ import ts from "typescript";
4
+ import { importGraph } from "#imports/graph.ts";
5
+ import { packageOf } from "#imports/workspace.ts";
6
+ import { isTestCode } from "#naming/testName.ts";
7
+ import type { RuleInputs } from "#rule.ts";
8
+ import { storyProgram } from "#rules/stories/program.ts";
9
+ import { nodesWhere } from "#rules/stories/syntax.ts";
10
+ import { readPackageManifest } from "./manifestInventory.ts";
11
+ import { queueTestingOrigin } from "./queueTestingOrigin.ts";
12
+
13
+ const MESSAGE =
14
+ "Reads jobs-testing queue storage. An enqueued job or its state does not prove the work ran. Assert the application's visible result instead; use jobs-testing only to control and settle workers.";
15
+
16
+ export const queueReadoutFindings = Effect.fn("Stories.queueReadoutFindings")(function* (inputs: RuleInputs) {
17
+ const graph = yield* importGraph(inputs);
18
+ const root = yield* Effect.promise(() => readPackageManifest(inputs.readText, "package.json"));
19
+ const program = storyProgram(inputs, graph);
20
+ const origin = queueTestingOrigin(program.getTypeChecker());
21
+ return inputs.sources.flatMap((file) => {
22
+ const owner = packageOf(graph.packages, file.path)?.name ?? root?.name;
23
+ if (!isTestCode(file.path) || owner === "@shivaedev/jobs") {
24
+ return [];
25
+ }
26
+ const source = program.getSourceFile(join(inputs.root, file.path));
27
+ if (source === undefined) {
28
+ return [];
29
+ }
30
+ return nodesWhere(
31
+ source,
32
+ (node) =>
33
+ ((ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node)) && origin(node) === "readout")
34
+ || (ts.isBindingElement(node) && origin(node) === "readout"),
35
+ ).map((node) => ({ file: file.path, line: source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1, message: MESSAGE }));
36
+ });
37
+ });
@@ -0,0 +1,113 @@
1
+ import ts from "typescript";
2
+ import { importFrom } from "#rules/stories/importOrigin.ts";
3
+ import { memberName, unwrapped } from "#rules/stories/syntax.ts";
4
+
5
+ type Origin = "module" | "factory" | "controller" | "readout" | undefined;
6
+
7
+ const TESTING_MODULE = "@shivaedev/jobs/server/testing.ts";
8
+
9
+ function importedOrigin(node: ts.Node): Origin {
10
+ if (importFrom(node) !== TESTING_MODULE) {
11
+ return undefined;
12
+ }
13
+ if (ts.isImportSpecifier(node)) {
14
+ return (node.propertyName ?? node.name).text === "makePgBossTesting" ? "factory" : undefined;
15
+ }
16
+ return ts.isNamespaceImport(node) ? "module" : undefined;
17
+ }
18
+
19
+ export function queueTestingOrigin(checker: ts.TypeChecker) {
20
+ const visiting = new Set<ts.Node>();
21
+ const known = new Map<ts.Node, Origin>();
22
+
23
+ function member(receiver: Origin, name: string): Origin {
24
+ if (receiver === "module") {
25
+ return name === "makePgBossTesting" ? "factory" : undefined;
26
+ }
27
+ return receiver === "controller" && (name === "jobs" || name === "snapshot") ? "readout" : undefined;
28
+ }
29
+
30
+ function symbol(value: ts.Symbol | undefined): Origin {
31
+ const direct = value?.declarations?.map(visit).find((result) => result !== undefined);
32
+ return direct ?? (value !== undefined && value.flags & ts.SymbolFlags.Alias ? symbol(checker.getAliasedSymbol(value)) : undefined);
33
+ }
34
+
35
+ function typed(node: ts.Node): Origin {
36
+ if (!(ts.isParameter(node) || ts.isVariableDeclaration(node) || ts.isPropertySignature(node))) {
37
+ return undefined;
38
+ }
39
+ const type = node.type;
40
+ if (type !== undefined && ts.isTypeReferenceNode(type)) {
41
+ const value = checker.getSymbolAtLocation(type.typeName);
42
+ if (
43
+ value?.declarations?.some(
44
+ (declaration) =>
45
+ ts.isImportSpecifier(declaration)
46
+ && importFrom(declaration) === TESTING_MODULE
47
+ && (declaration.propertyName ?? declaration.name).text === "PgBossTesting",
48
+ )
49
+ ) {
50
+ return "controller";
51
+ }
52
+ }
53
+ return undefined;
54
+ }
55
+
56
+ function binding(node: ts.BindingElement): Origin {
57
+ const declaration = node.parent.parent;
58
+ const name = node.propertyName ?? node.name;
59
+ if ((ts.isIdentifier(name) || ts.isStringLiteral(name)) && name.text === "jobsTesting") {
60
+ return "controller";
61
+ }
62
+ return ts.isVariableDeclaration(declaration) && ts.isObjectBindingPattern(node.parent) && (ts.isIdentifier(name) || ts.isStringLiteral(name))
63
+ ? member(visit(declaration), name.text)
64
+ : undefined;
65
+ }
66
+
67
+ function declaredOrigin(node: ts.Node): Origin {
68
+ if (ts.isVariableDeclaration(node) || ts.isPropertyAssignment(node)) {
69
+ return typed(node) ?? (node.initializer === undefined ? undefined : visit(node.initializer));
70
+ }
71
+ if (ts.isShorthandPropertyAssignment(node)) {
72
+ return symbol(checker.getShorthandAssignmentValueSymbol(node));
73
+ }
74
+ if (ts.isBindingElement(node)) {
75
+ return binding(node);
76
+ }
77
+ return typed(node) ?? importedOrigin(node);
78
+ }
79
+
80
+ function reference(node: ts.Node): Origin {
81
+ if (ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node)) {
82
+ const name = memberName(node);
83
+ return name === "jobsTesting" ? "controller" : (member(visit(node.expression), name ?? "") ?? symbol(checker.getSymbolAtLocation(node)));
84
+ }
85
+ if (ts.isIdentifier(node)) {
86
+ return node.text === "jobsTesting" ? "controller" : symbol(checker.getSymbolAtLocation(node));
87
+ }
88
+ return declaredOrigin(node);
89
+ }
90
+
91
+ function origin(node: ts.Node): Origin {
92
+ if (ts.isCallExpression(node)) {
93
+ return visit(node.expression) === "factory" ? "controller" : undefined;
94
+ }
95
+ if (ts.isExpression(node) && unwrapped(node) !== node) {
96
+ return visit(unwrapped(node));
97
+ }
98
+ return reference(node);
99
+ }
100
+
101
+ function visit(node: ts.Node): Origin {
102
+ if (visiting.has(node) || known.has(node)) {
103
+ return known.get(node);
104
+ }
105
+ visiting.add(node);
106
+ const result = origin(node);
107
+ visiting.delete(node);
108
+ known.set(node, result);
109
+ return result;
110
+ }
111
+
112
+ return visit;
113
+ }
@@ -0,0 +1,42 @@
1
+ import { basename, dirname, resolve } from "node:path";
2
+ import { pathToFileURL } from "node:url";
3
+ import { Effect, FileSystem } from "effect";
4
+ import { CONFIG_FILE } from "#config/constants.ts";
5
+ import { SetupFailure } from "#failure.ts";
6
+
7
+ function messageOf(cause: unknown): string {
8
+ return cause instanceof Error ? cause.message : String(cause);
9
+ }
10
+
11
+ function importDefault(file: string): Effect.Effect<unknown, SetupFailure> {
12
+ return Effect.flatMap(
13
+ Effect.tryPromise({
14
+ catch: (cause) => new SetupFailure({ cause, message: `cannot load ${file}: ${messageOf(cause)}` }),
15
+ try: async (): Promise<unknown> => import(pathToFileURL(file).href),
16
+ }),
17
+ (loaded) =>
18
+ typeof loaded === "object" && loaded !== null && "default" in loaded
19
+ ? Effect.succeed(loaded.default)
20
+ : Effect.fail(new SetupFailure({ message: `${file} has no default export. Export defineConfig({ ... }) as the default.` })),
21
+ );
22
+ }
23
+
24
+ export const readConfig = Effect.fn("Config.readConfig")(function* (cwd: string, path: string | undefined) {
25
+ const fs = yield* FileSystem.FileSystem;
26
+ const file = resolve(cwd, path ?? CONFIG_FILE);
27
+ const entries = yield* fs
28
+ .readDirectory(dirname(file))
29
+ .pipe(
30
+ Effect.catchTag("PlatformError", (error) =>
31
+ error.reason._tag === "NotFound"
32
+ ? Effect.succeed<string[]>([])
33
+ : Effect.fail(new SetupFailure({ cause: error, message: `cannot inspect ${file}: ${error.message}` })),
34
+ ),
35
+ );
36
+ const present = entries.includes(basename(file));
37
+ if (!present && path !== undefined) {
38
+ return yield* new SetupFailure({ message: `no config at ${file}. Check the --config path.` });
39
+ }
40
+ const loaded = present ? yield* importDefault(file) : {};
41
+ return { file, loaded };
42
+ });