@shivaedev/quality 0.67.0 → 0.67.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +5 -5
  3. package/biome/declarations.json +7 -1
  4. package/biome/preset.json +7 -1
  5. package/dist/adapters/buildEntryPaths.d.ts +3 -0
  6. package/dist/adapters/buildEntryPaths.d.ts.map +1 -0
  7. package/dist/adapters/buildEntryPaths.js +48 -0
  8. package/dist/adapters/buildEntryPaths.js.map +1 -0
  9. package/dist/adapters/buildEntryValue.d.ts +4 -0
  10. package/dist/adapters/buildEntryValue.d.ts.map +1 -0
  11. package/dist/adapters/buildEntryValue.js +47 -0
  12. package/dist/adapters/buildEntryValue.js.map +1 -0
  13. package/dist/adapters/bundlerEntries.d.ts +3 -0
  14. package/dist/adapters/bundlerEntries.d.ts.map +1 -0
  15. package/dist/adapters/bundlerEntries.js +49 -0
  16. package/dist/adapters/bundlerEntries.js.map +1 -0
  17. package/dist/adapters/callbackEscapes.d.ts +3 -0
  18. package/dist/adapters/callbackEscapes.d.ts.map +1 -0
  19. package/dist/adapters/callbackEscapes.js +24 -0
  20. package/dist/adapters/callbackEscapes.js.map +1 -0
  21. package/dist/adapters/composedContext.d.ts +3 -0
  22. package/dist/adapters/composedContext.d.ts.map +1 -0
  23. package/dist/adapters/composedContext.js +42 -0
  24. package/dist/adapters/composedContext.js.map +1 -0
  25. package/dist/adapters/containerDependency.d.ts +4 -0
  26. package/dist/adapters/containerDependency.d.ts.map +1 -0
  27. package/dist/adapters/containerDependency.js +28 -0
  28. package/dist/adapters/containerDependency.js.map +1 -0
  29. package/dist/adapters/contextCaptureFindings.d.ts.map +1 -1
  30. package/dist/adapters/contextCaptureFindings.js +3 -1
  31. package/dist/adapters/contextCaptureFindings.js.map +1 -1
  32. package/dist/adapters/foreignResources.d.ts +3 -0
  33. package/dist/adapters/foreignResources.d.ts.map +1 -0
  34. package/dist/adapters/foreignResources.js +80 -0
  35. package/dist/adapters/foreignResources.js.map +1 -0
  36. package/dist/adapters/frameworkCallback.d.ts +4 -0
  37. package/dist/adapters/frameworkCallback.d.ts.map +1 -0
  38. package/dist/adapters/frameworkCallback.js +92 -0
  39. package/dist/adapters/frameworkCallback.js.map +1 -0
  40. package/dist/adapters/frameworkOwner.d.ts +3 -0
  41. package/dist/adapters/frameworkOwner.d.ts.map +1 -0
  42. package/dist/adapters/frameworkOwner.js +35 -0
  43. package/dist/adapters/frameworkOwner.js.map +1 -0
  44. package/dist/adapters/importedCall.d.ts +6 -0
  45. package/dist/adapters/importedCall.d.ts.map +1 -0
  46. package/dist/adapters/importedCall.js +26 -0
  47. package/dist/adapters/importedCall.js.map +1 -0
  48. package/dist/adapters/isToolConfig.d.ts +2 -0
  49. package/dist/adapters/isToolConfig.d.ts.map +1 -0
  50. package/dist/adapters/isToolConfig.js +7 -0
  51. package/dist/adapters/isToolConfig.js.map +1 -0
  52. package/dist/adapters/knip/configuration.d.ts +1 -1
  53. package/dist/adapters/knip/configuration.d.ts.map +1 -1
  54. package/dist/adapters/knip/configuration.js +3 -2
  55. package/dist/adapters/knip/configuration.js.map +1 -1
  56. package/dist/adapters/knip/run.d.ts.map +1 -1
  57. package/dist/adapters/knip/run.js +3 -1
  58. package/dist/adapters/knip/run.js.map +1 -1
  59. package/dist/adapters/localFunctions.d.ts +3 -0
  60. package/dist/adapters/localFunctions.d.ts.map +1 -0
  61. package/dist/adapters/localFunctions.js +20 -0
  62. package/dist/adapters/localFunctions.js.map +1 -0
  63. package/dist/adapters/reachableBuildEntries.d.ts +5 -0
  64. package/dist/adapters/reachableBuildEntries.d.ts.map +1 -0
  65. package/dist/adapters/reachableBuildEntries.js +52 -0
  66. package/dist/adapters/reachableBuildEntries.js.map +1 -0
  67. package/dist/adapters/serviceStateProblems.d.ts.map +1 -1
  68. package/dist/adapters/serviceStateProblems.js +26 -14
  69. package/dist/adapters/serviceStateProblems.js.map +1 -1
  70. package/dist/inventory/programmaticEntries.d.ts +4 -0
  71. package/dist/inventory/programmaticEntries.d.ts.map +1 -0
  72. package/dist/inventory/programmaticEntries.js +9 -0
  73. package/dist/inventory/programmaticEntries.js.map +1 -0
  74. package/dist/rules/effect/contextCapture.js +1 -1
  75. package/dist/rules/effect/contextCapture.js.map +1 -1
  76. package/dist/rules/effect/program.d.ts +1 -0
  77. package/dist/rules/effect/program.d.ts.map +1 -1
  78. package/dist/rules/effect/program.js +17 -1
  79. package/dist/rules/effect/program.js.map +1 -1
  80. package/dist/rules/effect/serviceCatalog.d.ts.map +1 -1
  81. package/dist/rules/effect/serviceCatalog.js +10 -2
  82. package/dist/rules/effect/serviceCatalog.js.map +1 -1
  83. package/dist/rules/effect/serviceFindings.d.ts.map +1 -1
  84. package/dist/rules/effect/serviceFindings.js +33 -7
  85. package/dist/rules/effect/serviceFindings.js.map +1 -1
  86. package/dist/rules/effect/serviceOrigin.d.ts.map +1 -1
  87. package/dist/rules/effect/serviceOrigin.js +13 -1
  88. package/dist/rules/effect/serviceOrigin.js.map +1 -1
  89. package/dist/rules/effect/serviceParameters.d.ts.map +1 -1
  90. package/dist/rules/effect/serviceParameters.js +12 -12
  91. package/dist/rules/effect/serviceParameters.js.map +1 -1
  92. package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
  93. package/dist/rules/effect/serviceTypes.js +5 -1
  94. package/dist/rules/effect/serviceTypes.js.map +1 -1
  95. package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
  96. package/dist/rules/files/namedAfterExport.js +14 -13
  97. package/dist/rules/files/namedAfterExport.js.map +1 -1
  98. package/package.json +2 -1
  99. package/src/adapters/buildEntryPaths.ts +52 -0
  100. package/src/adapters/buildEntryValue.ts +52 -0
  101. package/src/adapters/bundlerEntries.ts +53 -0
  102. package/src/adapters/callbackEscapes.ts +32 -0
  103. package/src/adapters/composedContext.ts +48 -0
  104. package/src/adapters/containerDependency.ts +40 -0
  105. package/src/adapters/contextCaptureFindings.ts +3 -1
  106. package/src/adapters/foreignResources.ts +83 -0
  107. package/src/adapters/frameworkCallback.ts +106 -0
  108. package/src/adapters/frameworkOwner.ts +41 -0
  109. package/src/adapters/importedCall.ts +27 -0
  110. package/src/adapters/isToolConfig.ts +10 -0
  111. package/src/adapters/knip/configuration.ts +3 -2
  112. package/src/adapters/knip/run.ts +3 -1
  113. package/src/adapters/localFunctions.ts +22 -0
  114. package/src/adapters/reachableBuildEntries.ts +58 -0
  115. package/src/adapters/serviceStateProblems.ts +42 -17
  116. package/src/inventory/programmaticEntries.ts +10 -0
  117. package/src/rules/effect/contextCapture.ts +1 -1
  118. package/src/rules/effect/program.ts +19 -1
  119. package/src/rules/effect/serviceCatalog.ts +12 -2
  120. package/src/rules/effect/serviceFindings.ts +38 -7
  121. package/src/rules/effect/serviceOrigin.ts +14 -1
  122. package/src/rules/effect/serviceParameters.ts +13 -14
  123. package/src/rules/effect/serviceTypes.ts +11 -1
  124. package/src/rules/files/namedAfterExport.ts +19 -13
  125. package/dist/adapters/initializerDependency.d.ts +0 -3
  126. package/dist/adapters/initializerDependency.d.ts.map +0 -1
  127. package/dist/adapters/initializerDependency.js +0 -53
  128. package/dist/adapters/initializerDependency.js.map +0 -1
  129. package/src/adapters/initializerDependency.ts +0 -57
