Fix ExpectType with extra whitespace (microsoft#1011)

jakebailey · web-flow · commit c3d86f3804dc · 2024-06-18T15:59:10.000-07:00
diff --git a/.changeset/chatty-stingrays-walk.md b/.changeset/chatty-stingrays-walk.md
@@ -0,0 +1,5 @@
+---
+"@definitelytyped/eslint-plugin": patch
+---
+
+Fix ExpectType with extra whitespace
diff --git a/packages/eslint-plugin/src/rules/expect.ts b/packages/eslint-plugin/src/rules/expect.ts
@@ -401,7 +401,7 @@ function parseAssertions(sourceFile: ts.SourceFile): Assertions {
   const duplicates: number[] = [];
 
   const { text } = sourceFile;
-  const commentRegexp = /\/\/(.*)/g;
+  const commentRegexp = /\/\/\s*\$ExpectType\s+(.*)/g;
   const lineStarts = sourceFile.getLineStarts();
   let curLine = 0;
 
@@ -410,13 +410,8 @@ 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 ")) {
-      continue;
-    }
     const line = getLine(commentMatch.index);
-    const expectedType = commentMatch[1].slice(" $ExpectType ".length);
+    const expectedType = commentMatch[1].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);
diff --git a/packages/eslint-plugin/test/__file_snapshots__/types/expect/expect-tests.ts.lint b/packages/eslint-plugin/test/__file_snapshots__/types/expect/expect-tests.ts.lint
@@ -3,12 +3,12 @@ types/expect/expect-tests.ts
   number
 got:
   1234                                                                    @definitelytyped/expect
-  14:1  error  TypeScript expected type to be:
+  16: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
+  47: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
+  51: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)
 
@@ -30,6 +30,8 @@ got:
     // $ExpectType 1234
     expect.foo;
     
+    //    $ExpectType     1234   
+    expect.foo;
     
     // $ExpectType NotRightAtAll
     expect.foo;
diff --git a/packages/eslint-plugin/test/fixtures/types/expect/expect-tests.ts b/packages/eslint-plugin/test/fixtures/types/expect/expect-tests.ts
@@ -9,6 +9,8 @@ expect.foo;
 // $ExpectType 1234
 expect.foo;
 
+//    $ExpectType     1234   
+expect.foo;
 
 // $ExpectType NotRightAtAll
 expect.foo;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@definitelytyped/eslint-plugin": patch
 +---
++
 +Fix ExpectType with extra whitespace