@shivaedev/quality 0.51.0 → 0.52.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 +18 -0
- package/README.md +8 -5
- package/biome/plugins/ambient-runtime.grit +1 -1
- package/dist/baseline/format.d.ts +1 -0
- package/dist/baseline/format.d.ts.map +1 -1
- package/dist/baseline/format.js +3 -2
- package/dist/baseline/format.js.map +1 -1
- package/dist/baseline/update.js +1 -1
- package/dist/baseline/update.js.map +1 -1
- package/dist/imports/fences/compilePolicy.d.ts.map +1 -1
- package/dist/imports/fences/compilePolicy.js +6 -2
- package/dist/imports/fences/compilePolicy.js.map +1 -1
- package/dist/inventory/shadcnAlias.js.map +1 -1
- package/dist/rules/effect/boundary.js +1 -1
- package/dist/rules/effect/boundary.js.map +1 -1
- package/dist/rules/effect/boundaryCalls.js +1 -1
- package/dist/rules/effect/boundaryCalls.js.map +1 -1
- package/dist/rules/effect/boundaryReference.js +1 -1
- package/dist/rules/effect/boundaryReference.js.map +1 -1
- package/dist/rules/noBarrel.js +1 -1
- package/dist/rules/noBarrel.js.map +1 -1
- package/dist/rules/secondNames.d.ts.map +1 -1
- package/dist/rules/secondNames.js +5 -1
- package/dist/rules/secondNames.js.map +1 -1
- package/dist/rules/suppressions/hiddenCast.d.ts +4 -0
- package/dist/rules/suppressions/hiddenCast.d.ts.map +1 -0
- package/dist/rules/suppressions/hiddenCast.js +80 -0
- package/dist/rules/suppressions/hiddenCast.js.map +1 -0
- package/dist/rules/suppressions/noDoubleCast.d.ts.map +1 -1
- package/dist/rules/suppressions/noDoubleCast.js +55 -4
- package/dist/rules/suppressions/noDoubleCast.js.map +1 -1
- package/dist/rules/suppressions/readonlyWrite.d.ts +4 -0
- package/dist/rules/suppressions/readonlyWrite.d.ts.map +1 -0
- package/dist/rules/suppressions/readonlyWrite.js +113 -0
- package/dist/rules/suppressions/readonlyWrite.js.map +1 -0
- package/dist/unitIoGuard.config.js +2 -2
- package/dist/unitIoGuard.config.js.map +1 -1
- package/package.json +2 -2
- package/src/baseline/format.ts +4 -2
- package/src/baseline/update.ts +1 -1
- package/src/imports/fences/compilePolicy.ts +10 -2
- package/src/inventory/shadcnAlias.ts +1 -1
- package/src/rules/effect/boundary.ts +1 -1
- package/src/rules/effect/boundaryCalls.ts +1 -1
- package/src/rules/effect/boundaryReference.ts +1 -1
- package/src/rules/noBarrel.ts +1 -1
- package/src/rules/secondNames.ts +7 -1
- package/src/rules/suppressions/hiddenCast.ts +95 -0
- package/src/rules/suppressions/noDoubleCast.ts +61 -5
- package/src/rules/suppressions/readonlyWrite.ts +140 -0
- package/src/unitIoGuard.config.ts +3 -3
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
import { join } from "node:path";
|
|
1
2
|
import ts from "typescript";
|
|
2
3
|
import { defineRule } from "#rule.ts";
|
|
4
|
+
import { effectProgram } from "#rules/effect/program.ts";
|
|
3
5
|
import { parse } from "#rules/parse.ts";
|
|
6
|
+
import { hiddenCast, SQL_ROW_CAST } from "./hiddenCast.js";
|
|
7
|
+
import { readonlyWrite, writeCandidate } from "./readonlyWrite.js";
|
|
4
8
|
const BRIDGES = new Map([
|
|
5
9
|
[ts.SyntaxKind.UnknownKeyword, "unknown"],
|
|
6
10
|
[ts.SyntaxKind.AnyKeyword, "any"],
|
|
@@ -18,11 +22,14 @@ function bridgeOf(node) {
|
|
|
18
22
|
}
|
|
19
23
|
function castsIn(path, source) {
|
|
20
24
|
const findings = [];
|
|
25
|
+
const hidden = !/(?:^|\/)(?:adapters|test-support)\//u.test(path);
|
|
21
26
|
function visit(node) {
|
|
22
27
|
const bridge = isAssertion(node) ? bridgeOf(node) : undefined;
|
|
23
|
-
|
|
28
|
+
const implicit = hidden ? hiddenCast(node) : undefined;
|
|
29
|
+
const message = bridge === undefined ? implicit : `Casts through "${bridge}" to reach a type the value does not have.`;
|
|
30
|
+
if (message !== undefined) {
|
|
24
31
|
const line = source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1;
|
|
25
|
-
findings.push({ file: path, line, message
|
|
32
|
+
findings.push({ file: path, line, message });
|
|
26
33
|
}
|
|
27
34
|
ts.forEachChild(node, visit);
|
|
28
35
|
}
|
|
@@ -33,9 +40,53 @@ function doubleCasts(file) {
|
|
|
33
40
|
const source = parse(file);
|
|
34
41
|
return source === undefined ? [] : castsIn(file.path, source);
|
|
35
42
|
}
|
|
43
|
+
function typedNodes(source) {
|
|
44
|
+
const nodes = [];
|
|
45
|
+
function visit(node) {
|
|
46
|
+
if (writeCandidate(node) || (ts.isTaggedTemplateExpression(node) && node.typeArguments?.length && node.tag.getText() !== "sql")) {
|
|
47
|
+
nodes.push(node);
|
|
48
|
+
}
|
|
49
|
+
ts.forEachChild(node, visit);
|
|
50
|
+
}
|
|
51
|
+
visit(source);
|
|
52
|
+
return nodes;
|
|
53
|
+
}
|
|
54
|
+
function typedCast(node, checker) {
|
|
55
|
+
if (ts.isTaggedTemplateExpression(node)) {
|
|
56
|
+
const nativeSql = checker
|
|
57
|
+
.getTypeAtLocation(node.tag)
|
|
58
|
+
.getSymbol()
|
|
59
|
+
?.getDeclarations()
|
|
60
|
+
?.some((declaration) => /(?:^|\/)effect\/(?:src|dist(?:\/[^/]+)?)\/sql\/(?:SqlClient|Statement)\.(?:d\.)?ts$/u.test(declaration.getSourceFile().fileName));
|
|
61
|
+
return nativeSql ? SQL_ROW_CAST : undefined;
|
|
62
|
+
}
|
|
63
|
+
return readonlyWrite(node, checker);
|
|
64
|
+
}
|
|
65
|
+
function typedCasts(inputs) {
|
|
66
|
+
const sources = inputs.sources.filter((file) => {
|
|
67
|
+
const source = parse(file);
|
|
68
|
+
return !/(?:^|\/)(?:adapters|test-support)\//u.test(file.path) && source !== undefined && typedNodes(source).length > 0;
|
|
69
|
+
});
|
|
70
|
+
if (sources.length === 0) {
|
|
71
|
+
return [];
|
|
72
|
+
}
|
|
73
|
+
const program = effectProgram({ ...inputs, sources });
|
|
74
|
+
const checker = program.getTypeChecker();
|
|
75
|
+
return sources.flatMap((file) => {
|
|
76
|
+
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
77
|
+
return source === undefined
|
|
78
|
+
? []
|
|
79
|
+
: typedNodes(source).flatMap((node) => {
|
|
80
|
+
const message = typedCast(node, checker);
|
|
81
|
+
return message === undefined
|
|
82
|
+
? []
|
|
83
|
+
: [{ file: file.path, line: source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1, message }];
|
|
84
|
+
});
|
|
85
|
+
});
|
|
86
|
+
}
|
|
36
87
|
export const noDoubleCast = defineRule({
|
|
37
|
-
check: (
|
|
38
|
-
description: "
|
|
88
|
+
check: (inputs) => [...inputs.sources.flatMap(doubleCasts), ...typedCasts(inputs)],
|
|
89
|
+
description: "Decode unknown values with Schema.decodeUnknownEffect and SQL rows with SqlSchema. Check declared overload returns and preserve Context service types and readonly native fields. Reports double casts everywhere and hidden casts outside adapters/ and test-support/.",
|
|
39
90
|
id: "suppressions/no-double-cast",
|
|
40
91
|
registrable: false,
|
|
41
92
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"noDoubleCast.js","sourceRoot":"","sources":["../../../src/rules/suppressions/noDoubleCast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,UAAU,
|
|
1
|
+
{"version":3,"file":"noDoubleCast.js","sourceRoot":"","sources":["../../../src/rules/suppressions/noDoubleCast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAkD,MAAM,UAAU,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEnE,MAAM,OAAO,GAAuC,IAAI,GAAG,CAAC;IAC3D,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,EAAE,SAAS,CAAC;IACzC,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC;IACjC,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC;CACrC,CAAC,CAAC;AAIH,SAAS,WAAW,CAAC,IAAa;IACjC,OAAO,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,SAAS,CAAC,IAAmB;IACrC,OAAO,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/E,CAAC;AAED,SAAS,QAAQ,CAAC,IAAe;IAChC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,MAAqB;IACnD,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,CAAC,sCAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClE,SAAS,KAAK,CAAC,IAAa;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9D,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,MAAM,4CAA4C,CAAC;QACvH,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;YAClF,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,CAAC;IACd,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,IAAgB;IACpC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,MAAqB;IACxC,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,SAAS,KAAK,CAAC,IAAa;QAC3B,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC;YACjI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,IAAa,EAAE,OAAuB;IACxD,IAAI,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,OAAO;aACvB,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;aAC3B,SAAS,EAAE;YACZ,EAAE,eAAe,EAAE;YACnB,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CACtB,sFAAsF,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,CACjI,CAAC;QACH,OAAO,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,UAAU,CAAC,MAAkB;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,CAAC,sCAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACzH,CAAC,CAAC,CAAC;IACH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IACzC,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,OAAO,MAAM,KAAK,SAAS;YAC1B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACpC,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACzC,OAAO,OAAO,KAAK,SAAS;oBAC3B,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/G,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC;IACtC,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAClF,WAAW,EACV,yQAAyQ;IAC1Q,EAAE,EAAE,6BAA6B;IACjC,WAAW,EAAE,KAAK;CAClB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readonlyWrite.d.ts","sourceRoot":"","sources":["../../../src/rules/suppressions/readonlyWrite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AA+E5B,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAYrD;AAmCD,wBAAgB,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAaxF"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
function propertyName(node, checker) {
|
|
3
|
+
if (ts.isStringLiteralLike(node) || ts.isNumericLiteral(node)) {
|
|
4
|
+
return node.text;
|
|
5
|
+
}
|
|
6
|
+
const type = checker.getTypeAtLocation(node);
|
|
7
|
+
return type.isStringLiteral() || type.isNumberLiteral() ? String(type.value) : undefined;
|
|
8
|
+
}
|
|
9
|
+
function readonlyProperty(checker, target, key) {
|
|
10
|
+
const type = checker.getTypeAtLocation(target);
|
|
11
|
+
if (type.isUnionOrIntersection()) {
|
|
12
|
+
return type.types.some((part) => readonlyIn(part, key));
|
|
13
|
+
}
|
|
14
|
+
return readonlyIn(type, key);
|
|
15
|
+
}
|
|
16
|
+
function readonlyIn(type, key) {
|
|
17
|
+
const symbol = type.getProperty(key);
|
|
18
|
+
const mapped = type.getSymbol()?.getDeclarations()?.find(ts.isMappedTypeNode);
|
|
19
|
+
if (symbol !== undefined && mapped?.readonlyToken !== undefined) {
|
|
20
|
+
return mapped.readonlyToken.kind !== ts.SyntaxKind.MinusToken;
|
|
21
|
+
}
|
|
22
|
+
return (symbol
|
|
23
|
+
?.getDeclarations()
|
|
24
|
+
?.some((declaration) => (ts.canHaveModifiers(declaration) && ts.getModifiers(declaration)?.some((modifier) => modifier.kind === ts.SyntaxKind.ReadonlyKeyword))
|
|
25
|
+
|| (ts.isGetAccessorDeclaration(declaration) && !symbol.getDeclarations()?.some(ts.isSetAccessorDeclaration))) === true);
|
|
26
|
+
}
|
|
27
|
+
function scopeState(checker, target, key) {
|
|
28
|
+
if (key !== "state") {
|
|
29
|
+
return false;
|
|
30
|
+
}
|
|
31
|
+
return (checker
|
|
32
|
+
.getTypeAtLocation(target)
|
|
33
|
+
.getProperty("state")
|
|
34
|
+
?.getDeclarations()
|
|
35
|
+
?.some((declaration) => /(?:^|\/)effect\/(?:src|dist(?:\/[^/]+)?)\/Scope\.(?:d\.)?ts$/u.test(declaration.getSourceFile().fileName)) === true);
|
|
36
|
+
}
|
|
37
|
+
function overwritten(checker, target, keys) {
|
|
38
|
+
const key = keys.find((name) => readonlyProperty(checker, target, name) || scopeState(checker, target, name));
|
|
39
|
+
return key === undefined
|
|
40
|
+
? undefined
|
|
41
|
+
: `Writes ${key} on ${checker.typeToString(checker.getTypeAtLocation(target))}. Use the native constructor or copy API and preserve the declared readonly type; use Scope.close for Scope state.`;
|
|
42
|
+
}
|
|
43
|
+
function assignedKeys(checker, source) {
|
|
44
|
+
return checker
|
|
45
|
+
.getTypeAtLocation(source)
|
|
46
|
+
.getProperties()
|
|
47
|
+
.map((property) => property.name);
|
|
48
|
+
}
|
|
49
|
+
function writeTarget(node) {
|
|
50
|
+
if (ts.isBinaryExpression(node)
|
|
51
|
+
&& node.operatorToken.kind >= ts.SyntaxKind.FirstAssignment
|
|
52
|
+
&& node.operatorToken.kind <= ts.SyntaxKind.LastAssignment) {
|
|
53
|
+
return node.left;
|
|
54
|
+
}
|
|
55
|
+
if ((ts.isPrefixUnaryExpression(node) || ts.isPostfixUnaryExpression(node))
|
|
56
|
+
&& (node.operator === ts.SyntaxKind.PlusPlusToken || node.operator === ts.SyntaxKind.MinusMinusToken)) {
|
|
57
|
+
return node.operand;
|
|
58
|
+
}
|
|
59
|
+
return ts.isDeleteExpression(node) ? node.expression : undefined;
|
|
60
|
+
}
|
|
61
|
+
export function writeCandidate(node) {
|
|
62
|
+
const target = writeTarget(node);
|
|
63
|
+
return ((target !== undefined
|
|
64
|
+
&& (ts.isPropertyAccessExpression(target) || ts.isElementAccessExpression(target))
|
|
65
|
+
&& !constructorInitialization(node, target.expression))
|
|
66
|
+
|| (ts.isCallExpression(node)
|
|
67
|
+
&& ts.isPropertyAccessExpression(node.expression)
|
|
68
|
+
&& ts.isIdentifier(node.expression.expression)
|
|
69
|
+
&& ((node.expression.expression.text === "Object" && ["assign", "defineProperty"].includes(node.expression.name.text))
|
|
70
|
+
|| (node.expression.expression.text === "Reflect" && node.expression.name.text === "set"))));
|
|
71
|
+
}
|
|
72
|
+
function constructorInitialization(node, target) {
|
|
73
|
+
if (target?.kind !== ts.SyntaxKind.ThisKeyword) {
|
|
74
|
+
return false;
|
|
75
|
+
}
|
|
76
|
+
for (let parent = node.parent; parent !== undefined; parent = parent.parent) {
|
|
77
|
+
if (ts.isConstructorDeclaration(parent)) {
|
|
78
|
+
return true;
|
|
79
|
+
}
|
|
80
|
+
if (ts.isFunctionLike(parent)) {
|
|
81
|
+
break;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return false;
|
|
85
|
+
}
|
|
86
|
+
function callWrite(node, checker) {
|
|
87
|
+
const target = node.arguments[0];
|
|
88
|
+
if (target === undefined || constructorInitialization(node, target)) {
|
|
89
|
+
return undefined;
|
|
90
|
+
}
|
|
91
|
+
const method = ts.isPropertyAccessExpression(node.expression) ? node.expression.name.text : undefined;
|
|
92
|
+
if (method === "assign") {
|
|
93
|
+
return overwritten(checker, target, node.arguments.slice(1).flatMap((source) => assignedKeys(checker, source)));
|
|
94
|
+
}
|
|
95
|
+
const argument = node.arguments[1];
|
|
96
|
+
const key = argument === undefined ? undefined : propertyName(argument, checker);
|
|
97
|
+
return key === undefined ? undefined : overwritten(checker, target, [key]);
|
|
98
|
+
}
|
|
99
|
+
export function readonlyWrite(node, checker) {
|
|
100
|
+
if (ts.isCallExpression(node)) {
|
|
101
|
+
return callWrite(node, checker);
|
|
102
|
+
}
|
|
103
|
+
const target = writeTarget(node);
|
|
104
|
+
if (target === undefined || !(ts.isPropertyAccessExpression(target) || ts.isElementAccessExpression(target))) {
|
|
105
|
+
return undefined;
|
|
106
|
+
}
|
|
107
|
+
if (constructorInitialization(node, target.expression)) {
|
|
108
|
+
return undefined;
|
|
109
|
+
}
|
|
110
|
+
const key = ts.isPropertyAccessExpression(target) ? target.name.text : propertyName(target.argumentExpression, checker);
|
|
111
|
+
return key === undefined ? undefined : overwritten(checker, target.expression, [key]);
|
|
112
|
+
}
|
|
113
|
+
//# sourceMappingURL=readonlyWrite.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readonlyWrite.js","sourceRoot":"","sources":["../../../src/rules/suppressions/readonlyWrite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,SAAS,YAAY,CAAC,IAAmB,EAAE,OAAuB;IACjE,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1F,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAuB,EAAE,MAAqB,EAAE,GAAW;IACpF,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,IAAa,EAAE,GAAW;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,EAAE,eAAe,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC;IAC9E,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,EAAE,aAAa,KAAK,SAAS,EAAE,CAAC;QACjE,OAAO,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;IAC/D,CAAC;IACD,OAAO,CACN,MAAM;QACL,EAAE,eAAe,EAAE;QACnB,EAAE,IAAI,CACL,CAAC,WAAW,EAAE,EAAE,CACf,CAAC,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;WACpI,CAAC,EAAE,CAAC,wBAAwB,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC,CAC9G,KAAK,IAAI,CACX,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,OAAuB,EAAE,MAAqB,EAAE,GAAW;IAC9E,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CACN,OAAO;SACL,iBAAiB,CAAC,MAAM,CAAC;SACzB,WAAW,CAAC,OAAO,CAAC;QACrB,EAAE,eAAe,EAAE;QACnB,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,+DAA+D,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,CAAC,KAAK,IAAI,CAC7I,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,OAAuB,EAAE,MAAqB,EAAE,IAAuB;IAC3F,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9G,OAAO,GAAG,KAAK,SAAS;QACvB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,UAAU,GAAG,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,oHAAoH,CAAC;AACpM,CAAC;AAED,SAAS,YAAY,CAAC,OAAuB,EAAE,MAAqB;IACnE,OAAO,OAAO;SACZ,iBAAiB,CAAC,MAAM,CAAC;SACzB,aAAa,EAAE;SACf,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IACjC,IACC,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC;WACxB,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,eAAe;WACxD,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,EACzD,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IACD,IACC,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;WACpE,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EACpG,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa;IAC3C,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO,CACN,CAAC,MAAM,KAAK,SAAS;WACjB,CAAC,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;WAC/E,CAAC,yBAAyB,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;WACrD,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;eACzB,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;eAC9C,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;eAC3C,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;mBAClH,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAC7F,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAa,EAAE,MAAiC;IAClF,IAAI,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,KAAK,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,KAAK,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7E,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC;QACb,CAAC;QACD,IAAI,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/B,MAAM;QACP,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,IAAuB,EAAE,OAAuB;IAClE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS,IAAI,yBAAyB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,MAAM,GAAG,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACtG,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACzB,OAAO,WAAW,CACjB,OAAO,EACP,MAAM,EACN,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAC1E,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjF,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,OAAuB;IACnE,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC9G,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,yBAAyB,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,GAAG,GAAG,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACxH,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACvF,CAAC"}
|
|
@@ -6,8 +6,8 @@ const installed = Symbol.for("@shivaedev/quality/unitIoGuard");
|
|
|
6
6
|
let loading = 0;
|
|
7
7
|
function assertUnitIoAllowed(call, boundary) {
|
|
8
8
|
const worker = Reflect.get(globalThis, "__vitest_worker__");
|
|
9
|
-
const file = worker
|
|
10
|
-
if (loading > 0 || file
|
|
9
|
+
const file = typeof worker === "object" && worker !== null && "filepath" in worker ? worker.filepath : undefined;
|
|
10
|
+
if (loading > 0 || typeof file !== "string" || !/\.unit\.(?:test|spec)\.[cm]?[jt]sx?$/u.test(file)) {
|
|
11
11
|
return;
|
|
12
12
|
}
|
|
13
13
|
const error = new Error(`Unit test ${file} cannot call ${call}; use a story through the package's kit for I/O.`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"unitIoGuard.config.js","sourceRoot":"","sources":["../src/unitIoGuard.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACnE,6EAA6E;AAC7E,OAAO,cAAc,CAAC;AAEtB,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;AAC/D,IAAI,OAAO,GAAG,CAAC,CAAC;AAEhB,SAAS,mBAAmB,CAAC,IAAY,EAAE,QAAuC;IACjF,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"unitIoGuard.config.js","sourceRoot":"","sources":["../src/unitIoGuard.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACnE,6EAA6E;AAC7E,OAAO,cAAc,CAAC;AAEtB,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;AAC/D,IAAI,OAAO,GAAG,CAAC,CAAC;AAEhB,SAAS,mBAAmB,CAAC,IAAY,EAAE,QAAuC;IACjF,MAAM,MAAM,GAAY,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IACjH,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,uCAAuC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpG,OAAO;IACR,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,aAAa,IAAI,gBAAgB,IAAI,kDAAkD,CAAC,CAAC;IACjH,KAAK,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK;QACzB,EAAE,KAAK,CAAC,IAAI,CAAC;SACZ,KAAK,CAAC,CAAC,CAAC;SACR,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,kGAAkG;IAClG,IAAI,MAAM,KAAK,SAAS,IAAI,uGAAuG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAClJ,OAAO;IACR,CAAC;IACD,MAAM,KAAK,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAI,GAAY;IAClC,OAAO,IAAI,CAAC,CAAC;IACb,IAAI,CAAC;QACJ,OAAO,GAAG,EAAE,CAAC;IACd,CAAC;YAAS,CAAC;QACV,OAAO,IAAI,CAAC,CAAC;IACd,CAAC;AACF,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAChC,MAAM,MAAM,GAA4B,IAAI,CAAC,IAAI,CAAC,CAAC;IACnD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACpC,SAAS;QACV,CAAC;QACD,MAAM,KAAK,GAAwD,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC7F,mBAAmB,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;YAC7C,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QAChE,CAAC,CAAC;QACF,MAAM,SAAS,GAA4D,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;YACtG,mBAAmB,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;YACjD,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;YAClC,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAChD,QAAQ,EAAE,IAAI;SACd,CAAC,CAAC;IACJ,CAAC;AACF,CAAC;AAED,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,CAAC;QACxI,WAAW,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;IAC/B,UAAU,CAAC,KAAK,GAAG,SAAS,WAAW,CAAC,GAAG,IAAI;QAC9C,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB,CAAC,CAAC;IACF,qBAAqB,EAAE,CAAC;AACzB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/quality",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.52.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": {
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
"@effect/platform-node": "4.0.6",
|
|
63
63
|
"@effect/platform-node-shared": "4.0.6",
|
|
64
64
|
"@effect/vitest": "4.0.6",
|
|
65
|
-
"@shivaedev/test-story": "0.31.
|
|
65
|
+
"@shivaedev/test-story": "0.31.1",
|
|
66
66
|
"@types/node": "24.19.2",
|
|
67
67
|
"@typescript/native": "npm:typescript@7.0.2",
|
|
68
68
|
"effect": "4.0.6",
|
package/src/baseline/format.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { keyOf } from "#engine/violation.ts";
|
|
|
5
5
|
const Line = Schema.Struct({
|
|
6
6
|
count: Schema.Int.check(Schema.isGreaterThan(0)),
|
|
7
7
|
path: Schema.NonEmptyString,
|
|
8
|
+
reason: Schema.optionalKey(Schema.NonEmptyString),
|
|
8
9
|
rule: Schema.NonEmptyString,
|
|
9
10
|
});
|
|
10
11
|
|
|
@@ -13,6 +14,7 @@ const BaselineLine = Schema.fromJsonString(Line);
|
|
|
13
14
|
export interface BaselineEntry {
|
|
14
15
|
readonly count: number;
|
|
15
16
|
readonly file: string;
|
|
17
|
+
readonly reason?: string;
|
|
16
18
|
readonly rule: string;
|
|
17
19
|
}
|
|
18
20
|
|
|
@@ -51,10 +53,10 @@ export async function decodeBaseline(raw: string | undefined): Promise<Decoded<r
|
|
|
51
53
|
return issues.length === 0 ? { _tag: "Valid", value: entries } : { _tag: "Invalid", issues };
|
|
52
54
|
}
|
|
53
55
|
|
|
54
|
-
const LINE_KEYS = ["path", "rule", "count"];
|
|
56
|
+
const LINE_KEYS = ["path", "rule", "count", "reason"];
|
|
55
57
|
|
|
56
58
|
export function encodeEntry(entry: BaselineEntry): string {
|
|
57
|
-
return JSON.stringify({ count: entry.count, path: entry.file, rule: entry.rule }, LINE_KEYS);
|
|
59
|
+
return JSON.stringify({ count: entry.count, path: entry.file, reason: entry.reason, rule: entry.rule }, LINE_KEYS);
|
|
58
60
|
}
|
|
59
61
|
|
|
60
62
|
export function encodeBaseline(entries: readonly BaselineEntry[]): string {
|
package/src/baseline/update.ts
CHANGED
|
@@ -96,7 +96,7 @@ export function prune(
|
|
|
96
96
|
return [];
|
|
97
97
|
}
|
|
98
98
|
moved += Number(now.file !== before.file);
|
|
99
|
-
return [{ after: { count: Math.min(before.count, now.count), file: now.file
|
|
99
|
+
return [{ after: { ...before, count: Math.min(before.count, now.count), file: now.file }, before }];
|
|
100
100
|
});
|
|
101
101
|
return {
|
|
102
102
|
entries: kept.map(({ after }) => after),
|
|
@@ -31,8 +31,16 @@ function crossedBy(policy: readonly CompiledFence[], graph: FenceGraph): readonl
|
|
|
31
31
|
return policy.filter((compiled) => compiled.evaluate(graph).length > 0).map((compiled) => compiled.fence.name);
|
|
32
32
|
}
|
|
33
33
|
|
|
34
|
-
function exampleIssues(policy: readonly CompiledFence[], fence: Fence): readonly string[] {
|
|
34
|
+
function exampleIssues(policy: readonly CompiledFence[], fence: Fence, scope: PolicyScope): readonly string[] {
|
|
35
35
|
const where = `fence "${fence.name}"`;
|
|
36
|
+
const missing = (["illegal", "legal"] as const).flatMap((kind) =>
|
|
37
|
+
fence.examples[kind].flatMap((step) =>
|
|
38
|
+
typeof step === "string" && !scope.files.includes(step) ? [`${where}: the ${kind} example names "${step}", which is no checked file`] : [],
|
|
39
|
+
),
|
|
40
|
+
);
|
|
41
|
+
if (missing.length > 0) {
|
|
42
|
+
return missing;
|
|
43
|
+
}
|
|
36
44
|
const illegal = graphOf(fence.examples.illegal);
|
|
37
45
|
const legal = graphOf(fence.examples.legal);
|
|
38
46
|
if (illegal === undefined || legal === undefined) {
|
|
@@ -62,7 +70,7 @@ export function compilePolicy(fences: readonly Fence[], scope: PolicyScope): rea
|
|
|
62
70
|
const issues = [...declarationIssues(fences)];
|
|
63
71
|
const policy = fences.map((fence) => compileFence({ issues, scope }, fence));
|
|
64
72
|
if (issues.length === 0) {
|
|
65
|
-
issues.push(...fences.flatMap((fence) => exampleIssues(policy, fence)));
|
|
73
|
+
issues.push(...fences.flatMap((fence) => exampleIssues(policy, fence, scope)));
|
|
66
74
|
}
|
|
67
75
|
if (issues.length > 0) {
|
|
68
76
|
throw new Error(`the fence policy is invalid:\n${issues.map((issue) => ` - ${issue}`).join("\n")}`);
|
|
@@ -16,7 +16,7 @@ function capture(pattern: string, alias: string): string | undefined {
|
|
|
16
16
|
}
|
|
17
17
|
|
|
18
18
|
function pathTarget(alias: string, options: ts.CompilerOptions, directory: string): string | undefined {
|
|
19
|
-
const pathsBase = Reflect.get(options, "pathsBasePath");
|
|
19
|
+
const pathsBase: unknown = Reflect.get(options, "pathsBasePath");
|
|
20
20
|
const base = options.baseUrl ?? (typeof pathsBase === "string" ? pathsBase : directory);
|
|
21
21
|
const patterns = Object.entries(options.paths ?? {}).toSorted(([left], [right]) => right.indexOf("*") - left.indexOf("*"));
|
|
22
22
|
const exact = options.paths?.[alias]?.[0];
|
|
@@ -93,7 +93,7 @@ export const effectBoundary = defineRule({
|
|
|
93
93
|
return [...groups.values()].flatMap((sources) => checkBoundary({ ...inputs, sources }));
|
|
94
94
|
},
|
|
95
95
|
description:
|
|
96
|
-
"Use Effect instead of Promise syntax and parameters, synchronous Node IO, throwing helper calls or Effect.sync with throwing APIs. Runners belong at entry points, tool configs and tests. Only adapters/ and test-support/ folders are exempt. Use Effect services and tagged errors; bridge outside libraries in adapters/. No config exceptions or inline suppressions; baseline existing debt.",
|
|
96
|
+
"Use Effect instead of Promise syntax and parameters, synchronous Node IO, throwing helper calls or Effect.sync with throwing APIs. Runners belong at entry points (including main.tsx and entry.tsx), tool configs and tests. Only adapters/ and test-support/ folders are exempt; calls to throwing helpers defined in adapters/ are accepted. Use Effect services and tagged errors; bridge outside libraries in adapters/. No config exceptions or inline suppressions; baseline existing debt.",
|
|
97
97
|
id: "effect/boundary",
|
|
98
98
|
registrable: false,
|
|
99
99
|
});
|
|
@@ -77,7 +77,7 @@ export function boundaryCalls(checker: ts.TypeChecker) {
|
|
|
77
77
|
}
|
|
78
78
|
function guard(call: ts.CallExpression): boolean {
|
|
79
79
|
const body = functionBody(checker, call.expression);
|
|
80
|
-
return body !== undefined && throws(body);
|
|
80
|
+
return body !== undefined && !/(?:^|\/)adapters\//u.test(body.getSourceFile().fileName) && throws(body);
|
|
81
81
|
}
|
|
82
82
|
function unsafeSync(call: ts.CallExpression): boolean {
|
|
83
83
|
const callback = call.arguments[0];
|
|
@@ -66,7 +66,7 @@ export function boundaryReference(checker: ts.TypeChecker, node: ts.Node, seen =
|
|
|
66
66
|
}
|
|
67
67
|
|
|
68
68
|
export function boundaryEntryPoint(path: string, source: ts.SourceFile, checker: ts.TypeChecker): boolean {
|
|
69
|
-
if (/(?:^|\/)(?:cli|main|[^/]+-cli)\.[cm]?[jt]sx?$|\.(?:config|test|spec)\.[cm]?[jt]sx?$/u.test(path)) {
|
|
69
|
+
if (/(?:^|\/)(?:cli|main|entry|[^/]+-cli)\.[cm]?[jt]sx?$|\.(?:config|test|spec)\.[cm]?[jt]sx?$/u.test(path)) {
|
|
70
70
|
return true;
|
|
71
71
|
}
|
|
72
72
|
function visit(node: ts.Node): boolean {
|
package/src/rules/noBarrel.ts
CHANGED
|
@@ -24,6 +24,6 @@ export const noBarrel = defineRule({
|
|
|
24
24
|
return findings;
|
|
25
25
|
}),
|
|
26
26
|
description:
|
|
27
|
-
"Name modules after their purpose; import values from their defining module instead of exporting aliases, facades or unchanged forwarding calls.",
|
|
27
|
+
"Name modules after their purpose; import values from their defining module instead of exporting aliases, facades or unchanged forwarding calls. Wrappers that supply explicit type arguments keep their own meaning.",
|
|
28
28
|
id: "structure/no-barrel",
|
|
29
29
|
});
|
package/src/rules/secondNames.ts
CHANGED
|
@@ -18,7 +18,13 @@ function forwarding(node: ts.FunctionLikeDeclaration, origins: ReadonlyMap<strin
|
|
|
18
18
|
return undefined;
|
|
19
19
|
}
|
|
20
20
|
const call = returned(node.body);
|
|
21
|
-
if (
|
|
21
|
+
if (
|
|
22
|
+
call === undefined
|
|
23
|
+
|| !ts.isCallExpression(call)
|
|
24
|
+
|| call.questionDotToken !== undefined
|
|
25
|
+
|| call.typeArguments !== undefined
|
|
26
|
+
|| call.arguments.length !== node.parameters.length
|
|
27
|
+
) {
|
|
22
28
|
return undefined;
|
|
23
29
|
}
|
|
24
30
|
const visible = new Map(origins);
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
|
|
3
|
+
function concrete(type: ts.TypeNode | undefined): boolean {
|
|
4
|
+
return type !== undefined && type.kind !== ts.SyntaxKind.UnknownKeyword;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
function called(node: ts.Node, owner: string, method: string): node is ts.CallExpression {
|
|
8
|
+
return (
|
|
9
|
+
ts.isCallExpression(node)
|
|
10
|
+
&& ts.isPropertyAccessExpression(node.expression)
|
|
11
|
+
&& ts.isIdentifier(node.expression.expression)
|
|
12
|
+
&& ownerName(node.expression.expression) === owner
|
|
13
|
+
&& node.expression.name.text === method
|
|
14
|
+
);
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function ownerName(node: ts.Identifier): string {
|
|
18
|
+
for (const statement of node.getSourceFile().statements) {
|
|
19
|
+
if (!(ts.isImportDeclaration(statement) && ts.isStringLiteral(statement.moduleSpecifier))) {
|
|
20
|
+
continue;
|
|
21
|
+
}
|
|
22
|
+
const bindings = statement.importClause?.namedBindings;
|
|
23
|
+
if (bindings !== undefined && ts.isNamedImports(bindings)) {
|
|
24
|
+
const imported = bindings.elements.find((element) => element.name.text === node.text);
|
|
25
|
+
if (statement.moduleSpecifier.text === "effect" && imported !== undefined) {
|
|
26
|
+
return imported.propertyName?.text ?? imported.name.text;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
if (
|
|
30
|
+
bindings !== undefined
|
|
31
|
+
&& ts.isNamespaceImport(bindings)
|
|
32
|
+
&& bindings.name.text === node.text
|
|
33
|
+
&& statement.moduleSpecifier.text === "effect/Context"
|
|
34
|
+
) {
|
|
35
|
+
return "Context";
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return node.text;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
function unwrapped(node: ts.Expression): ts.Expression {
|
|
42
|
+
return ts.isParenthesizedExpression(node) ? unwrapped(node.expression) : node;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function bindingCast(node: ts.Node): string | undefined {
|
|
46
|
+
if (!ts.isVariableDeclaration(node) || node.initializer === undefined) {
|
|
47
|
+
return undefined;
|
|
48
|
+
}
|
|
49
|
+
const value = unwrapped(node.initializer);
|
|
50
|
+
if (called(value, "JSON", "parse") && concrete(node.type)) {
|
|
51
|
+
return `Assigns JSON.parse directly to ${node.type?.getText()}. Keep the result unknown and use Schema.decodeUnknownEffect with a schema for that declared type.`;
|
|
52
|
+
}
|
|
53
|
+
if (called(value, "Reflect", "get") && node.type?.kind !== ts.SyntaxKind.UnknownKeyword) {
|
|
54
|
+
return "Binds an unchecked Reflect.get result. Declare the result unknown and narrow it or use Schema.decodeUnknownEffect with the required schema.";
|
|
55
|
+
}
|
|
56
|
+
return undefined;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
function hasMapUnsafe(node: ts.Node): boolean {
|
|
60
|
+
return (ts.isPropertyAccessExpression(node) && node.name.text === "mapUnsafe") || ts.forEachChild(node, hasMapUnsafe) === true;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
function identityOverload(node: ts.Node): string | undefined {
|
|
64
|
+
if (!ts.isFunctionDeclaration(node) || node.body === undefined || node.type?.kind !== ts.SyntaxKind.UnknownKeyword || node.name === undefined) {
|
|
65
|
+
return undefined;
|
|
66
|
+
}
|
|
67
|
+
const statement = node.body.statements[0];
|
|
68
|
+
if (node.body.statements.length !== 1 || statement === undefined || !ts.isReturnStatement(statement) || statement.expression === undefined) {
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
const returned = unwrapped(statement.expression);
|
|
72
|
+
if (!(ts.isIdentifier(returned) && node.parameters.some((parameter) => ts.isIdentifier(parameter.name) && parameter.name.text === returned.text))) {
|
|
73
|
+
return undefined;
|
|
74
|
+
}
|
|
75
|
+
const siblings = ts.isSourceFile(node.parent) || ts.isBlock(node.parent) || ts.isModuleBlock(node.parent) ? node.parent.statements : [];
|
|
76
|
+
const overload = siblings.find(
|
|
77
|
+
(sibling) => ts.isFunctionDeclaration(sibling) && sibling.body === undefined && sibling.name?.text === node.name?.text && concrete(sibling.type),
|
|
78
|
+
);
|
|
79
|
+
return overload === undefined || !ts.isFunctionDeclaration(overload)
|
|
80
|
+
? undefined
|
|
81
|
+
: `An identity overload hides an unknown return value. Give the implementation the declared overload return type ${overload.type?.getText()} and let TypeScript check it; decode unknown input with Schema.decodeUnknownEffect.`;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function hiddenCast(node: ts.Node): string | undefined {
|
|
85
|
+
if (ts.isTaggedTemplateExpression(node) && node.typeArguments?.length && ts.isIdentifier(node.tag) && node.tag.text === "sql") {
|
|
86
|
+
return SQL_ROW_CAST;
|
|
87
|
+
}
|
|
88
|
+
if (called(node, "Context", "makeUnsafe") && node.arguments.some(hasMapUnsafe)) {
|
|
89
|
+
return "Retags a Context through mapUnsafe. Preserve its declared Context service type and use Context.add or Effect.provideService for the required services.";
|
|
90
|
+
}
|
|
91
|
+
return bindingCast(node) ?? identityOverload(node);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export const SQL_ROW_CAST =
|
|
95
|
+
"Declares SQL rows with a generic instead of checking them. Use SqlSchema.findAll or SqlSchema.findOne with the declared row schema to decode the result.";
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
import { join } from "node:path";
|
|
1
2
|
import ts from "typescript";
|
|
2
|
-
import { defineRule, type Finding, type SourceFile } from "#rule.ts";
|
|
3
|
+
import { defineRule, type Finding, type RuleInputs, type SourceFile } from "#rule.ts";
|
|
4
|
+
import { effectProgram } from "#rules/effect/program.ts";
|
|
3
5
|
import { parse } from "#rules/parse.ts";
|
|
6
|
+
import { hiddenCast, SQL_ROW_CAST } from "./hiddenCast.ts";
|
|
7
|
+
import { readonlyWrite, writeCandidate } from "./readonlyWrite.ts";
|
|
4
8
|
|
|
5
9
|
const BRIDGES: ReadonlyMap<ts.SyntaxKind, string> = new Map([
|
|
6
10
|
[ts.SyntaxKind.UnknownKeyword, "unknown"],
|
|
@@ -25,11 +29,14 @@ function bridgeOf(node: Assertion): string | undefined {
|
|
|
25
29
|
|
|
26
30
|
function castsIn(path: string, source: ts.SourceFile): readonly Finding[] {
|
|
27
31
|
const findings: Finding[] = [];
|
|
32
|
+
const hidden = !/(?:^|\/)(?:adapters|test-support)\//u.test(path);
|
|
28
33
|
function visit(node: ts.Node): void {
|
|
29
34
|
const bridge = isAssertion(node) ? bridgeOf(node) : undefined;
|
|
30
|
-
|
|
35
|
+
const implicit = hidden ? hiddenCast(node) : undefined;
|
|
36
|
+
const message = bridge === undefined ? implicit : `Casts through "${bridge}" to reach a type the value does not have.`;
|
|
37
|
+
if (message !== undefined) {
|
|
31
38
|
const line = source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1;
|
|
32
|
-
findings.push({ file: path, line, message
|
|
39
|
+
findings.push({ file: path, line, message });
|
|
33
40
|
}
|
|
34
41
|
ts.forEachChild(node, visit);
|
|
35
42
|
}
|
|
@@ -42,10 +49,59 @@ function doubleCasts(file: SourceFile): readonly Finding[] {
|
|
|
42
49
|
return source === undefined ? [] : castsIn(file.path, source);
|
|
43
50
|
}
|
|
44
51
|
|
|
52
|
+
function typedNodes(source: ts.SourceFile): readonly ts.Node[] {
|
|
53
|
+
const nodes: ts.Node[] = [];
|
|
54
|
+
function visit(node: ts.Node): void {
|
|
55
|
+
if (writeCandidate(node) || (ts.isTaggedTemplateExpression(node) && node.typeArguments?.length && node.tag.getText() !== "sql")) {
|
|
56
|
+
nodes.push(node);
|
|
57
|
+
}
|
|
58
|
+
ts.forEachChild(node, visit);
|
|
59
|
+
}
|
|
60
|
+
visit(source);
|
|
61
|
+
return nodes;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
function typedCast(node: ts.Node, checker: ts.TypeChecker): string | undefined {
|
|
65
|
+
if (ts.isTaggedTemplateExpression(node)) {
|
|
66
|
+
const nativeSql = checker
|
|
67
|
+
.getTypeAtLocation(node.tag)
|
|
68
|
+
.getSymbol()
|
|
69
|
+
?.getDeclarations()
|
|
70
|
+
?.some((declaration) =>
|
|
71
|
+
/(?:^|\/)effect\/(?:src|dist(?:\/[^/]+)?)\/sql\/(?:SqlClient|Statement)\.(?:d\.)?ts$/u.test(declaration.getSourceFile().fileName),
|
|
72
|
+
);
|
|
73
|
+
return nativeSql ? SQL_ROW_CAST : undefined;
|
|
74
|
+
}
|
|
75
|
+
return readonlyWrite(node, checker);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
function typedCasts(inputs: RuleInputs): readonly Finding[] {
|
|
79
|
+
const sources = inputs.sources.filter((file) => {
|
|
80
|
+
const source = parse(file);
|
|
81
|
+
return !/(?:^|\/)(?:adapters|test-support)\//u.test(file.path) && source !== undefined && typedNodes(source).length > 0;
|
|
82
|
+
});
|
|
83
|
+
if (sources.length === 0) {
|
|
84
|
+
return [];
|
|
85
|
+
}
|
|
86
|
+
const program = effectProgram({ ...inputs, sources });
|
|
87
|
+
const checker = program.getTypeChecker();
|
|
88
|
+
return sources.flatMap((file) => {
|
|
89
|
+
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
90
|
+
return source === undefined
|
|
91
|
+
? []
|
|
92
|
+
: typedNodes(source).flatMap((node) => {
|
|
93
|
+
const message = typedCast(node, checker);
|
|
94
|
+
return message === undefined
|
|
95
|
+
? []
|
|
96
|
+
: [{ file: file.path, line: source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1, message }];
|
|
97
|
+
});
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
|
|
45
101
|
export const noDoubleCast = defineRule({
|
|
46
|
-
check: (
|
|
102
|
+
check: (inputs) => [...inputs.sources.flatMap(doubleCasts), ...typedCasts(inputs)],
|
|
47
103
|
description:
|
|
48
|
-
"
|
|
104
|
+
"Decode unknown values with Schema.decodeUnknownEffect and SQL rows with SqlSchema. Check declared overload returns and preserve Context service types and readonly native fields. Reports double casts everywhere and hidden casts outside adapters/ and test-support/.",
|
|
49
105
|
id: "suppressions/no-double-cast",
|
|
50
106
|
registrable: false,
|
|
51
107
|
});
|