@shivaedev/quality 0.63.0 → 0.66.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 (163) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +13 -5
  3. package/biome/plugins/ambient-runtime.grit +3 -3
  4. package/dist/adapters/callerContextData.d.ts +3 -0
  5. package/dist/adapters/callerContextData.d.ts.map +1 -0
  6. package/dist/adapters/callerContextData.js +42 -0
  7. package/dist/adapters/callerContextData.js.map +1 -0
  8. package/dist/adapters/contextCaptureFindings.d.ts +4 -0
  9. package/dist/adapters/contextCaptureFindings.d.ts.map +1 -0
  10. package/dist/adapters/contextCaptureFindings.js +49 -0
  11. package/dist/adapters/contextCaptureFindings.js.map +1 -0
  12. package/dist/adapters/import-compiler/browserChecker.d.ts +4 -0
  13. package/dist/adapters/import-compiler/browserChecker.d.ts.map +1 -0
  14. package/dist/adapters/import-compiler/browserChecker.js +4 -0
  15. package/dist/adapters/import-compiler/browserChecker.js.map +1 -0
  16. package/dist/adapters/import-compiler/departures.d.ts +5 -0
  17. package/dist/adapters/import-compiler/departures.d.ts.map +1 -0
  18. package/dist/adapters/import-compiler/departures.js +5 -0
  19. package/dist/adapters/import-compiler/departures.js.map +1 -0
  20. package/dist/adapters/import-compiler/graph.d.ts +4 -0
  21. package/dist/adapters/import-compiler/graph.d.ts.map +1 -0
  22. package/dist/adapters/import-compiler/graph.js +6 -0
  23. package/dist/adapters/import-compiler/graph.js.map +1 -0
  24. package/dist/adapters/import-compiler/service.d.ts +10 -0
  25. package/dist/adapters/import-compiler/service.d.ts.map +1 -0
  26. package/dist/adapters/import-compiler/service.js +16 -0
  27. package/dist/adapters/import-compiler/service.js.map +1 -0
  28. package/dist/adapters/initializerDependency.d.ts +3 -0
  29. package/dist/adapters/initializerDependency.d.ts.map +1 -0
  30. package/dist/adapters/initializerDependency.js +53 -0
  31. package/dist/adapters/initializerDependency.js.map +1 -0
  32. package/dist/adapters/outsideImportFindings.d.ts.map +1 -1
  33. package/dist/adapters/outsideImportFindings.js +13 -1
  34. package/dist/adapters/outsideImportFindings.js.map +1 -1
  35. package/dist/adapters/serviceDefinitionProblems.js +1 -1
  36. package/dist/adapters/serviceDefinitionProblems.js.map +1 -1
  37. package/dist/adapters/serviceFolderFindings.d.ts.map +1 -1
  38. package/dist/adapters/serviceFolderFindings.js +12 -0
  39. package/dist/adapters/serviceFolderFindings.js.map +1 -1
  40. package/dist/adapters/serviceModelFindings.d.ts +4 -0
  41. package/dist/adapters/serviceModelFindings.d.ts.map +1 -0
  42. package/dist/adapters/serviceModelFindings.js +48 -0
  43. package/dist/adapters/serviceModelFindings.js.map +1 -0
  44. package/dist/adapters/serviceModelSyntax.d.ts +5 -0
  45. package/dist/adapters/serviceModelSyntax.d.ts.map +1 -0
  46. package/dist/adapters/serviceModelSyntax.js +53 -0
  47. package/dist/adapters/serviceModelSyntax.js.map +1 -0
  48. package/dist/adapters/serviceOperationProblems.d.ts +8 -0
  49. package/dist/adapters/serviceOperationProblems.d.ts.map +1 -0
  50. package/dist/adapters/serviceOperationProblems.js +108 -0
  51. package/dist/adapters/serviceOperationProblems.js.map +1 -0
  52. package/dist/adapters/serviceStateProblems.d.ts +7 -0
  53. package/dist/adapters/serviceStateProblems.d.ts.map +1 -0
  54. package/dist/adapters/serviceStateProblems.js +66 -0
  55. package/dist/adapters/serviceStateProblems.js.map +1 -0
  56. package/dist/cli/lint.js +1 -1
  57. package/dist/cli/lint.js.map +1 -1
  58. package/dist/imports/browserGlobals.js +1 -1
  59. package/dist/imports/browserGlobals.js.map +1 -1
  60. package/dist/imports/departures.js +1 -1
  61. package/dist/imports/departures.js.map +1 -1
  62. package/dist/imports/graph.js +1 -1
  63. package/dist/imports/graph.js.map +1 -1
  64. package/dist/rules/builtIn.d.ts +2 -2
  65. package/dist/rules/builtIn.d.ts.map +1 -1
  66. package/dist/rules/builtIn.js +2 -20
  67. package/dist/rules/builtIn.js.map +1 -1
  68. package/dist/rules/effect/adapterImports.js +1 -1
  69. package/dist/rules/effect/adapterImports.js.map +1 -1
  70. package/dist/rules/effect/contextCapture.d.ts +2 -0
  71. package/dist/rules/effect/contextCapture.d.ts.map +1 -0
  72. package/dist/rules/effect/contextCapture.js +9 -0
  73. package/dist/rules/effect/contextCapture.js.map +1 -0
  74. package/dist/rules/effect/policy.d.ts +2 -0
  75. package/dist/rules/effect/policy.d.ts.map +1 -0
  76. package/dist/rules/effect/policy.js +27 -0
  77. package/dist/rules/effect/policy.js.map +1 -0
  78. package/dist/rules/effect/serviceCatalog.d.ts +2 -2
  79. package/dist/rules/effect/serviceCatalog.d.ts.map +1 -1
  80. package/dist/rules/effect/serviceCatalog.js +14 -10
  81. package/dist/rules/effect/serviceCatalog.js.map +1 -1
  82. package/dist/rules/effect/serviceDefinitionAssembly.js +1 -1
  83. package/dist/rules/effect/serviceDefinitionAssembly.js.map +1 -1
  84. package/dist/rules/effect/serviceFolders.js +1 -1
  85. package/dist/rules/effect/serviceFolders.js.map +1 -1
  86. package/dist/rules/effect/serviceModel.d.ts +2 -0
  87. package/dist/rules/effect/serviceModel.d.ts.map +1 -0
  88. package/dist/rules/effect/serviceModel.js +9 -0
  89. package/dist/rules/effect/serviceModel.js.map +1 -0
  90. package/dist/rules/effect/serviceTypes.d.ts +2 -2
  91. package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
  92. package/dist/rules/effect/serviceTypes.js +15 -3
  93. package/dist/rules/effect/serviceTypes.js.map +1 -1
  94. package/dist/rules/files/folderNames.d.ts.map +1 -1
  95. package/dist/rules/files/folderNames.js +4 -1
  96. package/dist/rules/files/folderNames.js.map +1 -1
  97. package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
  98. package/dist/rules/files/namedAfterExport.js +16 -3
  99. package/dist/rules/files/namedAfterExport.js.map +1 -1
  100. package/dist/rules/stories/adapters/failureDeadline.d.ts +5 -0
  101. package/dist/rules/stories/adapters/failureDeadline.d.ts.map +1 -0
  102. package/dist/rules/stories/adapters/failureDeadline.js +66 -0
  103. package/dist/rules/stories/adapters/failureDeadline.js.map +1 -0
  104. package/dist/rules/stories/adapters/realTime.d.ts +4 -0
  105. package/dist/rules/stories/adapters/realTime.d.ts.map +1 -0
  106. package/dist/rules/stories/adapters/realTime.js +65 -0
  107. package/dist/rules/stories/adapters/realTime.js.map +1 -0
  108. package/dist/rules/stories/waitOnEvents.d.ts.map +1 -1
  109. package/dist/rules/stories/waitOnEvents.js +13 -70
  110. package/dist/rules/stories/waitOnEvents.js.map +1 -1
  111. package/package.json +15 -15
  112. package/src/adapters/callerContextData.ts +46 -0
  113. package/src/adapters/contextCaptureFindings.ts +58 -0
  114. package/src/adapters/import-compiler/browserChecker.ts +5 -0
  115. package/src/adapters/import-compiler/departures.ts +9 -0
  116. package/src/adapters/import-compiler/graph.ts +9 -0
  117. package/src/adapters/import-compiler/service.ts +17 -0
  118. package/src/adapters/initializerDependency.ts +57 -0
  119. package/src/adapters/outsideImportFindings.ts +14 -1
  120. package/src/adapters/serviceDefinitionProblems.ts +1 -1
  121. package/src/adapters/serviceFolderFindings.ts +14 -0
  122. package/src/adapters/serviceModelFindings.ts +52 -0
  123. package/src/adapters/serviceModelSyntax.ts +58 -0
  124. package/src/adapters/serviceOperationProblems.ts +131 -0
  125. package/src/adapters/serviceStateProblems.ts +86 -0
  126. package/src/cli/lint.ts +1 -1
  127. package/src/imports/browserGlobals.ts +1 -1
  128. package/src/imports/departures.ts +1 -1
  129. package/src/imports/graph.ts +1 -1
  130. package/src/rules/builtIn.ts +2 -20
  131. package/src/rules/effect/adapterImports.ts +1 -1
  132. package/src/rules/effect/contextCapture.ts +10 -0
  133. package/src/rules/effect/policy.ts +27 -0
  134. package/src/rules/effect/serviceCatalog.ts +15 -10
  135. package/src/rules/effect/serviceDefinitionAssembly.ts +1 -1
  136. package/src/rules/effect/serviceFolders.ts +1 -1
  137. package/src/rules/effect/serviceModel.ts +10 -0
  138. package/src/rules/effect/serviceTypes.ts +15 -3
  139. package/src/rules/files/folderNames.ts +4 -1
  140. package/src/rules/files/namedAfterExport.ts +16 -3
  141. package/src/rules/stories/adapters/failureDeadline.ts +78 -0
  142. package/src/rules/stories/adapters/realTime.ts +76 -0
  143. package/src/rules/stories/waitOnEvents.ts +12 -82
  144. package/dist/adapters/ImportCompiler.d.ts +0 -10
  145. package/dist/adapters/ImportCompiler.d.ts.map +0 -1
  146. package/dist/adapters/ImportCompiler.js +0 -16
  147. package/dist/adapters/ImportCompiler.js.map +0 -1
  148. package/dist/adapters/imports/analyzeDepartures.d.ts +0 -5
  149. package/dist/adapters/imports/analyzeDepartures.d.ts.map +0 -1
  150. package/dist/adapters/imports/analyzeDepartures.js +0 -5
  151. package/dist/adapters/imports/analyzeDepartures.js.map +0 -1
  152. package/dist/adapters/imports/analyzeGraph.d.ts +0 -4
  153. package/dist/adapters/imports/analyzeGraph.d.ts.map +0 -1
  154. package/dist/adapters/imports/analyzeGraph.js +0 -6
  155. package/dist/adapters/imports/analyzeGraph.js.map +0 -1
  156. package/dist/adapters/imports/checkBrowser.d.ts +0 -4
  157. package/dist/adapters/imports/checkBrowser.d.ts.map +0 -1
  158. package/dist/adapters/imports/checkBrowser.js +0 -4
  159. package/dist/adapters/imports/checkBrowser.js.map +0 -1
  160. package/src/adapters/ImportCompiler.ts +0 -17
  161. package/src/adapters/imports/analyzeDepartures.ts +0 -9
  162. package/src/adapters/imports/analyzeGraph.ts +0 -9
  163. package/src/adapters/imports/checkBrowser.ts +0 -5
