@shivaedev/quality 0.62.1 → 0.65.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 (125) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/README.md +20 -4
  3. package/biome/plugins/ambient-runtime.grit +3 -3
  4. package/dist/adapters/biome/run.d.ts.map +1 -1
  5. package/dist/adapters/biome/run.js +6 -2
  6. package/dist/adapters/biome/run.js.map +1 -1
  7. package/dist/adapters/databaseUrlFindings.d.ts +11 -0
  8. package/dist/adapters/databaseUrlFindings.d.ts.map +1 -0
  9. package/dist/adapters/databaseUrlFindings.js +20 -0
  10. package/dist/adapters/databaseUrlFindings.js.map +1 -0
  11. package/dist/adapters/databaseUrlReads.d.ts +3 -0
  12. package/dist/adapters/databaseUrlReads.d.ts.map +1 -0
  13. package/dist/adapters/databaseUrlReads.js +107 -0
  14. package/dist/adapters/databaseUrlReads.js.map +1 -0
  15. package/dist/adapters/imports/resolve.js +1 -1
  16. package/dist/adapters/imports/resolve.js.map +1 -1
  17. package/dist/adapters/knip/report.d.ts +3 -0
  18. package/dist/adapters/knip/report.d.ts.map +1 -0
  19. package/dist/adapters/knip/report.js +22 -0
  20. package/dist/adapters/knip/report.js.map +1 -0
  21. package/dist/adapters/knip/run.d.ts +1 -1
  22. package/dist/adapters/knip/run.d.ts.map +1 -1
  23. package/dist/adapters/knip/run.js +3 -5
  24. package/dist/adapters/knip/run.js.map +1 -1
  25. package/dist/adapters/outsideImportFindings.d.ts.map +1 -1
  26. package/dist/adapters/outsideImportFindings.js +15 -31
  27. package/dist/adapters/outsideImportFindings.js.map +1 -1
  28. package/dist/adapters/units/runtime.d.ts +6 -0
  29. package/dist/adapters/units/runtime.d.ts.map +1 -0
  30. package/dist/adapters/units/runtime.js +46 -0
  31. package/dist/adapters/units/runtime.js.map +1 -0
  32. package/dist/adapters/units/runtimeImports.d.ts +10 -0
  33. package/dist/adapters/units/runtimeImports.d.ts.map +1 -0
  34. package/dist/adapters/units/runtimeImports.js +51 -0
  35. package/dist/adapters/units/runtimeImports.js.map +1 -0
  36. package/dist/adapters/units/runtimeOrigins.d.ts +4 -0
  37. package/dist/adapters/units/runtimeOrigins.d.ts.map +1 -0
  38. package/dist/adapters/units/runtimeOrigins.js +85 -0
  39. package/dist/adapters/units/runtimeOrigins.js.map +1 -0
  40. package/dist/adapters/units/runtimeUse.d.ts +8 -0
  41. package/dist/adapters/units/runtimeUse.d.ts.map +1 -0
  42. package/dist/adapters/units/runtimeUse.js +60 -0
  43. package/dist/adapters/units/runtimeUse.js.map +1 -0
  44. package/dist/cli/lint.js +1 -1
  45. package/dist/cli/lint.js.map +1 -1
  46. package/dist/imports/extract.d.ts.map +1 -1
  47. package/dist/imports/extract.js +13 -2
  48. package/dist/imports/extract.js.map +1 -1
  49. package/dist/inventory/collect.d.ts.map +1 -1
  50. package/dist/inventory/collect.js +3 -0
  51. package/dist/inventory/collect.js.map +1 -1
  52. package/dist/inventory/skillCopies.d.ts +7 -0
  53. package/dist/inventory/skillCopies.d.ts.map +1 -0
  54. package/dist/inventory/skillCopies.js +25 -0
  55. package/dist/inventory/skillCopies.js.map +1 -0
  56. package/dist/manifests/sorted.d.ts +1 -1
  57. package/dist/manifests/sorted.d.ts.map +1 -1
  58. package/dist/manifests/sorted.js +7 -4
  59. package/dist/manifests/sorted.js.map +1 -1
  60. package/dist/rules/builtIn.d.ts +2 -2
  61. package/dist/rules/builtIn.d.ts.map +1 -1
  62. package/dist/rules/builtIn.js +4 -0
  63. package/dist/rules/builtIn.js.map +1 -1
  64. package/dist/rules/effect/adapterImports.js +1 -1
  65. package/dist/rules/effect/adapterImports.js.map +1 -1
  66. package/dist/rules/files/folderNames.d.ts.map +1 -1
  67. package/dist/rules/files/folderNames.js +4 -1
  68. package/dist/rules/files/folderNames.js.map +1 -1
  69. package/dist/rules/manifestsNoTestKits.d.ts +2 -0
  70. package/dist/rules/manifestsNoTestKits.d.ts.map +1 -0
  71. package/dist/rules/manifestsNoTestKits.js +59 -0
  72. package/dist/rules/manifestsNoTestKits.js.map +1 -0
  73. package/dist/rules/stories/adapters/failureDeadline.d.ts +5 -0
  74. package/dist/rules/stories/adapters/failureDeadline.d.ts.map +1 -0
  75. package/dist/rules/stories/adapters/failureDeadline.js +66 -0
  76. package/dist/rules/stories/adapters/failureDeadline.js.map +1 -0
  77. package/dist/rules/stories/adapters/realTime.d.ts +4 -0
  78. package/dist/rules/stories/adapters/realTime.d.ts.map +1 -0
  79. package/dist/rules/stories/adapters/realTime.js +65 -0
  80. package/dist/rules/stories/adapters/realTime.js.map +1 -0
  81. package/dist/rules/stories/databaseUrl.d.ts +2 -0
  82. package/dist/rules/stories/databaseUrl.d.ts.map +1 -0
  83. package/dist/rules/stories/databaseUrl.js +8 -0
  84. package/dist/rules/stories/databaseUrl.js.map +1 -0
  85. package/dist/rules/stories/engineOf.d.ts.map +1 -1
  86. package/dist/rules/stories/engineOf.js +1 -0
  87. package/dist/rules/stories/engineOf.js.map +1 -1
  88. package/dist/rules/stories/specs.d.ts.map +1 -1
  89. package/dist/rules/stories/specs.js +2 -1
  90. package/dist/rules/stories/specs.js.map +1 -1
  91. package/dist/rules/stories/unitTests.d.ts +2 -2
  92. package/dist/rules/stories/unitTests.d.ts.map +1 -1
  93. package/dist/rules/stories/unitTests.js +6 -2
  94. package/dist/rules/stories/unitTests.js.map +1 -1
  95. package/dist/rules/stories/waitOnEvents.d.ts.map +1 -1
  96. package/dist/rules/stories/waitOnEvents.js +13 -70
  97. package/dist/rules/stories/waitOnEvents.js.map +1 -1
  98. package/package.json +15 -15
  99. package/src/adapters/biome/run.ts +6 -2
  100. package/src/adapters/databaseUrlFindings.ts +23 -0
  101. package/src/adapters/databaseUrlReads.ts +119 -0
  102. package/src/adapters/imports/resolve.ts +1 -1
  103. package/src/adapters/knip/report.ts +22 -0
  104. package/src/adapters/knip/run.ts +3 -7
  105. package/src/adapters/outsideImportFindings.ts +15 -34
  106. package/src/adapters/units/runtime.ts +53 -0
  107. package/src/adapters/units/runtimeImports.ts +60 -0
  108. package/src/adapters/units/runtimeOrigins.ts +96 -0
  109. package/src/adapters/units/runtimeUse.ts +72 -0
  110. package/src/cli/lint.ts +1 -1
  111. package/src/imports/extract.ts +16 -2
  112. package/src/inventory/collect.ts +3 -0
  113. package/src/inventory/skillCopies.ts +30 -0
  114. package/src/manifests/sorted.ts +9 -8
  115. package/src/rules/builtIn.ts +4 -0
  116. package/src/rules/effect/adapterImports.ts +1 -1
  117. package/src/rules/files/folderNames.ts +4 -1
  118. package/src/rules/manifestsNoTestKits.ts +73 -0
  119. package/src/rules/stories/adapters/failureDeadline.ts +78 -0
  120. package/src/rules/stories/adapters/realTime.ts +76 -0
  121. package/src/rules/stories/databaseUrl.ts +8 -0
  122. package/src/rules/stories/engineOf.ts +1 -0
  123. package/src/rules/stories/specs.ts +2 -1
  124. package/src/rules/stories/unitTests.ts +10 -2
  125. package/src/rules/stories/waitOnEvents.ts +12 -82
