fix(46570): Unhelpful Promise type argument hint in JS file

Author: nicdard

src/compiler/checker.ts

@@ -30414,7 +30414,9 @@ namespace ts {
                 : min < max ? min + "-" + max
                 : min;
             const error = hasRestParameter ? Diagnostics.Expected_at_least_0_arguments_but_got_1
-                : parameterRange === 1 && args.length === 0 && isPromiseResolveArityError(node) ? Diagnostics.Expected_0_arguments_but_got_1_TypeScript_may_need_a_JSDoc_hint_that_the_call_to_new_Promise_produces_a_Promise_void
+                : parameterRange === 1 && args.length === 0 && isPromiseResolveArityError(node) ? isInJSFile(node)
+                    ? Diagnostics.Expected_0_arguments_but_got_1_TypeScript_may_need_a_JSDoc_hint_that_the_call_to_new_Promise_produces_a_Promise_void
+                    : Diagnostics.Expected_0_arguments_but_got_1_Did_you_forget_to_include_void_in_your_type_argument_to_Promise
                 : Diagnostics.Expected_0_arguments_but_got_1;
             if (min < args.length && args.length < max) {
                 // between min and max, but with no matching overload

src/compiler/diagnosticMessages.json

@@ -3309,7 +3309,7 @@
         "category": "Error",
         "code": 2793
     },
-    "Expected {0} arguments, but got {1}. TypeScript may need a JSDoc hint that the call to 'new Promise()' produces a 'Promise<void>'": {
+    "Expected {0} arguments, but got {1}. Did you forget to include 'void' in your type argument to 'Promise'?": {
         "category": "Error",
         "code": 2794
     },
@@ -3369,6 +3369,10 @@
         "category": "Error",
         "code": 2809
     },
+    "Expected {0} arguments, but got {1}. TypeScript may need a JSDoc hint that the call to 'new Promise()' produces a 'Promise<void>'": {
+        "category": "Error",
+        "code": 2810
+    },
     "Initializer for property '{0}'": {
         "category": "Error",
         "code": 2811

src/services/codefixes/fixAddVoidToPromise.ts

@@ -3,7 +3,8 @@ namespace ts.codefix {
     const fixName = "addVoidToPromise";
     const fixId = "addVoidToPromise";
     const errorCodes = [
-        Diagnostics.Expected_0_arguments_but_got_1_TypeScript_may_need_a_JSDoc_hint_that_the_call_to_new_Promise_produces_a_Promise_void.code
+        Diagnostics.Expected_0_arguments_but_got_1_TypeScript_may_need_a_JSDoc_hint_that_the_call_to_new_Promise_produces_a_Promise_void.code,
+        Diagnostics.Expected_0_arguments_but_got_1_Did_you_forget_to_include_void_in_your_type_argument_to_Promise.code
     ];
     registerCodeFix({
         errorCodes,

tests/cases/fourslash/codeFixAddVoidToPromiseJS.1.ts

@@ -9,7 +9,7 @@
 ////const p1 = new Promise(resolve => resolve());
 
 verify.codeFix({
-    errorCode: 2794,
+    errorCode: 2810,
     description: "Add 'void' to Promise resolved without a value",
     index: 2,
     newFileContent: `const p1 = /** @type {Promise<void>} */(new Promise(resolve => resolve()));`

tests/cases/fourslash/codeFixAddVoidToPromiseJS.2.ts

@@ -9,7 +9,7 @@
 ////const p2 = /** @type {Promise<number>} */(new Promise(resolve => resolve()));
 
 verify.codeFix({
-    errorCode: 2794,
+    errorCode: 2810,
     description: "Add 'void' to Promise resolved without a value",
     index: 2,
     newFileContent: `const p2 = /** @type {Promise<number | void>} */(new Promise(resolve => resolve()));`

tests/cases/fourslash/codeFixAddVoidToPromiseJS.3.ts

@@ -9,7 +9,7 @@
 ////const p3 = /** @type {Promise<number | string>} */(new Promise(resolve => resolve()));
 
 verify.codeFix({
-    errorCode: 2794,
+    errorCode: 2810,
     description: "Add 'void' to Promise resolved without a value",
     index: 2,
     newFileContent: `const p3 = /** @type {Promise<number | string | void>} */(new Promise(resolve => resolve()));`

tests/cases/fourslash/codeFixAddVoidToPromiseJS.4.ts

@@ -9,7 +9,7 @@
 ////const p4 = /** @type {Promise<{ x: number } & { y: string }>} */(new Promise(resolve => resolve()));
 
 verify.codeFix({
-    errorCode: 2794,
+    errorCode: 2810,
     description: "Add 'void' to Promise resolved without a value",
     index: 2,
     newFileContent: `const p4 = /** @type {Promise<({ x: number } & { y: string }) | void>} */(new Promise(resolve => resolve()));`