@shivaedev/quality 0.42.0 → 0.44.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 (214) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/README.md +98 -38
  3. package/biome/declarations.json +6 -1
  4. package/biome/plugins/ambient-runtime.grit +3 -1
  5. package/biome/preset.json +62 -62
  6. package/dist/adapters/knip/configuration.d.ts +29 -0
  7. package/dist/adapters/knip/configuration.d.ts.map +1 -0
  8. package/dist/adapters/knip/configuration.js +56 -0
  9. package/dist/adapters/knip/configuration.js.map +1 -0
  10. package/dist/adapters/knip/entryPointFindings.d.ts +3 -0
  11. package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -0
  12. package/dist/adapters/knip/entryPointFindings.js +49 -0
  13. package/dist/adapters/knip/entryPointFindings.js.map +1 -0
  14. package/dist/adapters/knip/findings.d.ts +4 -0
  15. package/dist/adapters/knip/findings.d.ts.map +1 -0
  16. package/dist/adapters/knip/findings.js +40 -0
  17. package/dist/adapters/knip/findings.js.map +1 -0
  18. package/dist/adapters/knip/run.d.ts +3 -0
  19. package/dist/adapters/knip/run.d.ts.map +1 -0
  20. package/dist/adapters/knip/run.js +46 -0
  21. package/dist/adapters/knip/run.js.map +1 -0
  22. package/dist/adapters/knip/sourceConfig.d.ts +4 -0
  23. package/dist/adapters/knip/sourceConfig.d.ts.map +1 -0
  24. package/dist/adapters/knip/sourceConfig.js +15 -0
  25. package/dist/adapters/knip/sourceConfig.js.map +1 -0
  26. package/dist/biome/recognizeDiagnostics.js +2 -2
  27. package/dist/biome/recognizeDiagnostics.js.map +1 -1
  28. package/dist/docs/documentedImports.d.ts +12 -0
  29. package/dist/docs/documentedImports.d.ts.map +1 -0
  30. package/dist/docs/documentedImports.js +80 -0
  31. package/dist/docs/documentedImports.js.map +1 -0
  32. package/dist/docs/documentedModule.d.ts +11 -0
  33. package/dist/docs/documentedModule.d.ts.map +1 -0
  34. package/dist/docs/documentedModule.js +32 -0
  35. package/dist/docs/documentedModule.js.map +1 -0
  36. package/dist/docs/exportsName.d.ts +2 -0
  37. package/dist/docs/exportsName.d.ts.map +1 -0
  38. package/dist/docs/exportsName.js +25 -0
  39. package/dist/docs/exportsName.js.map +1 -0
  40. package/dist/docs/headingAnchors.d.ts +4 -0
  41. package/dist/docs/headingAnchors.d.ts.map +1 -0
  42. package/dist/docs/headingAnchors.js +43 -0
  43. package/dist/docs/headingAnchors.js.map +1 -0
  44. package/dist/docs/importFindings.d.ts +12 -0
  45. package/dist/docs/importFindings.d.ts.map +1 -0
  46. package/dist/docs/importFindings.js +36 -0
  47. package/dist/docs/importFindings.js.map +1 -0
  48. package/dist/docs/isDocument.d.ts +2 -0
  49. package/dist/docs/isDocument.d.ts.map +1 -0
  50. package/dist/docs/isDocument.js +6 -0
  51. package/dist/docs/isDocument.js.map +1 -0
  52. package/dist/docs/linkFindings.d.ts +12 -0
  53. package/dist/docs/linkFindings.d.ts.map +1 -0
  54. package/dist/docs/linkFindings.js +59 -0
  55. package/dist/docs/linkFindings.js.map +1 -0
  56. package/dist/docs/markdownLines.d.ts +11 -0
  57. package/dist/docs/markdownLines.d.ts.map +1 -0
  58. package/dist/docs/markdownLines.js +38 -0
  59. package/dist/docs/markdownLines.js.map +1 -0
  60. package/dist/docs/markdownLinks.d.ts +7 -0
  61. package/dist/docs/markdownLinks.d.ts.map +1 -0
  62. package/dist/docs/markdownLinks.js +23 -0
  63. package/dist/docs/markdownLinks.js.map +1 -0
  64. package/dist/docs/repositoryLink.d.ts +11 -0
  65. package/dist/docs/repositoryLink.d.ts.map +1 -0
  66. package/dist/docs/repositoryLink.js +28 -0
  67. package/dist/docs/repositoryLink.js.map +1 -0
  68. package/dist/imports/fences/compilePolicy.d.ts.map +1 -1
  69. package/dist/imports/fences/compilePolicy.js +1 -1
  70. package/dist/imports/fences/compilePolicy.js.map +1 -1
  71. package/dist/imports/fences/match.d.ts +1 -1
  72. package/dist/imports/fences/match.d.ts.map +1 -1
  73. package/dist/imports/fences/match.js +1 -1
  74. package/dist/imports/fences/match.js.map +1 -1
  75. package/dist/imports/packageExports.d.ts +1 -0
  76. package/dist/imports/packageExports.d.ts.map +1 -1
  77. package/dist/imports/packageExports.js +7 -5
  78. package/dist/imports/packageExports.js.map +1 -1
  79. package/dist/imports/packageName.d.ts +4 -0
  80. package/dist/imports/packageName.d.ts.map +1 -0
  81. package/dist/imports/packageName.js +25 -0
  82. package/dist/imports/packageName.js.map +1 -0
  83. package/dist/imports/resolve.d.ts +0 -2
  84. package/dist/imports/resolve.d.ts.map +1 -1
  85. package/dist/imports/resolve.js +1 -24
  86. package/dist/imports/resolve.js.map +1 -1
  87. package/dist/inventory/collect.d.ts +0 -1
  88. package/dist/inventory/collect.d.ts.map +1 -1
  89. package/dist/inventory/collect.js +1 -4
  90. package/dist/inventory/collect.js.map +1 -1
  91. package/dist/inventory/linesOf.d.ts +2 -0
  92. package/dist/inventory/linesOf.d.ts.map +1 -0
  93. package/dist/inventory/linesOf.js +5 -0
  94. package/dist/inventory/linesOf.js.map +1 -0
  95. package/dist/rules/builtIn.d.ts +2 -2
  96. package/dist/rules/builtIn.d.ts.map +1 -1
  97. package/dist/rules/builtIn.js +12 -0
  98. package/dist/rules/builtIn.js.map +1 -1
  99. package/dist/rules/docs/references.d.ts +2 -0
  100. package/dist/rules/docs/references.d.ts.map +1 -0
  101. package/dist/rules/docs/references.js +66 -0
  102. package/dist/rules/docs/references.js.map +1 -0
  103. package/dist/rules/docs/unversionedInstalls.d.ts +2 -0
  104. package/dist/rules/docs/unversionedInstalls.d.ts.map +1 -0
  105. package/dist/rules/docs/unversionedInstalls.js +36 -0
  106. package/dist/rules/docs/unversionedInstalls.js.map +1 -0
  107. package/dist/rules/effect/boundary.d.ts +2 -0
  108. package/dist/rules/effect/boundary.d.ts.map +1 -0
  109. package/dist/rules/effect/boundary.js +66 -0
  110. package/dist/rules/effect/boundary.js.map +1 -0
  111. package/dist/rules/effect/layerConstructor.d.ts +3 -0
  112. package/dist/rules/effect/layerConstructor.d.ts.map +1 -0
  113. package/dist/rules/effect/layerConstructor.js +35 -0
  114. package/dist/rules/effect/layerConstructor.js.map +1 -0
  115. package/dist/rules/effect/ownsParameters.d.ts +3 -0
  116. package/dist/rules/effect/ownsParameters.d.ts.map +1 -0
  117. package/dist/rules/effect/ownsParameters.js +45 -0
  118. package/dist/rules/effect/ownsParameters.js.map +1 -0
  119. package/dist/rules/effect/program.d.ts +4 -0
  120. package/dist/rules/effect/program.d.ts.map +1 -0
  121. package/dist/rules/effect/program.js +24 -0
  122. package/dist/rules/effect/program.js.map +1 -0
  123. package/dist/rules/effect/publicFunctions.d.ts +3 -0
  124. package/dist/rules/effect/publicFunctions.d.ts.map +1 -0
  125. package/dist/rules/effect/publicFunctions.js +68 -0
  126. package/dist/rules/effect/publicFunctions.js.map +1 -0
  127. package/dist/rules/effect/serviceCatalog.d.ts +8 -0
  128. package/dist/rules/effect/serviceCatalog.d.ts.map +1 -0
  129. package/dist/rules/effect/serviceCatalog.js +56 -0
  130. package/dist/rules/effect/serviceCatalog.js.map +1 -0
  131. package/dist/rules/effect/serviceFindings.d.ts +5 -0
  132. package/dist/rules/effect/serviceFindings.d.ts.map +1 -0
  133. package/dist/rules/effect/serviceFindings.js +88 -0
  134. package/dist/rules/effect/serviceFindings.js.map +1 -0
  135. package/dist/rules/effect/serviceOrigin.d.ts +3 -0
  136. package/dist/rules/effect/serviceOrigin.d.ts.map +1 -0
  137. package/dist/rules/effect/serviceOrigin.js +85 -0
  138. package/dist/rules/effect/serviceOrigin.js.map +1 -0
  139. package/dist/rules/effect/serviceParameters.d.ts +2 -0
  140. package/dist/rules/effect/serviceParameters.d.ts.map +1 -0
  141. package/dist/rules/effect/serviceParameters.js +33 -0
  142. package/dist/rules/effect/serviceParameters.js.map +1 -0
  143. package/dist/rules/effect/serviceTypes.d.ts +8 -0
  144. package/dist/rules/effect/serviceTypes.d.ts.map +1 -0
  145. package/dist/rules/effect/serviceTypes.js +94 -0
  146. package/dist/rules/effect/serviceTypes.js.map +1 -0
  147. package/dist/rules/files/folderNames.js +2 -2
  148. package/dist/rules/files/folderNames.js.map +1 -1
  149. package/dist/rules/imports/manifest.js +1 -1
  150. package/dist/rules/imports/manifest.js.map +1 -1
  151. package/dist/rules/imports/runtime.js +1 -1
  152. package/dist/rules/imports/runtime.js.map +1 -1
  153. package/dist/rules/react/jsxConditionals.d.ts +2 -0
  154. package/dist/rules/react/jsxConditionals.d.ts.map +1 -0
  155. package/dist/rules/react/jsxConditionals.js +54 -0
  156. package/dist/rules/react/jsxConditionals.js.map +1 -0
  157. package/dist/rules/stories/engineOf.d.ts.map +1 -1
  158. package/dist/rules/stories/engineOf.js +2 -1
  159. package/dist/rules/stories/engineOf.js.map +1 -1
  160. package/dist/rules/stories/namedValues.js +4 -4
  161. package/dist/rules/stories/namedValues.js.map +1 -1
  162. package/dist/rules/stories/unitTests.js +1 -1
  163. package/dist/rules/stories/unitTests.js.map +1 -1
  164. package/dist/rules/unusedCode.d.ts +2 -0
  165. package/dist/rules/unusedCode.d.ts.map +1 -0
  166. package/dist/rules/unusedCode.js +9 -0
  167. package/dist/rules/unusedCode.js.map +1 -0
  168. package/docs/debt-and-hooks.md +0 -1
  169. package/docs/north-star.md +1 -1
  170. package/package.json +5 -4
  171. package/src/adapters/knip/configuration.ts +66 -0
  172. package/src/adapters/knip/entryPointFindings.ts +54 -0
  173. package/src/adapters/knip/findings.ts +46 -0
  174. package/src/adapters/knip/run.ts +60 -0
  175. package/src/adapters/knip/sourceConfig.ts +20 -0
  176. package/src/biome/recognizeDiagnostics.ts +2 -2
  177. package/src/docs/documentedImports.ts +104 -0
  178. package/src/docs/documentedModule.ts +44 -0
  179. package/src/docs/exportsName.ts +27 -0
  180. package/src/docs/headingAnchors.ts +52 -0
  181. package/src/docs/importFindings.ts +62 -0
  182. package/src/docs/isDocument.ts +6 -0
  183. package/src/docs/linkFindings.ts +90 -0
  184. package/src/docs/markdownLines.ts +56 -0
  185. package/src/docs/markdownLinks.ts +33 -0
  186. package/src/docs/repositoryLink.ts +44 -0
  187. package/src/imports/fences/compilePolicy.ts +2 -1
  188. package/src/imports/fences/match.ts +2 -1
  189. package/src/imports/packageExports.ts +8 -5
  190. package/src/imports/packageName.ts +31 -0
  191. package/src/imports/resolve.ts +1 -31
  192. package/src/inventory/collect.ts +1 -5
  193. package/src/inventory/linesOf.ts +4 -0
  194. package/src/rules/builtIn.ts +12 -0
  195. package/src/rules/docs/references.ts +83 -0
  196. package/src/rules/docs/unversionedInstalls.ts +53 -0
  197. package/src/rules/effect/boundary.ts +75 -0
  198. package/src/rules/effect/layerConstructor.ts +40 -0
  199. package/src/rules/effect/ownsParameters.ts +46 -0
  200. package/src/rules/effect/program.ts +26 -0
  201. package/src/rules/effect/publicFunctions.ts +70 -0
  202. package/src/rules/effect/serviceCatalog.ts +57 -0
  203. package/src/rules/effect/serviceFindings.ts +96 -0
  204. package/src/rules/effect/serviceOrigin.ts +94 -0
  205. package/src/rules/effect/serviceParameters.ts +35 -0
  206. package/src/rules/effect/serviceTypes.ts +101 -0
  207. package/src/rules/files/folderNames.ts +2 -2
  208. package/src/rules/imports/manifest.ts +1 -1
  209. package/src/rules/imports/runtime.ts +1 -1
  210. package/src/rules/react/jsxConditionals.ts +59 -0
  211. package/src/rules/stories/engineOf.ts +2 -1
  212. package/src/rules/stories/namedValues.ts +4 -4
  213. package/src/rules/stories/unitTests.ts +1 -1
  214. package/src/rules/unusedCode.ts +10 -0
