@shivaedev/quality 0.55.0 → 0.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (528) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/README.md +76 -17
  3. package/biome/plugins/effect-test-bodies.grit +1 -1
  4. package/dist/adapters/ImportCompiler.d.ts +21 -0
  5. package/dist/adapters/ImportCompiler.d.ts.map +1 -0
  6. package/dist/adapters/ImportCompiler.js +22 -0
  7. package/dist/adapters/ImportCompiler.js.map +1 -0
  8. package/dist/{rules/suppressions → adapters}/biome/configs.d.ts +2 -2
  9. package/dist/adapters/biome/configs.d.ts.map +1 -0
  10. package/dist/{rules/suppressions → adapters}/biome/configs.js +2 -2
  11. package/dist/adapters/biome/configs.js.map +1 -0
  12. package/dist/adapters/biome/presetConfig.d.ts +21 -0
  13. package/dist/adapters/biome/presetConfig.d.ts.map +1 -0
  14. package/dist/adapters/biome/presetConfig.js +32 -0
  15. package/dist/adapters/biome/presetConfig.js.map +1 -0
  16. package/dist/adapters/biome/relocateConfig.d.ts.map +1 -0
  17. package/dist/adapters/biome/relocateConfig.js.map +1 -0
  18. package/dist/adapters/biome/resolvePackage.d.ts.map +1 -0
  19. package/dist/adapters/biome/resolvePackage.js.map +1 -0
  20. package/dist/adapters/biome/rootConfig.d.ts +9 -0
  21. package/dist/adapters/biome/rootConfig.d.ts.map +1 -0
  22. package/dist/adapters/biome/rootConfig.js +11 -0
  23. package/dist/adapters/biome/rootConfig.js.map +1 -0
  24. package/dist/adapters/biome/run.js +1 -1
  25. package/dist/adapters/biome/run.js.map +1 -1
  26. package/dist/adapters/biome/syntaxOf.d.ts +3 -0
  27. package/dist/adapters/biome/syntaxOf.d.ts.map +1 -0
  28. package/dist/adapters/biome/syntaxOf.js +11 -0
  29. package/dist/adapters/biome/syntaxOf.js.map +1 -0
  30. package/dist/adapters/biome/withExceptionConfig.d.ts +8 -0
  31. package/dist/adapters/biome/withExceptionConfig.d.ts.map +1 -0
  32. package/dist/adapters/biome/withExceptionConfig.js +38 -0
  33. package/dist/adapters/biome/withExceptionConfig.js.map +1 -0
  34. package/dist/adapters/changeKeyApi.d.ts +4 -0
  35. package/dist/adapters/changeKeyApi.d.ts.map +1 -0
  36. package/dist/adapters/changeKeyApi.js +58 -0
  37. package/dist/adapters/changeKeyApi.js.map +1 -0
  38. package/dist/adapters/changeKeyFindings.d.ts +4 -0
  39. package/dist/adapters/changeKeyFindings.d.ts.map +1 -0
  40. package/dist/adapters/changeKeyFindings.js +87 -0
  41. package/dist/adapters/changeKeyFindings.js.map +1 -0
  42. package/dist/adapters/changeKeyLiterals.d.ts +3 -0
  43. package/dist/adapters/changeKeyLiterals.d.ts.map +1 -0
  44. package/dist/adapters/changeKeyLiterals.js +56 -0
  45. package/dist/adapters/changeKeyLiterals.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/browserChecker.d.ts +3 -0
  51. package/dist/adapters/imports/browserChecker.d.ts.map +1 -0
  52. package/dist/adapters/imports/browserChecker.js +8 -0
  53. package/dist/adapters/imports/browserChecker.js.map +1 -0
  54. package/dist/adapters/imports/departures.d.ts +5 -0
  55. package/dist/adapters/imports/departures.d.ts.map +1 -0
  56. package/dist/adapters/imports/departures.js +61 -0
  57. package/dist/adapters/imports/departures.js.map +1 -0
  58. package/dist/adapters/imports/fakeReferences.d.ts +14 -0
  59. package/dist/adapters/imports/fakeReferences.d.ts.map +1 -0
  60. package/dist/adapters/imports/fakeReferences.js +103 -0
  61. package/dist/adapters/imports/fakeReferences.js.map +1 -0
  62. package/dist/adapters/imports/fakeTargets.d.ts +13 -0
  63. package/dist/adapters/imports/fakeTargets.d.ts.map +1 -0
  64. package/dist/adapters/imports/fakeTargets.js +14 -0
  65. package/dist/adapters/imports/fakeTargets.js.map +1 -0
  66. package/dist/adapters/imports/graph.d.ts +4 -0
  67. package/dist/adapters/imports/graph.d.ts.map +1 -0
  68. package/dist/adapters/imports/graph.js +44 -0
  69. package/dist/adapters/imports/graph.js.map +1 -0
  70. package/dist/adapters/imports/projects.d.ts.map +1 -0
  71. package/dist/adapters/imports/projects.js.map +1 -0
  72. package/dist/{imports → adapters/imports}/resolve.d.ts +3 -10
  73. package/dist/adapters/imports/resolve.d.ts.map +1 -0
  74. package/dist/{imports → adapters/imports}/resolve.js +1 -1
  75. package/dist/adapters/imports/resolve.js.map +1 -0
  76. package/dist/adapters/knip/entryPointFindings.d.ts +2 -1
  77. package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -1
  78. package/dist/adapters/knip/entryPointFindings.js +7 -6
  79. package/dist/adapters/knip/entryPointFindings.js.map +1 -1
  80. package/dist/adapters/knip/run.d.ts +1 -1
  81. package/dist/adapters/knip/run.d.ts.map +1 -1
  82. package/dist/adapters/knip/run.js +1 -1
  83. package/dist/adapters/knip/run.js.map +1 -1
  84. package/dist/adapters/outsideImportFindings.d.ts +5 -0
  85. package/dist/adapters/outsideImportFindings.d.ts.map +1 -0
  86. package/dist/adapters/outsideImportFindings.js +78 -0
  87. package/dist/adapters/outsideImportFindings.js.map +1 -0
  88. package/dist/adapters/queueReadoutFindings.d.ts +8 -0
  89. package/dist/adapters/queueReadoutFindings.d.ts.map +1 -0
  90. package/dist/adapters/queueReadoutFindings.js +30 -0
  91. package/dist/adapters/queueReadoutFindings.js.map +1 -0
  92. package/dist/adapters/queueTestingOrigin.d.ts +5 -0
  93. package/dist/adapters/queueTestingOrigin.d.ts.map +1 -0
  94. package/dist/adapters/queueTestingOrigin.js +95 -0
  95. package/dist/adapters/queueTestingOrigin.js.map +1 -0
  96. package/dist/adapters/readConfig.d.ts +7 -0
  97. package/dist/adapters/readConfig.d.ts.map +1 -0
  98. package/dist/adapters/readConfig.js +40 -0
  99. package/dist/adapters/readConfig.js.map +1 -0
  100. package/dist/adapters/rule.d.ts +9 -0
  101. package/dist/adapters/rule.d.ts.map +1 -0
  102. package/dist/adapters/rule.js +35 -0
  103. package/dist/adapters/rule.js.map +1 -0
  104. package/dist/adapters/serviceIdFindings.d.ts +4 -0
  105. package/dist/adapters/serviceIdFindings.d.ts.map +1 -0
  106. package/dist/adapters/serviceIdFindings.js +65 -0
  107. package/dist/adapters/serviceIdFindings.js.map +1 -0
  108. package/dist/adapters/sharedErrorFindings.d.ts +4 -0
  109. package/dist/adapters/sharedErrorFindings.d.ts.map +1 -0
  110. package/dist/adapters/sharedErrorFindings.js +71 -0
  111. package/dist/adapters/sharedErrorFindings.js.map +1 -0
  112. package/dist/adapters/sharedErrorModules.d.ts +7 -0
  113. package/dist/adapters/sharedErrorModules.d.ts.map +1 -0
  114. package/dist/adapters/sharedErrorModules.js +66 -0
  115. package/dist/adapters/sharedErrorModules.js.map +1 -0
  116. package/dist/adapters/standardSchema.d.ts.map +1 -0
  117. package/dist/adapters/standardSchema.js.map +1 -0
  118. package/dist/adapters/testProjects.d.ts.map +1 -1
  119. package/dist/adapters/testProjects.js +18 -2
  120. package/dist/adapters/testProjects.js.map +1 -1
  121. package/dist/appTestConfig.d.ts +1 -1
  122. package/dist/appTestConfig.d.ts.map +1 -1
  123. package/dist/appTestConfig.js.map +1 -1
  124. package/dist/biome/exceptionConfig.d.ts +0 -7
  125. package/dist/biome/exceptionConfig.d.ts.map +1 -1
  126. package/dist/biome/exceptionConfig.js +0 -36
  127. package/dist/biome/exceptionConfig.js.map +1 -1
  128. package/dist/biome/recognizeDiagnostics.d.ts.map +1 -1
  129. package/dist/biome/recognizeDiagnostics.js +2 -1
  130. package/dist/biome/recognizeDiagnostics.js.map +1 -1
  131. package/dist/biome/syntax.d.ts +0 -1
  132. package/dist/biome/syntax.d.ts.map +1 -1
  133. package/dist/biome/syntax.js +0 -9
  134. package/dist/biome/syntax.js.map +1 -1
  135. package/dist/biome/withoutEntryPointImports.d.ts +32 -2
  136. package/dist/biome/withoutEntryPointImports.d.ts.map +1 -1
  137. package/dist/biome/withoutEntryPointImports.js +12 -10
  138. package/dist/biome/withoutEntryPointImports.js.map +1 -1
  139. package/dist/cli/fixRule.js +1 -1
  140. package/dist/cli/fixRule.js.map +1 -1
  141. package/dist/config/decode.d.ts +2 -2
  142. package/dist/config/decode.d.ts.map +1 -1
  143. package/dist/config/decode.js +3 -2
  144. package/dist/config/decode.js.map +1 -1
  145. package/dist/config/globs.d.ts.map +1 -1
  146. package/dist/config/globs.js +1 -5
  147. package/dist/config/globs.js.map +1 -1
  148. package/dist/config/load.d.ts +2 -2
  149. package/dist/config/load.d.ts.map +1 -1
  150. package/dist/config/load.js +5 -36
  151. package/dist/config/load.js.map +1 -1
  152. package/dist/config/resolve.d.ts +2 -2
  153. package/dist/config/resolve.d.ts.map +1 -1
  154. package/dist/config/resolve.js +2 -1
  155. package/dist/config/resolve.js.map +1 -1
  156. package/dist/config.d.ts +5 -5
  157. package/dist/config.d.ts.map +1 -1
  158. package/dist/decoded.d.ts.map +1 -1
  159. package/dist/decoded.js +1 -1
  160. package/dist/decoded.js.map +1 -1
  161. package/dist/domEnvironment.config.js +1 -1
  162. package/dist/domEnvironment.config.js.map +1 -1
  163. package/dist/exceptions/biomeFindings.d.ts +1 -1
  164. package/dist/exceptions/biomeFindings.d.ts.map +1 -1
  165. package/dist/exceptions/biomeFindings.js +10 -6
  166. package/dist/exceptions/biomeFindings.js.map +1 -1
  167. package/dist/imports/Endpoint.d.ts +9 -0
  168. package/dist/imports/Endpoint.d.ts.map +1 -0
  169. package/dist/imports/Endpoint.js +2 -0
  170. package/dist/imports/Endpoint.js.map +1 -0
  171. package/dist/imports/browserGlobals.d.ts +2 -1
  172. package/dist/imports/browserGlobals.d.ts.map +1 -1
  173. package/dist/imports/browserGlobals.js +6 -9
  174. package/dist/imports/browserGlobals.js.map +1 -1
  175. package/dist/imports/departures.d.ts +3 -2
  176. package/dist/imports/departures.d.ts.map +1 -1
  177. package/dist/imports/departures.js +8 -61
  178. package/dist/imports/departures.js.map +1 -1
  179. package/dist/imports/fences/check.d.ts +3 -2
  180. package/dist/imports/fences/check.d.ts.map +1 -1
  181. package/dist/imports/fences/check.js +5 -4
  182. package/dist/imports/fences/check.js.map +1 -1
  183. package/dist/imports/fences/compilePolicy.js.map +1 -1
  184. package/dist/imports/fences/match.d.ts +1 -1
  185. package/dist/imports/fences/match.d.ts.map +1 -1
  186. package/dist/imports/fences/match.js.map +1 -1
  187. package/dist/imports/fences/reach.d.ts +1 -1
  188. package/dist/imports/fences/reach.d.ts.map +1 -1
  189. package/dist/imports/fences/vocabulary.d.ts +1 -1
  190. package/dist/imports/fences/vocabulary.d.ts.map +1 -1
  191. package/dist/imports/graph.d.ts +4 -3
  192. package/dist/imports/graph.d.ts.map +1 -1
  193. package/dist/imports/graph.js +17 -55
  194. package/dist/imports/graph.js.map +1 -1
  195. package/dist/inventory/collect.js +2 -2
  196. package/dist/inventory/collect.js.map +1 -1
  197. package/dist/inventory/ignoreScope.d.ts +2 -2
  198. package/dist/inventory/ignoreScope.d.ts.map +1 -1
  199. package/dist/inventory/ignoreScope.js +2 -2
  200. package/dist/inventory/ignoreScope.js.map +1 -1
  201. package/dist/naming/packageLayout.d.ts +2 -1
  202. package/dist/naming/packageLayout.d.ts.map +1 -1
  203. package/dist/naming/packageLayout.js +4 -6
  204. package/dist/naming/packageLayout.js.map +1 -1
  205. package/dist/naming/testName.d.ts +1 -1
  206. package/dist/naming/testName.d.ts.map +1 -1
  207. package/dist/naming/testName.js +1 -1
  208. package/dist/naming/testName.js.map +1 -1
  209. package/dist/rule.d.ts +12 -8
  210. package/dist/rule.d.ts.map +1 -1
  211. package/dist/rule.js +8 -31
  212. package/dist/rule.js.map +1 -1
  213. package/dist/rules/biome.d.ts +1 -8
  214. package/dist/rules/biome.d.ts.map +1 -1
  215. package/dist/rules/biome.js +6 -15
  216. package/dist/rules/biome.js.map +1 -1
  217. package/dist/rules/builtIn.d.ts +2 -2
  218. package/dist/rules/builtIn.d.ts.map +1 -1
  219. package/dist/rules/builtIn.js +12 -0
  220. package/dist/rules/builtIn.js.map +1 -1
  221. package/dist/rules/effect/adapterImports.d.ts +2 -0
  222. package/dist/rules/effect/adapterImports.d.ts.map +1 -0
  223. package/dist/rules/effect/adapterImports.js +9 -0
  224. package/dist/rules/effect/adapterImports.js.map +1 -0
  225. package/dist/rules/effect/program.d.ts +1 -1
  226. package/dist/rules/effect/program.d.ts.map +1 -1
  227. package/dist/rules/effect/program.js +3 -3
  228. package/dist/rules/effect/program.js.map +1 -1
  229. package/dist/rules/effect/serviceIds.d.ts +2 -0
  230. package/dist/rules/effect/serviceIds.d.ts.map +1 -0
  231. package/dist/rules/effect/serviceIds.js +9 -0
  232. package/dist/rules/effect/serviceIds.js.map +1 -0
  233. package/dist/rules/effect/sharedErrorClasses.d.ts +2 -0
  234. package/dist/rules/effect/sharedErrorClasses.d.ts.map +1 -0
  235. package/dist/rules/effect/sharedErrorClasses.js +9 -0
  236. package/dist/rules/effect/sharedErrorClasses.js.map +1 -0
  237. package/dist/rules/files/folderNames.d.ts.map +1 -1
  238. package/dist/rules/files/folderNames.js +7 -7
  239. package/dist/rules/files/folderNames.js.map +1 -1
  240. package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
  241. package/dist/rules/files/namedAfterExport.js +6 -6
  242. package/dist/rules/files/namedAfterExport.js.map +1 -1
  243. package/dist/rules/files/otherNames.d.ts.map +1 -1
  244. package/dist/rules/files/otherNames.js +7 -7
  245. package/dist/rules/files/otherNames.js.map +1 -1
  246. package/dist/rules/files/packageImports.d.ts +2 -1
  247. package/dist/rules/files/packageImports.d.ts.map +1 -1
  248. package/dist/rules/files/packageImports.js +4 -3
  249. package/dist/rules/files/packageImports.js.map +1 -1
  250. package/dist/rules/files/stylesheetImporters.d.ts +2 -1
  251. package/dist/rules/files/stylesheetImporters.d.ts.map +1 -1
  252. package/dist/rules/files/stylesheetImporters.js +5 -4
  253. package/dist/rules/files/stylesheetImporters.js.map +1 -1
  254. package/dist/rules/imports/adminPaths.js +1 -1
  255. package/dist/rules/imports/adminPaths.js.map +1 -1
  256. package/dist/rules/imports/aliased.d.ts.map +1 -1
  257. package/dist/rules/imports/aliased.js +3 -2
  258. package/dist/rules/imports/aliased.js.map +1 -1
  259. package/dist/rules/imports/cycles.d.ts.map +1 -1
  260. package/dist/rules/imports/cycles.js +4 -3
  261. package/dist/rules/imports/cycles.js.map +1 -1
  262. package/dist/rules/imports/manifest.d.ts.map +1 -1
  263. package/dist/rules/imports/manifest.js +6 -5
  264. package/dist/rules/imports/manifest.js.map +1 -1
  265. package/dist/rules/imports/noTestCode.d.ts.map +1 -1
  266. package/dist/rules/imports/noTestCode.js +3 -2
  267. package/dist/rules/imports/noTestCode.js.map +1 -1
  268. package/dist/rules/imports/resolvable.js +1 -1
  269. package/dist/rules/imports/resolvable.js.map +1 -1
  270. package/dist/rules/imports/runtime.d.ts.map +1 -1
  271. package/dist/rules/imports/runtime.js +3 -2
  272. package/dist/rules/imports/runtime.js.map +1 -1
  273. package/dist/rules/manifestsApplication.d.ts.map +1 -1
  274. package/dist/rules/manifestsApplication.js +22 -22
  275. package/dist/rules/manifestsApplication.js.map +1 -1
  276. package/dist/rules/manifestsExportsShape.d.ts.map +1 -1
  277. package/dist/rules/manifestsExportsShape.js +32 -8
  278. package/dist/rules/manifestsExportsShape.js.map +1 -1
  279. package/dist/rules/manifestsSorted.d.ts.map +1 -1
  280. package/dist/rules/manifestsSorted.js +6 -5
  281. package/dist/rules/manifestsSorted.js.map +1 -1
  282. package/dist/rules/manifestsSourceFirst.d.ts.map +1 -1
  283. package/dist/rules/manifestsSourceFirst.js +6 -5
  284. package/dist/rules/manifestsSourceFirst.js.map +1 -1
  285. package/dist/rules/stories/adapterOnlyFakes.d.ts +2 -0
  286. package/dist/rules/stories/adapterOnlyFakes.d.ts.map +1 -0
  287. package/dist/rules/stories/adapterOnlyFakes.js +63 -0
  288. package/dist/rules/stories/adapterOnlyFakes.js.map +1 -0
  289. package/dist/rules/stories/engine.d.ts.map +1 -1
  290. package/dist/rules/stories/engine.js +5 -4
  291. package/dist/rules/stories/engine.js.map +1 -1
  292. package/dist/rules/stories/engineOf.d.ts +1 -1
  293. package/dist/rules/stories/engineOf.d.ts.map +1 -1
  294. package/dist/rules/stories/fakeImplementation.d.ts +4 -0
  295. package/dist/rules/stories/fakeImplementation.d.ts.map +1 -0
  296. package/dist/rules/stories/fakeImplementation.js +22 -0
  297. package/dist/rules/stories/fakeImplementation.js.map +1 -0
  298. package/dist/rules/stories/fakeReplacements.d.ts +4 -0
  299. package/dist/rules/stories/fakeReplacements.d.ts.map +1 -0
  300. package/dist/rules/stories/fakeReplacements.js +71 -0
  301. package/dist/rules/stories/fakeReplacements.js.map +1 -0
  302. package/dist/rules/stories/globalRetries.js +1 -1
  303. package/dist/rules/stories/globalRetries.js.map +1 -1
  304. package/dist/rules/stories/importOrigin.js +2 -2
  305. package/dist/rules/stories/importOrigin.js.map +1 -1
  306. package/dist/rules/stories/importedChangeKeys.d.ts +2 -0
  307. package/dist/rules/stories/importedChangeKeys.d.ts.map +1 -0
  308. package/dist/rules/stories/importedChangeKeys.js +9 -0
  309. package/dist/rules/stories/importedChangeKeys.js.map +1 -0
  310. package/dist/rules/stories/noExpect.d.ts.map +1 -1
  311. package/dist/rules/stories/noExpect.js +4 -3
  312. package/dist/rules/stories/noExpect.js.map +1 -1
  313. package/dist/rules/stories/pureNetImport.d.ts +4 -0
  314. package/dist/rules/stories/pureNetImport.d.ts.map +1 -0
  315. package/dist/rules/stories/pureNetImport.js +23 -0
  316. package/dist/rules/stories/pureNetImport.js.map +1 -0
  317. package/dist/rules/stories/queueReadouts.d.ts +2 -0
  318. package/dist/rules/stories/queueReadouts.d.ts.map +1 -0
  319. package/dist/rules/stories/queueReadouts.js +9 -0
  320. package/dist/rules/stories/queueReadouts.js.map +1 -0
  321. package/dist/rules/stories/sources.d.ts +1 -1
  322. package/dist/rules/stories/sources.d.ts.map +1 -1
  323. package/dist/rules/stories/sources.js +1 -1
  324. package/dist/rules/stories/sources.js.map +1 -1
  325. package/dist/rules/stories/specs.d.ts.map +1 -1
  326. package/dist/rules/stories/specs.js +5 -4
  327. package/dist/rules/stories/specs.js.map +1 -1
  328. package/dist/rules/stories/unitTests.d.ts.map +1 -1
  329. package/dist/rules/stories/unitTests.js +4 -3
  330. package/dist/rules/stories/unitTests.js.map +1 -1
  331. package/dist/rules/suppressions/biome/weakenings.d.ts +1 -1
  332. package/dist/rules/suppressions/biome/weakenings.d.ts.map +1 -1
  333. package/dist/rules/suppressions/biomeOverrides.d.ts.map +1 -1
  334. package/dist/rules/suppressions/biomeOverrides.js +5 -5
  335. package/dist/rules/suppressions/biomeOverrides.js.map +1 -1
  336. package/dist/rules/suppressions/biomeRecommended.d.ts +1 -1
  337. package/dist/rules/suppressions/biomeRecommended.d.ts.map +1 -1
  338. package/dist/rules/suppressions/biomeRecommended.js +12 -30
  339. package/dist/rules/suppressions/biomeRecommended.js.map +1 -1
  340. package/dist/rules/test-names/colocated.js +2 -2
  341. package/dist/rules/test-names/colocated.js.map +1 -1
  342. package/dist/rules/test-names/follow.js +4 -4
  343. package/dist/rules/test-names/follow.js.map +1 -1
  344. package/dist/testing/adapters/cli.d.ts +21 -0
  345. package/dist/testing/adapters/cli.d.ts.map +1 -0
  346. package/dist/testing/adapters/cli.js +85 -0
  347. package/dist/testing/adapters/cli.js.map +1 -0
  348. package/dist/testing/adapters/git.d.ts +14 -0
  349. package/dist/testing/adapters/git.d.ts.map +1 -0
  350. package/dist/testing/adapters/git.js +52 -0
  351. package/dist/testing/adapters/git.js.map +1 -0
  352. package/dist/testing/adapters/hookPath.d.ts +2 -0
  353. package/dist/testing/adapters/hookPath.d.ts.map +1 -0
  354. package/dist/testing/adapters/hookPath.js +6 -0
  355. package/dist/testing/adapters/hookPath.js.map +1 -0
  356. package/dist/testing/adapters/hookRepository.d.ts +25 -0
  357. package/dist/testing/adapters/hookRepository.d.ts.map +1 -0
  358. package/dist/testing/adapters/hookRepository.js +96 -0
  359. package/dist/testing/adapters/hookRepository.js.map +1 -0
  360. package/dist/testing/adapters/imports.d.ts +5 -0
  361. package/dist/testing/adapters/imports.d.ts.map +1 -0
  362. package/dist/testing/adapters/imports.js +29 -0
  363. package/dist/testing/adapters/imports.js.map +1 -0
  364. package/dist/testing/adapters/packageExports.d.ts +15 -0
  365. package/dist/testing/adapters/packageExports.d.ts.map +1 -0
  366. package/dist/testing/adapters/packageExports.js +29 -0
  367. package/dist/testing/adapters/packageExports.js.map +1 -0
  368. package/dist/testing/adapters/qualityTree.d.ts +4 -0
  369. package/dist/testing/adapters/qualityTree.d.ts.map +1 -0
  370. package/dist/testing/adapters/qualityTree.js +21 -0
  371. package/dist/testing/adapters/qualityTree.js.map +1 -0
  372. package/dist/testing/adapters/run.d.ts +4 -0
  373. package/dist/testing/adapters/run.d.ts.map +1 -0
  374. package/dist/testing/adapters/run.js +6 -0
  375. package/dist/testing/adapters/run.js.map +1 -0
  376. package/dist/testing/adapters/storySpecFiles.d.ts +7 -0
  377. package/dist/testing/adapters/storySpecFiles.d.ts.map +1 -0
  378. package/dist/testing/adapters/storySpecFiles.js +48 -0
  379. package/dist/testing/adapters/storySpecFiles.js.map +1 -0
  380. package/dist/testing/adapters/tree.d.ts +13 -0
  381. package/dist/testing/adapters/tree.d.ts.map +1 -0
  382. package/dist/testing/adapters/tree.js +42 -0
  383. package/dist/testing/adapters/tree.js.map +1 -0
  384. package/dist/testing/adapters/writePackageExports.d.ts +2 -0
  385. package/dist/testing/adapters/writePackageExports.d.ts.map +1 -0
  386. package/dist/testing/adapters/writePackageExports.js +9 -0
  387. package/dist/testing/adapters/writePackageExports.js.map +1 -0
  388. package/dist/testing/ruleStory.d.ts +28 -0
  389. package/dist/testing/ruleStory.d.ts.map +1 -0
  390. package/dist/testing/ruleStory.js +115 -0
  391. package/dist/testing/ruleStory.js.map +1 -0
  392. package/dist/unitIoGuard.config.js +1 -1
  393. package/dist/unitIoGuard.config.js.map +1 -1
  394. package/package.json +8 -3
  395. package/src/adapters/ImportCompiler.ts +30 -0
  396. package/src/{rules/suppressions → adapters}/biome/configs.ts +2 -2
  397. package/src/adapters/biome/presetConfig.ts +34 -0
  398. package/src/adapters/biome/rootConfig.ts +19 -0
  399. package/src/adapters/biome/run.ts +1 -1
  400. package/src/adapters/biome/syntaxOf.ts +12 -0
  401. package/src/adapters/biome/withExceptionConfig.ts +45 -0
  402. package/src/adapters/changeKeyApi.ts +62 -0
  403. package/src/adapters/changeKeyFindings.ts +96 -0
  404. package/src/adapters/changeKeyLiterals.ts +60 -0
  405. package/src/adapters/ignore.ts +16 -0
  406. package/src/adapters/imports/browserChecker.ts +8 -0
  407. package/src/adapters/imports/departures.ts +82 -0
  408. package/src/adapters/imports/fakeReferences.ts +115 -0
  409. package/src/adapters/imports/fakeTargets.ts +21 -0
  410. package/src/adapters/imports/graph.ts +48 -0
  411. package/src/{imports → adapters/imports}/resolve.ts +4 -7
  412. package/src/adapters/knip/entryPointFindings.ts +12 -9
  413. package/src/adapters/knip/run.ts +1 -1
  414. package/src/adapters/outsideImportFindings.ts +98 -0
  415. package/src/adapters/queueReadoutFindings.ts +37 -0
  416. package/src/adapters/queueTestingOrigin.ts +113 -0
  417. package/src/adapters/readConfig.ts +42 -0
  418. package/src/adapters/rule.ts +53 -0
  419. package/src/adapters/serviceIdFindings.ts +80 -0
  420. package/src/adapters/sharedErrorFindings.ts +84 -0
  421. package/src/adapters/sharedErrorModules.ts +81 -0
  422. package/src/adapters/testProjects.ts +18 -2
  423. package/src/appTestConfig.ts +1 -1
  424. package/src/biome/exceptionConfig.ts +0 -43
  425. package/src/biome/recognizeDiagnostics.ts +2 -1
  426. package/src/biome/syntax.ts +0 -10
  427. package/src/biome/withoutEntryPointImports.ts +15 -10
  428. package/src/cli/fixRule.ts +1 -1
  429. package/src/config/decode.ts +5 -4
  430. package/src/config/globs.ts +1 -6
  431. package/src/config/load.ts +6 -38
  432. package/src/config/resolve.ts +7 -6
  433. package/src/config.ts +5 -5
  434. package/src/decoded.ts +1 -1
  435. package/src/domEnvironment.config.ts +1 -1
  436. package/src/exceptions/biomeFindings.ts +11 -10
  437. package/src/imports/Endpoint.ts +3 -0
  438. package/src/imports/browserGlobals.ts +6 -10
  439. package/src/imports/departures.ts +9 -80
  440. package/src/imports/fences/check.ts +6 -5
  441. package/src/imports/fences/compilePolicy.ts +1 -1
  442. package/src/imports/fences/match.ts +1 -1
  443. package/src/imports/fences/reach.ts +1 -1
  444. package/src/imports/fences/vocabulary.ts +1 -1
  445. package/src/imports/graph.ts +25 -61
  446. package/src/inventory/collect.ts +2 -2
  447. package/src/inventory/ignoreScope.ts +3 -3
  448. package/src/naming/packageLayout.ts +14 -7
  449. package/src/naming/testName.ts +1 -1
  450. package/src/rule.ts +20 -52
  451. package/src/rules/biome.ts +6 -23
  452. package/src/rules/builtIn.ts +12 -0
  453. package/src/rules/effect/adapterImports.ts +10 -0
  454. package/src/rules/effect/program.ts +3 -3
  455. package/src/rules/effect/serviceIds.ts +10 -0
  456. package/src/rules/effect/sharedErrorClasses.ts +10 -0
  457. package/src/rules/files/folderNames.ts +19 -18
  458. package/src/rules/files/namedAfterExport.ts +10 -9
  459. package/src/rules/files/otherNames.ts +17 -16
  460. package/src/rules/files/packageImports.ts +14 -4
  461. package/src/rules/files/stylesheetImporters.ts +13 -6
  462. package/src/rules/imports/adminPaths.ts +1 -1
  463. package/src/rules/imports/aliased.ts +10 -7
  464. package/src/rules/imports/cycles.ts +4 -3
  465. package/src/rules/imports/manifest.ts +8 -5
  466. package/src/rules/imports/noTestCode.ts +12 -9
  467. package/src/rules/imports/resolvable.ts +1 -1
  468. package/src/rules/imports/runtime.ts +3 -2
  469. package/src/rules/manifestsApplication.ts +44 -33
  470. package/src/rules/manifestsExportsShape.ts +45 -15
  471. package/src/rules/manifestsSorted.ts +16 -11
  472. package/src/rules/manifestsSourceFirst.ts +22 -17
  473. package/src/rules/stories/adapterOnlyFakes.ts +66 -0
  474. package/src/rules/stories/engine.ts +5 -4
  475. package/src/rules/stories/engineOf.ts +1 -1
  476. package/src/rules/stories/fakeImplementation.ts +23 -0
  477. package/src/rules/stories/fakeReplacements.ts +74 -0
  478. package/src/rules/stories/globalRetries.ts +1 -1
  479. package/src/rules/stories/importOrigin.ts +2 -2
  480. package/src/rules/stories/importedChangeKeys.ts +10 -0
  481. package/src/rules/stories/noExpect.ts +4 -3
  482. package/src/rules/stories/pureNetImport.ts +29 -0
  483. package/src/rules/stories/queueReadouts.ts +9 -0
  484. package/src/rules/stories/sources.ts +1 -1
  485. package/src/rules/stories/specs.ts +5 -4
  486. package/src/rules/stories/unitTests.ts +6 -3
  487. package/src/rules/suppressions/biome/weakenings.ts +1 -1
  488. package/src/rules/suppressions/biomeOverrides.ts +17 -16
  489. package/src/rules/suppressions/biomeRecommended.ts +13 -32
  490. package/src/rules/test-names/colocated.ts +2 -2
  491. package/src/rules/test-names/follow.ts +4 -4
  492. package/src/testing/adapters/cli.ts +105 -0
  493. package/src/testing/adapters/git.ts +62 -0
  494. package/src/testing/adapters/hookPath.ts +6 -0
  495. package/src/testing/adapters/hookRepository.ts +134 -0
  496. package/src/testing/adapters/imports.ts +35 -0
  497. package/src/testing/adapters/packageExports.ts +37 -0
  498. package/src/testing/adapters/qualityTree.ts +26 -0
  499. package/src/testing/adapters/run.ts +7 -0
  500. package/src/testing/adapters/storySpecFiles.ts +54 -0
  501. package/src/testing/adapters/tree.ts +55 -0
  502. package/src/testing/adapters/writePackageExports.ts +9 -0
  503. package/src/testing/ruleStory.ts +139 -0
  504. package/src/unitIoGuard.config.ts +1 -1
  505. package/dist/biome/relocateConfig.d.ts.map +0 -1
  506. package/dist/biome/relocateConfig.js.map +0 -1
  507. package/dist/imports/projects.d.ts.map +0 -1
  508. package/dist/imports/projects.js.map +0 -1
  509. package/dist/imports/resolve.d.ts.map +0 -1
  510. package/dist/imports/resolve.js.map +0 -1
  511. package/dist/rules/suppressions/biome/configs.d.ts.map +0 -1
  512. package/dist/rules/suppressions/biome/configs.js.map +0 -1
  513. package/dist/rules/suppressions/biome/resolvePackage.d.ts.map +0 -1
  514. package/dist/rules/suppressions/biome/resolvePackage.js.map +0 -1
  515. package/dist/standardSchema.d.ts.map +0 -1
  516. package/dist/standardSchema.js.map +0 -1
  517. /package/dist/{biome → adapters/biome}/relocateConfig.d.ts +0 -0
  518. /package/dist/{biome → adapters/biome}/relocateConfig.js +0 -0
  519. /package/dist/{rules/suppressions → adapters}/biome/resolvePackage.d.ts +0 -0
  520. /package/dist/{rules/suppressions → adapters}/biome/resolvePackage.js +0 -0
  521. /package/dist/{imports → adapters/imports}/projects.d.ts +0 -0
  522. /package/dist/{imports → adapters/imports}/projects.js +0 -0
  523. /package/dist/{standardSchema.d.ts → adapters/standardSchema.d.ts} +0 -0
  524. /package/dist/{standardSchema.js → adapters/standardSchema.js} +0 -0
  525. /package/src/{biome → adapters/biome}/relocateConfig.ts +0 -0
  526. /package/src/{rules/suppressions → adapters}/biome/resolvePackage.ts +0 -0
  527. /package/src/{imports → adapters/imports}/projects.ts +0 -0
  528. /package/src/{standardSchema.ts → adapters/standardSchema.ts} +0 -0