@@ -1,7 +1,7 @@
1
1
  import ts from "typescript";
2
- import { initializerDependency } from "#adapters/initializerDependency.ts";
2
+ import { containerDependency } from "#adapters/containerDependency.ts";
3
3
  import { serviceProperty } from "#adapters/serviceAssemblySyntax.ts";
4
- import { effectSuccess, resolvedValue } from "#adapters/serviceModelSyntax.ts";
4
+ import { effectApi, effectSuccess, resolvedValue } from "#adapters/serviceModelSyntax.ts";
5
5
  import type { serviceTypes } from "#rules/effect/serviceTypes.ts";
6
6
  import { returnValues } from "#rules/stories/returnValues.ts";
7
7
 
@@ -12,7 +12,7 @@ function capturesDependency(
12
12
  seen = new Set<ts.Node>(),
13
13
  closing = false,
14
14
  ): boolean {
15
- if (seen.has(value)) {
15
+ if (seen.has(value) || ts.isTypeNode(value)) {
16
16
  return false;
17
17
  }
18
18
  seen.add(value);
@@ -27,24 +27,46 @@ function capturesDependency(
27
27
  return false;
28
28
  }
29
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
- );
30
+ return callDependency(checker, value, services, seen, closing);
35
31
  }
36
32
  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);
33
+ return identifierDependency(checker, value, services, seen, closing);
42
34
  }
43
35
  return (
44
36
  ts.forEachChild(value, (child) => capturesDependency(checker, child, services, seen, closing || ts.isFunctionLike(value)) || undefined) ?? false
45
37
  );
