@qualety/typescript 0.1.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/LICENSE +21 -0
- package/dist/exhaustive-switch.d.ts +8 -0
- package/dist/exhaustive-switch.d.ts.map +1 -0
- package/dist/exhaustive-switch.js +198 -0
- package/dist/exhaustive-switch.js.map +1 -0
- package/dist/explicit-public-return-types.d.ts +8 -0
- package/dist/explicit-public-return-types.d.ts.map +1 -0
- package/dist/explicit-public-return-types.js +123 -0
- package/dist/explicit-public-return-types.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +70 -0
- package/dist/index.js.map +1 -0
- package/dist/narrowing.d.ts +36 -0
- package/dist/narrowing.d.ts.map +1 -0
- package/dist/narrowing.js +776 -0
- package/dist/narrowing.js.map +1 -0
- package/dist/no-constant-condition.d.ts +8 -0
- package/dist/no-constant-condition.d.ts.map +1 -0
- package/dist/no-constant-condition.js +59 -0
- package/dist/no-constant-condition.js.map +1 -0
- package/dist/no-empty-catch.d.ts +7 -0
- package/dist/no-empty-catch.d.ts.map +1 -0
- package/dist/no-empty-catch.js +23 -0
- package/dist/no-empty-catch.js.map +1 -0
- package/dist/no-export-star.d.ts +7 -0
- package/dist/no-export-star.d.ts.map +1 -0
- package/dist/no-export-star.js +30 -0
- package/dist/no-export-star.js.map +1 -0
- package/dist/no-floating-promises.d.ts +14 -0
- package/dist/no-floating-promises.d.ts.map +1 -0
- package/dist/no-floating-promises.js +129 -0
- package/dist/no-floating-promises.js.map +1 -0
- package/dist/no-misused-promises.d.ts +8 -0
- package/dist/no-misused-promises.d.ts.map +1 -0
- package/dist/no-misused-promises.js +188 -0
- package/dist/no-misused-promises.js.map +1 -0
- package/dist/no-non-null-assertion.d.ts +7 -0
- package/dist/no-non-null-assertion.d.ts.map +1 -0
- package/dist/no-non-null-assertion.js +24 -0
- package/dist/no-non-null-assertion.js.map +1 -0
- package/dist/no-public-any.d.ts +8 -0
- package/dist/no-public-any.d.ts.map +1 -0
- package/dist/no-public-any.js +92 -0
- package/dist/no-public-any.js.map +1 -0
- package/dist/no-unnecessary-abstraction.d.ts +8 -0
- package/dist/no-unnecessary-abstraction.d.ts.map +1 -0
- package/dist/no-unnecessary-abstraction.js +452 -0
- package/dist/no-unnecessary-abstraction.js.map +1 -0
- package/dist/no-unsafe-assertion.d.ts +7 -0
- package/dist/no-unsafe-assertion.d.ts.map +1 -0
- package/dist/no-unsafe-assertion.js +38 -0
- package/dist/no-unsafe-assertion.js.map +1 -0
- package/dist/parse-flow.d.ts +16 -0
- package/dist/parse-flow.d.ts.map +1 -0
- package/dist/parse-flow.js +136 -0
- package/dist/parse-flow.js.map +1 -0
- package/dist/public-exports-tested.d.ts +8 -0
- package/dist/public-exports-tested.d.ts.map +1 -0
- package/dist/public-exports-tested.js +170 -0
- package/dist/public-exports-tested.js.map +1 -0
- package/dist/ts-source.d.ts +5 -0
- package/dist/ts-source.d.ts.map +1 -0
- package/dist/ts-source.js +28 -0
- package/dist/ts-source.js.map +1 -0
- package/dist/type-narrowing-checks.d.ts +8 -0
- package/dist/type-narrowing-checks.d.ts.map +1 -0
- package/dist/type-narrowing-checks.js +99 -0
- package/dist/type-narrowing-checks.js.map +1 -0
- package/dist/zod-boundary.d.ts +8 -0
- package/dist/zod-boundary.d.ts.map +1 -0
- package/dist/zod-boundary.js +110 -0
- package/dist/zod-boundary.js.map +1 -0
- package/package.json +44 -0
- package/tsconfig/recommended.json +11 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 NavehBrenner
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type RuleContext } from "qualety";
|
|
2
|
+
export declare const exhaustiveSwitch: {
|
|
3
|
+
meta: import("qualety").RuleMeta & {
|
|
4
|
+
requires?: readonly ["typescript"] | undefined;
|
|
5
|
+
};
|
|
6
|
+
create(context: RuleContext<readonly ["typescript"]>): void | import("qualety").RuleListener;
|
|
7
|
+
};
|
|
8
|
+
//# sourceMappingURL=exhaustive-switch.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exhaustive-switch.d.ts","sourceRoot":"","sources":["../src/exhaustive-switch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAOvD,eAAO,MAAM,gBAAgB;;;;;CAkB3B,CAAC"}
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
import { defineRule } from "qualety";
|
|
2
|
+
import { Node, SyntaxKind } from "ts-morph";
|
|
3
|
+
import { isFunctionLike } from "./parse-flow.js";
|
|
4
|
+
import { reportAt, walkTsSources } from "./ts-source.js";
|
|
5
|
+
const HINT = "Add the missing case(s) or `const _exhaustive: never = …`.";
|
|
6
|
+
export const exhaustiveSwitch = defineRule({
|
|
7
|
+
meta: {
|
|
8
|
+
requires: ["typescript"],
|
|
9
|
+
docs: {
|
|
10
|
+
description: "Switch on a finite union or enum must handle every member or use a never-typed default.",
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
create(context) {
|
|
14
|
+
const artifact = context.getArtifact("typescript");
|
|
15
|
+
walkTsSources(artifact.sources, (unit, file) => {
|
|
16
|
+
for (const node of unit.getDescendantsOfKind(SyntaxKind.SwitchStatement)) {
|
|
17
|
+
if (Node.isSwitchStatement(node)) {
|
|
18
|
+
considerSwitch(node, file, context);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
function considerSwitch(stmt, file, context) {
|
|
25
|
+
if (!Node.isSwitchStatement(stmt)) {
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
const units = finiteUnits(stmt.getExpression().getType());
|
|
29
|
+
if (units === undefined) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
const remaining = uncoveredUnits(stmt, units);
|
|
33
|
+
if (remaining === undefined || remaining.length === 0) {
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
const names = remaining
|
|
37
|
+
.map((type) => type.getText())
|
|
38
|
+
.filter((text) => text.length <= 40 && !text.includes("import("));
|
|
39
|
+
const listed = names.length > 0 ? names.join(", ") : "union members";
|
|
40
|
+
reportAt(context, file, stmt.getExpression(), `Switch is missing case(s) ${listed}.`, HINT);
|
|
41
|
+
}
|
|
42
|
+
function uncoveredUnits(stmt, units) {
|
|
43
|
+
if (!Node.isSwitchStatement(stmt)) {
|
|
44
|
+
return units;
|
|
45
|
+
}
|
|
46
|
+
const remaining = [...units];
|
|
47
|
+
for (const clause of stmt.getCaseBlock().getClauses()) {
|
|
48
|
+
if (Node.isDefaultClause(clause)) {
|
|
49
|
+
if (hasExhaustiveDefault(clause)) {
|
|
50
|
+
return undefined;
|
|
51
|
+
}
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
if (Node.isCaseClause(clause)) {
|
|
55
|
+
dropCovered(remaining, clause.getExpression().getType());
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return remaining;
|
|
59
|
+
}
|
|
60
|
+
function dropCovered(remaining, caseType) {
|
|
61
|
+
for (let index = remaining.length - 1; index >= 0; index -= 1) {
|
|
62
|
+
const member = remaining[index];
|
|
63
|
+
if (member !== undefined && sameUnit(caseType, member)) {
|
|
64
|
+
remaining.splice(index, 1);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
function finiteUnits(type) {
|
|
69
|
+
if (type.isAny() || type.isUnknown() || type.getText() === "error") {
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
const parts = type.isUnion() ? type.getUnionTypes() : [type];
|
|
73
|
+
const units = [];
|
|
74
|
+
for (const part of parts) {
|
|
75
|
+
if (part.isNever()) {
|
|
76
|
+
continue;
|
|
77
|
+
}
|
|
78
|
+
if (part.isEnum()) {
|
|
79
|
+
const members = enumMemberTypes(part);
|
|
80
|
+
if (members === undefined) {
|
|
81
|
+
return undefined;
|
|
82
|
+
}
|
|
83
|
+
units.push(...members);
|
|
84
|
+
continue;
|
|
85
|
+
}
|
|
86
|
+
if (!(part.isStringLiteral() ||
|
|
87
|
+
part.isNumberLiteral() ||
|
|
88
|
+
part.isBooleanLiteral() ||
|
|
89
|
+
part.isNull() ||
|
|
90
|
+
part.isUndefined() ||
|
|
91
|
+
part.isEnumLiteral())) {
|
|
92
|
+
return undefined;
|
|
93
|
+
}
|
|
94
|
+
units.push(part);
|
|
95
|
+
}
|
|
96
|
+
if (units.length === 0) {
|
|
97
|
+
return undefined;
|
|
98
|
+
}
|
|
99
|
+
return units;
|
|
100
|
+
}
|
|
101
|
+
function enumMemberTypes(type) {
|
|
102
|
+
const symbol = type.getSymbol();
|
|
103
|
+
if (symbol === undefined) {
|
|
104
|
+
return undefined;
|
|
105
|
+
}
|
|
106
|
+
const members = [];
|
|
107
|
+
for (const exported of symbol.getExports()) {
|
|
108
|
+
const decl = exported.getDeclarations()[0];
|
|
109
|
+
if (decl === undefined || !Node.isEnumMember(decl)) {
|
|
110
|
+
continue;
|
|
111
|
+
}
|
|
112
|
+
members.push(decl.getType());
|
|
113
|
+
}
|
|
114
|
+
if (members.length === 0) {
|
|
115
|
+
return undefined;
|
|
116
|
+
}
|
|
117
|
+
return members;
|
|
118
|
+
}
|
|
119
|
+
function sameUnit(left, right) {
|
|
120
|
+
if (left.getText() === right.getText()) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
if (left.isAssignableTo(right) && right.isAssignableTo(left)) {
|
|
124
|
+
return true;
|
|
125
|
+
}
|
|
126
|
+
const leftValue = unitValue(left);
|
|
127
|
+
const rightValue = unitValue(right);
|
|
128
|
+
return leftValue !== undefined && leftValue === rightValue;
|
|
129
|
+
}
|
|
130
|
+
function unitValue(type) {
|
|
131
|
+
if (type.isNull()) {
|
|
132
|
+
return "null";
|
|
133
|
+
}
|
|
134
|
+
if (type.isUndefined()) {
|
|
135
|
+
return "undefined";
|
|
136
|
+
}
|
|
137
|
+
if (type.isBooleanLiteral()) {
|
|
138
|
+
return type.getText();
|
|
139
|
+
}
|
|
140
|
+
if (type.isNumberLiteral()) {
|
|
141
|
+
return `v:${type.getText()}`;
|
|
142
|
+
}
|
|
143
|
+
if (type.isStringLiteral()) {
|
|
144
|
+
return unquote(type.getText());
|
|
145
|
+
}
|
|
146
|
+
return enumMemberValue(type);
|
|
147
|
+
}
|
|
148
|
+
function unquote(text) {
|
|
149
|
+
if (text.startsWith('"') || text.startsWith("'")) {
|
|
150
|
+
if (text.endsWith('"') || text.endsWith("'")) {
|
|
151
|
+
return text.slice(1, -1);
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
return text;
|
|
155
|
+
}
|
|
156
|
+
function enumMemberValue(type) {
|
|
157
|
+
const decl = type.getSymbol()?.getDeclarations()[0];
|
|
158
|
+
if (decl === undefined || !Node.isEnumMember(decl)) {
|
|
159
|
+
return undefined;
|
|
160
|
+
}
|
|
161
|
+
const value = decl.getValue();
|
|
162
|
+
if (typeof value === "number") {
|
|
163
|
+
return `v:${value}`;
|
|
164
|
+
}
|
|
165
|
+
if (typeof value === "string") {
|
|
166
|
+
return value;
|
|
167
|
+
}
|
|
168
|
+
return undefined;
|
|
169
|
+
}
|
|
170
|
+
function hasExhaustiveDefault(clause) {
|
|
171
|
+
for (const node of clause.getDescendants()) {
|
|
172
|
+
if (nestedInFunction(node, clause)) {
|
|
173
|
+
continue;
|
|
174
|
+
}
|
|
175
|
+
if (Node.isVariableDeclaration(node) && node.getTypeNode()?.getText().trim() === "never") {
|
|
176
|
+
return true;
|
|
177
|
+
}
|
|
178
|
+
if (Node.isReturnStatement(node)) {
|
|
179
|
+
const expr = node.getExpression();
|
|
180
|
+
if (expr !== undefined &&
|
|
181
|
+
(expr.getType().isNever() || expr.getType().getText() === "never")) {
|
|
182
|
+
return true;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
return false;
|
|
187
|
+
}
|
|
188
|
+
function nestedInFunction(node, root) {
|
|
189
|
+
let current = node.getParent();
|
|
190
|
+
while (current !== undefined && current !== root) {
|
|
191
|
+
if (isFunctionLike(current)) {
|
|
192
|
+
return true;
|
|
193
|
+
}
|
|
194
|
+
current = current.getParent();
|
|
195
|
+
}
|
|
196
|
+
return false;
|
|
197
|
+
}
|
|
198
|
+
//# sourceMappingURL=exhaustive-switch.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exhaustive-switch.js","sourceRoot":"","sources":["../src/exhaustive-switch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAoB,MAAM,SAAS,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAa,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEzD,MAAM,IAAI,GAAG,4DAA4D,CAAC;AAE1E,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACzC,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,YAAY,CAAC;QACxB,IAAI,EAAE;YACJ,WAAW,EACT,yFAAyF;SAC5F;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACnD,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAC7C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;gBACzE,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,cAAc,CAAC,IAAU,EAAE,IAAY,EAAE,OAAoC;IACpF,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IACD,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9C,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,SAAS;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;SAC7B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC;IACrE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,6BAA6B,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;AAC9F,CAAC;AAED,SAAS,cAAc,CAAC,IAAU,EAAE,KAAa;IAC/C,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,WAAW,CAAC,SAAiB,EAAE,QAAc;IACpD,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC9D,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;YACvD,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,IAAU;IAC7B,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,OAAO,EAAE,CAAC;QACnE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAClB,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YACvB,SAAS;QACX,CAAC;QACD,IACE,CAAC,CACC,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,gBAAgB,EAAE;YACvB,IAAI,CAAC,MAAM,EAAE;YACb,IAAI,CAAC,WAAW,EAAE;YAClB,IAAI,CAAC,aAAa,EAAE,CACrB,EACD,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,IAAU;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAW,EAAE,CAAC;IAC3B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,KAAW;IACvC,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED,SAAS,SAAS,CAAC,IAAU;IAC3B,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QAC3B,OAAO,KAAK,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QAC3B,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACjD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,IAAU;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,KAAK,EAAE,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAY;IACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACnC,SAAS;QACX,CAAC;QACD,IAAI,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;YACzF,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAClC,IACE,IAAI,KAAK,SAAS;gBAClB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,OAAO,CAAC,EAClE,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAU,EAAE,IAAU;IAC9C,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAC/B,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACjD,IAAI,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type RuleContext } from "qualety";
|
|
2
|
+
export declare const explicitPublicReturnTypes: {
|
|
3
|
+
meta: import("qualety").RuleMeta & {
|
|
4
|
+
requires?: readonly ["typescript"] | undefined;
|
|
5
|
+
};
|
|
6
|
+
create(context: RuleContext<readonly ["typescript"]>): void | import("qualety").RuleListener;
|
|
7
|
+
};
|
|
8
|
+
//# sourceMappingURL=explicit-public-return-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"explicit-public-return-types.d.ts","sourceRoot":"","sources":["../src/explicit-public-return-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAMvD,eAAO,MAAM,yBAAyB;;;;;CAiBpC,CAAC"}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { defineRule } from "qualety";
|
|
2
|
+
import { Node, SyntaxKind } from "ts-morph";
|
|
3
|
+
import { unwrapParens } from "./narrowing.js";
|
|
4
|
+
import { isFunctionLike } from "./parse-flow.js";
|
|
5
|
+
import { reportAt, walkTsSources } from "./ts-source.js";
|
|
6
|
+
export const explicitPublicReturnTypes = defineRule({
|
|
7
|
+
meta: {
|
|
8
|
+
requires: ["typescript"],
|
|
9
|
+
docs: {
|
|
10
|
+
description: "Exported functions and public class methods must have an explicit return type.",
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
create(context) {
|
|
14
|
+
const artifact = context.getArtifact("typescript");
|
|
15
|
+
walkTsSources(artifact.sources, (unit, file) => {
|
|
16
|
+
for (const stmt of unit.getStatements()) {
|
|
17
|
+
if (stmt.getPos() >= 0) {
|
|
18
|
+
considerStatement(stmt, file, context);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
function considerStatement(stmt, file, context) {
|
|
25
|
+
if (considerExportedFunction(stmt, file, context) || considerExportedVars(stmt, file, context)) {
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
if (Node.isClassDeclaration(stmt) && stmt.hasExportKeyword() && !stmt.hasDeclareKeyword()) {
|
|
29
|
+
considerClass(stmt, stmt.getName() ?? "default", file, context);
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
if (Node.isExportAssignment(stmt) && !stmt.isExportEquals()) {
|
|
33
|
+
const expr = unwrapParens(stmt.getExpression());
|
|
34
|
+
if (isFunctionLike(expr)) {
|
|
35
|
+
considerFn(expr, "default", file, context);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
function considerExportedFunction(stmt, file, context) {
|
|
40
|
+
if (Node.isFunctionDeclaration(stmt)) {
|
|
41
|
+
if (stmt.hasExportKeyword() && !stmt.hasDeclareKeyword()) {
|
|
42
|
+
const name = stmt.isDefaultExport() ? "default" : (stmt.getName() ?? "default");
|
|
43
|
+
considerFn(stmt, name, file, context);
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
return false;
|
|
48
|
+
}
|
|
49
|
+
function considerExportedVars(stmt, file, context) {
|
|
50
|
+
if (Node.isVariableStatement(stmt)) {
|
|
51
|
+
if (stmt.hasExportKeyword()) {
|
|
52
|
+
for (const decl of stmt.getDeclarations()) {
|
|
53
|
+
considerVar(decl, file, context);
|
|
54
|
+
}
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return false;
|
|
59
|
+
}
|
|
60
|
+
function considerVar(decl, file, context) {
|
|
61
|
+
const init = decl.getInitializer();
|
|
62
|
+
if (init === undefined) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
const expr = unwrapParens(init);
|
|
66
|
+
if (!isFunctionLike(expr)) {
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
if (decl.getTypeNode() !== undefined && decl.getType().getCallSignatures().length > 0) {
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
considerFn(expr, decl.getName(), file, context);
|
|
73
|
+
}
|
|
74
|
+
function considerClass(stmt, className, file, context) {
|
|
75
|
+
if (!Node.isClassDeclaration(stmt)) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
for (const member of stmt.getMembers()) {
|
|
79
|
+
if (Node.isMethodDeclaration(member) && publicMember(member)) {
|
|
80
|
+
considerFn(member, `${className}.${member.getName()}`, file, context);
|
|
81
|
+
}
|
|
82
|
+
if (Node.isGetAccessorDeclaration(member) && publicMember(member)) {
|
|
83
|
+
considerGetter(member, `${className}.${member.getName()}`, file, context);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
function publicMember(member) {
|
|
88
|
+
if (!Node.isMethodDeclaration(member) && !Node.isGetAccessorDeclaration(member)) {
|
|
89
|
+
return false;
|
|
90
|
+
}
|
|
91
|
+
if (member.hasModifier(SyntaxKind.PrivateKeyword) ||
|
|
92
|
+
member.hasModifier(SyntaxKind.ProtectedKeyword)) {
|
|
93
|
+
return false;
|
|
94
|
+
}
|
|
95
|
+
return !Node.isPrivateIdentifier(member.getNameNode());
|
|
96
|
+
}
|
|
97
|
+
function considerFn(fn, name, file, context) {
|
|
98
|
+
if (fn.getReturnTypeNode() !== undefined) {
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
const at = Node.isFunctionDeclaration(fn) || Node.isMethodDeclaration(fn) || Node.isFunctionExpression(fn)
|
|
102
|
+
? (fn.getNameNode() ?? fn)
|
|
103
|
+
: fn;
|
|
104
|
+
reportAt(context, file, at, `Public export "${name}" is missing an explicit return type.`, returnHint(fn));
|
|
105
|
+
}
|
|
106
|
+
function considerGetter(getter, name, file, context) {
|
|
107
|
+
if (getter.getReturnTypeNode() !== undefined) {
|
|
108
|
+
return;
|
|
109
|
+
}
|
|
110
|
+
reportAt(context, file, getter.getNameNode() ?? getter, `Public export "${name}" is missing an explicit return type.`, returnHint(getter));
|
|
111
|
+
}
|
|
112
|
+
function returnHint(fn) {
|
|
113
|
+
const text = fn.getReturnType().getText();
|
|
114
|
+
if (text === "error" ||
|
|
115
|
+
text === "any" ||
|
|
116
|
+
text === "unknown" ||
|
|
117
|
+
text.length > 40 ||
|
|
118
|
+
text.includes("import(")) {
|
|
119
|
+
return "Add an explicit return type annotation.";
|
|
120
|
+
}
|
|
121
|
+
return `Add an explicit return type (e.g. ): ${text}).`;
|
|
122
|
+
}
|
|
123
|
+
//# sourceMappingURL=explicit-public-return-types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"explicit-public-return-types.js","sourceRoot":"","sources":["../src/explicit-public-return-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAoB,MAAM,SAAS,CAAC;AACvD,OAAO,EAA+B,IAAI,EAAE,UAAU,EAA4B,MAAM,UAAU,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAqB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEzD,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC;IAClD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,YAAY,CAAC;QACxB,IAAI,EAAE;YACJ,WAAW,EAAE,gFAAgF;SAC9F;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACnD,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAC7C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;gBACxC,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;oBACvB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,iBAAiB,CAAC,IAAU,EAAE,IAAY,EAAE,OAAoC;IACvF,IAAI,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QAC/F,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;QAC1F,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAChE,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAChD,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAC/B,IAAU,EACV,IAAY,EACZ,OAAoC;IAEpC,IAAI,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YACzD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,SAAS,CAAC,CAAC;YAChF,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAC3B,IAAU,EACV,IAAY,EACZ,OAAoC;IAEpC,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;YAC5B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;gBAC1C,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAClB,IAAyB,EACzB,IAAY,EACZ,OAAoC;IAEpC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,iBAAiB,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtF,OAAO;IACT,CAAC;IACD,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,aAAa,CACpB,IAAU,EACV,SAAiB,EACjB,IAAY,EACZ,OAAoC;IAEpC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,OAAO;IACT,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7D,UAAU,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACxE,CAAC;QACD,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAClE,cAAc,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAY;IAChC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IACE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAC/C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,UAAU,CACjB,EAAgB,EAChB,IAAY,EACZ,IAAY,EACZ,OAAoC;IAEpC,IAAI,EAAE,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO;IACT,CAAC;IACD,MAAM,EAAE,GACN,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAC7F,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;QAC1B,CAAC,CAAC,EAAE,CAAC;IACT,QAAQ,CACN,OAAO,EACP,IAAI,EACJ,EAAE,EACF,kBAAkB,IAAI,uCAAuC,EAC7D,UAAU,CAAC,EAAE,CAAC,CACf,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CACrB,MAA8B,EAC9B,IAAY,EACZ,IAAY,EACZ,OAAoC;IAEpC,IAAI,MAAM,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;QAC7C,OAAO;IACT,CAAC;IACD,QAAQ,CACN,OAAO,EACP,IAAI,EACJ,MAAM,CAAC,WAAW,EAAE,IAAI,MAAM,EAC9B,kBAAkB,IAAI,uCAAuC,EAC7D,UAAU,CAAC,MAAM,CAAC,CACnB,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,EAAyC;IAC3D,MAAM,IAAI,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,CAAC;IAC1C,IACE,IAAI,KAAK,OAAO;QAChB,IAAI,KAAK,KAAK;QACd,IAAI,KAAK,SAAS;QAClB,IAAI,CAAC,MAAM,GAAG,EAAE;QAChB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EACxB,CAAC;QACD,OAAO,yCAAyC,CAAC;IACnD,CAAC;IACD,OAAO,wCAAwC,IAAI,IAAI,CAAC;AAC1D,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAgBtC,QAAA,MAAM,MAAM,EAAE,MAoDb,CAAC;eAEa,MAAM;AACrB,OAAO,EAAE,MAAM,EAAE,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { exhaustiveSwitch } from "./exhaustive-switch.js";
|
|
2
|
+
import { explicitPublicReturnTypes } from "./explicit-public-return-types.js";
|
|
3
|
+
import { noConstantCondition } from "./no-constant-condition.js";
|
|
4
|
+
import { noEmptyCatch } from "./no-empty-catch.js";
|
|
5
|
+
import { noExportStar } from "./no-export-star.js";
|
|
6
|
+
import { noFloatingPromises } from "./no-floating-promises.js";
|
|
7
|
+
import { noMisusedPromises } from "./no-misused-promises.js";
|
|
8
|
+
import { noNonNullAssertion } from "./no-non-null-assertion.js";
|
|
9
|
+
import { noPublicAny } from "./no-public-any.js";
|
|
10
|
+
import { noUnnecessaryAbstraction } from "./no-unnecessary-abstraction.js";
|
|
11
|
+
import { noUnsafeAssertion } from "./no-unsafe-assertion.js";
|
|
12
|
+
import { publicExportsTested } from "./public-exports-tested.js";
|
|
13
|
+
import { typeNarrowingChecks } from "./type-narrowing-checks.js";
|
|
14
|
+
import { zodBoundary } from "./zod-boundary.js";
|
|
15
|
+
const plugin = {
|
|
16
|
+
name: "ts",
|
|
17
|
+
rules: {
|
|
18
|
+
"exhaustive-switch": exhaustiveSwitch,
|
|
19
|
+
"explicit-public-return-types": explicitPublicReturnTypes,
|
|
20
|
+
"no-constant-condition": noConstantCondition,
|
|
21
|
+
"no-empty-catch": noEmptyCatch,
|
|
22
|
+
"no-export-star": noExportStar,
|
|
23
|
+
"no-floating-promises": noFloatingPromises,
|
|
24
|
+
"no-misused-promises": noMisusedPromises,
|
|
25
|
+
"no-non-null-assertion": noNonNullAssertion,
|
|
26
|
+
"no-public-any": noPublicAny,
|
|
27
|
+
"no-unnecessary-abstraction": noUnnecessaryAbstraction,
|
|
28
|
+
"no-unsafe-assertion": noUnsafeAssertion,
|
|
29
|
+
"public-exports-tested": publicExportsTested,
|
|
30
|
+
"type-narrowing-checks": typeNarrowingChecks,
|
|
31
|
+
"zod-boundary": zodBoundary,
|
|
32
|
+
},
|
|
33
|
+
configs: {
|
|
34
|
+
recommended: {
|
|
35
|
+
rules: {
|
|
36
|
+
"ts/exhaustive-switch": "error",
|
|
37
|
+
"ts/explicit-public-return-types": "error",
|
|
38
|
+
"ts/no-constant-condition": "error",
|
|
39
|
+
"ts/no-empty-catch": "error",
|
|
40
|
+
"ts/no-export-star": "error",
|
|
41
|
+
"ts/no-floating-promises": "error",
|
|
42
|
+
"ts/no-misused-promises": "error",
|
|
43
|
+
"ts/no-non-null-assertion": "error",
|
|
44
|
+
"ts/no-public-any": "error",
|
|
45
|
+
"ts/no-unnecessary-abstraction": "error",
|
|
46
|
+
"ts/no-unsafe-assertion": "error",
|
|
47
|
+
"ts/public-exports-tested": "error",
|
|
48
|
+
"ts/type-narrowing-checks": "error",
|
|
49
|
+
"ts/zod-boundary": "error",
|
|
50
|
+
},
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
biome: {
|
|
54
|
+
rules: {
|
|
55
|
+
"nursery/noUnsafeTypeAssertion": "error",
|
|
56
|
+
"complexity/noExcessiveCognitiveComplexity": ["error", { maxAllowedComplexity: 15 }],
|
|
57
|
+
"suspicious/noExplicitAny": "error",
|
|
58
|
+
"style/noNonNullAssertion": "error",
|
|
59
|
+
"suspicious/noTsIgnore": "error",
|
|
60
|
+
"complexity/noBannedTypes": "error",
|
|
61
|
+
"suspicious/noFocusedTests": "error",
|
|
62
|
+
"correctness/noUnusedFunctionParameters": "error",
|
|
63
|
+
"style/useThrowOnlyError": "error",
|
|
64
|
+
"nursery/noImpliedEval": "error",
|
|
65
|
+
},
|
|
66
|
+
},
|
|
67
|
+
};
|
|
68
|
+
export default plugin;
|
|
69
|
+
export { plugin };
|
|
70
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,MAAM,GAAW;IACrB,IAAI,EAAE,IAAI;IACV,KAAK,EAAE;QACL,mBAAmB,EAAE,gBAAgB;QACrC,8BAA8B,EAAE,yBAAyB;QACzD,uBAAuB,EAAE,mBAAmB;QAC5C,gBAAgB,EAAE,YAAY;QAC9B,gBAAgB,EAAE,YAAY;QAC9B,sBAAsB,EAAE,kBAAkB;QAC1C,qBAAqB,EAAE,iBAAiB;QACxC,uBAAuB,EAAE,kBAAkB;QAC3C,eAAe,EAAE,WAAW;QAC5B,4BAA4B,EAAE,wBAAwB;QACtD,qBAAqB,EAAE,iBAAiB;QACxC,uBAAuB,EAAE,mBAAmB;QAC5C,uBAAuB,EAAE,mBAAmB;QAC5C,cAAc,EAAE,WAAW;KAC5B;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,KAAK,EAAE;gBACL,sBAAsB,EAAE,OAAO;gBAC/B,iCAAiC,EAAE,OAAO;gBAC1C,0BAA0B,EAAE,OAAO;gBACnC,mBAAmB,EAAE,OAAO;gBAC5B,mBAAmB,EAAE,OAAO;gBAC5B,yBAAyB,EAAE,OAAO;gBAClC,wBAAwB,EAAE,OAAO;gBACjC,0BAA0B,EAAE,OAAO;gBACnC,kBAAkB,EAAE,OAAO;gBAC3B,+BAA+B,EAAE,OAAO;gBACxC,wBAAwB,EAAE,OAAO;gBACjC,0BAA0B,EAAE,OAAO;gBACnC,0BAA0B,EAAE,OAAO;gBACnC,iBAAiB,EAAE,OAAO;aAC3B;SACF;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE;YACL,+BAA+B,EAAE,OAAO;YACxC,2CAA2C,EAAE,CAAC,OAAO,EAAE,EAAE,oBAAoB,EAAE,EAAE,EAAE,CAAC;YACpF,0BAA0B,EAAE,OAAO;YACnC,0BAA0B,EAAE,OAAO;YACnC,uBAAuB,EAAE,OAAO;YAChC,0BAA0B,EAAE,OAAO;YACnC,2BAA2B,EAAE,OAAO;YACpC,wCAAwC,EAAE,OAAO;YACjD,yBAAyB,EAAE,OAAO;YAClC,uBAAuB,EAAE,OAAO;SACjC;KACF;CACF,CAAC;AAEF,eAAe,MAAM,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { RuleContext } from "qualety";
|
|
2
|
+
import { Node, SourceFile, type Type } from "ts-morph";
|
|
3
|
+
import { type FunctionLike, isFunctionLike } from "./parse-flow.ts";
|
|
4
|
+
export type CheckCandidate = {
|
|
5
|
+
node: Node;
|
|
6
|
+
subject: string;
|
|
7
|
+
kind: "predicate" | "typeof" | "instanceof" | "nullish" | "truthiness" | "nonempty" | "schema-parse";
|
|
8
|
+
};
|
|
9
|
+
export type ConstantHit = {
|
|
10
|
+
polarity: "true" | "false";
|
|
11
|
+
reason: "param-type" | "prior-guard" | "call-site" | "literal" | "prior-parse";
|
|
12
|
+
suggestion: string;
|
|
13
|
+
reportAt: Node;
|
|
14
|
+
message?: string;
|
|
15
|
+
};
|
|
16
|
+
export declare function unwrapParens(node: Node): Node;
|
|
17
|
+
export declare function splitNegation(node: Node): {
|
|
18
|
+
inner: Node;
|
|
19
|
+
negated: boolean;
|
|
20
|
+
};
|
|
21
|
+
export declare function bindFunctionScan(scan: (fn: FunctionLike, file: string, sourceFile: SourceFile, context: Pick<RuleContext, "report">, reported: Set<string>) => void): (context: RuleContext) => void;
|
|
22
|
+
export declare function classifyCondition(fn: FunctionLike, cond: Node): CheckCandidate | undefined;
|
|
23
|
+
export declare function conditionLeaves(fn: FunctionLike, cond: Node): CheckCandidate[];
|
|
24
|
+
export declare function diagnoseConstant(fn: FunctionLike, cond: Node, sourceFile: SourceFile): ConstantHit | undefined;
|
|
25
|
+
export declare function mixedHitsForCondition(fn: FunctionLike, cond: Node, sourceFile: SourceFile): ConstantHit[];
|
|
26
|
+
export declare function secondParseNodes(fn: FunctionLike): Node[];
|
|
27
|
+
export declare function hasPriorParse(fn: FunctionLike, subject: string, before: number): boolean;
|
|
28
|
+
export declare function isStrictRefinement(before: Type, after: Type): boolean;
|
|
29
|
+
export declare function subjectIdentIn(root: Node, name: string): Node | undefined;
|
|
30
|
+
export declare function conditionNodes(fn: FunctionLike): Node[];
|
|
31
|
+
export declare function truePathRoot(cond: Node): Node | undefined;
|
|
32
|
+
export declare function shouldReportUnchanged(cand: CheckCandidate, before: Type, after: Type): boolean;
|
|
33
|
+
export declare function enclosingFunction(node: Node): FunctionLike | undefined;
|
|
34
|
+
export type { FunctionLike };
|
|
35
|
+
export { isFunctionLike };
|
|
36
|
+
//# sourceMappingURL=narrowing.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"narrowing.d.ts","sourceRoot":"","sources":["../src/narrowing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAEL,IAAI,EACJ,UAAU,EAEV,KAAK,IAAI,EAEV,MAAM,UAAU,CAAC;AAClB,OAAO,EAEL,KAAK,YAAY,EAEjB,cAAc,EAGf,MAAM,iBAAiB,CAAC;AAEzB,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EACA,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,UAAU,GACV,cAAc,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,YAAY,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,aAAa,CAAC;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAYF,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAM7C;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAW3E;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,CACJ,EAAE,EAAE,YAAY,EAChB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,EACpC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,KAClB,IAAI,GACR,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAehC;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,GAAG,SAAS,CAG1F;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,EAAE,CAe9E;AAgHD,wBAAgB,gBAAgB,CAC9B,EAAE,EAAE,YAAY,EAChB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,UAAU,GACrB,WAAW,GAAG,SAAS,CAgBzB;AAgED,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,YAAY,EAChB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,UAAU,GACrB,WAAW,EAAE,CAkBf;AA2BD,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,EAAE,CAsBzD;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAYxF;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAKrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAUzE;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,EAAE,CAWvD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAgBzD;AA6FD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAqB9F;AAkKD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,GAAG,SAAS,CAStE;AA0ND,YAAY,EAAE,YAAY,EAAE,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAC"}
|