@@ -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,48 @@
1
+ import { join, posix } from "node:path";
2
+ import ts from "typescript";
3
+ import { ambientModules } from "#imports/ambient.ts";
4
+ import { type ImportRequest, importsOf } from "#imports/extract.ts";
5
+ import type { ImportEdge, ImportGraph, UnresolvedImport } from "#imports/graph.ts";
6
+ import type { RuleInputs } from "#rule.ts";
7
+ import { parse } from "#rules/parse.ts";
8
+ import { type Project, projectsFor } from "./projects.ts";
9
+ import { isDeclarationFile, presumedTarget, resolveImport } from "./resolve.ts";
10
+
11
+ const QUERY = /\?.*$/u;
12
+
13
+ function relativeTarget(from: string, request: ImportRequest): string | undefined {
14
+ const relative = request.kind === "path-reference" || request.specifier.startsWith("./") || request.specifier.startsWith("../");
15
+ return relative ? posix.join(posix.dirname(from), request.specifier.replace(QUERY, "")) : undefined;
16
+ }
17
+
18
+ // A relative import or a package import of a missing file still names a path, so fences see it before its generator writes it.
19
+ function missingTarget(root: string, from: string, request: ImportRequest, project: Project): string | undefined {
20
+ const target = presumedTarget(root, request, join(root, from), project) ?? relativeTarget(from, request);
21
+ return target === undefined || target.startsWith("../") ? undefined : target;
22
+ }
23
+
24
+ export function graph(inputs: RuleInputs, root: string): Pick<ImportGraph, "configFindings" | "edges" | "modules" | "unresolved"> {
25
+ const projectOf = projectsFor(root);
26
+ const parsed = inputs.sources.flatMap((file) => {
27
+ const syntax = parse(file);
28
+ return syntax === undefined ? [] : [{ file, path: join(root, file.path), syntax }];
29
+ });
30
+ const ambient = ambientModules(parsed);
31
+ const edges: ImportEdge[] = [];
32
+ const unresolved: UnresolvedImport[] = [];
33
+ for (const { file, path, syntax } of parsed) {
34
+ const project = projectOf(path);
35
+ syntax.impliedNodeFormat = ts.getImpliedNodeFormatForFile(path, undefined, ts.sys, project.options);
36
+ for (const request of importsOf(syntax, isDeclarationFile(file.path), project.options)) {
37
+ const to = resolveImport(root, ambient, request, path, project);
38
+ if (to === undefined) {
39
+ const missing = missingTarget(root, file.path, request, project);
40
+ unresolved.push({ ...request, from: file.path, missing });
41
+ edges.push(...(missing === undefined ? [] : [{ ...request, from: file.path, to: { kind: "file" as const, path: missing } }]));
42
+ } else {
43
+ edges.push({ ...request, from: file.path, to });
44
+ }
45
+ }
46
+ }
47
+ return { configFindings: projectOf.findings, edges, modules: parsed.map(({ file }) => file.path), unresolved };
48
+ }
@@ -1,16 +1,13 @@
1
1
  import { realpathSync } from "node:fs";