@@ -2,92 +2,18 @@ import { Effect } from "effect";
2
2
  import ts from "typescript";
3
3
  import { isTestSupport } from "#naming/testName.ts";
4
4
  import { defineRule } from "#rule.ts";
5
+ import { failingSleep } from "#rules/stories/adapters/failureDeadline.ts";
6
+ import { realTime } from "#rules/stories/adapters/realTime.ts";
5
7
  import { bindsModule, type ImportBinding, importBindings } from "./importBindings.ts";
6
8
  import { storyWaitSources } from "./sources.ts";
7
9
  import { memberName, syntaxFindings, unwrapped } from "./syntax.ts";
8
10
 
9
11
  const MESSAGE =
10
- "Waits on time in a story or reachable test-support: a sleep, a timer, polling with eventually or waitFor, fake timers or a clock adjustment in the spec. Settle on the engine's own signal through a kit verb, such as a Deferred the engine completes, story.runUntil or screenDriver's settle(). A deadline bounds a failure but does not prove completion; reaching it must fail the story. When time passing is the behaviour, name it in a kit verb that advances TestClock.";
12
+ "Waits on time in a story or reachable test-support: a sleep, a real timer, a wall-clock read such as Date.now(), polling with eventually or waitFor, fake timers or a clock adjustment in the spec. Settle on the engine's own signal through a kit verb, such as a Deferred the engine completes, story.runUntil or screenDriver's settle(). A deadline bounds a failure but does not prove completion; reaching it must fail the story. When time passing is the behaviour, name it in a kit verb that advances TestClock.";
11
13
 
