Report assignability errors on the return/yield keywords (#52943)

Author: Andarist

src/compiler/utilities.ts

@@ -2179,13 +2179,14 @@ function getErrorSpanForArrowFunction(sourceFile: SourceFile, node: ArrowFunctio
 export function getErrorSpanForNode(sourceFile: SourceFile, node: Node): TextSpan {
     let errorNode: Node | undefined = node;
     switch (node.kind) {
-        case SyntaxKind.SourceFile:
+        case SyntaxKind.SourceFile: {
             const pos = skipTrivia(sourceFile.text, 0, /*stopAfterLineBreak*/ false);
             if (pos === sourceFile.text.length) {
                 // file is empty - return span for the beginning of the file
                 return createTextSpan(0, 0);
             }
             return getSpanOfTokenAtPosition(sourceFile, pos);
+        }
         // This list is a work in progress. Add missing node kinds to improve their error
         // spans.
         case SyntaxKind.VariableDeclaration:
@@ -2210,10 +2211,16 @@ export function getErrorSpanForNode(sourceFile: SourceFile, node: Node): TextSpa
         case SyntaxKind.ArrowFunction:
             return getErrorSpanForArrowFunction(sourceFile, node as ArrowFunction);
         case SyntaxKind.CaseClause:
-        case SyntaxKind.DefaultClause:
+        case SyntaxKind.DefaultClause: {
             const start = skipTrivia(sourceFile.text, (node as CaseOrDefaultClause).pos);
             const end = (node as CaseOrDefaultClause).statements.length > 0 ? (node as CaseOrDefaultClause).statements[0].pos : (node as CaseOrDefaultClause).end;
             return createTextSpanFromBounds(start, end);
+        }
+        case SyntaxKind.ReturnStatement:
+        case SyntaxKind.YieldExpression: {
+            const pos = skipTrivia(sourceFile.text, (node as ReturnStatement | YieldExpression).pos);
+            return getSpanOfTokenAtPosition(sourceFile, pos);
+        }
     }
 
     if (errorNode === undefined) {

tests/baselines/reference/accessors_spec_section-4.5_error-cases.errors.txt

@@ -8,11 +8,11 @@ tests/cases/compiler/accessors_spec_section-4.5_error-cases.ts(11,51): error TS2
     class LanguageSpec_section_4_5_error_cases {
         public set AnnotatedSetter_SetterFirst(a: number) { }
         public get AnnotatedSetter_SetterFirst() { return ""; }
-                                                   ~~~~~~~~~~
+                                                   ~~~~~~
 !!! error TS2322: Type 'string' is not assignable to type 'number'.
 
         public get AnnotatedSetter_SetterLast() { return ""; }
-                                                  ~~~~~~~~~~
+                                                  ~~~~~~
 !!! error TS2322: Type 'string' is not assignable to type 'number'.
         public set AnnotatedSetter_SetterLast(a: number) { }
 

tests/baselines/reference/asyncArrowFunction_allowJs.errors.txt

@@ -28,7 +28,7 @@ tests/cases/conformance/async/es2017/asyncArrowFunction/file.js(19,3): error TS2
 !!! error TS1064: The return type of an async function or method must be the global Promise<T> type. Did you mean to write 'Promise<string>'?
     const c = async () => {
     	return 0
-    	~~~~~~~~
+    	~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     }
 

tests/baselines/reference/baseConstraintOfDecorator.errors.txt

@@ -7,22 +7,17 @@ tests/cases/compiler/baseConstraintOfDecorator.ts(12,18): error TS2545: A mixin
 ==== tests/cases/compiler/baseConstraintOfDecorator.ts (3 errors) ====
     export function classExtender<TFunction>(superClass: TFunction, _instanceModifier: (instance: any, args: any[]) => void): TFunction {
         return class decoratorFunc extends superClass {
-        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        ~~~~~~
+!!! error TS2322: Type 'typeof decoratorFunc' is not assignable to type 'TFunction'.
+!!! error TS2322:   'TFunction' could be instantiated with an arbitrary type which could be unrelated to 'typeof decoratorFunc'.
                                            ~~~~~~~~~~
 !!! error TS2507: Type 'TFunction' is not a constructor function type.
 !!! related TS2735 tests/cases/compiler/baseConstraintOfDecorator.ts:1:31: Did you mean for 'TFunction' to be constrained to type 'new (...args: any[]) => unknown'?
             constructor(...args: any[]) {
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                 super(...args);
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
                 _instanceModifier(this, args);
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
             }
-    ~~~~~~~~~
         };
-    ~~~~~~
-!!! error TS2322: Type 'typeof decoratorFunc' is not assignable to type 'TFunction'.
-!!! error TS2322:   'TFunction' could be instantiated with an arbitrary type which could be unrelated to 'typeof decoratorFunc'.
     }
 
     class MyClass { private x; }

tests/baselines/reference/checkJsdocReturnTag2.errors.txt

@@ -12,7 +12,7 @@ tests/cases/conformance/jsdoc/returns.js(13,5): error TS2322: Type 'number | boo
      */
     function f() {
         return 5;
-        ~~~~~~~~~
+        ~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     }
 
@@ -21,7 +21,7 @@ tests/cases/conformance/jsdoc/returns.js(13,5): error TS2322: Type 'number | boo
      */
     function f1() {
         return 5 || true;
-        ~~~~~~~~~~~~~~~~~
+        ~~~~~~
 !!! error TS2322: Type 'number | boolean' is not assignable to type 'string | number'.
 !!! error TS2322:   Type 'boolean' is not assignable to type 'string | number'.
     }

tests/baselines/reference/checkJsdocTypeTag5.errors.txt

@@ -13,28 +13,28 @@ tests/cases/conformance/jsdoc/test.js(34,5): error TS2322: Type '1 | 2' is not a
     // all 6 should error on return statement/expression
     /** @type {(x: number) => string} */
     function h(x) { return x }
-                    ~~~~~~~~
+                    ~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     /** @type {(x: number) => string} */
     var f = x => x
                  ~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     /** @type {(x: number) => string} */
     var g = function (x) { return x }
-                           ~~~~~~~~
+                           ~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
 
     /** @type {{ (x: number): string }} */
     function i(x) { return x }
-                    ~~~~~~~~
+                    ~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     /** @type {{ (x: number): string }} */
     var j = x => x
                  ~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     /** @type {{ (x: number): string }} */
     var k = function (x) { return x }
-                           ~~~~~~~~
+                           ~~~~~~
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
 
 

tests/baselines/reference/checkJsdocTypeTagOnObjectProperty2.errors.txt

@@ -19,7 +19,7 @@ tests/cases/conformance/jsdoc/0.js(22,22): error TS2345: Argument of type 'strin
       /** @type {function(number): number} */
       method1(n1) {
           return "42";
-          ~~~~~~~~~~~~
+          ~~~~~~
 !!! error TS2322: Type 'string' is not assignable to type 'number'.
       },
       /** @type {function(number): number} */

tests/baselines/reference/complicatedIndexedAccessKeyofReliesOnKeyofNeverUpperBound.errors.txt

@@ -53,7 +53,7 @@ tests/cases/compiler/complicatedIndexedAccessKeyofReliesOnKeyofNeverUpperBound.t
     export function makeNewChannel<T extends ChannelType>(type: T): NewChannel<ChannelOfType<T>> {
         const localChannelId = `blahblahblah`;
         return { type, localChannelId };
-        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        ~~~~~~
 !!! error TS2322: Type '{ type: T; localChannelId: string; }' is not assignable to type 'NewChannel<ChannelOfType<T, TextChannel> | ChannelOfType<T, EmailChannel>>'.
 !!! error TS2322:   Type '{ type: T; localChannelId: string; }' is not assignable to type 'Pick<ChannelOfType<T, TextChannel> | ChannelOfType<T, EmailChannel>, "type">'.
 !!! error TS2322:     Types of property 'type' are incompatible.

tests/baselines/reference/conditionalTypeAssignabilityWhenDeferred.errors.txt

@@ -129,7 +129,7 @@ tests/cases/compiler/conditionalTypeAssignabilityWhenDeferred.ts(116,3): error T
 
     function f3<Q extends (arg: any) => any>(x: Q): InferBecauseWhyNot<Q> {
       return x;
-      ~~~~~~~~~
+      ~~~~~~
 !!! error TS2322: Type 'Q' is not assignable to type 'InferBecauseWhyNot<Q>'.
 !!! error TS2322:   Type '(arg: any) => any' is not assignable to type 'InferBecauseWhyNot<Q>'.
     }
@@ -142,7 +142,7 @@ tests/cases/compiler/conditionalTypeAssignabilityWhenDeferred.ts(116,3): error T
       x: Q
     ): InferBecauseWhyNotDistributive<Q> {
       return x; // should fail
-      ~~~~~~~~~
+      ~~~~~~
 !!! error TS2322: Type 'Q' is not assignable to type 'InferBecauseWhyNotDistributive<Q>'.
 !!! error TS2322:   Type '(arg: any) => any' is not assignable to type 'InferBecauseWhyNotDistributive<Q>'.
     }

tests/baselines/reference/constEnumPropertyAccess1.errors.txt

@@ -27,7 +27,7 @@ tests/cases/conformance/constEnums/constEnumPropertyAccess1.ts(25,9): error TS23
         [G.A]() { }
         get [G.B]() {
             return true;
-            ~~~~~~~~~~~~
+            ~~~~~~
 !!! error TS2322: Type 'boolean' is not assignable to type 'number'.
         }
         set [G.B](x: number) { }