2
2
  import { dirname, join, relative } from "node:path";
3
3
  import ts from "typescript";
4
+ import type { Ambient } from "#imports/ambient.ts";
5
+ import type { Endpoint } from "#imports/Endpoint.ts";
6
+ import type { ImportRequest } from "#imports/extract.ts";
7
+ import { builtinName, nameAt, packageNameOf } from "#imports/packageName.ts";
4
8
  import { posix } from "#inventory/ignoreScope.ts";
5
- import type { Ambient } from "./ambient.ts";
6
- import type { ImportRequest } from "./extract.ts";
7
- import { builtinName, nameAt, packageNameOf } from "./packageName.ts";
8
9
  import type { Project } from "./projects.ts";
9
10
 
10
- export type Endpoint =
11
- | { readonly kind: "file"; readonly path: string }
12
- | { readonly kind: "external"; readonly package: string; readonly specifier: string };
13
-
14
11
  const NODE_MODULES = "/node_modules/";
15
12
 
16
13
  const ASSET_DECLARATION = /\.d(?<extension>\.[^./]+)\.ts$/u;
@@ -1,10 +1,11 @@
1
1
  import { join, posix } from "node:path";
2
+ import { Effect } from "effect";
3
+ import { projectsFor } from "#adapters/imports/projects.ts";
2
4
  import { readPackageManifest } from "#adapters/manifestInventory.ts";
