Add related span pointing at missing arguments (#27013)

Author: weswigham

src/compiler/checker.ts

@@ -19208,12 +19208,16 @@ namespace ts {
             let aboveArgCount = Number.POSITIVE_INFINITY;
 
             let argCount = args.length;
+            let closestSignature: Signature | undefined;
             for (const sig of signatures) {
                 const minCount = getMinArgumentCount(sig);
                 const maxCount = getParameterCount(sig);
                 if (minCount < argCount && minCount > belowArgCount) belowArgCount = minCount;
                 if (argCount < maxCount && maxCount < aboveArgCount) aboveArgCount = maxCount;
-                min = Math.min(min, minCount);
+                if (minCount < min) {
+                    min = minCount;
+                    closestSignature = sig;
+                }
                 max = Math.max(max, maxCount);
             }
 
@@ -19226,16 +19230,29 @@ namespace ts {
                 argCount--;
             }
 
+            let related: DiagnosticWithLocation | undefined;
+            if (closestSignature && getMinArgumentCount(closestSignature) > argCount && closestSignature.declaration) {
+                const paramDecl = closestSignature.declaration.parameters[closestSignature.thisParameter ? argCount + 1 : argCount];
+                if (paramDecl) {
+                    related = createDiagnosticForNode(
+                        paramDecl,
+                        isBindingPattern(paramDecl.name) ? Diagnostics.An_argument_matching_this_binding_pattern_was_not_provided : Diagnostics.An_argument_for_0_was_not_provided,
+                        !paramDecl.name ? argCount : !isBindingPattern(paramDecl.name) ? idText(getFirstIdentifier(paramDecl.name)) : undefined
+                    );
+                }
+            }
             if (hasRestParameter || hasSpreadArgument) {
                 const error = hasRestParameter && hasSpreadArgument ? Diagnostics.Expected_at_least_0_arguments_but_got_1_or_more :
                     hasRestParameter ? Diagnostics.Expected_at_least_0_arguments_but_got_1 :
                     Diagnostics.Expected_0_arguments_but_got_1_or_more;
-                return createDiagnosticForNode(node, error, paramRange, argCount);
+                const diagnostic = createDiagnosticForNode(node, error, paramRange, argCount);
+                return related ? addRelatedInfo(diagnostic, related) : diagnostic;
             }
             if (min < argCount && argCount < max) {
                 return createDiagnosticForNode(node, Diagnostics.No_overload_expects_0_arguments_but_overloads_do_exist_that_expect_either_1_or_2_arguments, argCount, belowArgCount, aboveArgCount);
             }
-            return createDiagnosticForNode(node, Diagnostics.Expected_0_arguments_but_got_1, paramRange, argCount);
+            const diagnostic = createDiagnosticForNode(node, Diagnostics.Expected_0_arguments_but_got_1, paramRange, argCount);
+            return related ? addRelatedInfo(diagnostic, related) : diagnostic;
         }
 
         function getTypeArgumentArityError(node: Node, signatures: ReadonlyArray<Signature>, typeArguments: NodeArray<TypeNode>) {

src/compiler/diagnosticMessages.json

@@ -3708,6 +3708,14 @@
         "category": "Message",
         "code": 6209
     },
+    "An argument for '{0}' was not provided.": {
+        "category": "Message",
+        "code": 6210
+    },
+    "An argument matching this binding pattern was not provided.": {
+        "category": "Message",
+        "code": 6211
+    },
 
     "Projects to reference": {
         "category": "Message",

tests/baselines/reference/arityErrorRelatedSpanBindingPattern.errors.txt

@@ -0,0 +1,19 @@
+tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts(5,1): error TS2554: Expected 3 arguments, but got 2.
+tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts(7,1): error TS2554: Expected 3 arguments, but got 2.
+
+
+==== tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts (2 errors) ====
+    function foo(a, b, {c}): void {}
+    
+    function bar(a, b, [c]): void {}
+    
+    foo("", 0);
+    ~~~~~~~~~~
+!!! error TS2554: Expected 3 arguments, but got 2.
+!!! related TS6211 tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts:1:20: An argument matching this binding pattern was not provided.
+    
+    bar("", 0);
+    ~~~~~~~~~~
+!!! error TS2554: Expected 3 arguments, but got 2.
+!!! related TS6211 tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts:3:20: An argument matching this binding pattern was not provided.
+    

tests/baselines/reference/arityErrorRelatedSpanBindingPattern.js

@@ -0,0 +1,19 @@
+//// [arityErrorRelatedSpanBindingPattern.ts]
+function foo(a, b, {c}): void {}
+
+function bar(a, b, [c]): void {}
+
+foo("", 0);
+
+bar("", 0);
+
+
+//// [arityErrorRelatedSpanBindingPattern.js]
+function foo(a, b, _a) {
+    var c = _a.c;
+}
+function bar(a, b, _a) {
+    var c = _a[0];
+}
+foo("", 0);
+bar("", 0);

tests/baselines/reference/arityErrorRelatedSpanBindingPattern.symbols

@@ -0,0 +1,19 @@
+=== tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts ===
+function foo(a, b, {c}): void {}
+>foo : Symbol(foo, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 0))
+>a : Symbol(a, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 13))
+>b : Symbol(b, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 15))
+>c : Symbol(c, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 20))
+
+function bar(a, b, [c]): void {}
+>bar : Symbol(bar, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 32))
+>a : Symbol(a, Decl(arityErrorRelatedSpanBindingPattern.ts, 2, 13))
+>b : Symbol(b, Decl(arityErrorRelatedSpanBindingPattern.ts, 2, 15))
+>c : Symbol(c, Decl(arityErrorRelatedSpanBindingPattern.ts, 2, 20))
+
+foo("", 0);
+>foo : Symbol(foo, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 0))
+
+bar("", 0);
+>bar : Symbol(bar, Decl(arityErrorRelatedSpanBindingPattern.ts, 0, 32))
+

