fix(45901): Error 1064 should apply to @callback definitions in the same way as @param, but doesn't

[a-tarasyuk]

Fixes #45901

[sandersn]

I think the basic approach is fine, and as a targetted fix, this just needs a little cleanup. Couple of points to follow up on, though:

1. I would inline getReturnInfoOfSignatureDeclaration since it's only used once and it allocates (unless the VM optimises it).
2. I thought there was a utility function that checks for a @type tag if getEffectiveReturnTypeNode returns undefined. Is that utility appropriate here? It probably doesn't return enough information though -- my memory is that it returns a Type instead of a Node. However, if you can find that utility, you should look at its callers to see if they could improve their error messages if they called getReturnInfoOfSignatureDeclaration instead.

I also need to think about the wording of the new error message. It's a little off but I haven't figured out an improvement.

[fatcerberus]

Shouldn't the error message be the same as other instances of this error? i.e.

The return type of an async function or method must be the global Promise<T> type.

I'm not sure why a new error message is even needed.

[a-tarasyuk]

@sandersn Thanks for the feedback. There is a utility called getReturnTypeFromAnnotation that returns a Type. This utility handles cases with JSDoc type tags by utilizing getReturnTypeOfTypeTag, which also returns a Type. We can attempt to use the type instead of the TypeNode to perform all checks. However, we still need the return TypeNode for error messages.

I would inline getReturnInfoOfSignatureDeclaration since it's only used once and it allocates (unless the VM optimises it)

Are you suggesting moving the logic from getReturnInfoOfSignatureDeclaration directly into checkSignatureDeclarationDiagnostics or relocating getReturnInfoOfSignatureDeclaration to the scope of checkSignatureDeclarationDiagnostics?

[sandersn]

Sorry I dropped this. Now that I look at it again:

1. Move the logic directly into checkSignatureDeclarationDiagnostics.
2. I now disagree with my past self: I don't think it's worthwhile to reuse getReturnTypeFromAnnotation.

[sandersn]

re @fatcerberus 's comment: the did-you-mean isn't appropriate since the change needs to be on the callback tag, but the rest of the error still applies.