46
38
  }
47
39
 
40
+ function identifierDependency(
41
+ checker: ts.TypeChecker,
42
+ value: ts.Identifier,
43
+ services: ReturnType<typeof serviceTypes>,
44
+ seen: Set<ts.Node>,
45
+ closing: boolean,
46
+ ): boolean {
47
+ const symbol = checker.getSymbolAtLocation(value);
48
+ const target = symbol !== undefined && symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
49
+ if (target !== undefined && target.flags & ts.SymbolFlags.ValueModule) {
50
+ return false;
51
+ }
52
+ const resolved = resolvedValue(checker, value);
53
+ return resolved === value ? services.carries(checker.getTypeAtLocation(value)) : capturesDependency(checker, resolved, services, seen, closing);
54
+ }
55
+
56
+ function callDependency(
57
+ checker: ts.TypeChecker,
58
+ value: ts.CallExpression,
59
+ services: ReturnType<typeof serviceTypes>,
60
+ seen: Set<ts.Node>,
61
+ closing: boolean,
62
+ ): boolean {
63
+ const owner = ts.isPropertyAccessExpression(value.expression) ? value.expression.expression : undefined;
64
+ return (
65
+ (owner !== undefined && services.implementation(checker.getTypeAtLocation(owner)) && capturesDependency(checker, owner, services, seen, closing))
66
+ || value.arguments.some((argument) => capturesDependency(checker, argument, services, seen, closing))
67
+ );
68
+ }
69
+
48
70
  export function serviceStateProblems(
49
71
  checker: ts.TypeChecker,
50
72
  config: ts.ObjectLiteralExpression,
@@ -54,13 +76,16 @@ export function serviceStateProblems(
54
76
  if (initialize === undefined) {
55
77
  return [];
56
78
  }
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)));
79
+ const type = checker.getTypeAtLocation(initialize);
80
+ const state = effectSuccess(checker, type);
81
+ let dependency = services.carries(type) || (state !== undefined && (services.carries(state) || containerDependency(checker, state, services)));
61
82
  const initializer = resolvedValue(checker, initialize);
62
83
  // A function in state can hide a service even when its public type does not carry it.
