Token hints for missing closing braces: classes, enums, jsx, modules, types

This commit adds token hints for missing close braces in

- Class definitions
- Enum definitions
- JSX expressions
- Module definitions (this includes augmentations and namespaces)
- Type member lists (this includes interfaces)

The token hint refers to the opening brace for which the parser expected
a corresponding closing brace.

Note that this commit *does not* update all occurences of an expectation
for a close brace to provide token hints. Constructs for which this
token hint is not provided include:

- Mapped types
- Switch statements
- Object binding patterns
- JSX spread attributes (`<div {...props}></div>`)
- JSDoc implements/augments tags (`/* @implements {SomeInterface} */`)

Part of #35597.

Author: Ayaz Hafiz

src/compiler/diagnosticMessages.json

@@ -15,7 +15,7 @@
         "category": "Error",
         "code": 1006
     },
-    "The parser expected to find a '}' to match the '{' token here.": {
+    "The parser expected to find a '{0}' to match the '{1}' token here.": {
         "category": "Error",
         "code": 1007
     },

src/compiler/parser.ts

@@ -1308,6 +1308,23 @@ namespace ts {
             return false;
         }
 
+        function parseExpectedCloseToken(closeTokenKind: SyntaxKind, openTokenKind: SyntaxKind, openTokenPos: number, shouldAdvance = true): boolean {
+            if (!parseExpected(closeTokenKind, /*diagnosticMessage*/ undefined, shouldAdvance)) {
+                const lastError = lastOrUndefined(parseDiagnostics);
+                if (lastError && lastError.code === Diagnostics._0_expected.code) {
+                    const openTokenStr = tokenToString(openTokenKind)!;
+                    const closeTokenStr = tokenToString(closeTokenKind)!;
+                    addRelatedInfo(
+                        lastError,
+                        createFileDiagnostic(sourceFile, openTokenPos, openTokenStr.length,
+                                             Diagnostics.The_parser_expected_to_find_a_0_to_match_the_1_token_here, closeTokenStr, openTokenStr)
+                    );
+                }
+                return false;
+            }
+            return true;
+        }
+
         function parseExpectedJSDoc(kind: JSDocSyntaxKind) {
             if (token() === kind) {
                 nextTokenJSDoc();
@@ -2988,9 +3005,10 @@ namespace ts {
 
         function parseObjectTypeMembers(): NodeArray<TypeElement> {
             let members: NodeArray<TypeElement>;
+            const openBracePosition = scanner.getTokenPos();
             if (parseExpected(SyntaxKind.OpenBraceToken)) {
                 members = parseList(ParsingContext.TypeMembers, parseTypeMember);
-                parseExpected(SyntaxKind.CloseBraceToken);
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
                 members = createMissingList<TypeElement>();
@@ -4654,6 +4672,7 @@ namespace ts {
         function parseJsxExpression(inExpressionContext: boolean): JsxExpression | undefined {
             const node = <JsxExpression>createNode(SyntaxKind.JsxExpression);
 
+            const openBracePosition = scanner.getTokenPos();
             if (!parseExpected(SyntaxKind.OpenBraceToken)) {
                 return undefined;
             }
@@ -4666,10 +4685,10 @@ namespace ts {
                 node.expression = parseExpression();
             }
             if (inExpressionContext) {
-                parseExpected(SyntaxKind.CloseBraceToken);
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
-                if (parseExpected(SyntaxKind.CloseBraceToken, /*message*/ undefined, /*shouldAdvance*/ false)) {
+                if (parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition, /*shouldAdvance*/ false)) {
                     scanJsxText();
                 }
             }
@@ -5121,15 +5140,7 @@ namespace ts {
             }
 
             node.properties = parseDelimitedList(ParsingContext.ObjectLiteralMembers, parseObjectLiteralElement, /*considerSemicolonAsDelimiter*/ true);
-            if (!parseExpected(SyntaxKind.CloseBraceToken)) {
-                const lastError = lastOrUndefined(parseDiagnostics);
-                if (lastError && lastError.code === Diagnostics._0_expected.code) {
-                    addRelatedInfo(
-                        lastError,
-                        createFileDiagnostic(sourceFile, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
-                    );
-                }
-            }
+            parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             return finishNode(node);
         }
 
@@ -5214,15 +5225,7 @@ namespace ts {
                 }
 
                 node.statements = parseList(ParsingContext.BlockStatements, parseStatement);
-                if (!parseExpected(SyntaxKind.CloseBraceToken)) {
-                    const lastError = lastOrUndefined(parseDiagnostics);
-                    if (lastError && lastError.code === Diagnostics._0_expected.code) {
-                        addRelatedInfo(
-                            lastError,
-                            createFileDiagnostic(sourceFile, openBracePosition, 1, Diagnostics.The_parser_expected_to_find_a_to_match_the_token_here)
-                        );
-                    }
-                }
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
                 node.statements = createMissingList<Statement>();
@@ -6262,11 +6265,12 @@ namespace ts {
             node.typeParameters = parseTypeParameters();
             node.heritageClauses = parseHeritageClauses();
 
+            const openBracePosition = scanner.getTokenPos();
             if (parseExpected(SyntaxKind.OpenBraceToken)) {
                 // ClassTail[Yield,Await] : (Modified) See 14.5
                 //      ClassHeritage[?Yield,?Await]opt { ClassBody[?Yield,?Await]opt }
                 node.members = parseClassMembers();
-                parseExpected(SyntaxKind.CloseBraceToken);
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
                 node.members = createMissingList<ClassElement>();
@@ -6367,9 +6371,10 @@ namespace ts {
             node.kind = SyntaxKind.EnumDeclaration;
             parseExpected(SyntaxKind.EnumKeyword);
             node.name = parseIdentifier();
+            const openBracePosition = scanner.getTokenPos();
             if (parseExpected(SyntaxKind.OpenBraceToken)) {
                 node.members = doOutsideOfYieldAndAwaitContext(() => parseDelimitedList(ParsingContext.EnumMembers, parseEnumMember));
-                parseExpected(SyntaxKind.CloseBraceToken);
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
                 node.members = createMissingList<EnumMember>();
@@ -6379,9 +6384,10 @@ namespace ts {
 
         function parseModuleBlock(): ModuleBlock {
             const node = <ModuleBlock>createNode(SyntaxKind.ModuleBlock);
+            const openBracePosition = scanner.getTokenPos();
             if (parseExpected(SyntaxKind.OpenBraceToken)) {
                 node.statements = parseList(ParsingContext.BlockStatements, parseStatement);
-                parseExpected(SyntaxKind.CloseBraceToken);
+                parseExpectedCloseToken(SyntaxKind.CloseBraceToken, SyntaxKind.OpenBraceToken, openBracePosition);
             }
             else {
                 node.statements = createMissingList<Statement>();

tests/baselines/reference/classMemberWithMissingIdentifier.errors.txt

@@ -10,6 +10,7 @@ tests/cases/compiler/classMemberWithMissingIdentifier.ts(3,1): error TS1128: Dec
 !!! error TS1146: Declaration expected.
                ~
 !!! error TS1005: ';' expected.
+!!! related TS1007 tests/cases/compiler/classMemberWithMissingIdentifier.ts:1:9: The parser expected to find a '}' to match the '{' token here.
     }
     ~
 !!! error TS1128: Declaration or statement expected.

tests/baselines/reference/classMemberWithMissingIdentifier2.errors.txt

@@ -14,6 +14,7 @@ tests/cases/compiler/classMemberWithMissingIdentifier2.ts(3,1): error TS1128: De
 !!! error TS1146: Declaration expected.
                ~
 !!! error TS1005: ';' expected.
+!!! related TS1007 tests/cases/compiler/classMemberWithMissingIdentifier2.ts:1:9: The parser expected to find a '}' to match the '{' token here.
                      ~
 !!! error TS1005: ',' expected.
                       ~~~~~~

tests/baselines/reference/constructorWithIncompleteTypeAnnotation.errors.txt

@@ -142,6 +142,7 @@ tests/cases/compiler/constructorWithIncompleteTypeAnnotation.ts(261,1): error TS
                     if (retValue != 0) {
                                  ~~
 !!! error TS1005: ',' expected.
+!!! related TS1007 tests/cases/compiler/constructorWithIncompleteTypeAnnotation.ts:15:26: The parser expected to find a '}' to match the '{' token here.
                                      ~
 !!! error TS1005: ';' expected.
 

tests/baselines/reference/derivedClassSuperCallsInNonConstructorMembers.errors.txt

@@ -50,6 +50,7 @@ tests/cases/conformance/classes/constructorDeclarations/superCalls/derivedClassS
 !!! error TS2304: Cannot find name 'super'.
                 ~
 !!! error TS1005: ';' expected.
+!!! related TS1007 tests/cases/conformance/classes/constructorDeclarations/superCalls/derivedClassSuperCallsInNonConstructorMembers.ts:7:28: The parser expected to find a '}' to match the '{' token here.
                  ~
 !!! error TS1109: Expression expected.
         b() {

tests/baselines/reference/errorRecoveryWithDotFollowedByNamespaceKeyword.errors.txt

@@ -17,4 +17,5 @@ tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts(9,2): err
 
 !!! error TS1005: '}' expected.
 !!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:3:19: The parser expected to find a '}' to match the '{' token here.
-!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:2:20: The parser expected to find a '}' to match the '{' token here.
+!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:2:20: The parser expected to find a '}' to match the '{' token here.
+!!! related TS1007 tests/cases/compiler/errorRecoveryWithDotFollowedByNamespaceKeyword.ts:1:13: The parser expected to find a '}' to match the '{' token here.

tests/baselines/reference/jsxAndTypeAssertion.errors.txt

@@ -21,9 +21,11 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(18,69): error TS1381: Unexpe
 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(18,76): error TS1381: Unexpected token. Did you mean `{'}'}` or `}`?
 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: ':' expected.
 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' expected.
+tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' expected.
+tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' expected.
 
 
-==== tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx (23 errors) ====
+==== tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx (25 errors) ====
     declare var createElement: any;
 
     class foo {}
@@ -36,6 +38,7 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' ex
 !!! error TS2582: Cannot find name 'test'. Do you need to install type definitions for a test runner? Try `npm i @types/jest` or `npm i @types/mocha`.
                     ~
 !!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:6:11: The parser expected to find a '}' to match the '{' token here.
                                   ~
 !!! error TS1381: Unexpected token. Did you mean `{'}'}` or `&rbrace;`?
 
@@ -50,6 +53,7 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' ex
 !!! error TS1381: Unexpected token. Did you mean `{'}'}` or `&rbrace;`?
                                    ~
 !!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:10:16: The parser expected to find a '}' to match the '{' token here.
 
     x = <foo test={<foo>{}}>hello</foo>;
                           ~
@@ -58,6 +62,7 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' ex
 !!! error TS1382: Unexpected token. Did you mean `{'>'}` or `&gt;`?
                                        ~
 !!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:12:15: The parser expected to find a '}' to match the '{' token here.
 
     x = <foo test={<foo>{}}>hello{<foo>{}}</foo>;
                     ~~~
@@ -70,6 +75,7 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' ex
 !!! error TS1381: Unexpected token. Did you mean `{'}'}` or `&rbrace;`?
                                                 ~
 !!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:14:30: The parser expected to find a '}' to match the '{' token here.
 
     x = <foo>x</foo>, x = <foo/>;
 
@@ -89,5 +95,12 @@ tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx(21,1): error TS1005: '</' ex
 
 
 !!! error TS1005: ':' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:18:17: The parser expected to find a '}' to match the '{' token here.
+    
+!!! error TS1005: '</' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:14:15: The parser expected to find a '}' to match the '{' token here.
+    
+!!! error TS1005: '</' expected.
+!!! related TS1007 tests/cases/conformance/jsx/jsxAndTypeAssertion.tsx:18:6: The parser expected to find a '}' to match the '{' token here.
 
 !!! error TS1005: '</' expected.

tests/baselines/reference/jsxInvalidEsprimaTestSuite.errors.txt

@@ -244,6 +244,7 @@ tests/cases/conformance/jsx/9.tsx(1,16): error TS1109: Expression expected.
     <a>{"str";}</a>;
              ~
 !!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/conformance/jsx/20.tsx:1:4: The parser expected to find a '}' to match the '{' token here.
               ~
 !!! error TS1381: Unexpected token. Did you mean `{'}'}` or `&rbrace;`?
 ==== tests/cases/conformance/jsx/21.tsx (1 errors) ====

tests/baselines/reference/missingCloseBraceInClassDeclaration.errors.txt

@@ -0,0 +1,14 @@
+tests/cases/compiler/missingCloseBraceInClassDeclaration.ts(7,1): error TS1005: '}' expected.
+
+
+==== tests/cases/compiler/missingCloseBraceInClassDeclaration.ts (1 errors) ====
+    class TestCls {
+      prop = 0;
+      method() {
+        return this.prop;
+      }
+    
+    
+    
+!!! error TS1005: '}' expected.
+!!! related TS1007 tests/cases/compiler/missingCloseBraceInClassDeclaration.ts:1:15: The parser expected to find a '}' to match the '{' token here.