Re-fix ExpectType (#1016)

.changeset/eighty-dolls-train.md

@@ -0,0 +1,5 @@
+---
+"@definitelytyped/eslint-plugin": patch
+---
+
+Re-fix ExpectType

packages/eslint-plugin/src/rules/expect.ts

@@ -239,6 +239,8 @@ const zeroSourceLocation: Readonly<TSESTree.SourceLocation> = {
   end: { line: 0, column: 0 },
 };
 
+const expectTypeToken = "$ExpectType"
+
 function walk(
   getLocFromIndex: (index: number) => Readonly<TSESTree.Position>,
   report: Reporter,
@@ -285,7 +287,7 @@ function walk(
     }
   }
 
-  if (sourceFile.isDeclarationFile || !sourceFile.text.includes("$ExpectType")) {
+  if (sourceFile.isDeclarationFile || !sourceFile.text.includes(expectTypeToken)) {
     // Normal file.
     return;
   }
@@ -401,7 +403,7 @@ function parseAssertions(sourceFile: ts.SourceFile): Assertions {
   const duplicates: number[] = [];
 
   const { text } = sourceFile;
-  const commentRegexp = /\/\/(.*)/g;
+  const commentRegexp = /^(.*?)\/\/(.*)$/gm;
   const lineStarts = sourceFile.getLineStarts();
   let curLine = 0;
 
@@ -410,13 +412,12 @@ function parseAssertions(sourceFile: ts.SourceFile): Assertions {
     if (commentMatch === null) {
       break;
     }
-    // Match on the contents of that comment so we do nothing in a commented-out assertion,
-    // i.e. `// foo; // $ExpectType number`
-    if (!commentMatch[1].startsWith(" $ExpectType ")) {
+    const comment = commentMatch[2].trim();
+    if (!comment.startsWith(expectTypeToken)) {
       continue;
     }
-    const line = getLine(commentMatch.index);
-    const expectedType = commentMatch[1].slice(" $ExpectType ".length);
+    const line = getLine(commentMatch.index + commentMatch[1].length);
+    const expectedType = comment.slice(expectTypeToken.length).trim();
     // Don't bother with the assertion if there are 2 assertions on 1 line. Just fail for the duplicate.
     if (typeAssertions.delete(line)) {
       duplicates.push(line);

packages/eslint-plugin/test/__file_snapshots__/types/expect/expect-tests.ts.lint

@@ -3,14 +3,22 @@ types/expect/expect-tests.ts
   number
 got:
   1234                                                                    @definitelytyped/expect
-  14:1  error  TypeScript expected type to be:
+  24:1  error  TypeScript expected type to be:
   NotRightAtAll
 got:
   1234                                                             @definitelytyped/expect
-  45:1  error  Cannot match a node to this assertion. If this is a multiline function call, ensure the assertion is on the line above  @definitelytyped/expect
-  49:1  error  Cannot match a node to this assertion. If this is a multiline function call, ensure the assertion is on the line above  @definitelytyped/expect
+  26:1  error  TypeScript expected type to be:
+  NotRightAtAll
+got:
+  1234                                                             @definitelytyped/expect
+  28:1  error  TypeScript expected type to be:
+  NotRightAtAll
+got:
+  1234                                                             @definitelytyped/expect
+  67:1  error  Cannot match a node to this assertion. If this is a multiline function call, ensure the assertion is on the line above  @definitelytyped/expect
+  71:1  error  Cannot match a node to this assertion. If this is a multiline function call, ensure the assertion is on the line above  @definitelytyped/expect
 
-✖ 4 problems (4 errors, 0 warnings)
+✖ 6 problems (6 errors, 0 warnings)
 
 ==== types/expect/expect-tests.ts ====
 
@@ -30,6 +38,16 @@ got:
     // $ExpectType 1234
     expect.foo;
 
+    //    $ExpectType     1234   
+    expect.foo;
+
+    //$ExpectType     1234   
+    expect.foo;
+
+    expect.foo; // $ExpectType 1234
+
+    const foo = expect.foo;
+    foo; // $ExpectType 1234
 
     // $ExpectType NotRightAtAll
     expect.foo;
@@ -39,6 +57,28 @@ got:
 !!!                        : got:
 !!!                        :   1234
 
+    expect.foo; // $ExpectType NotRightAtAll
+    ~~~~~~~~~~
+!!! @definitelytyped/expect: TypeScript expected type to be:
+!!!                        :   NotRightAtAll
+!!!                        : got:
+!!!                        :   1234
+
+    foo; // $ExpectType NotRightAtAll
+    ~~~
+!!! @definitelytyped/expect: TypeScript expected type to be:
+!!!                        :   NotRightAtAll
+!!!                        : got:
+!!!                        :   1234
+
+    // These should not be matched.
+    // // $ExpectType NotRightAtAll
+    expect.foo;
+
+    expect.foo; // // $ExpectType NotRightAtAll
+
+    expect.foo; /// $ExpectType NotRightAtAll
+
 
     // $ExpectType string | number | undefined
     expect.aUnion;

packages/eslint-plugin/test/fixtures/types/expect/expect-tests.ts

@@ -9,10 +9,32 @@ expect.foo;
 // $ExpectType 1234
 expect.foo;
 
+//    $ExpectType     1234   
+expect.foo;
+
+//$ExpectType     1234   
+expect.foo;
+
+expect.foo; // $ExpectType 1234
+
+const foo = expect.foo;
+foo; // $ExpectType 1234
 
 // $ExpectType NotRightAtAll
 expect.foo;
 
+expect.foo; // $ExpectType NotRightAtAll
+
+foo; // $ExpectType NotRightAtAll
+
+// These should not be matched.
+// // $ExpectType NotRightAtAll
+expect.foo;
+
+expect.foo; // // $ExpectType NotRightAtAll
+
+expect.foo; /// $ExpectType NotRightAtAll
+
 
 // $ExpectType string | number | undefined
 expect.aUnion;