@typescript-eslint/eslint-plugin 8.7.1-alpha.10 → 8.7.1-alpha.11
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.
|
@@ -59,48 +59,48 @@ exports.default = (0, util_1.createRule)({
|
|
|
59
59
|
}
|
|
60
60
|
return false;
|
|
61
61
|
}
|
|
62
|
-
function isAllowedBitwiseOperand(decl, node) {
|
|
63
|
-
return (node.type === utils_1.AST_NODE_TYPES.Literal || isSelfEnumMember(decl, node));
|
|
64
|
-
}
|
|
65
62
|
return {
|
|
66
63
|
TSEnumMember(node) {
|
|
67
64
|
// If there is no initializer, then this node is just the name of the member, so ignore.
|
|
68
65
|
if (node.initializer == null) {
|
|
69
66
|
return;
|
|
70
67
|
}
|
|
71
|
-
// any old literal
|
|
72
|
-
if (node.initializer.type === utils_1.AST_NODE_TYPES.Literal) {
|
|
73
|
-
return;
|
|
74
|
-
}
|
|
75
|
-
// TemplateLiteral without expressions
|
|
76
|
-
if (node.initializer.type === utils_1.AST_NODE_TYPES.TemplateLiteral &&
|
|
77
|
-
node.initializer.expressions.length === 0) {
|
|
78
|
-
return;
|
|
79
|
-
}
|
|
80
68
|
const declaration = node.parent.parent;
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
return;
|
|
69
|
+
function isAllowedInitializerExpressionRecursive(node, partOfBitwiseComputation) {
|
|
70
|
+
// You can only refer to an enum member if it's part of a bitwise computation.
|
|
71
|
+
// so C = B isn't allowed (special case), but C = A | B is.
|
|
72
|
+
if (partOfBitwiseComputation && isSelfEnumMember(declaration, node)) {
|
|
73
|
+
return true;
|
|
86
74
|
}
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
75
|
+
switch (node.type) {
|
|
76
|
+
// any old literal
|
|
77
|
+
case utils_1.AST_NODE_TYPES.Literal:
|
|
78
|
+
return true;
|
|
79
|
+
// TemplateLiteral without expressions
|
|
80
|
+
case utils_1.AST_NODE_TYPES.TemplateLiteral:
|
|
81
|
+
return node.expressions.length === 0;
|
|
82
|
+
case utils_1.AST_NODE_TYPES.UnaryExpression:
|
|
83
|
+
// +123, -123, etc.
|
|
84
|
+
if (['+', '-'].includes(node.operator)) {
|
|
85
|
+
return isAllowedInitializerExpressionRecursive(node.argument, partOfBitwiseComputation);
|
|
86
|
+
}
|
|
87
|
+
if (allowBitwiseExpressions) {
|
|
88
|
+
return (node.operator === '~' &&
|
|
89
|
+
isAllowedInitializerExpressionRecursive(node.argument, true));
|
|
90
|
+
}
|
|
91
|
+
return false;
|
|
92
|
+
case utils_1.AST_NODE_TYPES.BinaryExpression:
|
|
93
|
+
if (allowBitwiseExpressions) {
|
|
94
|
+
return (['|', '&', '^', '<<', '>>', '>>>'].includes(node.operator) &&
|
|
95
|
+
isAllowedInitializerExpressionRecursive(node.left, true) &&
|
|
96
|
+
isAllowedInitializerExpressionRecursive(node.right, true));
|
|
97
|
+
}
|
|
98
|
+
return false;
|
|
99
|
+
default:
|
|
100
|
+
return false;
|
|
91
101
|
}
|
|
92
102
|
}
|
|
93
|
-
if (node.initializer
|
|
94
|
-
node.initializer.argument.type === utils_1.AST_NODE_TYPES.Literal &&
|
|
95
|
-
(['+', '-'].includes(node.initializer.operator) ||
|
|
96
|
-
(allowBitwiseExpressions && node.initializer.operator === '~'))) {
|
|
97
|
-
return;
|
|
98
|
-
}
|
|
99
|
-
if (allowBitwiseExpressions &&
|
|
100
|
-
node.initializer.type === utils_1.AST_NODE_TYPES.BinaryExpression &&
|
|
101
|
-
['|', '&', '^', '<<', '>>', '>>>'].includes(node.initializer.operator) &&
|
|
102
|
-
isAllowedBitwiseOperand(declaration, node.initializer.left) &&
|
|
103
|
-
isAllowedBitwiseOperand(declaration, node.initializer.right)) {
|
|
103
|
+
if (isAllowedInitializerExpressionRecursive(node.initializer, false)) {
|
|
104
104
|
return;
|
|
105
105
|
}
|
|
106
106
|
context.report({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prefer-literal-enum-member.js","sourceRoot":"","sources":["../../src/rules/prefer-literal-enum-member.ts"],"names":[],"mappings":";;AACA,oDAA0D;AAE1D,kCAA2D;AAE3D,kBAAe,IAAA,iBAAU,EAAC;IACxB,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,+CAA+C;YAC5D,WAAW,EAAE,QAAQ;YACrB,oBAAoB,EAAE,KAAK;SAC5B;QACD,QAAQ,EAAE;YACR,UAAU,EAAE,sEAAsE;SACnF;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,uBAAuB,EAAE;wBACvB,WAAW,EACT,kEAAkE;wBACpE,IAAI,EAAE,SAAS;qBAChB;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE;QACd;YACE,uBAAuB,EAAE,KAAK;SAC/B;KACF;IACD,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,uBAAuB,EAAE,CAAC;QAC3C,SAAS,oBAAoB,CAAC,IAAmB,EAAE,IAAY;YAC7D,OAAO,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;QACvE,CAAC;QAED,SAAS,aAAa,CACpB,IAAgC,EAChC,IAAY;YAEZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAC3B,MAAM,CAAC,EAAE,CACP,oBAAoB,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC;gBACrC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO;oBACxC,IAAA,2BAAoB,EAAC,MAAM,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAC9C,CAAC;QACJ,CAAC;QAED,SAAS,gBAAgB,CACvB,IAAgC,EAChC,IAAmB;YAEnB,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;gBAC5C,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;YAED,IACE,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB;gBAC7C,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAC/C,CAAC;gBACD,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;oBACrD,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjD,CAAC;gBAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,MAAM,YAAY,GAAG,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACzD,IAAI,YAAY,EAAE,CAAC;wBACjB,OAAO,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,
|
|
1
|
+
{"version":3,"file":"prefer-literal-enum-member.js","sourceRoot":"","sources":["../../src/rules/prefer-literal-enum-member.ts"],"names":[],"mappings":";;AACA,oDAA0D;AAE1D,kCAA2D;AAE3D,kBAAe,IAAA,iBAAU,EAAC;IACxB,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,+CAA+C;YAC5D,WAAW,EAAE,QAAQ;YACrB,oBAAoB,EAAE,KAAK;SAC5B;QACD,QAAQ,EAAE;YACR,UAAU,EAAE,sEAAsE;SACnF;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,uBAAuB,EAAE;wBACvB,WAAW,EACT,kEAAkE;wBACpE,IAAI,EAAE,SAAS;qBAChB;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE;QACd;YACE,uBAAuB,EAAE,KAAK;SAC/B;KACF;IACD,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,uBAAuB,EAAE,CAAC;QAC3C,SAAS,oBAAoB,CAAC,IAAmB,EAAE,IAAY;YAC7D,OAAO,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;QACvE,CAAC;QAED,SAAS,aAAa,CACpB,IAAgC,EAChC,IAAY;YAEZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAC3B,MAAM,CAAC,EAAE,CACP,oBAAoB,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC;gBACrC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO;oBACxC,IAAA,2BAAoB,EAAC,MAAM,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAC9C,CAAC;QACJ,CAAC;QAED,SAAS,gBAAgB,CACvB,IAAgC,EAChC,IAAmB;YAEnB,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;gBAC5C,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;YAED,IACE,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB;gBAC7C,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAC/C,CAAC;gBACD,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;oBACrD,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjD,CAAC;gBAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,MAAM,YAAY,GAAG,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACzD,IAAI,YAAY,EAAE,CAAC;wBACjB,OAAO,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO;YACL,YAAY,CAAC,IAAI;gBACf,wFAAwF;gBACxF,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;oBAC7B,OAAO;gBACT,CAAC;gBACD,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;gBAEvC,SAAS,uCAAuC,CAC9C,IAAsD,EACtD,wBAAiC;oBAEjC,8EAA8E;oBAC9E,2DAA2D;oBAC3D,IAAI,wBAAwB,IAAI,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC;wBACpE,OAAO,IAAI,CAAC;oBACd,CAAC;oBAED,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;wBAClB,kBAAkB;wBAClB,KAAK,sBAAc,CAAC,OAAO;4BACzB,OAAO,IAAI,CAAC;wBAEd,sCAAsC;wBACtC,KAAK,sBAAc,CAAC,eAAe;4BACjC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC;wBAEvC,KAAK,sBAAc,CAAC,eAAe;4BACjC,mBAAmB;4BACnB,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gCACvC,OAAO,uCAAuC,CAC5C,IAAI,CAAC,QAAQ,EACb,wBAAwB,CACzB,CAAC;4BACJ,CAAC;4BAED,IAAI,uBAAuB,EAAE,CAAC;gCAC5B,OAAO,CACL,IAAI,CAAC,QAAQ,KAAK,GAAG;oCACrB,uCAAuC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAC7D,CAAC;4BACJ,CAAC;4BACD,OAAO,KAAK,CAAC;wBAEf,KAAK,sBAAc,CAAC,gBAAgB;4BAClC,IAAI,uBAAuB,EAAE,CAAC;gCAC5B,OAAO,CACL,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;oCAC1D,uCAAuC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;oCACxD,uCAAuC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAC1D,CAAC;4BACJ,CAAC;4BACD,OAAO,KAAK,CAAC;wBAEf;4BACE,OAAO,KAAK,CAAC;oBACjB,CAAC;gBACH,CAAC;gBAED,IAAI,uCAAuC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC;oBACrE,OAAO;gBACT,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI,EAAE,IAAI,CAAC,EAAE;oBACb,SAAS,EAAE,YAAY;iBACxB,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -9,7 +9,9 @@ import TabItem from '@theme/TabItem';
|
|
|
9
9
|
>
|
|
10
10
|
> See **https://typescript-eslint.io/rules/no-unsafe-enum-comparison** for documentation.
|
|
11
11
|
|
|
12
|
-
The TypeScript compiler can be surprisingly lenient when working with enums.
|
|
12
|
+
The TypeScript compiler can be surprisingly lenient when working with enums.
|
|
13
|
+
While overt safety problems with enums were [resolved in TypeScript 5.0](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#all-enums-are-union-enums), some logical pitfalls remain permitted.
|
|
14
|
+
For example, it is allowed to compare enum values against non-enum values:
|
|
13
15
|
|
|
14
16
|
```ts
|
|
15
17
|
enum Vegetable {
|
|
@@ -21,7 +23,9 @@ declare const vegetable: Vegetable;
|
|
|
21
23
|
vegetable === 'asparagus'; // No error
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
The above code snippet should instead be written as `vegetable === Vegetable.Asparagus`.
|
|
26
|
+
The above code snippet should instead be written as `vegetable === Vegetable.Asparagus`.
|
|
27
|
+
Allowing non-enums in comparisons subverts the point of using enums in the first place.
|
|
28
|
+
By enforcing comparisons with properly typed enums:
|
|
25
29
|
|
|
26
30
|
- It makes a codebase more resilient to enum members changing values.
|
|
27
31
|
- It allows for code IDEs to use the "Rename Symbol" feature to quickly rename an enum.
|
|
@@ -39,17 +43,22 @@ enum Fruit {
|
|
|
39
43
|
|
|
40
44
|
declare let fruit: Fruit;
|
|
41
45
|
|
|
46
|
+
// bad - comparison between enum and explicit value instead of named enum member
|
|
42
47
|
fruit === 0;
|
|
43
|
-
```
|
|
44
48
|
|
|
45
|
-
```ts
|
|
46
49
|
enum Vegetable {
|
|
47
50
|
Asparagus = 'asparagus',
|
|
48
51
|
}
|
|
49
52
|
|
|
50
53
|
declare let vegetable: Vegetable;
|
|
51
54
|
|
|
55
|
+
// bad - comparison between enum and explicit value instead of named enum member
|
|
52
56
|
vegetable === 'asparagus';
|
|
57
|
+
|
|
58
|
+
declare let anyString: string;
|
|
59
|
+
|
|
60
|
+
// bad - comparison between enum and non-enum value
|
|
61
|
+
anyString === Vegetable.Asparagus;
|
|
53
62
|
```
|
|
54
63
|
|
|
55
64
|
</TabItem>
|
|
@@ -63,9 +72,7 @@ enum Fruit {
|
|
|
63
72
|
declare let fruit: Fruit;
|
|
64
73
|
|
|
65
74
|
fruit === Fruit.Apple;
|
|
66
|
-
```
|
|
67
75
|
|
|
68
|
-
```ts
|
|
69
76
|
enum Vegetable {
|
|
70
77
|
Asparagus = 'asparagus',
|
|
71
78
|
}
|
|
@@ -80,7 +87,12 @@ vegetable === Vegetable.Asparagus;
|
|
|
80
87
|
|
|
81
88
|
## When Not To Use It
|
|
82
89
|
|
|
83
|
-
If you don't mind
|
|
90
|
+
If you don't mind enums being treated as a namespaced bag of values, rather than opaque identifiers, you likely don't need this rule.
|
|
91
|
+
|
|
92
|
+
Sometimes, you may want to ingest a value from an API or user input, then use it as an enum throughout your application.
|
|
93
|
+
While validating the input, it may be appropriate to disable the rule.
|
|
94
|
+
Alternately, you might consider making use of a validation library like [Zod](https://zod.dev/?id=native-enums).
|
|
95
|
+
See further discussion of this topic in [#8557](https://github.com/typescript-eslint/typescript-eslint/issues/8557).
|
|
84
96
|
|
|
85
|
-
|
|
97
|
+
Finally, in the rare case of relying on an third party enums that are only imported as `type`s, it may be difficult to adhere to this rule.
|
|
86
98
|
You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@typescript-eslint/eslint-plugin",
|
|
3
|
-
"version": "8.7.1-alpha.
|
|
3
|
+
"version": "8.7.1-alpha.11",
|
|
4
4
|
"description": "TypeScript plugin for ESLint",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist",
|
|
@@ -60,10 +60,10 @@
|
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
62
|
"@eslint-community/regexpp": "^4.10.0",
|
|
63
|
-
"@typescript-eslint/scope-manager": "8.7.1-alpha.
|
|
64
|
-
"@typescript-eslint/type-utils": "8.7.1-alpha.
|
|
65
|
-
"@typescript-eslint/utils": "8.7.1-alpha.
|
|
66
|
-
"@typescript-eslint/visitor-keys": "8.7.1-alpha.
|
|
63
|
+
"@typescript-eslint/scope-manager": "8.7.1-alpha.11",
|
|
64
|
+
"@typescript-eslint/type-utils": "8.7.1-alpha.11",
|
|
65
|
+
"@typescript-eslint/utils": "8.7.1-alpha.11",
|
|
66
|
+
"@typescript-eslint/visitor-keys": "8.7.1-alpha.11",
|
|
67
67
|
"graphemer": "^1.4.0",
|
|
68
68
|
"ignore": "^5.3.1",
|
|
69
69
|
"natural-compare": "^1.4.0",
|
|
@@ -74,8 +74,8 @@
|
|
|
74
74
|
"@types/marked": "^5.0.2",
|
|
75
75
|
"@types/mdast": "^4.0.3",
|
|
76
76
|
"@types/natural-compare": "*",
|
|
77
|
-
"@typescript-eslint/rule-schema-to-typescript-types": "8.7.1-alpha.
|
|
78
|
-
"@typescript-eslint/rule-tester": "8.7.1-alpha.
|
|
77
|
+
"@typescript-eslint/rule-schema-to-typescript-types": "8.7.1-alpha.11",
|
|
78
|
+
"@typescript-eslint/rule-tester": "8.7.1-alpha.11",
|
|
79
79
|
"ajv": "^6.12.6",
|
|
80
80
|
"cross-env": "^7.0.3",
|
|
81
81
|
"cross-fetch": "*",
|