@@ -0,0 +1,131 @@
1
+ import { posix } from "node:path";
2
+ import ts from "typescript";
3
+ import { serviceProperty } from "#adapters/serviceAssemblySyntax.ts";
4
+ import { effectApi, resolvedValue } from "#adapters/serviceModelSyntax.ts";
5
+ import { returnValues } from "#rules/stories/returnValues.ts";
6
+
7
+ function operationValues(checker: ts.TypeChecker, expression: ts.Expression, seen = new Set<ts.Node>()): readonly ts.Node[] {
8
+ const value = resolvedValue(checker, expression);
9
+ if (seen.has(value)) {
10
+ return [value];
11
+ }
12
+ seen.add(value);
13
+ if (ts.isConditionalExpression(value)) {
14
+ return [value.whenTrue, value.whenFalse].flatMap((branch) => operationValues(checker, branch, new Set(seen)));
15
+ }
16
+ if (!ts.isCallExpression(value)) {
17
+ return [value];
18
+ }
19
+ if (ts.isCallExpression(value.expression) && effectApi(checker, value.expression.expression, "fn")) {
20
+ return [value];
21
+ }
22
+ if (ts.isPropertyAccessExpression(value.expression) && value.expression.name.text === "pipe") {
23
+ return operationValues(checker, value.expression.expression, seen);
24
+ }
25
+ // genericMethod preserves the operation rather than introducing a new implementation.
26
+ const declaration = checker.getResolvedSignature(value)?.declaration;
27
+ if (
28
+ declaration !== undefined
29
+ && /\/service\/(?:src|dist)\/genericMethod\.(?:d\.)?ts$/u.test(declaration.getSourceFile().fileName.replaceAll("\\", "/"))
30
+ ) {
31
+ const method = value.arguments[0];
32
+ return method === undefined ? [value] : operationValues(checker, method, seen);
33
+ }
34
+ const reference = resolvedValue(checker, value.expression);
35
+ if (ts.isFunctionLike(reference)) {
36
+ const returns = returnValues(reference).flatMap((item) => (item === undefined ? [] : operationValues(checker, item, new Set(seen))));
37
+ return returns.length > 0 ? returns : [value];
38
+ }
39
+ return [value];
40
+ }
41
+
42
+ type OperationLocations = Map<string, Map<string, ts.Node>>;
43
+
44
+ interface OperationProblem {
45
+ readonly message: string;
46
+ readonly node: ts.Node;
47
+ }
48
+
49
+ function tracedOperation(checker: ts.TypeChecker, value: ts.Node, span: string): boolean {
50
+ if (!(ts.isCallExpression(value) && ts.isCallExpression(value.expression))) {
51
+ return false;
52
+ }
53
+ const label = value.expression.arguments[0];
54
+ return effectApi(checker, value.expression.expression, "fn") && label !== undefined && ts.isStringLiteral(label) && label.text === span;
55
+ }
56
+
57
+ function operationProblems(
58
+ checker: ts.TypeChecker,
59
+ object: ts.ObjectLiteralExpression,
60
+ member: ts.ObjectLiteralElementLike,
61
+ service: string | undefined,
62
+ file: string,
63
+ locations: OperationLocations,
64
+ ): readonly OperationProblem[] {
65
+ const name = member.name;
66
+ if (name === undefined || !(ts.isIdentifier(name) || ts.isStringLiteral(name))) {
67
+ return [];
68
+ }
69
+ const expression = serviceProperty(object, name.text);
70
+ const span = `${service ?? "Service"}.${name.text}`;
71
+ const values = expression === undefined ? [member] : operationValues(checker, expression);
72
+ for (const value of values) {
73
+ const path = value.getSourceFile().fileName.replaceAll("\\", "/");
74
+ if (path !== file && posix.dirname(path) === posix.dirname(file)) {
75
+ const operations = locations.get(path) ?? new Map<string, ts.Node>();
76
+ operations.set(name.text, member);
77
+ locations.set(path, operations);
78
+ }
79
+ }
80
+ const found: OperationProblem[] = [];
81
+ if (service === undefined || !values.every((value) => tracedOperation(checker, value, span))) {
82
+ found.push({
83
+ message: `Export this operation as Effect.fn("${span}"). Yield dependencies and the caller from the environment; a state factory may capture only owned lifetime state.`,
84
+ node: member,
85
+ });
86
+ }
87
+ if (
88
+ expression !== undefined
89
+ && values.some((value) => {
90
+ const path = value.getSourceFile().fileName.replaceAll("\\", "/");
91
+ return path === file || posix.dirname(path) !== posix.dirname(file);
92
+ })
93
+ ) {
94
+ found.push({
95
+ message: `Keep the ${name.text} operation export in a sibling file beside this service's service.ts, one operation per file.`,
96
+ node: member,
97
+ });
98
+ }
99
+ return found;
100
+ }
101
+
102
+ export function serviceOperationProblems(checker: ts.TypeChecker, config: ts.ObjectLiteralExpression, file: string): readonly OperationProblem[] {
103
+ const id = serviceProperty(config, "id");
104
+ const type = id === undefined ? undefined : checker.getTypeAtLocation(id);
105
+ const service = type?.isStringLiteral() ? type.value.split("/").at(-1) : undefined;
106
+ const methods = serviceProperty(config, "methods");
107
+ if (methods === undefined) {
108
+ return [];
109
+ }
110
+ const factory = resolvedValue(checker, methods);
111
+ const records = ts.isFunctionLike(factory) ? returnValues(factory) : [methods];
112
+ const locations: OperationLocations = new Map();
113
+ const findings = records.flatMap((record) => {
114
+ if (record === undefined) {
115
+ return [];
116
+ }
117
+ const object = resolvedValue(checker, record);
118
+ return ts.isObjectLiteralExpression(object)
119
+ ? object.properties.flatMap((member) => operationProblems(checker, object, member, service, file, locations))
120
+ : [];
121
+ });
122
+ const shared = [...locations].flatMap(([path, operations]) =>
123
+ operations.size > 1
124
+ ? [...operations.values()].map((node) => ({
125
+ message: `Keep one operation export per file beside service.ts. ${posix.basename(path)} holds more than one operation.`,
126
+ node,
127
+ }))
128
+ : [],
129
+ );
130
+ return [...findings, ...shared];
131
+ }
@@ -0,0 +1,86 @@
1
+ import ts from "typescript";
2
+ import { initializerDependency } from "#adapters/initializerDependency.ts";
3
+ import { serviceProperty } from "#adapters/serviceAssemblySyntax.ts";
4
+ import { effectSuccess, resolvedValue } from "#adapters/serviceModelSyntax.ts";
5
+ import type { serviceTypes } from "#rules/effect/serviceTypes.ts";
6
+ import { returnValues } from "#rules/stories/returnValues.ts";
7
+
8
+ function capturesDependency(
9
+ checker: ts.TypeChecker,
10
+ value: ts.Node,
11
+ services: ReturnType<typeof serviceTypes>,
12
+ seen = new Set<ts.Node>(),
13
+ closing = false,
14
+ ): boolean {
15
+ if (seen.has(value)) {
16
+ return false;
17
+ }
18
+ seen.add(value);
19
+ if (ts.isYieldExpression(value) && value.expression !== undefined && services.carries(checker.getTypeAtLocation(value.expression))) {
20
+ return true;
21
+ }
22
+ if (
23
+ !closing
24
+ && ts.isExpression(value)
25
+ && checker.getTypeAtLocation(value).flags & (ts.TypeFlags.StringLike | ts.TypeFlags.NumberLike | ts.TypeFlags.BooleanLike)
26
+ ) {
27
+ return false;
28
+ }
29
+ if (ts.isCallExpression(value)) {
30
+ const owner = ts.isPropertyAccessExpression(value.expression) ? value.expression.expression : undefined;
31
+ return (
32
+ (owner !== undefined && services.implementation(checker.getTypeAtLocation(owner)))
33
+ || value.arguments.some((argument) => capturesDependency(checker, argument, services, seen, closing))
34
+ );
35
+ }
36
+ if (ts.isIdentifier(value)) {
37
+ if (services.carries(checker.getTypeAtLocation(value))) {
38
+ return true;
39
+ }
40
+ const resolved = resolvedValue(checker, value);
41
+ return resolved !== value && capturesDependency(checker, resolved, services, seen, closing);
42
+ }
43
+ return (
44
+ ts.forEachChild(value, (child) => capturesDependency(checker, child, services, seen, closing || ts.isFunctionLike(value)) || undefined) ?? false
45
+ );
46
+ }
47
+
48
+ export function serviceStateProblems(
49
+ checker: ts.TypeChecker,
50
+ config: ts.ObjectLiteralExpression,
51
+ services: ReturnType<typeof serviceTypes>,
52
+ ): readonly { node: ts.Node; message: string }[] {
53
+ const initialize = serviceProperty(config, "initialize");
54
+ if (initialize === undefined) {
55
+ return [];
56
+ }
57
+ const state = effectSuccess(checker, checker.getTypeAtLocation(initialize));
58
+ let dependency =
59
+ services.carries(checker.getTypeAtLocation(initialize))
60
+ || (state !== undefined && (services.carries(state) || initializerDependency(checker, state)));
61
+ const initializer = resolvedValue(checker, initialize);
62
+ // A function in state can hide a service even when its public type does not carry it.
63
+ function inspect(node: ts.Node): void {
64
+ if (ts.isFunctionLike(node)) {
65
+ for (const value of returnValues(node)) {
66
+ if (value !== undefined && capturesDependency(checker, value, services)) {
67
+ dependency = true;
68
+ }
69
+ }
70
+ return;
71
+ }
72
+ ts.forEachChild(node, inspect);
73
+ }
74
+ if (!dependency) {
75
+ inspect(initializer);
76
+ }
77
+ return dependency
78
+ ? [
79
+ {
80
+ message:
81
+ "Initializer state carries a dependency. Declare it in requires and yield it in each operation. Keep only owned caches, refs, locks and captured context data in initialize; choose their lifetime where the Layer is registered.",
82
+ node: initialize,
83
+ },
84
+ ]
85
+ : [];
86
+ }
package/src/cli/lint.ts CHANGED
@@ -40,7 +40,7 @@ export const lint = Effect.fn("Cli.lint")(
40
40
  (effect) =>
41
41
  withHeavyLock(effect, { command: "quality lint" }).pipe(
42
42
  Effect.catchTag("HeavyLockError", (cause) => new SetupFailure({ cause, message: cause.message })),
43
- Effect.provide(NodeCrypto.layer),
43
+ Effect.provide(NodeCrypto.layerSecureRandom),
44
44
  Effect.provide(NodePath.layer),
45
45
  ),
46
46
  );