3
5
  import { ambientModules } from "#imports/ambient.ts";
4
6
  import { importGraph } from "#imports/graph.ts";
5
7
  import { isTooling } from "#imports/isTooling.ts";
6
8
  import { packageNameOf } from "#imports/packageName.ts";
7
- import { projectsFor } from "#imports/projects.ts";
8
9
  import { packageOf } from "#imports/workspace.ts";
9
10
  import { entryPointsOf, isApplication, provider } from "#manifests/entryPoints.ts";
10
11
  import { isTestCode } from "#naming/testName.ts";
@@ -15,8 +16,8 @@ function importedPackage(specifier: string) {
15
16
  return /^[.#/]/u.test(specifier) ? undefined : packageNameOf(specifier);
16
17
  }
17
18
 
18
- export async function entryPointFindings(inputs: RuleInputs, findings: Findings): Promise<Findings> {
19
- const graph = await importGraph(inputs);
19
+ export const entryPointFindings = Effect.fn("Knip.entryPointFindings")(function* (inputs: RuleInputs, findings: Findings) {
20
+ const graph = yield* importGraph(inputs);
20
21
  const projectOf = projectsFor(inputs.root);
21
22
  const ambient = ambientModules(
22
23
  inputs.sources.flatMap((file) => {
@@ -28,11 +29,13 @@ export async function entryPointFindings(inputs: RuleInputs, findings: Findings)
28
29
  const workspace = new Map(graph.packages.map(({ name, directory }) => [name, directory]));
29
30
  const directories = [".", ...graph.packages.map(({ directory }) => directory)];
30
31
  const policies = new Map(
31
- await Promise.all(
32
- directories.map(async (directory) => {
33
- const manifest = await readPackageManifest(inputs.readText, posix.join(directory, "package.json"));
34
- return [directory, isApplication(manifest) ? await entryPointsOf(inputs, directory, manifest, workspace) : []] as const;
35
- }),
32
+ yield* Effect.promise(() =>
33
+ Promise.all(
34
+ directories.map(async (directory) => {
35
+ const manifest = await readPackageManifest(inputs.readText, posix.join(directory, "package.json"));
36
+ return [directory, isApplication(manifest) ? await entryPointsOf(inputs, directory, manifest, workspace) : []] as const;
37
+ }),
38
+ ),
36
39
  ),
37
40
  );
38
41
  function owner(path: string) {
@@ -72,4 +75,4 @@ export async function entryPointFindings(inputs: RuleInputs, findings: Findings)
72
75
  : supplied !== undefined && workspace.get(supplied.name) === directory && target === name;
73
76
  });
74
77
  });
75
- }
78
+ });
@@ -74,5 +74,5 @@ export const runKnip = Effect.fn("Knip.runKnip")(function* (inputs: RuleInputs)
74
74
  return report.filter((finding) => checked.has(finding.file));
75
75
  }),
76
76
  );
