@shivaedev/quality 0.65.0 → 0.67.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.
- package/CHANGELOG.md +20 -0
- package/README.md +17 -7
- package/dist/adapters/asymmetricMatcher.d.ts +3 -0
- package/dist/adapters/asymmetricMatcher.d.ts.map +1 -0
- package/dist/adapters/asymmetricMatcher.js +27 -0
- package/dist/adapters/asymmetricMatcher.js.map +1 -0
- package/dist/adapters/callerContextData.d.ts +3 -0
- package/dist/adapters/callerContextData.d.ts.map +1 -0
- package/dist/adapters/callerContextData.js +42 -0
- package/dist/adapters/callerContextData.js.map +1 -0
- package/dist/adapters/contextCaptureFindings.d.ts +4 -0
- package/dist/adapters/contextCaptureFindings.d.ts.map +1 -0
- package/dist/adapters/contextCaptureFindings.js +49 -0
- package/dist/adapters/contextCaptureFindings.js.map +1 -0
- package/dist/adapters/import-compiler/browserChecker.d.ts +4 -0
- package/dist/adapters/import-compiler/browserChecker.d.ts.map +1 -0
- package/dist/adapters/import-compiler/browserChecker.js +4 -0
- package/dist/adapters/import-compiler/browserChecker.js.map +1 -0
- package/dist/adapters/import-compiler/departures.d.ts +5 -0
- package/dist/adapters/import-compiler/departures.d.ts.map +1 -0
- package/dist/adapters/import-compiler/departures.js +5 -0
- package/dist/adapters/import-compiler/departures.js.map +1 -0
- package/dist/adapters/import-compiler/graph.d.ts +4 -0
- package/dist/adapters/import-compiler/graph.d.ts.map +1 -0
- package/dist/adapters/import-compiler/graph.js +6 -0
- package/dist/adapters/import-compiler/graph.js.map +1 -0
- package/dist/adapters/import-compiler/service.d.ts +10 -0
- package/dist/adapters/import-compiler/service.d.ts.map +1 -0
- package/dist/adapters/import-compiler/service.js +16 -0
- package/dist/adapters/import-compiler/service.js.map +1 -0
- package/dist/adapters/initializerDependency.d.ts +3 -0
- package/dist/adapters/initializerDependency.d.ts.map +1 -0
- package/dist/adapters/initializerDependency.js +53 -0
- package/dist/adapters/initializerDependency.js.map +1 -0
- package/dist/adapters/knip/configuration.d.ts.map +1 -1
- package/dist/adapters/knip/configuration.js +2 -1
- package/dist/adapters/knip/configuration.js.map +1 -1
- package/dist/adapters/pureReader.d.ts +3 -0
- package/dist/adapters/pureReader.d.ts.map +1 -0
- package/dist/adapters/pureReader.js +52 -0
- package/dist/adapters/pureReader.js.map +1 -0
- package/dist/adapters/readConfig.js +1 -1
- package/dist/adapters/readConfig.js.map +1 -1
- package/dist/adapters/scriptPaths.d.ts +2 -0
- package/dist/adapters/scriptPaths.d.ts.map +1 -0
- package/dist/adapters/scriptPaths.js +5 -0
- package/dist/adapters/scriptPaths.js.map +1 -0
- package/dist/adapters/serviceDefinitionProblems.js +1 -1
- package/dist/adapters/serviceDefinitionProblems.js.map +1 -1
- package/dist/adapters/serviceFolderFindings.d.ts.map +1 -1
- package/dist/adapters/serviceFolderFindings.js +12 -0
- package/dist/adapters/serviceFolderFindings.js.map +1 -1
- package/dist/adapters/serviceModelFindings.d.ts +4 -0
- package/dist/adapters/serviceModelFindings.d.ts.map +1 -0
- package/dist/adapters/serviceModelFindings.js +48 -0
- package/dist/adapters/serviceModelFindings.js.map +1 -0
- package/dist/adapters/serviceModelSyntax.d.ts +5 -0
- package/dist/adapters/serviceModelSyntax.d.ts.map +1 -0
- package/dist/adapters/serviceModelSyntax.js +53 -0
- package/dist/adapters/serviceModelSyntax.js.map +1 -0
- package/dist/adapters/serviceOperationProblems.d.ts +8 -0
- package/dist/adapters/serviceOperationProblems.d.ts.map +1 -0
- package/dist/adapters/serviceOperationProblems.js +108 -0
- package/dist/adapters/serviceOperationProblems.js.map +1 -0
- package/dist/adapters/serviceStateProblems.d.ts +7 -0
- package/dist/adapters/serviceStateProblems.d.ts.map +1 -0
- package/dist/adapters/serviceStateProblems.js +66 -0
- package/dist/adapters/serviceStateProblems.js.map +1 -0
- package/dist/adapters/specReaderSources.d.ts +7 -0
- package/dist/adapters/specReaderSources.d.ts.map +1 -0
- package/dist/adapters/specReaderSources.js +73 -0
- package/dist/adapters/specReaderSources.js.map +1 -0
- package/dist/cli/args.js +2 -2
- package/dist/cli/args.js.map +1 -1
- package/dist/cli/fix.d.ts +0 -1
- package/dist/cli/fix.d.ts.map +1 -1
- package/dist/cli/fix.js +1 -1
- package/dist/cli/fix.js.map +1 -1
- package/dist/cli/limits.d.ts +2 -0
- package/dist/cli/limits.d.ts.map +1 -0
- package/dist/cli/limits.js +2 -0
- package/dist/cli/limits.js.map +1 -0
- package/dist/cli/{options.d.ts → misplaced.d.ts} +1 -1
- package/dist/cli/misplaced.d.ts.map +1 -0
- package/dist/cli/{options.js → misplaced.js} +1 -1
- package/dist/cli/misplaced.js.map +1 -0
- package/dist/cli/program.js +1 -1
- package/dist/cli/program.js.map +1 -1
- package/dist/cli/subcommands.d.ts +2 -0
- package/dist/cli/subcommands.d.ts.map +1 -0
- package/dist/cli/subcommands.js +6 -0
- package/dist/cli/subcommands.js.map +1 -0
- package/dist/cli/{messages.d.ts → usage.d.ts} +1 -2
- package/dist/cli/usage.d.ts.map +1 -0
- package/{src/cli/messages.ts → dist/cli/usage.js} +1 -6
- package/dist/cli/usage.js.map +1 -0
- package/dist/config/defaultExtensions.d.ts +2 -0
- package/dist/config/defaultExtensions.d.ts.map +1 -0
- package/{src/config/constants.ts → dist/config/defaultExtensions.js} +1 -2
- package/dist/config/defaultExtensions.js.map +1 -0
- package/dist/config/file.d.ts +2 -0
- package/dist/config/file.d.ts.map +1 -0
- package/dist/config/file.js +2 -0
- package/dist/config/file.js.map +1 -0
- package/dist/config/load.js +1 -1
- package/dist/config/load.js.map +1 -1
- package/dist/hooks/install.js +1 -1
- package/dist/hooks/install.js.map +1 -1
- package/dist/imports/browserGlobals.js +1 -1
- package/dist/imports/browserGlobals.js.map +1 -1
- package/dist/imports/departures.js +1 -1
- package/dist/imports/departures.js.map +1 -1
- package/dist/imports/graph.js +1 -1
- package/dist/imports/graph.js.map +1 -1
- package/dist/imports/testComposition.d.ts +4 -0
- package/dist/imports/testComposition.d.ts.map +1 -0
- package/dist/imports/testComposition.js +38 -0
- package/dist/imports/testComposition.js.map +1 -0
- package/dist/naming/adapters/plainData.d.ts +5 -0
- package/dist/naming/adapters/plainData.d.ts.map +1 -0
- package/dist/naming/adapters/plainData.js +77 -0
- package/dist/naming/adapters/plainData.js.map +1 -0
- package/dist/naming/constantModule.d.ts +3 -0
- package/dist/naming/constantModule.d.ts.map +1 -0
- package/dist/naming/constantModule.js +25 -0
- package/dist/naming/constantModule.js.map +1 -0
- package/dist/naming/{migrationFile.d.ts → isMigrationFile.d.ts} +1 -1
- package/dist/naming/isMigrationFile.d.ts.map +1 -0
- package/dist/naming/{migrationFile.js → isMigrationFile.js} +1 -1
- package/dist/naming/isMigrationFile.js.map +1 -0
- package/dist/naming/ownExports.d.ts +0 -1
- package/dist/naming/ownExports.d.ts.map +1 -1
- package/dist/naming/ownExports.js +11 -25
- package/dist/naming/ownExports.js.map +1 -1
- package/dist/naming/packageTests.d.ts +7 -0
- package/dist/naming/packageTests.d.ts.map +1 -0
- package/dist/naming/packageTests.js +21 -0
- package/dist/naming/packageTests.js.map +1 -0
- package/dist/naming/testCode.d.ts +4 -0
- package/dist/naming/testCode.d.ts.map +1 -0
- package/dist/naming/testCode.js +46 -0
- package/dist/naming/testCode.js.map +1 -0
- package/dist/rules/builtIn.d.ts +2 -2
- package/dist/rules/builtIn.d.ts.map +1 -1
- package/dist/rules/builtIn.js +2 -20
- package/dist/rules/builtIn.js.map +1 -1
- package/dist/rules/comments/kinds.js +1 -1
- package/dist/rules/comments/kinds.js.map +1 -1
- package/dist/rules/effect/contextCapture.d.ts +2 -0
- package/dist/rules/effect/contextCapture.d.ts.map +1 -0
- package/dist/rules/effect/contextCapture.js +9 -0
- package/dist/rules/effect/contextCapture.js.map +1 -0
- package/dist/rules/effect/policy.d.ts +2 -0
- package/dist/rules/effect/policy.d.ts.map +1 -0
- package/dist/rules/effect/policy.js +27 -0
- package/dist/rules/effect/policy.js.map +1 -0
- package/dist/rules/effect/serviceCatalog.d.ts +2 -2
- package/dist/rules/effect/serviceCatalog.d.ts.map +1 -1
- package/dist/rules/effect/serviceCatalog.js +14 -10
- package/dist/rules/effect/serviceCatalog.js.map +1 -1
- package/dist/rules/effect/serviceDefinitionAssembly.js +1 -1
- package/dist/rules/effect/serviceDefinitionAssembly.js.map +1 -1
- package/dist/rules/effect/serviceFolders.js +1 -1
- package/dist/rules/effect/serviceFolders.js.map +1 -1
- package/dist/rules/effect/serviceModel.d.ts +2 -0
- package/dist/rules/effect/serviceModel.d.ts.map +1 -0
- package/dist/rules/effect/serviceModel.js +9 -0
- package/dist/rules/effect/serviceModel.js.map +1 -0
- package/dist/rules/effect/serviceTypes.d.ts +2 -2
- package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
- package/dist/rules/effect/serviceTypes.js +15 -3
- package/dist/rules/effect/serviceTypes.js.map +1 -1
- package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
- package/dist/rules/files/namedAfterExport.js +38 -13
- package/dist/rules/files/namedAfterExport.js.map +1 -1
- package/dist/rules/imports/manifest.d.ts.map +1 -1
- package/dist/rules/imports/manifest.js +9 -11
- package/dist/rules/imports/manifest.js.map +1 -1
- package/dist/rules/imports/noTestCode.d.ts.map +1 -1
- package/dist/rules/imports/noTestCode.js +13 -9
- package/dist/rules/imports/noTestCode.js.map +1 -1
- package/dist/rules/maxLines.d.ts.map +1 -1
- package/dist/rules/maxLines.js +7 -2
- package/dist/rules/maxLines.js.map +1 -1
- package/dist/rules/stories/specHelpers.d.ts.map +1 -1
- package/dist/rules/stories/specHelpers.js +8 -4
- package/dist/rules/stories/specHelpers.js.map +1 -1
- package/dist/rules/suppressions/{directives.d.ts → in.d.ts} +1 -1
- package/dist/rules/suppressions/in.d.ts.map +1 -0
- package/dist/rules/suppressions/{directives.js → in.js} +1 -1
- package/dist/rules/suppressions/in.js.map +1 -0
- package/dist/rules/suppressions/noInline.js +1 -1
- package/dist/rules/suppressions/noInline.js.map +1 -1
- package/dist/rules/test-names/colocated.d.ts.map +1 -1
- package/dist/rules/test-names/colocated.js +7 -4
- package/dist/rules/test-names/colocated.js.map +1 -1
- package/dist/rules/test-names/follow.d.ts.map +1 -1
- package/dist/rules/test-names/follow.js +13 -6
- package/dist/rules/test-names/follow.js.map +1 -1
- package/package.json +4 -4
- package/src/adapters/asymmetricMatcher.ts +33 -0
- package/src/adapters/callerContextData.ts +46 -0
- package/src/adapters/contextCaptureFindings.ts +58 -0
- package/src/adapters/import-compiler/browserChecker.ts +5 -0
- package/src/adapters/import-compiler/departures.ts +9 -0
- package/src/adapters/import-compiler/graph.ts +9 -0
- package/src/adapters/import-compiler/service.ts +17 -0
- package/src/adapters/initializerDependency.ts +57 -0
- package/src/adapters/knip/configuration.ts +2 -5
- package/src/adapters/pureReader.ts +56 -0
- package/src/adapters/readConfig.ts +1 -1
- package/src/adapters/scriptPaths.ts +5 -0
- package/src/adapters/serviceDefinitionProblems.ts +1 -1
- package/src/adapters/serviceFolderFindings.ts +14 -0
- package/src/adapters/serviceModelFindings.ts +52 -0
- package/src/adapters/serviceModelSyntax.ts +58 -0
- package/src/adapters/serviceOperationProblems.ts +131 -0
- package/src/adapters/serviceStateProblems.ts +86 -0
- package/src/adapters/specReaderSources.ts +77 -0
- package/src/cli/args.ts +2 -2
- package/src/cli/fix.ts +1 -2
- package/src/cli/limits.ts +1 -0
- package/src/cli/program.ts +1 -1
- package/src/cli/subcommands.ts +5 -0
- package/{dist/cli/messages.js → src/cli/usage.ts} +0 -6
- package/{dist/config/constants.js → src/config/defaultExtensions.ts} +0 -2
- package/src/config/file.ts +1 -0
- package/src/config/load.ts +1 -1
- package/src/hooks/install.ts +1 -1
- package/src/imports/browserGlobals.ts +1 -1
- package/src/imports/departures.ts +1 -1
- package/src/imports/graph.ts +1 -1
- package/src/imports/testComposition.ts +47 -0
- package/src/naming/adapters/plainData.ts +88 -0
- package/src/naming/constantModule.ts +28 -0
- package/src/naming/ownExports.ts +11 -28
- package/src/naming/packageTests.ts +24 -0
- package/src/naming/testCode.ts +62 -0
- package/src/rules/builtIn.ts +2 -20
- package/src/rules/comments/kinds.ts +1 -1
- package/src/rules/effect/contextCapture.ts +10 -0
- package/src/rules/effect/policy.ts +27 -0
- package/src/rules/effect/serviceCatalog.ts +15 -10
- package/src/rules/effect/serviceDefinitionAssembly.ts +1 -1
- package/src/rules/effect/serviceFolders.ts +1 -1
- package/src/rules/effect/serviceModel.ts +10 -0
- package/src/rules/effect/serviceTypes.ts +15 -3
- package/src/rules/files/namedAfterExport.ts +43 -13
- package/src/rules/imports/manifest.ts +18 -10
- package/src/rules/imports/noTestCode.ts +13 -12
- package/src/rules/maxLines.ts +7 -3
- package/src/rules/stories/specHelpers.ts +14 -4
- package/src/rules/suppressions/noInline.ts +1 -1
- package/src/rules/test-names/colocated.ts +7 -4
- package/src/rules/test-names/follow.ts +13 -6
- package/dist/adapters/ImportCompiler.d.ts +0 -10
- package/dist/adapters/ImportCompiler.d.ts.map +0 -1
- package/dist/adapters/ImportCompiler.js +0 -16
- package/dist/adapters/ImportCompiler.js.map +0 -1
- package/dist/adapters/imports/analyzeDepartures.d.ts +0 -5
- package/dist/adapters/imports/analyzeDepartures.d.ts.map +0 -1
- package/dist/adapters/imports/analyzeDepartures.js +0 -5
- package/dist/adapters/imports/analyzeDepartures.js.map +0 -1
- package/dist/adapters/imports/analyzeGraph.d.ts +0 -4
- package/dist/adapters/imports/analyzeGraph.d.ts.map +0 -1
- package/dist/adapters/imports/analyzeGraph.js +0 -6
- package/dist/adapters/imports/analyzeGraph.js.map +0 -1
- package/dist/adapters/imports/checkBrowser.d.ts +0 -4
- package/dist/adapters/imports/checkBrowser.d.ts.map +0 -1
- package/dist/adapters/imports/checkBrowser.js +0 -4
- package/dist/adapters/imports/checkBrowser.js.map +0 -1
- package/dist/cli/messages.d.ts.map +0 -1
- package/dist/cli/messages.js.map +0 -1
- package/dist/cli/options.d.ts.map +0 -1
- package/dist/cli/options.js.map +0 -1
- package/dist/config/constants.d.ts +0 -3
- package/dist/config/constants.d.ts.map +0 -1
- package/dist/config/constants.js.map +0 -1
- package/dist/naming/migrationFile.d.ts.map +0 -1
- package/dist/naming/migrationFile.js.map +0 -1
- package/dist/rules/suppressions/directives.d.ts.map +0 -1
- package/dist/rules/suppressions/directives.js.map +0 -1
- package/src/adapters/ImportCompiler.ts +0 -17
- package/src/adapters/imports/analyzeDepartures.ts +0 -9
- package/src/adapters/imports/analyzeGraph.ts +0 -9
- package/src/adapters/imports/checkBrowser.ts +0 -5
- /package/src/cli/{options.ts → misplaced.ts} +0 -0
- /package/src/naming/{migrationFile.ts → isMigrationFile.ts} +0 -0
- /package/src/rules/suppressions/{directives.ts → in.ts} +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/quality",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.67.0",
|
|
4
4
|
"description": "Repository quality gate with typed rules, a baseline of existing debt and a registry of reasoned exceptions",
|
|
5
5
|
"homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/quality#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"@shivaedev/skills": "0.8.0",
|
|
58
58
|
"@vitest/coverage-v8": "5.0.5",
|
|
59
59
|
"ignore": "7.0.14",
|
|
60
|
-
"knip": "6.
|
|
60
|
+
"knip": "6.44.0",
|
|
61
61
|
"sort-package-json": "4.1.0",
|
|
62
62
|
"typescript": "npm:@typescript/typescript6@6.0.2"
|
|
63
63
|
},
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"@effect/platform-node": "4.1.0",
|
|
66
66
|
"@effect/platform-node-shared": "4.1.0",
|
|
67
67
|
"@effect/vitest": "4.1.0",
|
|
68
|
-
"@shivaedev/test-story": "0.
|
|
68
|
+
"@shivaedev/test-story": "0.43.0",
|
|
69
69
|
"@types/node": "24.19.2",
|
|
70
70
|
"@typescript/native": "npm:typescript@7.0.2",
|
|
71
71
|
"effect": "4.1.0",
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
"peerDependencies": {
|
|
75
75
|
"@effect/platform-node": "4.1.0",
|
|
76
76
|
"@effect/platform-node-shared": "4.1.0",
|
|
77
|
-
"@shivaedev/test-story": "0.
|
|
77
|
+
"@shivaedev/test-story": "0.43.0",
|
|
78
78
|
"effect": "4.1.0",
|
|
79
79
|
"vitest": "5.0.5"
|
|
80
80
|
},
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { importFrom } from "#rules/stories/importOrigin.ts";
|
|
3
|
+
import { unwrapped } from "#rules/stories/syntax.ts";
|
|
4
|
+
|
|
5
|
+
const MATCHERS = new Set(["any", "anything", "arrayContaining", "objectContaining", "stringContaining", "stringMatching"]);
|
|
6
|
+
|
|
7
|
+
function importedExpect(node: ts.Expression, checker: ts.TypeChecker): boolean {
|
|
8
|
+
const value = unwrapped(node);
|
|
9
|
+
if (ts.isPropertyAccessExpression(value) && value.name.text === "not") {
|
|
10
|
+
return importedExpect(value.expression, checker);
|
|
11
|
+
}
|
|
12
|
+
const namespace = ts.isPropertyAccessExpression(value) && value.name.text === "expect";
|
|
13
|
+
const receiver = namespace ? value.expression : value;
|
|
14
|
+
if (!ts.isIdentifier(receiver)) {
|
|
15
|
+
return false;
|
|
16
|
+
}
|
|
17
|
+
return (
|
|
18
|
+
checker.getSymbolAtLocation(receiver)?.declarations?.some((declaration) => {
|
|
19
|
+
const from = importFrom(declaration);
|
|
20
|
+
return (
|
|
21
|
+
(from === "vitest" || from === "@effect/vitest")
|
|
22
|
+
&& (namespace
|
|
23
|
+
? ts.isNamespaceImport(declaration)
|
|
24
|
+
: ts.isImportSpecifier(declaration) && (declaration.propertyName ?? declaration.name).text === "expect")
|
|
25
|
+
);
|
|
26
|
+
}) === true
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export function asymmetricMatcher(call: ts.CallExpression, checker: ts.TypeChecker): boolean {
|
|
31
|
+
const target = unwrapped(call.expression);
|
|
32
|
+
return ts.isPropertyAccessExpression(target) && MATCHERS.has(target.name.text) && importedExpect(target.expression, checker);
|
|
33
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
|
|
3
|
+
const CALLERS = new Set(["SessionUser", "Subject", "Identity", "SessionUserWithProviderAccounts"]);
|
|
4
|
+
|
|
5
|
+
function data(checker: ts.TypeChecker, value: ts.Type, seen: Set<ts.Type>): boolean {
|
|
6
|
+
if (seen.has(value)) {
|
|
7
|
+
return true;
|
|
8
|
+
}
|
|
9
|
+
seen.add(value);
|
|
10
|
+
if (value.flags & (ts.TypeFlags.Any | ts.TypeFlags.Unknown)) {
|
|
11
|
+
return false;
|
|
12
|
+
}
|
|
13
|
+
if (
|
|
14
|
+
value.flags
|
|
15
|
+
& (ts.TypeFlags.StringLike
|
|
16
|
+
| ts.TypeFlags.NumberLike
|
|
17
|
+
| ts.TypeFlags.BooleanLike
|
|
18
|
+
| ts.TypeFlags.ESSymbolLike
|
|
19
|
+
| ts.TypeFlags.BigIntLike
|
|
20
|
+
| ts.TypeFlags.Null
|
|
21
|
+
| ts.TypeFlags.Undefined
|
|
22
|
+
| ts.TypeFlags.Never)
|
|
23
|
+
) {
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
if (value.isUnionOrIntersection()) {
|
|
27
|
+
return value.types.every((part) => data(checker, part, seen));
|
|
28
|
+
}
|
|
29
|
+
if (value.getProperty("~effect/Context/Service") !== undefined || value.getProperty("~effect/Context") !== undefined) {
|
|
30
|
+
return false;
|
|
31
|
+
}
|
|
32
|
+
if (value.getProperty("~effect/Effect") !== undefined) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
if (value.getCallSignatures().length > 0 || value.getConstructSignatures().length > 0) {
|
|
36
|
+
return false;
|
|
37
|
+
}
|
|
38
|
+
const element = checker.getIndexTypeOfType(value, ts.IndexKind.Number);
|
|
39
|
+
return element === undefined
|
|
40
|
+
? value.getProperties().every((property) => data(checker, checker.getTypeOfSymbol(property), seen))
|
|
41
|
+
: data(checker, element, seen);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export function callerContextData(checker: ts.TypeChecker, type: ts.Type, name: string): boolean {
|
|
45
|
+
return CALLERS.has(name) && data(checker, type, new Set());
|
|
46
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { join } from "node:path";
|
|
2
|
+
import { Effect } from "effect";
|
|
3
|
+
import ts from "typescript";
|
|
4
|
+
import { effectApi } from "#adapters/serviceModelSyntax.ts";
|
|
5
|
+
import type { Finding, RuleInputs } from "#rule.ts";
|
|
6
|
+
import { effectProgram } from "#rules/effect/program.ts";
|
|
7
|
+
|
|
8
|
+
const RUNNERS = ["provideContext", "runPromiseWith", "runForkWith"];
|
|
9
|
+
const PROVIDERS = [...RUNNERS, "provide"];
|
|
10
|
+
|
|
11
|
+
function context(type: ts.Type): boolean {
|
|
12
|
+
return type.isUnionOrIntersection() ? type.types.some(context) : type.getProperty("~effect/Context") !== undefined;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
function reprovides(checker: ts.TypeChecker, call: ts.CallExpression): boolean {
|
|
16
|
+
if (RUNNERS.some((name) => effectApi(checker, call.expression, name))) {
|
|
17
|
+
return true;
|
|
18
|
+
}
|
|
19
|
+
if (!effectApi(checker, call.expression, "provide")) {
|
|
20
|
+
return false;
|
|
21
|
+
}
|
|
22
|
+
const environment = call.arguments.at(-1);
|
|
23
|
+
return environment !== undefined && context(checker.getTypeAtLocation(environment));
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export const contextCaptureFindings = Effect.fn("ContextCapture.contextCaptureFindings")((inputs: RuleInputs) =>
|
|
27
|
+
Effect.sync(() => {
|
|
28
|
+
const sources = inputs.sources.filter(
|
|
29
|
+
(file) => !/(?:^|\/)(?:adapters|test-support)\//u.test(file.path) && PROVIDERS.some((name) => file.text.includes(name)),
|
|
30
|
+
);
|
|
31
|
+
if (sources.length === 0) {
|
|
32
|
+
return [];
|
|
33
|
+
}
|
|
34
|
+
const program = effectProgram({ ...inputs, sources });
|
|
35
|
+
const checker = program.getTypeChecker();
|
|
36
|
+
return sources.flatMap((file): readonly Finding[] => {
|
|
37
|
+
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
38
|
+
if (source === undefined) {
|
|
39
|
+
return [];
|
|
40
|
+
}
|
|
41
|
+
const syntax = source;
|
|
42
|
+
const findings: Finding[] = [];
|
|
43
|
+
function visit(node: ts.Node): void {
|
|
44
|
+
if (ts.isCallExpression(node) && reprovides(checker, node)) {
|
|
45
|
+
findings.push({
|
|
46
|
+
file: file.path,
|
|
47
|
+
line: syntax.getLineAndCharacterOfPosition(node.getStart(syntax)).line + 1,
|
|
48
|
+
message:
|
|
49
|
+
"Do not re-provide a captured Effect context in core code. Declare service requirements once and yield dependencies and the caller from the environment. Register the Layer at the host; put runtime bridges in adapters/ or test-support/.",
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
ts.forEachChild(node, visit);
|
|
53
|
+
}
|
|
54
|
+
visit(source);
|
|
55
|
+
return findings;
|
|
56
|
+
});
|
|
57
|
+
}),
|
|
58
|
+
);
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type ts from "typescript";
|
|
3
|
+
import { browserChecker as createBrowserChecker } from "#adapters/imports/browserChecker.ts";
|
|
4
|
+
|
|
5
|
+
export const browserChecker = Effect.fn("ImportCompiler.browserChecker")((source: ts.SourceFile) => Effect.sync(() => createBrowserChecker(source)));
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { analysisFailure } from "#adapters/imports/analysisFailure.ts";
|
|
3
|
+
import { departures as findDepartures } from "#adapters/imports/departures.ts";
|
|
4
|
+
import type { WorkspacePackage } from "#imports/workspace.ts";
|
|
5
|
+
import type { RuleInputs } from "#rule.ts";
|
|
6
|
+
|
|
7
|
+
export const departures = Effect.fn("ImportCompiler.departures")((inputs: RuleInputs, packages: readonly WorkspacePackage[]) =>
|
|
8
|
+
Effect.try({ catch: (cause) => analysisFailure(inputs.root, cause), try: () => findDepartures(inputs, packages) }),
|
|
9
|
+
);
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { realpathSync } from "node:fs";
|
|
2
|
+
import { Effect } from "effect";
|
|
3
|
+
import { analysisFailure } from "#adapters/imports/analysisFailure.ts";
|
|
4
|
+
import { graph as buildGraph } from "#adapters/imports/graph.ts";
|
|
5
|
+
import type { RuleInputs } from "#rule.ts";
|
|
6
|
+
|
|
7
|
+
export const graph = Effect.fn("ImportCompiler.graph")((inputs: RuleInputs) =>
|
|
8
|
+
Effect.try({ catch: (cause) => analysisFailure(inputs.root, cause), try: () => buildGraph(inputs, realpathSync(inputs.root)) }),
|
|
9
|
+
);
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type ts from "typescript";
|
|
3
|
+
import { defineService } from "@shivaedev/service/defineService.ts";
|
|
4
|
+
import { browserChecker } from "./browserChecker.ts";
|
|
5
|
+
import { departures } from "./departures.ts";
|
|
6
|
+
import { graph } from "./graph.ts";
|
|
7
|
+
|
|
8
|
+
export const ImportCompiler = defineService({
|
|
9
|
+
id: "@shivaedev/quality/ImportCompiler",
|
|
10
|
+
initialize: Effect.void,
|
|
11
|
+
methods: () => ({
|
|
12
|
+
browserChecker: browserChecker satisfies (source: ts.SourceFile) => Effect.Effect<ts.TypeChecker>,
|
|
13
|
+
departures,
|
|
14
|
+
graph,
|
|
15
|
+
}),
|
|
16
|
+
requires: [],
|
|
17
|
+
});
|
|
@@ -0,0 +1,57 @@
|
|
|
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
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
2
|
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
3
|
+
import { scriptPaths } from "#adapters/scriptPaths.ts";
|
|
3
4
|
import { exportedModule, exportTargets } from "#imports/packageExports.ts";
|
|
4
5
|
import { packageOf, workspacePackages } from "#imports/workspace.ts";
|
|
5
6
|
import { SHADCN_FILE_GLOB } from "#inventory/shadcnFiles.ts";
|
|
@@ -33,11 +34,7 @@ export async function knipConfiguration(inputs: RuleInputs, toolOwned: readonly
|
|
|
33
34
|
return { directory, manifest };
|
|
34
35
|
}),
|
|
35
36
|
);
|
|
36
|
-
const scripted = new Set(
|
|
37
|
-
manifests.flatMap(({ directory, manifest }) =>
|
|
38
|
-
Object.values(manifest.scripts ?? {}).flatMap((script) => script.split(/[\s'"`;|&()]+/u).map((word) => posix.join(directory, word))),
|
|
39
|
-
),
|
|
40
|
-
);
|
|
37
|
+
const scripted = new Set(manifests.flatMap(({ directory, manifest }) => scriptPaths(directory, manifest.scripts ?? {})));
|
|
41
38
|
const workspaces = manifests.map(({ directory, manifest }) => {
|
|
42
39
|
const sources = inputs.sources
|
|
43
40
|
.filter(({ path }) => (packageOf(packages, path)?.directory ?? ".") === directory)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { unwrapped } from "#rules/stories/syntax.ts";
|
|
3
|
+
|
|
4
|
+
function functionOf(name: ts.Node): ts.FunctionDeclaration | ts.ArrowFunction | ts.FunctionExpression | undefined {
|
|
5
|
+
const declaration = name.parent;
|
|
6
|
+
if (ts.isFunctionDeclaration(declaration)) {
|
|
7
|
+
return declaration;
|
|
8
|
+
}
|
|
9
|
+
const value = ts.isVariableDeclaration(declaration) ? declaration.initializer : undefined;
|
|
10
|
+
const node = value === undefined ? undefined : unwrapped(value);
|
|
11
|
+
return node !== undefined && (ts.isArrowFunction(node) || ts.isFunctionExpression(node)) ? node : undefined;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function action(node: ts.Node, readCall: (call: ts.CallExpression) => boolean): boolean {
|
|
15
|
+
if (
|
|
16
|
+
((ts.isArrowFunction(node) || ts.isFunctionExpression(node) || ts.isFunctionDeclaration(node))
|
|
17
|
+
&& (node.asteriskToken !== undefined || node.modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.AsyncKeyword)))
|
|
18
|
+
|| ts.isJsxElement(node)
|
|
19
|
+
|| ts.isJsxSelfClosingElement(node)
|
|
20
|
+
|| ts.isJsxFragment(node)
|
|
21
|
+
|| ts.isAwaitExpression(node)
|
|
22
|
+
|| ts.isYieldExpression(node)
|
|
23
|
+
|| ts.isNewExpression(node)
|
|
24
|
+
|| ts.isThrowStatement(node)
|
|
25
|
+
|| ts.isDeleteExpression(node)
|
|
26
|
+
|| ts.isPostfixUnaryExpression(node)
|
|
27
|
+
|| (ts.isPrefixUnaryExpression(node) && [ts.SyntaxKind.PlusPlusToken, ts.SyntaxKind.MinusMinusToken].includes(node.operator))
|
|
28
|
+
|| (ts.isBinaryExpression(node)
|
|
29
|
+
&& node.operatorToken.kind >= ts.SyntaxKind.FirstAssignment
|
|
30
|
+
&& node.operatorToken.kind <= ts.SyntaxKind.LastAssignment)
|
|
31
|
+
) {
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
return ts.isCallExpression(node) && !readCall(node);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export function pureReader(name: ts.Node, readCall: (call: ts.CallExpression) => boolean): boolean {
|
|
38
|
+
const fn = functionOf(name);
|
|
39
|
+
if (fn?.body === undefined || fn.asteriskToken !== undefined || fn.modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.AsyncKeyword)) {
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
let returns = !ts.isBlock(fn.body);
|
|
43
|
+
let acts = false;
|
|
44
|
+
let reads = false;
|
|
45
|
+
function visit(node: ts.Node): void {
|
|
46
|
+
returns ||= ts.isReturnStatement(node) && node.expression !== undefined;
|
|
47
|
+
acts ||= action(node, readCall);
|
|
48
|
+
reads ||= ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node) || ts.isBinaryExpression(node);
|
|
49
|
+
ts.forEachChild(node, visit);
|
|
50
|
+
}
|
|
51
|
+
for (const parameter of fn.parameters) {
|
|
52
|
+
visit(parameter);
|
|
53
|
+
}
|
|
54
|
+
visit(fn.body);
|
|
55
|
+
return returns && reads && !acts;
|
|
56
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { basename, dirname, resolve } from "node:path";
|
|
2
2
|
import { pathToFileURL } from "node:url";
|
|
3
3
|
import { Effect, FileSystem } from "effect";
|
|
4
|
-
import { CONFIG_FILE } from "#config/
|
|
4
|
+
import { CONFIG_FILE } from "#config/file.ts";
|
|
5
5
|
import { SetupFailure } from "#failure.ts";
|
|
6
6
|
|
|
7
7
|
function messageOf(cause: unknown): string {
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { posix } from "node:path";
|
|
2
|
+
|
|
3
|
+
export function scriptPaths(directory: string, scripts: Readonly<Record<string, string>>): readonly string[] {
|
|
4
|
+
return Object.values(scripts).flatMap((script) => script.split(/[\s'"`;|&()]+/u).map((word) => posix.join(directory, word)));
|
|
5
|
+
}
|
|
@@ -54,7 +54,7 @@ export function serviceDefinitionProblems(
|
|
|
54
54
|
for (const operation of methods?.properties ?? []) {
|
|
55
55
|
if (!isOperationReference(operation, imports, generics)) {
|
|
56
56
|
found.push({
|
|
57
|
-
message: "Reference a named operation export
|
|
57
|
+
message: "Reference a named Effect.fn operation export that yields its dependencies. Use a state factory only for owned lifetime state.",
|
|
58
58
|
node: operation,
|
|
59
59
|
});
|
|
60
60
|
}
|
|
@@ -59,6 +59,20 @@ export function serviceFolderFindings({ files, sources }: RuleInputs): readonly
|
|
|
59
59
|
}),
|
|
60
60
|
);
|
|
61
61
|
const findings: Finding[] = [];
|
|
62
|
+
for (const file of sources) {
|
|
63
|
+
const source = parse(file);
|
|
64
|
+
if (source !== undefined && directServiceDefinitions(source, serviceAssemblyImports(source).definitions).length > 0) {
|
|
65
|
+
folders.add(posix.dirname(file.path));
|
|
66
|
+
if (posix.basename(file.path) !== "service.ts" && files.includes(`${posix.dirname(file.path)}/service.ts`)) {
|
|
67
|
+
findings.push({
|
|
68
|
+
file: file.path,
|
|
69
|
+
message:
|
|
70
|
+
"Give each service its own folder and move this declaration to its service.ts. Keep that service's operations in focused sibling files.",
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
62
76
|
for (const folder of folders) {
|
|
63
77
|
const service = `${folder}/service.ts`;
|
|
64
78
|
if (!files.includes(service)) {
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { join } from "node:path";
|
|
2
|
+
import { Effect } from "effect";
|
|
3
|
+
import ts from "typescript";
|
|
4
|
+
import { serviceAssemblyImports } from "#adapters/serviceAssemblyImports.ts";
|
|
5
|
+
import { directServiceDefinitions } from "#adapters/serviceAssemblySyntax.ts";
|
|
6
|
+
import { serviceOperationProblems } from "#adapters/serviceOperationProblems.ts";
|
|
7
|
+
import { serviceStateProblems } from "#adapters/serviceStateProblems.ts";
|
|
8
|
+
import type { Finding, RuleInputs } from "#rule.ts";
|
|
9
|
+
import { effectProgram } from "#rules/effect/program.ts";
|
|
10
|
+
import { serviceCatalog } from "#rules/effect/serviceCatalog.ts";
|
|
11
|
+
import { parse } from "#rules/parse.ts";
|
|
12
|
+
|
|
13
|
+
function checkServices(inputs: RuleInputs): readonly Finding[] {
|
|
14
|
+
const program = effectProgram(inputs);
|
|
15
|
+
const checker = program.getTypeChecker();
|
|
16
|
+
const services = serviceCatalog(program, checker, [], true);
|
|
17
|
+
const found: Finding[] = [];
|
|
18
|
+
for (const file of inputs.sources) {
|
|
19
|
+
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
20
|
+
if (source === undefined) {
|
|
21
|
+
continue;
|
|
22
|
+
}
|
|
23
|
+
for (const definition of directServiceDefinitions(source, serviceAssemblyImports(source).definitions)) {
|
|
24
|
+
const config = definition.arguments[0];
|
|
25
|
+
if (config === undefined || !ts.isObjectLiteralExpression(config)) {
|
|
26
|
+
continue;
|
|
27
|
+
}
|
|
28
|
+
const problems = [...serviceStateProblems(checker, config, services), ...serviceOperationProblems(checker, config, source.fileName)];
|
|
29
|
+
for (const { node, message } of problems) {
|
|
30
|
+
found.push({ file: file.path, line: source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1, message });
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
return found;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export const serviceModelFindings = Effect.fn("ServiceModel.serviceModelFindings")((inputs: RuleInputs) =>
|
|
38
|
+
Effect.sync(() => {
|
|
39
|
+
const groups = new Map<string, RuleInputs["sources"][number][]>();
|
|
40
|
+
for (const file of inputs.sources) {
|
|
41
|
+
const source = parse(file);
|
|
42
|
+
if (source === undefined || directServiceDefinitions(source, serviceAssemblyImports(source).definitions).length === 0) {
|
|
43
|
+
continue;
|
|
44
|
+
}
|
|
45
|
+
const group = /^(?:packages|examples)\/[^/]+/u.exec(file.path)?.[0] ?? ".";
|
|
46
|
+
const sources = groups.get(group) ?? [];
|
|
47
|
+
sources.push(file);
|
|
48
|
+
groups.set(group, sources);
|
|
49
|
+
}
|
|
50
|
+
return [...groups.values()].flatMap((sources) => checkServices({ ...inputs, sources }));
|
|
51
|
+
}),
|
|
52
|
+
);
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { unwrapExpression } from "#adapters/serviceAssemblySyntax.ts";
|
|
3
|
+
import { boundaryReference } from "#rules/effect/boundaryReference.ts";
|
|
4
|
+
|
|
5
|
+
export function effectApi(checker: ts.TypeChecker, node: ts.Node, name: string): boolean {
|
|
6
|
+
if (ts.isParenthesizedExpression(node)) {
|
|
7
|
+
return effectApi(checker, node.expression, name);
|
|
8
|
+
}
|
|
9
|
+
if (ts.isPropertyAccessExpression(node) && node.name.text !== name) {
|
|
10
|
+
return false;
|
|
11
|
+
}
|
|
12
|
+
const reference = boundaryReference(checker, node);
|
|
13
|
+
if (reference === `effect.Effect.${name}` || reference === `effect/Effect.${name}`) {
|
|
14
|
+
return true;
|
|
15
|
+
}
|
|
16
|
+
const declaration = declarationOf(checker, node);
|
|
17
|
+
if (declaration === undefined) {
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
const path = declaration.getSourceFile().fileName.replaceAll("\\", "/");
|
|
21
|
+
return (
|
|
22
|
+
/\/effect\/(?:src|dist(?:\/dts)?)\/Effect\.(?:d\.)?ts$/u.test(path)
|
|
23
|
+
&& (ts.isVariableDeclaration(declaration) || ts.isFunctionDeclaration(declaration))
|
|
24
|
+
&& declaration.name !== undefined
|
|
25
|
+
&& ts.isIdentifier(declaration.name)
|
|
26
|
+
&& declaration.name.text === name
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function declarationOf(checker: ts.TypeChecker, node: ts.Node): ts.Declaration | undefined {
|
|
31
|
+
const symbol = ts.isShorthandPropertyAssignment(node.parent)
|
|
32
|
+
? checker.getShorthandAssignmentValueSymbol(node.parent)
|
|
33
|
+
: checker.getSymbolAtLocation(node);
|
|
34
|
+
if (symbol === undefined) {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
const target = symbol.flags & ts.SymbolFlags.Alias ? checker.getAliasedSymbol(symbol) : symbol;
|
|
38
|
+
return target.valueDeclaration ?? target.declarations?.[0];
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export function resolvedValue(checker: ts.TypeChecker, expression: ts.Expression, seen = new Set<ts.Node>()): ts.Node {
|
|
42
|
+
const value = unwrapExpression(expression);
|
|
43
|
+
if (seen.has(value)) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
seen.add(value);
|
|
47
|
+
const declaration = declarationOf(checker, value);
|
|
48
|
+
if (declaration !== undefined && ts.isVariableDeclaration(declaration) && declaration.initializer !== undefined) {
|
|
49
|
+
return resolvedValue(checker, declaration.initializer, seen);
|
|
50
|
+
}
|
|
51
|
+
return declaration !== undefined && (ts.isFunctionDeclaration(declaration) || ts.isMethodDeclaration(declaration)) ? declaration : value;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export function effectSuccess(checker: ts.TypeChecker, type: ts.Type): ts.Type | undefined {
|
|
55
|
+
const brand = type.getProperty("~effect/Effect");
|
|
56
|
+
const success = brand === undefined ? undefined : checker.getTypeOfSymbol(brand).getProperty("_A");
|
|
57
|
+
return success === undefined ? undefined : checker.getTypeOfSymbol(success).getCallSignatures()[0]?.getReturnType();
|
|
58
|
+
}
|
|
@@ -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
|
+
}
|