@@ -3,7 +3,7 @@ import { defineRule } from "#rule.ts";
3
3
  import { isSpec, memberName, nodesWhere, numericValue, syntaxFindings, unwrapped } from "./syntax.ts";
4
4
 
5
5
  const MESSAGE =
6
- "Passes a numeric literal or a matcher-only spec-local numeric const to toBe or toHaveLength. Assert the observed items, write the literal where accepted (zero, or a status or exit code), or derive the value from the story's inputs.";
6
+ 'Passes a numeric literal or a matcher-only spec-local numeric const to toBe or toHaveLength. Assert the observed items, write the literal where accepted (zero or a process exitCode), or derive the value from the story\'s inputs. For HTTP statuses, import * as HttpStatus from "effect/http/HttpStatus" and use HttpStatus.fromLiteral("NotFound"), for example.';
7
7
 
8
8
  function matcherCall(node: ts.Node): node is ts.CallExpression {
9
9
  return ts.isCallExpression(node) && ["toBe", "toHaveLength"].includes(memberName(node.expression) ?? "");
@@ -52,7 +52,7 @@ function matcherAliases(source: ts.SourceFile): ReadonlySet<ts.Node> {
52
52
  );
53
53
  }
54
54
 
55
- function codeSubject(expression: ts.Expression): boolean {
55
+ function exitCodeSubject(expression: ts.Expression): boolean {
56
56
  const value = unwrapped(expression);
57
57
  if (!(ts.isPropertyAccessExpression(value) || ts.isElementAccessExpression(value))) {
58
58
  return false;
@@ -72,13 +72,13 @@ function codeSubject(expression: ts.Expression): boolean {
72
72
  return false;
73
73
  }
74
74
  const subject = unwrapped(argument);
75
- return ["status", "code", "exitCode"].includes(ts.isIdentifier(subject) ? subject.text : (memberName(subject) ?? ""));
75
+ return (ts.isIdentifier(subject) ? subject.text : memberName(subject)) === "exitCode";
76
76
  }
77
77
 
78
78
  function numericAssertion(node: ts.Node): boolean {
79
79
  return (
80
80
  matcherCall(node)
81
- && !codeSubject(node.expression)
81
+ && !exitCodeSubject(node.expression)
82
82
  && node.arguments.some((argument) => {
83
83
  const value = numericValue(argument);
84
84
  return value !== undefined && value !== 0;
@@ -1,6 +1,6 @@
1
1
  import { labelOf, outgoing, type Reached, type Trail, walkFrom } from "#imports/fences/reach.ts";
2
2
  import type { ImportEdge, ImportGraph } from "#imports/graph.ts";
3
- import { packageNameOf } from "#imports/resolve.ts";
3
+ import { packageNameOf } from "#imports/packageName.ts";
4
4
  import { isTestSupport } from "#naming/testName.ts";
5
5
  import type { Finding, SourceFile } from "#rule.ts";
6
6
  import { parse } from "#rules/parse.ts";
@@ -0,0 +1,10 @@
1
+ import { runKnip } from "#adapters/knip/run.ts";
2
+ import { defineRule } from "#rule.ts";
3
+
4
+ export const unusedCode = defineRule({
5
+ check: runKnip,
6
+ description:
7
+ "Reports unused files, exports and package dependencies, and missing dependencies, through knip. Reach code from declared entry points or remove it; record existing debt in the baseline.",
8
+ id: "code/unused",
9
+ registrable: false,
10
+ });