tests/baselines/reference/arityErrorRelatedSpanBindingPattern.types

@@ -0,0 +1,25 @@
+=== tests/cases/compiler/arityErrorRelatedSpanBindingPattern.ts ===
+function foo(a, b, {c}): void {}
+>foo : (a: any, b: any, { c }: { c: any; }) => void
+>a : any
+>b : any
+>c : any
+
+function bar(a, b, [c]): void {}
+>bar : (a: any, b: any, [c]: [any]) => void
+>a : any
+>b : any
+>c : any
+
+foo("", 0);
+>foo("", 0) : void
+>foo : (a: any, b: any, { c }: { c: any; }) => void
+>"" : ""
+>0 : 0
+
+bar("", 0);
+>bar("", 0) : void
+>bar : (a: any, b: any, [c]: [any]) => void
+>"" : ""
+>0 : 0
+

tests/baselines/reference/baseCheck.errors.txt

@@ -32,6 +32,7 @@ tests/cases/compiler/baseCheck.ts(26,9): error TS2304: Cannot find name 'x'.
     class D extends C { constructor(public z: number) { super(this.z) }  } // too few params
                                                         ~~~~~~~~~~~~~
 !!! error TS2554: Expected 2 arguments, but got 1.
+!!! related TS6210 tests/cases/compiler/baseCheck.ts:1:34: An argument for 'y' was not provided.
                                                               ~~~~
 !!! error TS17009: 'super' must be called before accessing 'this' in the constructor of a derived class.
     class E extends C { constructor(public z: number) { super(0, this.z) } }

tests/baselines/reference/blockScopedSameNameFunctionDeclarationES5.errors.txt

@@ -34,4 +34,5 @@ tests/cases/compiler/blockScopedSameNameFunctionDeclarationES5.ts(16,1): error T
     foo(10);
     foo(); // not ok - needs number
     ~~~~~
-!!! error TS2554: Expected 1 arguments, but got 0.
+!!! error TS2554: Expected 1 arguments, but got 0.
+!!! related TS6210 tests/cases/compiler/blockScopedSameNameFunctionDeclarationES5.ts:1:14: An argument for 'a' was not provided.

tests/baselines/reference/blockScopedSameNameFunctionDeclarationES6.errors.txt

@@ -34,4 +34,5 @@ tests/cases/compiler/blockScopedSameNameFunctionDeclarationES6.ts(16,1): error T
     foo(10);
     foo(); // not ok - needs number
     ~~~~~
-!!! error TS2554: Expected 1 arguments, but got 0.
+!!! error TS2554: Expected 1 arguments, but got 0.
+!!! related TS6210 tests/cases/compiler/blockScopedSameNameFunctionDeclarationES6.ts:1:14: An argument for 'a' was not provided.

tests/baselines/reference/blockScopedSameNameFunctionDeclarationStrictES5.errors.txt

@@ -31,8 +31,10 @@ tests/cases/compiler/blockScopedSameNameFunctionDeclarationStrictES5.ts(17,1): e
         foo(); // not ok - needs number
         ~~~~~
 !!! error TS2554: Expected 1 arguments, but got 0.
+!!! related TS6210 tests/cases/compiler/blockScopedSameNameFunctionDeclarationStrictES5.ts:2:14: An argument for 'a' was not provided.
     }
     foo(10);
     foo(); // not ok - needs number
     ~~~~~
-!!! error TS2554: Expected 1 arguments, but got 0.
+!!! error TS2554: Expected 1 arguments, but got 0.
+!!! related TS6210 tests/cases/compiler/blockScopedSameNameFunctionDeclarationStrictES5.ts:2:14: An argument for 'a' was not provided.