/
no-unnecessary-condition.ts
143 lines (132 loc) · 4.03 KB
/
no-unnecessary-condition.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
import {
TSESTree,
AST_NODE_TYPES,
} from '@typescript-eslint/experimental-utils';
import ts, { TypeFlags } from 'typescript';
import {
isTypeFlagSet,
unionTypeParts,
isFalsyType,
isBooleanLiteralType,
isLiteralType,
} from 'tsutils';
import {
createRule,
getParserServices,
getConstrainedTypeAtLocation,
} from '../util';
// Truthiness utilities
// #region
const isTruthyLiteral = (type: ts.Type) =>
isBooleanLiteralType(type, true) || (isLiteralType(type) && type.value);
const isPossiblyFalsy = (type: ts.Type) =>
unionTypeParts(type)
// PossiblyFalsy flag includes literal values, so exclude ones that
// are definitely truthy
.filter(t => !isTruthyLiteral(t))
.some(type => isTypeFlagSet(type, ts.TypeFlags.PossiblyFalsy));
const isPossiblyTruthy = (type: ts.Type) =>
unionTypeParts(type).some(type => !isFalsyType(type));
// #endregion
type ExpressionWithTest =
| TSESTree.ConditionalExpression
| TSESTree.DoWhileStatement
| TSESTree.ForStatement
| TSESTree.IfStatement
| TSESTree.WhileStatement;
type Options = [
{
ignoreRhs?: boolean;
}
];
export default createRule<Options, 'alwaysTruthy' | 'alwaysFalsy' | 'never'>({
name: 'no-unnecessary-conditionals',
meta: {
type: 'suggestion',
docs: {
description:
'Prevents conditionals where the type is always truthy or always falsy',
category: 'Best Practices',
recommended: false,
},
schema: [
{
type: 'object',
properties: {
ignoreRhs: {
type: 'boolean',
},
},
additionalProperties: false,
},
],
messages: {
alwaysTruthy: 'Unnecessary conditional, value is always truthy.',
alwaysFalsy: 'Unnecessary conditional, value is always falsy.',
never: 'Unnecessary conditional, value is `never`',
},
},
defaultOptions: [
{
ignoreRhs: false,
},
],
create(context, [{ ignoreRhs }]) {
const service = getParserServices(context);
const checker = service.program.getTypeChecker();
/**
* Checks if a conditional node is necessary:
* if the type of the node is always true or always false, it's not necessary.
*/
function checkNode(node: TSESTree.Node): void {
const tsNode = service.esTreeNodeToTSNodeMap.get<ts.ExpressionStatement>(
node,
);
const type = getConstrainedTypeAtLocation(checker, tsNode);
// Conditional is always necessary if it involves `any` or `unknown`
if (isTypeFlagSet(type, TypeFlags.Any | TypeFlags.Unknown)) {
return;
}
if (isTypeFlagSet(type, TypeFlags.Never)) {
context.report({ node, messageId: 'never' });
} else if (!isPossiblyTruthy(type)) {
context.report({ node, messageId: 'alwaysFalsy' });
} else if (!isPossiblyFalsy(type)) {
context.report({ node, messageId: 'alwaysTruthy' });
}
}
/**
* Checks that a testable expression is necessarily conditional, reports otherwise.
* Filters all LogicalExpressions to prevent some duplicate reports.
*/
function checkIfTestExpressionIsNecessaryConditional(
node: ExpressionWithTest,
): void {
if (
node.test !== null &&
node.test.type !== AST_NODE_TYPES.LogicalExpression
) {
checkNode(node.test);
}
}
/**
* Checks that a logical expression contains a boolean, reports otherwise.
*/
function checkLogicalExpressionForUnnecessaryConditionals(
node: TSESTree.LogicalExpression,
): void {
checkNode(node.left);
if (!ignoreRhs) {
checkNode(node.right);
}
}
return {
ConditionalExpression: checkIfTestExpressionIsNecessaryConditional,
DoWhileStatement: checkIfTestExpressionIsNecessaryConditional,
ForStatement: checkIfTestExpressionIsNecessaryConditional,
IfStatement: checkIfTestExpressionIsNecessaryConditional,
WhileStatement: checkIfTestExpressionIsNecessaryConditional,
LogicalExpression: checkLogicalExpressionForUnnecessaryConditionals,
};
},
});