@@ -1,6 +1,6 @@
1
1
  import { Effect } from "effect";
2
2
  import ts from "typescript";
3
- import { ImportCompiler } from "#adapters/ImportCompiler.ts";
3
+ import { ImportCompiler } from "#adapters/import-compiler/service.ts";
4
4
  import type { Finding, SourceFile } from "#rule.ts";
5
5
  import { parse } from "#rules/parse.ts";
6
6
  import { browserNames } from "./browserNames.ts";
@@ -1,5 +1,5 @@
1
1
  import { Effect } from "effect";
2
- import { ImportCompiler } from "#adapters/ImportCompiler.ts";
2
+ import { ImportCompiler } from "#adapters/import-compiler/service.ts";
3
3
  import type { RuleInputs } from "#rule.ts";
4
4
  import type { SpecifierSite } from "./specifiers.ts";
5
5
  import { workspacePackages } from "./workspace.ts";
@@ -1,5 +1,5 @@
1
1
  import { Effect } from "effect";
2
- import { ImportCompiler } from "#adapters/ImportCompiler.ts";
2
+ import { ImportCompiler } from "#adapters/import-compiler/service.ts";
3
3
  import type { Findings, RuleInputs, SourceFile } from "#rule.ts";
4
4
  import type { Endpoint } from "./Endpoint.ts";