77
- return yield* Effect.promise(() => entryPointFindings(inputs, findings));
77
+ return yield* entryPointFindings(inputs, findings);
78
78
  });
@@ -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
+ });
@@ -0,0 +1,53 @@
1
+ import { Effect } from "effect";
2
+ import { validOrFail } from "#decoded.ts";
3
+ import type { Configured, Findings, RegisteredRule, RuleContext } from "#rule.ts";
4
+ import { describeIssue, type StandardSchemaV1 } from "./standardSchema.ts";
5
+
6
+ export type RuleCheckResult<TServices> = Findings | PromiseLike<Findings> | Effect.Effect<Findings, unknown, TServices>;
7
+
8
+ export const ruleConfiguration = Symbol("@shivaedev/quality/ruleConfiguration");
9
+
10
+ export const noOptions: StandardSchemaV1<undefined, undefined> = {
11
+ "~standard": {
12
+ validate: (value) => (value === undefined ? { value: undefined } : { issues: [{ message: "this rule takes no options" }] }),
13
+ vendor: "@shivaedev/quality",
14
+ version: 1,
15
+ },
16
+ };
17
+
18
+ export function configureRegistered<TServices>(rule: RegisteredRule<TServices>, options: unknown): Promise<Configured<TServices>> {
19
+ return rule[ruleConfiguration](options);
20
+ }
21
+
22
+ export function configureWith<TInput, TOptions, TServices>(
23
+ schema: StandardSchemaV1<TInput, TOptions>,
24
+ check: (context: RuleContext<TOptions>) => RuleCheckResult<TServices>,
25
+ id: string,
26
+ absent: unknown,
27
+ validate?: (context: RuleContext<TOptions>) => readonly string[],
28
+ ) {
29
+ return async (options: unknown): Promise<Configured<TServices>> => {
30
+ const result = await schema["~standard"].validate(options ?? absent);
31
+ if (result.issues !== undefined) {
32
+ return { _tag: "Invalid", issues: result.issues.map(describeIssue) };
33
+ }
34
+ const value = result.value;
35
+ return {
36
+ _tag: "Ready",
37
+ check: (inputs) =>
38
+ Effect.scoped(
39
+ Effect.gen(function* () {
40
+ const context = { ...inputs, options: value };
41
+ const issues = validate?.(context).map((issue) => `rules.${id}.options: ${issue}`) ?? [];
42
+ yield* validOrFail(
43
+ inputs.configFile ?? "quality.config.ts",
44
+ issues.length === 0 ? { _tag: "Valid", value: undefined } : { _tag: "Invalid", issues },
45
+ );
46
+ const signal = yield* Effect.abortSignal;
47
+ const checked = check({ ...inputs, options: value, signal });
48
+ return yield* Effect.isEffect(checked) ? checked : Effect.promise(() => Promise.resolve(checked));
49
+ }),
50
+ ),
51
+ };
52
+ };
53
+ }