12
- const TIMERS = new Set(["setInterval", "setTimeout"]);
13
14
  const VI_TIMING = /^(?:useFakeTimers|advanceTimers\w*|runAllTimers\w*|runOnlyPendingTimers\w*|runAllTicks|setSystemTime|waitFor|waitUntil)$/u;
14
15
  const CLOCK_CHANGES = new Set(["adjust", "setTime"]);
15
16
 
16
- function terminal(body: ts.ConciseBody): ts.Expression | undefined {
17
- if (!ts.isBlock(body)) {
18
- return unwrapped(body);
19
- }
20
- const last = body.statements.at(-1);
21
- return last !== undefined && (ts.isReturnStatement(last) || ts.isExpressionStatement(last)) ? last.expression : undefined;
22
- }
23
-
24
- function fails(expression: ts.Expression, bindings: ReadonlyMap<string, ImportBinding>): boolean {
25
- const value = unwrapped(expression);
26
- if (ts.isArrowFunction(value) || ts.isFunctionExpression(value)) {
27
- const result = terminal(value.body);
28
- return result !== undefined && fails(result, bindings);
29
- }
30
- if (!(ts.isCallExpression(value) && ts.isPropertyAccessExpression(value.expression))) {
31
- return false;
32
- }
33
- const receiver = value.expression.expression;
34
- return (
35
- ts.isIdentifier(receiver)
36
- && bindsModule(bindings.get(receiver.text), "Effect", ["effect"])
37
- && ["die", "fail"].includes(value.expression.name.text)
38
- );
39
- }
40
-
41
- function failingSleep(call: ts.CallExpression, bindings: ReadonlyMap<string, ImportBinding>): boolean {
42
- const access = call.parent;
43
- const pipe = access.parent;
44
- if (!(ts.isPropertyAccessExpression(access) && access.name.text === "pipe" && ts.isCallExpression(pipe) && pipe.arguments.length === 1)) {
45
- return false;
46
- }
47
- const step = pipe.arguments[0];
48
- if (step === undefined || !ts.isCallExpression(step) || memberName(step.expression) !== "andThen") {
49
- return false;
50
- }
51
- const receiver = ts.isPropertyAccessExpression(step.expression) ? step.expression.expression : undefined;
52
- return (
53
- receiver !== undefined
54
- && ts.isIdentifier(receiver)
55
- && bindsModule(bindings.get(receiver.text), "Effect", ["effect"])
56
- && step.arguments.length === 1
57
- && step.arguments[0] !== undefined
58
- && fails(step.arguments[0], bindings)
59
- );
60
- }
61
-
62
- function rejectionName(call: ts.CallExpression): string | undefined {
63
- for (let node: ts.Node | undefined = call.parent; node !== undefined; node = node.parent) {
64
- if (
65
- (ts.isArrowFunction(node) || ts.isFunctionExpression(node))
66
- && ts.isNewExpression(node.parent)
67
- && ts.isIdentifier(node.parent.expression)
68
- && node.parent.expression.text === "Promise"
69
- ) {
70
- const name = node.parameters[1]?.name;
71
- return name !== undefined && ts.isIdentifier(name) ? name.text : undefined;
72
- }
73
- }
74
- return undefined;
75
- }
76
-
77
- function rejectingTimer(call: ts.CallExpression): boolean {
78
- const reject = rejectionName(call);
79
- const callback = call.arguments[0];
80
- if (reject === undefined || callback === undefined) {
81
- return false;
82
- }
83
- const body = ts.isArrowFunction(callback) || ts.isFunctionExpression(callback) ? terminal(callback.body) : callback;
84
- return (
85
- body !== undefined
86
- && ((ts.isIdentifier(body) && body.text === reject)
87
- || (ts.isCallExpression(body) && ts.isIdentifier(body.expression) && body.expression.text === reject))
88
- );
89
- }
90
-
91
17
  function receiverOf(callee: ts.Expression): ts.Identifier | undefined {
92
18
  const receiver = ts.isPropertyAccessExpression(callee) ? unwrapped(callee.expression) : undefined;
93
19
  return receiver !== undefined && ts.isIdentifier(receiver) ? receiver : undefined;
@@ -101,21 +27,24 @@ function vitestTiming(receiver: ts.Identifier, bindings: ReadonlyMap<string, Imp
101
27
  function timedWait(call: ts.CallExpression, bindings: ReadonlyMap<string, ImportBinding>, support: boolean): boolean {
102
28
  const callee = unwrapped(call.expression);
103
29
  if (ts.isIdentifier(callee)) {
30
+ const binding = bindings.get(callee.text);
104
31
  return (
105
- (TIMERS.has(callee.text) && !(callee.text === "setTimeout" && rejectingTimer(call))) || bindings.get(callee.text)?.imported === "eventually"
32
+ binding?.imported === "eventually"
33
+ || (binding?.module === "effect/Effect" && binding.imported === "sleep" && !failingSleep(call, bindings))
34
+ || realTime(call, bindings)
106
35
  );
107
36
  }
108
37
  const member = memberName(callee) ?? "";
109
38
  const receiver = receiverOf(callee);
110
39
  if (receiver === undefined) {
111
- return false;
40
+ return realTime(call, bindings);
112
41
  }
113
42
  const binding = bindings.get(receiver.text);
114
43
  return (
115
- (member === "sleep" && bindsModule(binding, "Effect", ["effect"]) && !failingSleep(call, bindings))
44
+ realTime(call, bindings)
45
+ || (member === "sleep" && bindsModule(binding, "Effect", ["effect"]) && !failingSleep(call, bindings))
116
46
  || (VI_TIMING.test(member) && vitestTiming(receiver, bindings))
117
47
  || (!support && CLOCK_CHANGES.has(member) && bindsModule(binding, "TestClock", ["effect/testing"]))
118
- || (TIMERS.has(member) && receiver.text === "globalThis" && !(member === "setTimeout" && rejectingTimer(call)))
119
48
  );
120
49
  }
121
50
 
@@ -124,7 +53,7 @@ function timedWaits(source: ts.SourceFile): readonly ts.Node[] {
124
53
  const support = isTestSupport(source.fileName);
125
54
  const found: ts.Node[] = [];
126
55
  function visit(node: ts.Node): void {
127
- if (ts.isCallExpression(node) && timedWait(node, bindings, support)) {
56
+ if ((ts.isCallExpression(node) && timedWait(node, bindings, support)) || (ts.isNewExpression(node) && realTime(node, bindings))) {
128
57
  found.push(node);
129
58
  }
130
59
  ts.forEachChild(node, visit);
@@ -137,4 +66,5 @@ export const waitOnEvents = defineRule({
137
66
  check: (inputs) => Effect.map(storyWaitSources(inputs), (sources) => sources.flatMap((file) => syntaxFindings(file, timedWaits, MESSAGE))),
138
67
  description: "Stories and reachable test-support settle on the engine's own signals; controlled clock advances belong in kit verbs.",
139
68
  id: "tests/wait-on-events",
69
+ registrable: false,
140
70
  });