5
5
  import type { ImportKind } from "./extract.ts";
@@ -9,16 +9,7 @@ import { agentLinks } from "#rules/docs/agentLinks.ts";
9
9
  import { docsReferences } from "#rules/docs/references.ts";
10
10
  import { repositoryPaths } from "#rules/docs/repositoryPaths.ts";
11
11
  import { docsUnversionedInstalls } from "#rules/docs/unversionedInstalls.ts";
12
- import { adapterImports } from "#rules/effect/adapterImports.ts";
13
- import { effectBoundary } from "#rules/effect/boundary.ts";
14
- import { failureHonesty } from "#rules/effect/failureHonesty.ts";
15
- import { rpcBoundary } from "#rules/effect/rpcBoundary.ts";
16
- import { serviceDefinitionAssembly } from "#rules/effect/serviceDefinitionAssembly.ts";
17
- import { serviceFolders } from "#rules/effect/serviceFolders.ts";
18
- import { serviceIds } from "#rules/effect/serviceIds.ts";
19
- import { serviceParameters } from "#rules/effect/serviceParameters.ts";
20
- import { sharedErrorClasses } from "#rules/effect/sharedErrorClasses.ts";
21
- import { sqlTransact } from "#rules/effect/sqlTransact.ts";
12
+ import { effectPolicy } from "#rules/effect/policy.ts";
22
13
  import { ascii } from "#rules/files/ascii.ts";