63
84
  function inspect(node: ts.Node): void {
85
+ if (ts.isCallExpression(node) && ["succeed", "as"].some((name) => effectApi(checker, node.expression, name))) {
86
+ const retained = node.arguments.at(-1);
87
+ dependency ||= retained !== undefined && capturesDependency(checker, retained, services);
88
+ }
64
89
  if (ts.isFunctionLike(node)) {
65
90
  for (const value of returnValues(node)) {
66
91
  if (value !== undefined && capturesDependency(checker, value, services)) {
@@ -0,0 +1,10 @@
1
+ import { Effect } from "effect";
2
+ import { reachableBuildEntries } from "#adapters/reachableBuildEntries.ts";
3
+ import { importGraph } from "#imports/graph.ts";
4
+ import { packageLayout } from "#naming/packageLayout.ts";
5
+ import type { RuleInputs } from "#rule.ts";
6
+
7
+ export const programmaticEntries = Effect.fn("Inventory.programmaticEntries")(function* (inputs: RuleInputs) {
8
+ const layout = yield* packageLayout(inputs);
9
+ return layout.scripts.size === 0 ? new Set<string>() : reachableBuildEntries(inputs, yield* importGraph(inputs), layout);
10
+ });
@@ -4,7 +4,7 @@ import { defineRule } from "#rule.ts";
4
4
  export const contextCapture = defineRule({
5
5
  check: contextCaptureFindings,
6
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/.",
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. Contexts assembled from Layers at composition roots and fully provided application harnesses are accepted. Runtime bridges belong in adapters/ or test-support/.",
8
8
  id: "effect/context-capture",
9
9
  registrable: false,
10
10
  });
@@ -4,6 +4,10 @@ import { projectsFor } from "#adapters/imports/projects.ts";
4
4
  import type { RuleInputs } from "#rule.ts";
5
5
 
6
6
  export function effectProgram(inputs: RuleInputs, externalTypes = true, roots: readonly string[] = []): ts.Program {
7
+ return effectPrograms(inputs, externalTypes, roots)(inputs.sources);
8
+ }
9
+
10
+ export function effectPrograms(inputs: RuleInputs, externalTypes = true, roots: readonly string[] = []) {
7
11
  const projectOf = projectsFor(inputs.root);
8
12
  const options: ts.CompilerOptions = {
9
13
  allowJs: true,
@@ -25,5 +29,19 @@ export function effectProgram(inputs: RuleInputs, externalTypes = true, roots: r
25
29
  const project = projectOf(from);
26
30
  return ts.resolveModuleName(name, from, project.typesOptions, host, project.typesCache).resolvedModule;
27
31
  });
28
- return ts.createProgram([...texts.keys(), ...roots], options, host);
32
+ const sourceFiles = new Map<string, ts.SourceFile>();
33
+ const readSource = host.getSourceFile;
34
+ host.getSourceFile = (file, languageVersion, onError, shouldCreateNewSourceFile) => {
35
+ const previous = sourceFiles.get(file);
36
+ if (previous !== undefined && !shouldCreateNewSourceFile) {
37
+ return previous;
38
+ }
39
+ const source = readSource(file, languageVersion, onError, shouldCreateNewSourceFile);
40
+ if (source !== undefined) {
41
+ sourceFiles.set(file, source);
42
+ }
43
+ return source;
44
+ };
45
+ return (sources: RuleInputs["sources"]): ts.Program =>
46
+ ts.createProgram([...sources.map((source) => join(inputs.root, source.path)), ...roots], options, host);
29
47
  }
@@ -6,6 +6,11 @@ import { serviceTypes } from "#rules/effect/serviceTypes.ts";
6
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
8
  const services = serviceTypes(checker, initializerState);
9
+ function runtimeSymbol(symbol: ts.Symbol): boolean {
10
+ return (
11
+ initializerState || (symbol.declarations ?? []).some((declaration) => !/(?:^|\/)test-support\//u.test(declaration.getSourceFile().fileName))
12
+ );
13
+ }
9
14
  function imported(node: ts.ImportSpecifier | ts.NamespaceImport): void {
10
15
  const symbol = checker.getSymbolAtLocation(node.name);
11
16
  if (symbol === undefined) {
@@ -15,7 +20,7 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
15
20
  const candidates = target.flags & ts.SymbolFlags.Module ? checker.getExportsOfModule(target) : [target];
16
21
  for (const candidate of candidates) {
17
22
  const resolved = candidate.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(candidate) : candidate;
18
- if (serviceOrigin(checker, resolved)) {
23
+ if (runtimeSymbol(resolved) && serviceOrigin(checker, resolved)) {
19
24
  services.remember(checker.getTypeOfSymbol(resolved), resolved.name);
20
25
  }
21
26
  }
@@ -29,7 +34,9 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
29
34
  return;
30
35
  }
31
36
  const target = symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
32
- services.remember(checker.getTypeOfSymbol(target), target.name);
37
+ if (runtimeSymbol(target)) {
38
+ services.remember(checker.getTypeOfSymbol(target), target.name);
39
+ }
33
40
  }
34
41
 
35
42
  function named(node: ts.Node): void {
@@ -56,6 +63,9 @@ export function serviceCatalog(program: ts.Program, checker: ts.TypeChecker, pac
56
63
  ts.forEachChild(node, discover);
57
64
  }
58
65
  for (const source of program.getSourceFiles()) {
66
+ if (!initializerState && /(?:^|\/)test-support\//u.test(source.fileName)) {
67
+ continue;
68
+ }
59
69
  if (!source.fileName.includes("/node_modules/") || prefixes.some((prefix) => source.fileName.includes(`/${prefix}`))) {
60
70
  discover(source);
61
71
  }
@@ -1,5 +1,8 @@
1
1
  import { relative } from "node:path";
2
2
  import ts from "typescript";
3
+ import { foreignResources } from "#adapters/foreignResources.ts";
4
+ import { frameworkCallback, parameterSite } from "#adapters/frameworkCallback.ts";
5
+ import { localFunctions } from "#adapters/localFunctions.ts";
3
6
  import type { Finding } from "#rule.ts";
4
7
  import { layerConstructor } from "#rules/effect/layerConstructor.ts";
5
8
  import { publicFunctions } from "#rules/effect/publicFunctions.ts";
@@ -12,36 +15,59 @@ function publicDeclaration(declaration: ts.Declaration, local: ReadonlySet<ts.So
12
15
  return !((ts.isMethodDeclaration(declaration) || ts.isPropertyDeclaration(declaration)) && ts.isPrivateIdentifier(declaration.name));
13
16
  }
14
17
 
18
+ function implementationParameter(checker: ts.TypeChecker, parameter: ts.ParameterDeclaration, services: ReturnType<typeof serviceTypes>): boolean {
19
+ const fn = parameter.parent;
20
+ const property = ts.isPropertyAssignment(fn.parent) ? fn.parent : fn;
21
+ const object = property.parent;
22
+ return ts.isObjectLiteralExpression(object) && services.implementation(checker.getTypeAtLocation(object));
23
+ }
24
+
15
25
  export function serviceFindings(
16
26
  root: string,
17
27
  sources: readonly ts.SourceFile[],
18
28
  checker: ts.TypeChecker,
19
29
  services: ReturnType<typeof serviceTypes>,
20
30
  ): readonly Finding[] {
31
+ const resource = foreignResources(checker, sources);
21
32
  const findings = new Map<ts.ParameterDeclaration, Finding>();
22
33
  const visited = new Set<ts.Type>();
23
34
  const activeSignatures = new Set<NonNullable<ts.Signature["declaration"]>>();
24
35
  const local = new Set(sources);
25
- function parameterFinding(symbol: ts.Symbol): void {
36
+ function parameterFinding(symbol: ts.Symbol, signature?: ts.Signature): void {
26
37
  if (!services.carries(checker.getTypeOfSymbol(symbol))) {
27
38
  return;
28
39
  }
29
40
  for (const parameter of symbol.declarations ?? []) {
30
- if (!(ts.isParameter(parameter) && local.has(parameter.getSourceFile()))) {
41
+ if (
42
+ !(ts.isParameter(parameter) && local.has(parameter.getSourceFile()))
43
+ || implementationParameter(checker, parameter, services)
44
+ || resource(parameter)
45
+ || frameworkCallback(checker, parameter.parent, local)
46
+ || (signature !== undefined
47
+ && (checker.getTypePredicateOfSignature(signature) !== undefined
48
+ || (signature.declaration !== undefined && layerConstructor(checker, signature.declaration))
49
+ || signature.getReturnType().getProperty("~effect/Layer") !== undefined))
50
+ ) {
31
51
  continue;
32
52
  }
33
- const source = parameter.getSourceFile();
53
+ const site = parameterSite(checker, parameter, local);
54
+ const source = site.getSourceFile();
34
55
  const file = relative(root, source.fileName).replaceAll("\\", "/");
35
- findings.set(parameter, {
56
+ findings.set(site, {
36
57
  file,
37
- line: source.getLineAndCharacterOfPosition(parameter.getStart(source)).line + 1,
38
- message: `Parameter ${parameter.name.getText(source)} carries a service. Read services from Effect's environment instead of passing them; return an Effect or Stream with requirements. Service implementation methods and Layer constructors are accepted; only test-support/ folders are exempt, not adapters/.`,
58
+ line: source.getLineAndCharacterOfPosition(site.getStart(source)).line + 1,
59
+ message: `Parameter ${site.name.getText(source)} carries a service. Read services from Effect's environment instead of passing them; return an Effect or Stream with requirements. Service implementation methods and Layer constructors are accepted; only test-support/ folders are exempt, not adapters/.`,
39
60
  });
40
61
  }
41
62
  }
42
63
  function signatureFinding(signature: ts.Signature): void {
43
64
  const declaration = signature.declaration;
44
- if (declaration === undefined || !local.has(declaration.getSourceFile()) || layerConstructor(checker, declaration)) {
65
+ if (
66
+ declaration === undefined
67
+ || !local.has(declaration.getSourceFile())
68
+ || layerConstructor(checker, declaration)
69
+ || checker.getTypePredicateOfSignature(signature) !== undefined
70
+ ) {
45
71
  return;
46
72
  }
47
73
  const result = signature.getReturnType();
@@ -92,5 +118,10 @@ export function serviceFindings(
92
118
  }
93
119
  }
94
120
  publicFunctions(sources, checker, surface);
121
+ localFunctions(sources, checker, (signature) => {
122
+ for (const parameter of signature.parameters) {
123
+ parameterFinding(parameter, signature);
124
+ }
125
+ });
95
126
  return [...findings.values()];
96
127
  }
@@ -1,6 +1,8 @@
1
1
  import ts from "typescript";
2
2
  import { returnValues } from "#rules/stories/returnValues.ts";
3
3
 
4
+ const origins = new WeakMap<ts.TypeChecker, Map<ts.Symbol, boolean>>();
5
+
4
6
  const SERVICE_NAMES = new Set(["Service", "ServiceClass", "Key", "Reference", "Tag", "TagClass", "GenericTag"]);
5
7
 
6
8
  function annotation(declaration: ts.Declaration): ts.TypeNode | undefined {
@@ -31,11 +33,18 @@ function declarationOrigin(checker: ts.TypeChecker, declaration: ts.Declaration,
31
33
 
32
34
  function symbolOrigin(checker: ts.TypeChecker, symbol: ts.Symbol, seen: Set<ts.Symbol>): boolean {
33
35
  const target = symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
36
+ const known = origins.get(checker) ?? new Map<ts.Symbol, boolean>();
37
+ origins.set(checker, known);
38
+ const previous = known.get(target);
39
+ if (previous !== undefined) {
40
+ return previous;
41
+ }
42
+ const root = seen.size === 0;
34
43
  if (seen.has(target)) {
35
44
  return false;
36
45
  }
37
46
  seen.add(target);
38
- return (target.declarations ?? []).some((declaration) => {
47
+ const result = (target.declarations ?? []).some((declaration) => {
39
48
  const file = declaration.getSourceFile().fileName.replaceAll("\\", "/");
40
49
  if (
41
50
  /\/effect\/(?:src|dist)\/(?:Context|Effect)(?:\.d)?\.ts$/u.test(file)
@@ -53,6 +62,10 @@ function symbolOrigin(checker: ts.TypeChecker, symbol: ts.Symbol, seen: Set<ts.S
53
62
  }
54
63
  return declarationOrigin(checker, declaration, seen);
55
64
  });
65
+ if (root) {
66
+ known.set(target, result);
67
+ }
68
+ return result;
56
69
  }
57
70
 
58
71
  function reference(node: ts.Node): ts.Node | undefined {
@@ -2,8 +2,8 @@ import { join } from "node:path";
2
2
  import { Effect } from "effect";
3
3
  import { readPackageManifest } from "#adapters/manifestInventory.ts";
4
4
  import { packageOf, workspacePackages } from "#imports/workspace.ts";
5
- import { defineRule, type Finding, type RuleInputs } from "#rule.ts";
6
- import { effectProgram } from "#rules/effect/program.ts";
5
+ import { defineRule, type RuleInputs } from "#rule.ts";
6
+ import { effectPrograms } from "#rules/effect/program.ts";
7
7
  import { serviceCatalog } from "#rules/effect/serviceCatalog.ts";
8
8
  import { serviceFindings } from "#rules/effect/serviceFindings.ts";
9
9
 
@@ -22,20 +22,19 @@ export const serviceParameters = defineRule({
22
22
  files.push(source);
23
23
  groups.set(group, files);
24
24
  }
25
- return [...groups.values()].flatMap((sources) => checkServices({ ...inputs, sources }, names));
25
+ const programFor = effectPrograms(inputs);
26
+ return [...groups.values()].flatMap((files) => {
27
+ const program = programFor(files);
28
+ const checker = program.getTypeChecker();
29
+ const sources = files.flatMap((file) => {
30
+ const source = program.getSourceFile(join(inputs.root, file.path));
31
+ return source === undefined ? [] : [source];
32
+ });
33
+ return serviceFindings(inputs.root, sources, checker, serviceCatalog(program, checker, names));
34
+ });
26
35
  }),
27
36
  description:
28
- "Exported functions and public methods take services from Effect's environment, including aliases, constraints, inferred/destructured parameters and factory returns. Service keys/classes, non-empty Contexts and implementation shapes are services; Effect/Stream requirements are computations. Service implementation methods and Layer constructors are accepted. Within Effect code, test-support/ folders are exempt. The fixed adapters/ convention bridges outside libraries to Effect values; adapters still follow this rule and ambient runtime bans. No config exceptions or inline suppressions; baseline existing debt.",
37
+ "Exported and local functions and public methods take services from Effect's environment, including aliases, constraints, inferred/destructured parameters and factory returns. Service keys/classes, non-empty Contexts and implementation shapes are services; Effect/Stream requirements are computations. Service implementation methods, framework callbacks, owned foreign adapter resources and Layer constructors are accepted. Within Effect code, test-support/ folders are exempt. The fixed adapters/ convention bridges outside libraries to Effect values; adapters still follow this rule and ambient runtime bans. No config exceptions or inline suppressions; baseline existing debt.",
29
38
  id: "effect/service-parameters",
30
39
  registrable: false,
31
40
  });
32
-
33
- function checkServices(inputs: RuleInputs, packages: readonly string[]): readonly Finding[] {
34
- const program = effectProgram(inputs);
35
- const checker = program.getTypeChecker();
36
- const sources = inputs.sources.flatMap((file) => {
37
- const source = program.getSourceFile(join(inputs.root, file.path));
38
- return source === undefined ? [] : [source];
39
- });
40
- return serviceFindings(inputs.root, sources, checker, serviceCatalog(program, checker, packages));
41
- }
@@ -50,7 +50,17 @@ export function serviceTypes(checker: ts.TypeChecker, initializerState = false)
50
50
  }
51
51
  }
52
52
  function computation(type: ts.Type): boolean {
53
- return ["~effect/Effect", "~effect/Stream"].some((brand) => type.getProperty(brand) !== undefined);
53
+ const handle = ["~effect/Effect", "~effect/Stream", "~effect/Fiber", "~effect/Scope/Closeable"].some(
54
+ (brand) => type.getProperty(brand) !== undefined,
55
+ );
56
+ const symbol = type.getSymbol();
57
+ return (
58
+ handle
59
+ || (symbol?.name === "AtomContext"
60
+ && (symbol.declarations ?? []).some((declaration) =>
61
+ /\/effect\/(?:src|dist)\/reactivity\/Atom\.(?:d\.)?ts$/u.test(declaration.getSourceFile().fileName.replaceAll("\\", "/")),
62
+ ))
63
+ );
54
64
  }
55
65
  function implementation(type: ts.Type): boolean {
56
66
  if (shapes.has(type)) {
@@ -1,9 +1,11 @@
1
1
  import { posix } from "node:path";
2
2
  import { Effect, Schema } from "effect";
3
3
  import { ignorePatterns } from "#adapters/ignore.ts";
4
+ import { isToolConfig } from "#adapters/isToolConfig.ts";
4
5
  import { serviceAssemblyImports } from "#adapters/serviceAssemblyImports.ts";
5
6
  import { directServiceDefinitions } from "#adapters/serviceAssemblySyntax.ts";
6
7
  import { GlobDeclarations, globPatterns, validateGlobs } from "#config/globs.ts";
8
+ import { programmaticEntries } from "#inventory/programmaticEntries.ts";
7
9
  import { routeFiles } from "#inventory/routeFiles.ts";
8
10
  import { knownDataExports } from "#naming/adapters/plainData.ts";
9
11
  import { constantModule } from "#naming/constantModule.ts";
@@ -17,15 +19,7 @@ import { CAMEL, KEBAB, sameWord, wordsOf } from "#naming/words.ts";
17
19
  import { defineRule, type Finding, type SourceFile } from "#rule.ts";
18
20
  import { parse } from "#rules/parse.ts";
19
21
 
20
- const DEFAULT_TOOL_OWNED: readonly string[] = [
21
- "*.config.*",
22
- "*.d.ts",
23
- "*.d.mts",
24
- "*.d.cts",
25
- "**/.railway/railway.ts",
26
- "**/.railway/railway.py",
27
- "**/.railway/railway.go",
28
- ];
22
+ const DEFAULT_TOOL_OWNED: readonly string[] = ["*.d.ts", "*.d.mts", "*.d.cts"];
29
23
 
30
24
  const TEST = /\.(?:test|spec)\.[cm]?[jt]sx?$/u;
31
25
 
@@ -118,17 +112,29 @@ function findingsOf(file: SourceFile, layout: PackageLayout): readonly Finding[]
118
112
  }
119
113
 
120
114
  export const namedAfterExport = defineRule({
121
- check: ({ files, options, readText, root, sources }) =>
115
+ check: (inputs) =>
122
116
  Effect.gen(function* () {
123
- const layout = yield* packageLayout({ files, readText });
117
+ const { options, root, sources } = inputs;
118
+ const layout = yield* packageLayout(inputs);
119
+ const entries = yield* programmaticEntries(inputs);
124
120
  const routes = yield* routeFiles(root);
125
121
  const toolOwned = ignorePatterns([...DEFAULT_TOOL_OWNED, ...globPatterns(options.toolOwned)]);
126
122
  return sources
127
- .filter((file) => !(TEST.test(file.path) || isMigrationFile(file.path) || routes.files.has(file.path) || toolOwned.ignores(file.path)))
123
+ .filter(
124
+ (file) =>
125
+ !(
126
+ entries.has(file.path)
127
+ || isToolConfig(file.path)
128
+ || TEST.test(file.path)
129
+ || isMigrationFile(file.path)
130
+ || routes.files.has(file.path)
131
+ || toolOwned.ignores(file.path)
132
+ ),
133
+ )
128
134
  .flatMap((file) => findingsOf(file, layout));
129
135
  }),
130
136
  description:
131
- "A file is named after its main runtime export, ignoring private constants and plain-data constants beside it, with its folders as the prefix, including in test-support; 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 constants module holds only plain data and derived types, in a camelCase file named for words every constant shares (timeouts.ts), limits for max/min/limit constants, or defaults for default constants. Split unrelated constants. A file of several non-constant exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
137
+ "A file is named after its main runtime export, ignoring private constants and plain-data constants beside it, with its folders as the prefix, including in test-support; 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; programmatic bundler entries and tool configs keep their role names. A constants module holds only plain data and derived types, in a camelCase file named for words every constant shares (timeouts.ts), limits for max/min/limit constants, or defaults for default constants. Split unrelated constants. A file of several non-constant exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
132
138
  id: "files/named-after-export",
133
139
  options: Schema.toStandardSchemaV1(NamedAfterExportOptions, {
134
140
  parseOptions: { errors: "all", onExcessProperty: "error" },
@@ -1,3 +0,0 @@
1
- import ts from "typescript";
2
- export declare function initializerDependency(checker: ts.TypeChecker, type: ts.Type, seen?: Set<ts.Type>): boolean;
3
- //# sourceMappingURL=initializerDependency.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"initializerDependency.d.ts","sourceRoot":"","sources":["../../src/adapters/initializerDependency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AA8B5B,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,eAAqB,GAAG,OAAO,CA0BhH"}
@@ -1,53 +0,0 @@
1
- import ts from "typescript";
2
- import { effectSuccess } from "#adapters/serviceModelSyntax.ts";
3
- const DATA = ts.TypeFlags.StringLike
4
- | ts.TypeFlags.NumberLike
5
- | ts.TypeFlags.BooleanLike
6
- | ts.TypeFlags.ESSymbolLike
7
- | ts.TypeFlags.BigIntLike
8
- | ts.TypeFlags.Null
9
- | ts.TypeFlags.Undefined
10
- | ts.TypeFlags.Void
11
- | ts.TypeFlags.Never
12
- | ts.TypeFlags.Unknown
13
- | ts.TypeFlags.Any;
14
- const OWNED = /\/effect\/(?:src|dist(?:\/dts)?)\/(?:Ref|SynchronizedRef|ScopedRef|Cache|ScopedCache|Semaphore|Deferred)\.(?:d\.)?ts$/u;
15
- const COLLECTIONS = new Set(["Map", "ReadonlyMap", "Set", "ReadonlySet", "Array", "ReadonlyArray"]);
16
- function owned(type) {
17
- const symbol = type.getSymbol();
18
- return (symbol?.declarations ?? []).some((declaration) => {
19
- const path = declaration.getSourceFile().fileName.replaceAll("\\", "/");
20
- return OWNED.test(path) || (COLLECTIONS.has(symbol?.name ?? "") && /\/lib\.[^/]+\.d\.ts$/u.test(path));
21
- });
22
- }
23
- function reference(type) {
24
- return "objectFlags" in type && typeof type.objectFlags === "number" && (type.objectFlags & ts.ObjectFlags.Reference) !== 0;
25
- }
26
- export function initializerDependency(checker, type, seen = new Set()) {
27
- if (seen.has(type) || type.flags & DATA) {
28
- return false;
29
- }
30
- seen.add(type);
31
- if (type.isUnionOrIntersection()) {
32
- return type.types.some((part) => initializerDependency(checker, part, seen));
33
- }
34
- const success = effectSuccess(checker, type);
35
- if (success !== undefined) {
36
- return initializerDependency(checker, success, seen);
37
- }
38
- if (owned(type)) {
39
- const arguments_ = reference(type) ? checker.getTypeArguments(type) : [];
40
- return arguments_.some((argument) => initializerDependency(checker, argument, seen));
41
- }
42
- for (const signature of type.getCallSignatures()) {
43
- const result = signature.getReturnType();
44
- if (effectSuccess(checker, result) !== undefined || (result.getProperty("then") !== undefined && result.getSymbol()?.name === "Promise")) {
45
- return true;
46
- }
47
- if (initializerDependency(checker, result, seen)) {
48
- return true;
49
- }
50
- }
51
- return type.getProperties().some((property) => initializerDependency(checker, checker.getTypeOfSymbol(property), seen));
52
- }
53
- //# sourceMappingURL=initializerDependency.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"initializerDependency.js","sourceRoot":"","sources":["../../src/adapters/initializerDependency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,MAAM,IAAI,GACT,EAAE,CAAC,SAAS,CAAC,UAAU;MACrB,EAAE,CAAC,SAAS,CAAC,UAAU;MACvB,EAAE,CAAC,SAAS,CAAC,WAAW;MACxB,EAAE,CAAC,SAAS,CAAC,YAAY;MACzB,EAAE,CAAC,SAAS,CAAC,UAAU;MACvB,EAAE,CAAC,SAAS,CAAC,IAAI;MACjB,EAAE,CAAC,SAAS,CAAC,SAAS;MACtB,EAAE,CAAC,SAAS,CAAC,IAAI;MACjB,EAAE,CAAC,SAAS,CAAC,KAAK;MAClB,EAAE,CAAC,SAAS,CAAC,OAAO;MACpB,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC;AACpB,MAAM,KAAK,GAAG,wHAAwH,CAAC;AACvI,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;AAEpG,SAAS,KAAK,CAAC,IAAa;IAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,OAAO,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QACxD,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACxE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,IAAa;IAC/B,OAAO,aAAa,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC7H,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAuB,EAAE,IAAa,EAAE,IAAI,GAAG,IAAI,GAAG,EAAW;IACtG,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACjB,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IACtF,CAAC;IACD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;QAClD,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC;QACzC,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,KAAK,SAAS,CAAC,EAAE,CAAC;YAC1I,OAAO,IAAI,CAAC;QACb,CAAC;QACD,IAAI,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IACD,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;AACzH,CAAC"}
@@ -1,57 +0,0 @@
1
- import ts from "typescript";
2
- import { effectSuccess } from "#adapters/serviceModelSyntax.ts";
3
-
4
- const DATA =
5
- ts.TypeFlags.StringLike
6
- | ts.TypeFlags.NumberLike
7
- | ts.TypeFlags.BooleanLike
8
- | ts.TypeFlags.ESSymbolLike
9
- | ts.TypeFlags.BigIntLike
10
- | ts.TypeFlags.Null
11
- | ts.TypeFlags.Undefined
12
- | ts.TypeFlags.Void
13
- | ts.TypeFlags.Never
14
- | ts.TypeFlags.Unknown
15
- | ts.TypeFlags.Any;
16
- const OWNED = /\/effect\/(?:src|dist(?:\/dts)?)\/(?:Ref|SynchronizedRef|ScopedRef|Cache|ScopedCache|Semaphore|Deferred)\.(?:d\.)?ts$/u;
17
- const COLLECTIONS = new Set(["Map", "ReadonlyMap", "Set", "ReadonlySet", "Array", "ReadonlyArray"]);
18
-
19
- function owned(type: ts.Type): boolean {
20
- const symbol = type.getSymbol();
21
- return (symbol?.declarations ?? []).some((declaration) => {
22
- const path = declaration.getSourceFile().fileName.replaceAll("\\", "/");
23
- return OWNED.test(path) || (COLLECTIONS.has(symbol?.name ?? "") && /\/lib\.[^/]+\.d\.ts$/u.test(path));
24
- });
25
- }
26
-
27
- function reference(type: ts.Type): type is ts.TypeReference {
28
- return "objectFlags" in type && typeof type.objectFlags === "number" && (type.objectFlags & ts.ObjectFlags.Reference) !== 0;
29
- }
30
-
31
- export function initializerDependency(checker: ts.TypeChecker, type: ts.Type, seen = new Set<ts.Type>()): boolean {
32
- if (seen.has(type) || type.flags & DATA) {
33
- return false;
34
- }
35
- seen.add(type);
36
- if (type.isUnionOrIntersection()) {
37
- return type.types.some((part) => initializerDependency(checker, part, seen));
38
- }
39
- const success = effectSuccess(checker, type);
40
- if (success !== undefined) {
41
- return initializerDependency(checker, success, seen);
42
- }
43
- if (owned(type)) {
44
- const arguments_ = reference(type) ? checker.getTypeArguments(type) : [];
45
- return arguments_.some((argument) => initializerDependency(checker, argument, seen));
46
- }
47
- for (const signature of type.getCallSignatures()) {
48
- const result = signature.getReturnType();
49
- if (effectSuccess(checker, result) !== undefined || (result.getProperty("then") !== undefined && result.getSymbol()?.name === "Promise")) {
50
- return true;
51
- }
52
- if (initializerDependency(checker, result, seen)) {
53
- return true;
54
- }
55
- }
56
- return type.getProperties().some((property) => initializerDependency(checker, checker.getTypeOfSymbol(property), seen));
57
- }