@typescript-eslint/eslint-plugin 8.11.1-alpha.5 → 8.11.1-alpha.7
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.
|
@@ -135,6 +135,16 @@ exports.default = (0, util_1.createRule)({
|
|
|
135
135
|
}
|
|
136
136
|
return Usefulness.Never;
|
|
137
137
|
}
|
|
138
|
+
function isBuiltInStringCall(node) {
|
|
139
|
+
if (node.callee.type === utils_1.AST_NODE_TYPES.Identifier &&
|
|
140
|
+
node.callee.name === 'String' &&
|
|
141
|
+
node.arguments[0]) {
|
|
142
|
+
const scope = context.sourceCode.getScope(node);
|
|
143
|
+
const variable = scope.set.get('String');
|
|
144
|
+
return !variable?.defs.length;
|
|
145
|
+
}
|
|
146
|
+
return false;
|
|
147
|
+
}
|
|
138
148
|
return {
|
|
139
149
|
'AssignmentExpression[operator = "+="], BinaryExpression[operator = "+"]'(node) {
|
|
140
150
|
const leftType = services.getTypeAtLocation(node.left);
|
|
@@ -147,6 +157,11 @@ exports.default = (0, util_1.createRule)({
|
|
|
147
157
|
checkExpression(node.left, leftType);
|
|
148
158
|
}
|
|
149
159
|
},
|
|
160
|
+
CallExpression(node) {
|
|
161
|
+
if (isBuiltInStringCall(node)) {
|
|
162
|
+
checkExpression(node.arguments[0]);
|
|
163
|
+
}
|
|
164
|
+
},
|
|
150
165
|
'CallExpression > MemberExpression.callee > Identifier[name = /^(toLocaleString|toString)$/].property'(node) {
|
|
151
166
|
const memberExpr = node.parent;
|
|
152
167
|
checkExpression(memberExpr.object);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"no-base-to-string.js","sourceRoot":"","sources":["../../src/rules/no-base-to-string.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"no-base-to-string.js","sourceRoot":"","sources":["../../src/rules/no-base-to-string.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAGA,oDAA0D;AAC1D,+CAAiC;AAEjC,kCAAqE;AAErE,IAAK,UAIJ;AAJD,WAAK,UAAU;IACb,+BAAiB,CAAA;IACjB,4BAAc,CAAA;IACd,+BAAiB,CAAA;AACnB,CAAC,EAJI,UAAU,KAAV,UAAU,QAId;AASD,kBAAe,IAAA,iBAAU,EAAsB;IAC7C,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,8HAA8H;YAChI,WAAW,EAAE,aAAa;YAC1B,oBAAoB,EAAE,IAAI;SAC3B;QACD,QAAQ,EAAE;YACR,YAAY,EACV,4GAA4G;SAC/G;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,gBAAgB,EAAE;wBAChB,IAAI,EAAE,OAAO;wBACb,WAAW,EACT,0DAA0D;wBAC5D,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;yBACf;qBACF;iBACF;aACF;SACF;KACF;IACD,cAAc,EAAE;QACd;YACE,gBAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC;SAChE;KACF;IACD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC;QACtB,MAAM,QAAQ,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC;QAEvD,SAAS,eAAe,CAAC,IAAmB,EAAE,IAAc;YAC1D,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,EAAE,CAAC;gBACzC,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,wBAAwB,CACxC,IAAI,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CACzC,CAAC;YACF,IAAI,SAAS,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YAED,OAAO,CAAC,MAAM,CAAC;gBACb,IAAI;gBACJ,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;oBACtC,SAAS;iBACV;aACF,CAAC,CAAC;QACL,CAAC;QAED,SAAS,wBAAwB,CAAC,IAAa;YAC7C,MAAM,QAAQ,GACZ,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC;gBAC3C,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YACpD,MAAM,YAAY,GAAG,QAAQ,EAAE,eAAe,EAAE,CAAC;YACjD,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5D,OAAO,UAAU,CAAC,MAAM,CAAC;YAC3B,CAAC;YAED,mFAAmF;YACnF,IACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO;gBACjC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,cAAc,EACxC,CAAC;gBACD,OAAO,UAAU,CAAC,MAAM,CAAC;YAC3B,CAAC;YAED,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAA,kBAAW,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC1D,OAAO,UAAU,CAAC,MAAM,CAAC;YAC3B,CAAC;YAED,IACE,YAAY,CAAC,KAAK,CAChB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CACb,CAAC,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CACtE,EACD,CAAC;gBACD,OAAO,UAAU,CAAC,MAAM,CAAC;YAC3B,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC1B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACjC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;oBAE5D,IAAI,iBAAiB,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;wBAC5C,OAAO,UAAU,CAAC,MAAM,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBAED,OAAO,UAAU,CAAC,KAAK,CAAC;YAC1B,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBACpB,OAAO,UAAU,CAAC,KAAK,CAAC;YAC1B,CAAC;YAED,IAAI,iBAAiB,GAAG,IAAI,CAAC;YAC7B,IAAI,iBAAiB,GAAG,KAAK,CAAC;YAE9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACjC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;gBAE5D,IAAI,iBAAiB,KAAK,UAAU,CAAC,MAAM,IAAI,iBAAiB,EAAE,CAAC;oBACjE,iBAAiB,GAAG,KAAK,CAAC;gBAC5B,CAAC;gBAED,IAAI,iBAAiB,KAAK,UAAU,CAAC,KAAK,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBACjE,iBAAiB,GAAG,IAAI,CAAC;gBAC3B,CAAC;YACH,CAAC;YAED,IAAI,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;gBAC3C,OAAO,UAAU,CAAC,MAAM,CAAC;YAC3B,CAAC;YAED,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,UAAU,CAAC,SAAS,CAAC;YAC9B,CAAC;YAED,OAAO,UAAU,CAAC,KAAK,CAAC;QAC1B,CAAC;QAED,SAAS,mBAAmB,CAAC,IAA6B;YACxD,IACE,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;gBAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ;gBAC7B,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EACjB,CAAC;gBACD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACzC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC;YAChC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO;YACL,yEAAyE,CACvE,IAA+D;gBAE/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvD,MAAM,SAAS,GAAG,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAEzD,IAAI,IAAA,kBAAW,EAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAChD,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBACzC,CAAC;qBAAM,IACL,IAAA,kBAAW,EAAC,OAAO,EAAE,SAAS,CAAC,KAAK,QAAQ;oBAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,iBAAiB,EACnD,CAAC;oBACD,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;YACD,cAAc,CAAC,IAA6B;gBAC1C,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,sGAAsG,CACpG,IAAyB;gBAEzB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAmC,CAAC;gBAC5D,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACrC,CAAC;YACD,eAAe,CAAC,IAA8B;gBAC5C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,wBAAwB,EAAE,CAAC;oBACjE,OAAO;gBACT,CAAC;gBACD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC1C,eAAe,CAAC,UAAU,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
|
|
|
9
9
|
>
|
|
10
10
|
> See **https://typescript-eslint.io/rules/no-base-to-string** for documentation.
|
|
11
11
|
|
|
12
|
-
JavaScript will call `toString()` on an object when it is converted to a string, such as when
|
|
12
|
+
JavaScript will call `toString()` on an object when it is converted to a string, such as when concatenated with a string (`expr + ''`), when interpolated into template literals (`${expr}`), or when passed as an argument to the String constructor (`String(expr)`).
|
|
13
13
|
The default Object `.toString()` and `toLocaleString()` use the format `"[object Object]"`, which is often not what was intended.
|
|
14
14
|
This rule reports on stringified values that aren't primitives and don't define a more useful `.toString()` or `toLocaleString()` method.
|
|
15
15
|
|
|
@@ -31,6 +31,7 @@ value + '';
|
|
|
31
31
|
|
|
32
32
|
// Interpolation and manual .toString() and `toLocaleString()` calls too:
|
|
33
33
|
`Value: ${value}`;
|
|
34
|
+
String({});
|
|
34
35
|
({}).toString();
|
|
35
36
|
({}).toLocaleString();
|
|
36
37
|
```
|
|
@@ -44,6 +45,7 @@ value + '';
|
|
|
44
45
|
`Value: ${123}`;
|
|
45
46
|
`Arrays too: ${[1, 2, 3]}`;
|
|
46
47
|
(() => {}).toString();
|
|
48
|
+
String(42);
|
|
47
49
|
(() => {}).toLocaleString();
|
|
48
50
|
|
|
49
51
|
// Defining a custom .toString class is considered acceptable
|
|
@@ -64,6 +66,15 @@ const literalWithToString = {
|
|
|
64
66
|
</TabItem>
|
|
65
67
|
</Tabs>
|
|
66
68
|
|
|
69
|
+
## Alternatives
|
|
70
|
+
|
|
71
|
+
Consider using `JSON.stringify` when you want to convert non-primitive things to string for logging, debugging, etc.
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
declare const o: object;
|
|
75
|
+
const errorMessage = 'Found unexpected value: ' + JSON.stringify(o);
|
|
76
|
+
```
|
|
77
|
+
|
|
67
78
|
## Options
|
|
68
79
|
|
|
69
80
|
### `ignoredTypeNames`
|
|
@@ -82,6 +93,7 @@ The following patterns are considered correct with the default options `{ ignore
|
|
|
82
93
|
let value = /regex/;
|
|
83
94
|
value.toString();
|
|
84
95
|
let text = `${value}`;
|
|
96
|
+
String(/regex/);
|
|
85
97
|
```
|
|
86
98
|
|
|
87
99
|
## When Not To Use It
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@typescript-eslint/eslint-plugin",
|
|
3
|
-
"version": "8.11.1-alpha.
|
|
3
|
+
"version": "8.11.1-alpha.7",
|
|
4
4
|
"description": "TypeScript plugin for ESLint",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist",
|
|
@@ -61,10 +61,10 @@
|
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
63
|
"@eslint-community/regexpp": "^4.10.0",
|
|
64
|
-
"@typescript-eslint/scope-manager": "8.11.1-alpha.
|
|
65
|
-
"@typescript-eslint/type-utils": "8.11.1-alpha.
|
|
66
|
-
"@typescript-eslint/utils": "8.11.1-alpha.
|
|
67
|
-
"@typescript-eslint/visitor-keys": "8.11.1-alpha.
|
|
64
|
+
"@typescript-eslint/scope-manager": "8.11.1-alpha.7",
|
|
65
|
+
"@typescript-eslint/type-utils": "8.11.1-alpha.7",
|
|
66
|
+
"@typescript-eslint/utils": "8.11.1-alpha.7",
|
|
67
|
+
"@typescript-eslint/visitor-keys": "8.11.1-alpha.7",
|
|
68
68
|
"graphemer": "^1.4.0",
|
|
69
69
|
"ignore": "^5.3.1",
|
|
70
70
|
"natural-compare": "^1.4.0",
|
|
@@ -75,8 +75,8 @@
|
|
|
75
75
|
"@types/marked": "^5.0.2",
|
|
76
76
|
"@types/mdast": "^4.0.3",
|
|
77
77
|
"@types/natural-compare": "*",
|
|
78
|
-
"@typescript-eslint/rule-schema-to-typescript-types": "8.11.1-alpha.
|
|
79
|
-
"@typescript-eslint/rule-tester": "8.11.1-alpha.
|
|
78
|
+
"@typescript-eslint/rule-schema-to-typescript-types": "8.11.1-alpha.7",
|
|
79
|
+
"@typescript-eslint/rule-tester": "8.11.1-alpha.7",
|
|
80
80
|
"ajv": "^6.12.6",
|
|
81
81
|
"cross-env": "^7.0.3",
|
|
82
82
|
"cross-fetch": "*",
|