23
14
  import { distinctCase } from "#rules/files/distinctCase.ts";
24
15
  import { folderNames } from "#rules/files/folderNames.ts";
@@ -73,21 +64,12 @@ import { noBarrel } from "./noBarrel.ts";
73
64
  import { unusedCode } from "./unusedCode.ts";
74
65
 
75
66
  export const builtInRules = [
67
+ ...effectPolicy,
76
68
  agentLinks,
77
69
  repositoryPaths,
78
- serviceFolders,
79
70
  ascii,
80
71
  manifestsDependencyPins,
81
72
  unusedCode,
82
- adapterImports,
83
- effectBoundary,
84
- failureHonesty,
85
- rpcBoundary,
86
- serviceDefinitionAssembly,
87
- serviceIds,
88
- serviceParameters,
89
- sharedErrorClasses,
90
- sqlTransact,
91
73
  jsxConditionals,
92
74
  maxLines,
93
75
  maxDepth,
@@ -4,7 +4,7 @@ import { defineRule } from "#rule.ts";
4
4
  export const adapterImports = defineRule({
5
5
  check: outsideImportFindings,
6
6
  description:
7
- "Keep value imports of non-Effect runtime dependencies, peers, optional dependencies and Node builtins in adapters/. Type-only imports, workspace modules, test-support/ kits, Effect and @shivaedev packages and React in client/ folders and Vitest in unit tests are accepted. Move integrations into adapters/ and expose Effect values. No config exceptions or inline suppressions; baseline existing debt.",
7
+ "Keep value imports of non-Effect runtime dependencies, peers, optional dependencies and Node builtins in adapters/. Type-only imports, workspace modules, test-support/ kits, Effect and @shivaedev packages, supported UI, routing and styling libraries in client/ folders and Vitest in unit tests are accepted. Libraries that perform I/O or manage external state still need adapters/. Move integrations into adapters/ and expose Effect values. No config exceptions or inline suppressions; baseline existing debt.",
8
8
  id: "effect/adapter-imports",
9
9
  registrable: false,
10
10
  });
@@ -0,0 +1,10 @@
1
+ import { contextCaptureFindings } from "#adapters/contextCaptureFindings.ts";
2
+ import { defineRule } from "#rule.ts";
3
+
4
+ export const contextCapture = defineRule({
5
+ check: contextCaptureFindings,
6
+ description:
7
+ "Core code yields dependencies and the caller rather than re-providing captured contexts with Effect.provideContext, runPromiseWith, runForkWith or the Context overload of provide. Runtime bridges belong in adapters/ or test-support/.",
8
+ id: "effect/context-capture",
9
+ registrable: false,
10
+ });
@@ -0,0 +1,27 @@
1
+ import { adapterImports } from "#rules/effect/adapterImports.ts";
2
+ import { effectBoundary } from "#rules/effect/boundary.ts";
3
+ import { contextCapture } from "#rules/effect/contextCapture.ts";
4
+ import { failureHonesty } from "#rules/effect/failureHonesty.ts";
5
+ import { rpcBoundary } from "#rules/effect/rpcBoundary.ts";
6
+ import { serviceDefinitionAssembly } from "#rules/effect/serviceDefinitionAssembly.ts";
7
+ import { serviceFolders } from "#rules/effect/serviceFolders.ts";
8
+ import { serviceIds } from "#rules/effect/serviceIds.ts";
9
+ import { serviceModel } from "#rules/effect/serviceModel.ts";
10
+ import { serviceParameters } from "#rules/effect/serviceParameters.ts";
11
+ import { sharedErrorClasses } from "#rules/effect/sharedErrorClasses.ts";
12
+ import { sqlTransact } from "#rules/effect/sqlTransact.ts";
13
+
14
+ export const effectPolicy = [
15
+ adapterImports,
16
+ effectBoundary,
17
+ contextCapture,
18
+ failureHonesty,
19
+ rpcBoundary,
20
+ serviceDefinitionAssembly,
21
+ serviceFolders,
22
+ serviceIds,
23
+ serviceModel,
24
+ serviceParameters,
25
+ sharedErrorClasses,
26
+ sqlTransact,
27
+ ] as const;
@@ -3,9 +3,9 @@ import servicePackage from "@shivaedev/service/package.json" with { type: "json"
3
3
  import { serviceOrigin } from "#rules/effect/serviceOrigin.ts";
4
4
  import { serviceTypes } from "#rules/effect/serviceTypes.ts";
5
5
 
6
- export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, packages: readonly string[] = []) {
6
+ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, packages: readonly string[] = [], initializerState = false) {
7
7
  const prefixes = [servicePackage.name, ...packages].map((name) => `${name.startsWith("@") ? name.split("/")[0] : name}/`);
8
- const services = serviceTypes(checker);
8
+ const services = serviceTypes(checker, initializerState);
9
9
  function imported(node: ts.ImportSpecifier | ts.NamespaceImport): void {
10
10
  const symbol = checker.getSymbolAtLocation(node.name);
11
11
  if (symbol === undefined) {
@@ -16,7 +16,7 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
16
16
  for (const candidate of candidates) {
17
17
  const resolved = candidate.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(candidate) : candidate;
18
18
  if (serviceOrigin(checker, resolved)) {
19
- services.remember(checker.getTypeOfSymbol(resolved));
19
+ services.remember(checker.getTypeOfSymbol(resolved), resolved.name);
20
20
  }
21
21
  }
22
22
  }
@@ -29,7 +29,17 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
29
29
  return;
30
30
  }
31
31
  const target = symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
32
- services.remember(checker.getTypeOfSymbol(target));
32
+ services.remember(checker.getTypeOfSymbol(target), target.name);
33
+ }
34
+
35
+ function named(node: ts.Node): void {
36
+ if (!(ts.isClassDeclaration(node) || ts.isVariableDeclaration(node)) || node.name === undefined || !serviceOrigin(checker, node.name)) {
37
+ return;
38
+ }
39
+ const symbol = checker.getSymbolAtLocation(node.name);
40
+ if (symbol !== undefined) {
41
+ services.remember(checker.getTypeOfSymbol(symbol), symbol.name);
42
+ }
33
43
  }
34
44
 
35
45
  function discover(node: ts.Node): void {
@@ -39,12 +49,7 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
39
49
  if (ts.isImportSpecifier(node) || ts.isNamespaceImport(node)) {
40
50
  imported(node);
41
51
  }
42
- if (ts.isClassDeclaration(node) && node.name !== undefined && serviceOrigin(checker, node.name)) {
43
- services.remember(checker.getTypeAtLocation(node.name));
44
- }
45
- if (ts.isVariableDeclaration(node) && serviceOrigin(checker, node.name)) {
46
- services.remember(checker.getTypeAtLocation(node.name));
47
- }
52
+ named(node);
48
53
  if (ts.isTypeReferenceNode(node)) {
49
54
  referenced(node);
50
55
  }
@@ -40,7 +40,7 @@ function fileFindings(file: SourceFile): readonly Finding[] {
40
40
  export const serviceDefinitionAssembly = defineRule({
41
41
  check: ({ sources }) => sources.flatMap(fileFindings),
42
42
  description:
43
- "Keep defineService declarations as top-level operation inventories: list id, requires, initialize and methods directly. Import a named initializer (or use Effect.void) and named operations or state factories from focused files; genericMethod may wrap those references. Move implementation bodies out of the assembly file. Effect.fn span names follow the existing Biome checks. Includes adapters and tests; no config exceptions or inline suppressions.",
43
+ "Keep defineService declarations as top-level operation inventories: list id, requires, initialize and methods directly. Import a named initializer (or use Effect.void) and named Effect.fn operations from focused files; state factories capture only owned lifetime state; genericMethod may wrap those references. Move implementation bodies out of the assembly file. The service-model rule verifies tracing and owned state. Includes adapters and tests; no config exceptions or inline suppressions.",
44
44
  id: "effect/service-definition-assembly",
45
45
  registrable: false,
46
46
  });
@@ -4,7 +4,7 @@ import { defineRule } from "#rule.ts";
4
4
  export const serviceFolders = defineRule({
5
5
  check: serviceFolderFindings,
6
6
  description:
7
- "Each services/<name> folder has service.ts, and its service.ts exports one named const initialized by defineService. The service-definition-assembly rule checks its operation inventory.",
7
+ "Every folder containing a defineService declaration, and each services/<name> folder, has service.ts, and its service.ts exports one named const initialized by defineService. The service-definition-assembly rule checks its operation inventory.",
8
8
  id: "effect/service-folders",
9
9
  registrable: false,
10
10
  });
@@ -0,0 +1,10 @@
1
+ import { serviceModelFindings } from "#adapters/serviceModelFindings.ts";
2
+ import { defineRule } from "#rule.ts";
3
+
4
+ export const serviceModel = defineRule({
5
+ check: serviceModelFindings,
6
+ description:
7
+ "defineService initializer state owns lifetime state, never dependencies. Every inventoried operation, including factory returns and piped bodies, is a sibling Effect.fn export with its Service.operation span. Dependencies and the caller come from the environment; the Layer registration chooses lifetime.",
8
+ id: "effect/service-model",
9
+ registrable: false,
10
+ });
@@ -1,10 +1,12 @@
1
1
  import ts from "typescript";
2
+ import { callerContextData } from "#adapters/callerContextData.ts";
2
3
 
3
4
  const SERVICE = "~effect/Context/Service";
4
5
  const CONTEXT = "~effect/Context";
5
6
 
6
- export function serviceTypes(checker: ts.TypeChecker) {
7
+ export function serviceTypes(checker: ts.TypeChecker, initializerState = false) {
7
8
  const shapes = new Set<ts.Type>();
9
+ const contextData = new Set<ts.Type>();
8
10
  const carried = new Map<ts.Type, boolean>();
9
11
  function propertyType(type: ts.Type, name: string): ts.Type | undefined {
10
12
  const property = type.getProperty(name);
@@ -22,17 +24,26 @@ export function serviceTypes(checker: ts.TypeChecker) {
22
24
  && checker.getNonNullableType(checker.getTypeOfSymbol(property)).getCallSignatures().length === 0,
23
25
  );
24
26
  }
25
- function remember(type: ts.Type): void {
27
+ function remember(type: ts.Type, name?: string): void {
26
28
  if (type.getProperty(SERVICE) === undefined) {
27
29
  return;
28
30
  }
29
31
  const shape = propertyType(type, "Service");
32
+ if (initializerState && name !== undefined && shape !== undefined && callerContextData(checker, shape, name)) {
33
+ contextData.add(type);
34
+ contextData.add(shape);
35
+ shapes.delete(shape);
36
+ return;
37
+ }
38
+ if (shape !== undefined && contextData.has(shape)) {
39
+ return;
40
+ }
30
41
  if (
31
42
  shape !== undefined
32
43
  && shape.flags & ts.TypeFlags.Object
33
44
  && (shape.getProperties().length > 0 || shape.getCallSignatures().length > 0)
34
45
  && checker.getIndexInfosOfType(shape).length === 0
35
- && !options(shape)
46
+ && (initializerState || !options(shape))
36
47
  && (shape.getCallSignatures().length === 0 || type.getProperty("~effect/Context/Reference") === undefined)
37
48
  ) {
38
49
  shapes.add(shape);
@@ -61,6 +72,7 @@ export function serviceTypes(checker: ts.TypeChecker) {
61
72
  function carries(type: ts.Type, seen = new Set<ts.Type>()): boolean {
62
73
  if (
63
74
  seen.has(type)
75
+ || contextData.has(type)
64
76
  || type.flags
65
77
  & (ts.TypeFlags.Any
66
78
  | ts.TypeFlags.Unknown
@@ -63,6 +63,9 @@ interface Context {
63
63
 
64
64
  function messageFor(folder: string, context: Context): string | undefined {
65
65
  const name = posix.basename(folder);
66
+ if (name === "internal") {
67
+ return 'A folder named "internal" implies privacy that export maps do not enforce. Move its files into the parent folder or a folder named after their job.';
68
+ }
66
69
  if (context.owned.has(folder) || context.toolOwned.ignores(`${folder}/`) || isModule(folder, context.stems)) {
67
70
  return undefined;
68
71
  }
@@ -94,7 +97,7 @@ export const folderNames = defineRule({
94
97
  });
95
98
  }),
96
99
  description:
97
- "A package folder's final name or its path below the workspace package root joined with hyphens matches its unscoped package name. A module folder is named after its main file, a content folder in snake_case and every other folder in kebab-case. TanStack Router configuration owns route folder names.",
100
+ "Folders cannot be named internal. A package folder's final name or its path below the workspace package root joined with hyphens matches its unscoped package name. A module folder is named after its main file, a content folder in snake_case and every other folder in kebab-case. TanStack Router configuration owns route folder names.",
98
101
  id: "files/folder-names",
99
102
  options: Schema.toStandardSchemaV1(FolderNamesOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
100
103
  validate: validateGlobs,
@@ -1,6 +1,8 @@
1
1
  import { posix } from "node:path";
2
2
  import { Effect, Schema } from "effect";
3
3
  import { ignorePatterns } from "#adapters/ignore.ts";
4
+ import { serviceAssemblyImports } from "#adapters/serviceAssemblyImports.ts";
5
+ import { directServiceDefinitions } from "#adapters/serviceAssemblySyntax.ts";
4
6
  import { GlobDeclarations, globPatterns, validateGlobs } from "#config/globs.ts";
5
7
  import { routeFiles } from "#inventory/routeFiles.ts";
6
8
  import { exportFits } from "#naming/exportFits.ts";
@@ -72,12 +74,21 @@ function nameFinding(file: SourceFile, stem: string, folders: readonly string[])
72
74
  }
73
75
 
74
76
  function findingsOf(file: SourceFile, layout: PackageLayout): readonly Finding[] {
77
+ const source = posix.basename(file.path) === "service.ts" ? parse(file) : undefined;
78
+ if (source !== undefined && directServiceDefinitions(source, serviceAssemblyImports(source).definitions).length > 0) {
79
+ return [];
80
+ }
75
81
  const stem = stemOf(file.path);
76
82
  const folders = layout.foldersOf(file.path);
77
83
  if (layout.scripts.has(file.path) || file.text.startsWith(SHEBANG)) {
78
84
  return KEBAB.test(stem)
79
85
  ? []
80
- : [{ file: file.path, message: `"${stem}" is run as a script, so it is named in kebab-case, such as build-docs.ts.` }];
86
+ : [
87
+ {
88
+ file: file.path,
89
+ message: `"${stem}" is run as a script, so it is named in kebab-case, such as build-docs.ts.`,
90
+ },
91
+ ];
81
92
  }
82
93
  const root = moduleRoot(file.path);
83
94
  const admin = root === undefined ? undefined : /^(?:client|server)\/(?<path>admin\/.+)$/u.exec(file.path.slice(root.length + 1))?.groups?.path;
@@ -100,8 +111,10 @@ export const namedAfterExport = defineRule({
100
111
  .flatMap((file) => findingsOf(file, layout));
101
112
  }),
102
113
  description:
103
- "A file is named after its main export or a module-level constant, including a private constant, with its folders as the prefix; module client/admin and server/admin files may repeat names from above the admin folder. TanStack Router configuration owns route filenames. A file of several exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
114
+ "A file is named after its main export or a module-level constant, including a private constant, with its folders as the prefix; module client/admin and server/admin files may repeat names from above the admin folder. defineService declarations use service.ts; TanStack Router configuration owns route filenames. A file of several exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
104
115
  id: "files/named-after-export",
105
- options: Schema.toStandardSchemaV1(NamedAfterExportOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
116
+ options: Schema.toStandardSchemaV1(NamedAfterExportOptions, {
117
+ parseOptions: { errors: "all", onExcessProperty: "error" },
118
+ }),
106
119
  validate: validateGlobs,
107
120
  });
@@ -0,0 +1,78 @@
1
+ import ts from "typescript";
2
+ import { bindsModule, type ImportBinding } from "#rules/stories/importBindings.ts";
3
+ import { memberName, unwrapped } from "#rules/stories/syntax.ts";
4
+
5
+ function terminal(body: ts.ConciseBody): ts.Expression | undefined {
6
+ if (!ts.isBlock(body)) {
7
+ return unwrapped(body);
8
+ }
9
+ const last = body.statements.at(-1);
10
+ return last !== undefined && (ts.isReturnStatement(last) || ts.isExpressionStatement(last)) ? last.expression : undefined;
11
+ }
12
+
13
+ function fails(expression: ts.Expression, bindings: ReadonlyMap<string, ImportBinding>): boolean {
14
+ const value = unwrapped(expression);
15
+ if (ts.isArrowFunction(value) || ts.isFunctionExpression(value)) {
16
+ const result = terminal(value.body);
17
+ return result !== undefined && fails(result, bindings);
18
+ }
19
+ if (!(ts.isCallExpression(value) && ts.isPropertyAccessExpression(value.expression))) {
20
+ return false;
21
+ }
22
+ const receiver = value.expression.expression;
23
+ return (
24
+ ts.isIdentifier(receiver)
25
+ && bindsModule(bindings.get(receiver.text), "Effect", ["effect"])
26
+ && ["die", "fail"].includes(value.expression.name.text)
27
+ );
28
+ }
29
+
30
+ export function failingSleep(call: ts.CallExpression, bindings: ReadonlyMap<string, ImportBinding>): boolean {
31
+ const access = call.parent;
32
+ const pipe = access.parent;
33
+ if (!(ts.isPropertyAccessExpression(access) && access.name.text === "pipe" && ts.isCallExpression(pipe) && pipe.arguments.length === 1)) {
34
+ return false;
35
+ }
36
+ const step = pipe.arguments[0];
37
+ if (step === undefined || !ts.isCallExpression(step) || memberName(step.expression) !== "andThen") {
38
+ return false;
39
+ }
40
+ const receiver = ts.isPropertyAccessExpression(step.expression) ? step.expression.expression : undefined;
41
+ return (
42
+ receiver !== undefined
43
+ && ts.isIdentifier(receiver)
44
+ && bindsModule(bindings.get(receiver.text), "Effect", ["effect"])
45
+ && step.arguments.length === 1
46
+ && step.arguments[0] !== undefined
47
+ && fails(step.arguments[0], bindings)
48
+ );
49
+ }
50
+
51
+ function rejectionName(call: ts.CallExpression): string | undefined {
52
+ for (let node: ts.Node | undefined = call.parent; node !== undefined; node = node.parent) {
53
+ if (
54
+ (ts.isArrowFunction(node) || ts.isFunctionExpression(node))
55
+ && ts.isNewExpression(node.parent)
56
+ && ts.isIdentifier(node.parent.expression)
57
+ && node.parent.expression.text === "Promise"
58
+ ) {
59
+ const name = node.parameters[1]?.name;
60
+ return name !== undefined && ts.isIdentifier(name) ? name.text : undefined;
61
+ }
62
+ }
63
+ return undefined;
64
+ }
65
+
66
+ export function rejectingTimer(call: ts.CallExpression): boolean {
67
+ const reject = rejectionName(call);
68
+ const callback = call.arguments[0];
69
+ if (reject === undefined || callback === undefined) {
70
+ return false;
71
+ }
72
+ const body = ts.isArrowFunction(callback) || ts.isFunctionExpression(callback) ? terminal(callback.body) : callback;
73
+ return (
74
+ body !== undefined
75
+ && ((ts.isIdentifier(body) && body.text === reject)
76
+ || (ts.isCallExpression(body) && ts.isIdentifier(body.expression) && body.expression.text === reject))
77
+ );
78
+ }