feat(eslint-plugin): [no-unsafe-call][no-unsafe-member-access] improve report messages for this for noImplicitThis (typescript-eslint#3199)

JounQin · web-flow · commit b1b26c4843a4 · 2021-04-02T13:23:32.000-07:00
diff --git a/packages/eslint-plugin/src/rules/no-unsafe-assignment.ts b/packages/eslint-plugin/src/rules/no-unsafe-assignment.ts
@@ -2,8 +2,10 @@ import {
   TSESTree,
   AST_NODE_TYPES,
 } from '@typescript-eslint/experimental-utils';
+import * as tsutils from 'tsutils';
 import * as ts from 'typescript';
 import * as util from '../util';
+import { getThisExpression } from '../util';
 
 const enum ComparisonType {
   /** Do no assignment comparison */
@@ -25,20 +27,29 @@ export default util.createRule({
       requiresTypeChecking: true,
     },
     messages: {
-      anyAssignment: 'Unsafe assignment of an any value.',
-      unsafeArrayPattern: 'Unsafe array destructuring of an any array value.',
+      anyAssignment: 'Unsafe assignment of an `any` value.',
+      anyAssignmentThis: [
+        'Unsafe assignment of an `any` value. `this` is typed as `any`.',
+        'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.',
+      ].join('\n'),
+      unsafeArrayPattern: 'Unsafe array destructuring of an `any` array value.',
       unsafeArrayPatternFromTuple:
-        'Unsafe array destructuring of a tuple element with an any value.',
+        'Unsafe array destructuring of a tuple element with an `any` value.',
       unsafeAssignment:
         'Unsafe assignment of type {{sender}} to a variable of type {{receiver}}.',
-      unsafeArraySpread: 'Unsafe spread of an any value in an array.',
+      unsafeArraySpread: 'Unsafe spread of an `any` value in an array.',
     },
     schema: [],
   },
   defaultOptions: [],
   create(context) {
     const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context);
     const checker = program.getTypeChecker();
+    const compilerOptions = program.getCompilerOptions();
+    const isNoImplicitThis = tsutils.isStrictCompilerOptionEnabled(
+      compilerOptions,
+      'noImplicitThis',
+    );
 
     // returns true if the assignment reported
     function checkArrayDestructureHelper(
@@ -243,9 +254,27 @@ export default util.createRule({
           return false;
         }
 
+        let messageId: 'anyAssignment' | 'anyAssignmentThis' = 'anyAssignment';
+
+        if (!isNoImplicitThis) {
+          // `var foo = this`
+          const thisExpression = getThisExpression(senderNode);
+          if (
+            thisExpression &&
+            util.isTypeAnyType(
+              util.getConstrainedTypeAtLocation(
+                checker,
+                esTreeNodeToTSNodeMap.get(thisExpression),
+              ),
+            )
+          ) {
+            messageId = 'anyAssignmentThis';
+          }
+        }
+
         context.report({
           node: reportingNode,
-          messageId: 'anyAssignment',
+          messageId,
         });
         return true;
       }
diff --git a/packages/eslint-plugin/src/rules/no-unsafe-call.ts b/packages/eslint-plugin/src/rules/no-unsafe-call.ts
@@ -1,7 +1,13 @@
 import { TSESTree } from '@typescript-eslint/experimental-utils';
+import * as tsutils from 'tsutils';
 import * as util from '../util';
+import { getThisExpression } from '../util';
 
-type MessageIds = 'unsafeCall' | 'unsafeNew' | 'unsafeTemplateTag';
+type MessageIds =
+  | 'unsafeCall'
+  | 'unsafeCallThis'
+  | 'unsafeNew'
+  | 'unsafeTemplateTag';
 
 export default util.createRule<[], MessageIds>({
   name: 'no-unsafe-call',
@@ -14,7 +20,11 @@ export default util.createRule<[], MessageIds>({
       requiresTypeChecking: true,
     },
     messages: {
-      unsafeCall: 'Unsafe call of an any typed value.',
+      unsafeCall: 'Unsafe call of an `any` typed value.',
+      unsafeCallThis: [
+        'Unsafe call of an `any` typed value. `this` is typed as `any`.',
+        'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.',
+      ].join('\n'),
       unsafeNew: 'Unsafe construction of an any type value.',
       unsafeTemplateTag: 'Unsafe any typed template tag.',
     },
@@ -24,6 +34,11 @@ export default util.createRule<[], MessageIds>({
   create(context) {
     const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context);
     const checker = program.getTypeChecker();
+    const compilerOptions = program.getCompilerOptions();
+    const isNoImplicitThis = tsutils.isStrictCompilerOptionEnabled(
+      compilerOptions,
+      'noImplicitThis',
+    );
 
     function checkCall(
       node: TSESTree.Node,
@@ -34,6 +49,21 @@ export default util.createRule<[], MessageIds>({
       const type = util.getConstrainedTypeAtLocation(checker, tsNode);
 
       if (util.isTypeAnyType(type)) {
+        if (!isNoImplicitThis) {
+          // `this()` or `this.foo()` or `this.foo[bar]()`
+          const thisExpression = getThisExpression(node);
+          if (
+            thisExpression &&
+            util.isTypeAnyType(
+              util.getConstrainedTypeAtLocation(
+                checker,
+                esTreeNodeToTSNodeMap.get(thisExpression),
+              ),
+            )
+          ) {
+            messageId = 'unsafeCallThis';
+          }
+        }
         context.report({
           node: reportingNode,
           messageId: messageId,
diff --git a/packages/eslint-plugin/src/rules/no-unsafe-member-access.ts b/packages/eslint-plugin/src/rules/no-unsafe-member-access.ts
@@ -2,7 +2,9 @@ import {
   TSESTree,
   AST_NODE_TYPES,
 } from '@typescript-eslint/experimental-utils';
+import * as tsutils from 'tsutils';
 import * as util from '../util';
+import { getThisExpression } from '../util';
 
 const enum State {
   Unsafe = 1,
@@ -21,7 +23,11 @@ export default util.createRule({
     },
     messages: {
       unsafeMemberExpression:
-        'Unsafe member access {{property}} on an any value.',
+        'Unsafe member access {{property}} on an `any` value.',
+      unsafeThisMemberExpression: [
+        'Unsafe member access {{property}} on an `any` value. `this` is typed as `any`.',
+        'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.',
+      ].join('\n'),
       unsafeComputedMemberAccess:
         'Computed name {{property}} resolves to an any value.',
     },
@@ -31,6 +37,11 @@ export default util.createRule({
   create(context) {
     const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context);
     const checker = program.getTypeChecker();
+    const compilerOptions = program.getCompilerOptions();
+    const isNoImplicitThis = tsutils.isStrictCompilerOptionEnabled(
+      compilerOptions,
+      'noImplicitThis',
+    );
     const sourceCode = context.getSourceCode();
 
     const stateCache = new Map<TSESTree.Node, State>();
@@ -58,9 +69,30 @@ export default util.createRule({
 
       if (state === State.Unsafe) {
         const propertyName = sourceCode.getText(node.property);
+
+        let messageId: 'unsafeMemberExpression' | 'unsafeThisMemberExpression' =
+          'unsafeMemberExpression';
+
+        if (!isNoImplicitThis) {
+          // `this.foo` or `this.foo[bar]`
+          const thisExpression = getThisExpression(node);
+
+          if (
+            thisExpression &&
+            util.isTypeAnyType(
+              util.getConstrainedTypeAtLocation(
+                checker,
+                esTreeNodeToTSNodeMap.get(thisExpression),
+              ),
+            )
+          ) {
+            messageId = 'unsafeThisMemberExpression';
+          }
+        }
+
         context.report({
           node,
-          messageId: 'unsafeMemberExpression',
+          messageId,
           data: {
             property: node.computed ? `[${propertyName}]` : `.${propertyName}`,
           },
diff --git a/packages/eslint-plugin/src/rules/no-unsafe-return.ts b/packages/eslint-plugin/src/rules/no-unsafe-return.ts
@@ -2,8 +2,9 @@ import {
   TSESTree,
   AST_NODE_TYPES,
 } from '@typescript-eslint/experimental-utils';
-import { isExpression } from 'tsutils';
+import * as tsutils from 'tsutils';
 import * as util from '../util';
+import { getThisExpression } from '../util';
 
 export default util.createRule({
   name: 'no-unsafe-return',
@@ -16,16 +17,25 @@ export default util.createRule({
       requiresTypeChecking: true,
     },
     messages: {
-      unsafeReturn: 'Unsafe return of an {{type}} typed value',
+      unsafeReturn: 'Unsafe return of an `{{type}}` typed value.',
+      unsafeReturnThis: [
+        'Unsafe return of an `{{type}}` typed value. `this` is typed as `any`.',
+        'You can try to fix this by turning on the `noImplicitThis` compiler option, or adding a `this` parameter to the function.',
+      ].join('\n'),
       unsafeReturnAssignment:
-        'Unsafe return of type {{sender}} from function with return type {{receiver}}.',
+        'Unsafe return of type `{{sender}}` from function with return type `{{receiver}}`.',
     },
     schema: [],
   },
   defaultOptions: [],
   create(context) {
     const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context);
     const checker = program.getTypeChecker();
+    const compilerOptions = program.getCompilerOptions();
+    const isNoImplicitThis = tsutils.isStrictCompilerOptionEnabled(
+      compilerOptions,
+      'noImplicitThis',
+    );
 
     function getParentFunctionNode(
       node: TSESTree.Node,
@@ -74,7 +84,7 @@ export default util.createRule({
       // so we have to use the contextual typing in these cases, i.e.
       // const foo1: () => Set<string> = () => new Set<any>();
       // the return type of the arrow function is Set<any> even though the variable is typed as Set<string>
-      let functionType = isExpression(functionTSNode)
+      let functionType = tsutils.isExpression(functionTSNode)
         ? util.getContextualType(checker, functionTSNode)
         : checker.getTypeAtLocation(functionTSNode);
       if (!functionType) {
@@ -100,10 +110,28 @@ export default util.createRule({
           }
         }
 
+        let messageId: 'unsafeReturn' | 'unsafeReturnThis' = 'unsafeReturn';
+
+        if (!isNoImplicitThis) {
+          // `return this`
+          const thisExpression = getThisExpression(returnNode);
+          if (
+            thisExpression &&
+            util.isTypeAnyType(
+              util.getConstrainedTypeAtLocation(
+                checker,
+                esTreeNodeToTSNodeMap.get(thisExpression),
+              ),
+            )
+          ) {
+            messageId = 'unsafeReturnThis';
+          }
+        }
+
         // If the function return type was not unknown/unknown[], mark usage as unsafeReturn.
         return context.report({
           node: reportingNode,
-          messageId: 'unsafeReturn',
+          messageId,
           data: {
             type: anyType === util.AnyType.Any ? 'any' : 'any[]',
           },
diff --git a/packages/eslint-plugin/src/util/getThisExpression.ts b/packages/eslint-plugin/src/util/getThisExpression.ts
@@ -0,0 +1,24 @@
+import {
+  AST_NODE_TYPES,
+  TSESTree,
+} from '@typescript-eslint/experimental-utils';
+
+export function getThisExpression(
+  node: TSESTree.Node,
+): TSESTree.ThisExpression | undefined {
+  while (node) {
+    if (node.type === AST_NODE_TYPES.CallExpression) {
+      node = node.callee;
+    } else if (node.type === AST_NODE_TYPES.ThisExpression) {
+      return node;
+    } else if (node.type === AST_NODE_TYPES.MemberExpression) {
+      node = node.object;
+    } else if (node.type === AST_NODE_TYPES.ChainExpression) {
+      node = node.expression;
+    } else {
+      break;
+    }
+  }
+
+  return;
+}
diff --git a/packages/eslint-plugin/src/util/index.ts b/packages/eslint-plugin/src/util/index.ts
@@ -4,6 +4,7 @@ export * from './astUtils';
 export * from './collectUnusedVariables';
 export * from './createRule';
 export * from './getFunctionHeadLoc';
+export * from './getThisExpression';
 export * from './getWrappingFixer';
 export * from './isTypeReadonly';
 export * from './misc';
diff --git a/packages/eslint-plugin/tests/fixtures/tsconfig.noImplicitThis.json b/packages/eslint-plugin/tests/fixtures/tsconfig.noImplicitThis.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noImplicitThis": false
+  }
+}
diff --git a/packages/eslint-plugin/tests/rules/no-unsafe-assignment.test.ts b/packages/eslint-plugin/tests/rules/no-unsafe-assignment.test.ts
@@ -68,7 +68,7 @@ function assignmentTest(
 const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: './tsconfig.json',
+    project: './tsconfig.noImplicitThis.json',
     tsconfigRootDir: getFixturesRootDir(),
   },
 });
@@ -347,5 +347,20 @@ declare function Foo(props: Props): never;
         },
       ],
     },
+    {
+      code: `
+function foo() {
+  const bar = this;
+}
+      `,
+      errors: [
+        {
+          messageId: 'anyAssignmentThis',
+          line: 3,
+          column: 9,
+          endColumn: 19,
+        },
+      ],
+    },
   ],
 });
diff --git a/packages/eslint-plugin/tests/rules/no-unsafe-call.test.ts b/packages/eslint-plugin/tests/rules/no-unsafe-call.test.ts
@@ -9,7 +9,7 @@ import {
 const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: './tsconfig.json',
+    project: './tsconfig.noImplicitThis.json',
     tsconfigRootDir: getFixturesRootDir(),
   },
 });
@@ -148,5 +148,34 @@ function foo(x: { tag: any }) { x.tag\`foo\` }
         },
       ],
     }),
+    {
+      code: noFormat`
+const methods = {
+  methodA() {
+    return this.methodB()
+  },
+  methodB() {
+    return true
+  },
+  methodC() {
+    return this()
+  }
+};
+      `,
+      errors: [
+        {
+          messageId: 'unsafeCallThis',
+          line: 4,
+          column: 12,
+          endColumn: 24,
+        },
+        {
+          messageId: 'unsafeCallThis',
+          line: 10,
+          column: 12,
+          endColumn: 16,
+        },
+      ],
+    },
   ],
 });
diff --git a/packages/eslint-plugin/tests/rules/no-unsafe-member-access.test.ts b/packages/eslint-plugin/tests/rules/no-unsafe-member-access.test.ts
diff --git a/packages/eslint-plugin/tests/rules/no-unsafe-return.test.ts b/packages/eslint-plugin/tests/rules/no-unsafe-return.test.ts
