feat(eslint-plugin): [unbound-method] add support for methods with a …

…`this: void` parameter (#2796)
typescript-eslint · Nov 25, 2020 · 878dd4a · 878dd4a
1 parent 29428a4
commit 878dd4a
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 10 deletions.
diff --git a/packages/eslint-plugin/docs/rules/unbound-method.md b/packages/eslint-plugin/docs/rules/unbound-method.md
@@ -23,6 +23,14 @@ myLog();
 
 // This log might later be called with an incorrect scope
 const { log } = instance;
+
+// arith.double may refer to `this` internally
+const arith = {
+  double(x: number): number {
+    return x * 2;
+  },
+};
+const { double } = arith;
 ```
 
 Examples of **correct** code for this rule
@@ -45,6 +53,14 @@ logBound();
 // .bind and lambdas will also add a correct scope
 const dotBindLog = instance.logBound.bind(instance);
 const innerLog = () => instance.logBound();
+
+// arith.double explicitly declares that it does not refer to `this` internally
+const arith = {
+  double(this: void, x: number): number {
+    return x * 2;
+  },
+};
+const { double } = arith;
 ```
 
 ## Options

diff --git a/packages/eslint-plugin/src/rules/unbound-method.ts b/packages/eslint-plugin/src/rules/unbound-method.ts
@@ -248,14 +248,27 @@ function isDangerousMethod(symbol: ts.Symbol, ignoreStatic: boolean): boolean {
         ts.SyntaxKind.FunctionExpression
       );
     case ts.SyntaxKind.MethodDeclaration:
-    case ts.SyntaxKind.MethodSignature:
-      return !(
-        ignoreStatic &&
-        tsutils.hasModifier(
-          valueDeclaration.modifiers,
-          ts.SyntaxKind.StaticKeyword,
+    case ts.SyntaxKind.MethodSignature: {
+      const decl = valueDeclaration as
+        | ts.MethodDeclaration
+        | ts.MethodSignature;
+      const firstParam = decl.parameters[0];
+      const thisArgIsVoid =
+        firstParam?.name.kind === ts.SyntaxKind.Identifier &&
+        firstParam?.name.escapedText === 'this' &&
+        firstParam?.type?.kind === ts.SyntaxKind.VoidKeyword;
+
+      return (
+        !thisArgIsVoid &&
+        !(
+          ignoreStatic &&
+          tsutils.hasModifier(
+            valueDeclaration.modifiers,
+            ts.SyntaxKind.StaticKeyword,
+          )
         )
       );
+    }
   }
 
   return false;

diff --git a/packages/eslint-plugin/tests/rules/unbound-method.test.ts b/packages/eslint-plugin/tests/rules/unbound-method.test.ts
@@ -25,6 +25,12 @@ class ContainsMethods {
 
 let instance = new ContainsMethods();
 
+const arith = {
+  double(this: void, x: number): number {
+    return x * 2;
+  }
+};
+
 ${code}
   `;
 }
@@ -35,7 +41,7 @@ function addContainsMethodsClassInvalid(
     code: addContainsMethodsClass(c),
     errors: [
       {
-        line: 12,
+        line: 18,
         messageId: 'unbound',
       },
     ],
@@ -153,6 +159,8 @@ ruleTester.run('unbound-method', rule, {
       'if (!!instance.unbound) {}',
       'void instance.unbound',
       'delete instance.unbound',
+
+      'const { double } = arith;',
     ].map(addContainsMethodsClass),
     `
 interface RecordA {
@@ -300,15 +308,15 @@ function foo(arg: ContainsMethods | null) {
       `),
       errors: [
         {
-          line: 14,
+          line: 20,
           messageId: 'unbound',
         },
         {
-          line: 15,
+          line: 21,
           messageId: 'unbound',
         },
         {
-          line: 16,
+          line: 22,
           messageId: 'unbound',
         },
       ],