Skip to content

Commit 57e2fe0

Browse files
KingwlKingwl
authored
Improve deprecated suggestion node position (#39702)
* Improve deprecated suggestion node position * fix typo * Simplify code * merge helper function
1 parent a80f60c commit 57e2fe0

File tree

4 files changed

+56
-33
lines changed

4 files changed

+56
-33
lines changed

‎src/compiler/checker.ts‎

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24711,7 +24711,7 @@ namespace ts {
2471124711
if (isNodeOpeningLikeElement) {
2471224712
const jsxOpeningLikeNode = node as JsxOpeningLikeElement;
2471324713
const sig = getResolvedSignature(jsxOpeningLikeNode);
24714-
checkDeprecatedSignature(sig, node);
24714+
checkDeprecatedSignature(sig, <JsxOpeningLikeElement>node);
2471524715
checkJsxReturnAssignableToAppropriateBound(getJsxReferenceKind(jsxOpeningLikeNode), getReturnTypeOfSignature(sig), jsxOpeningLikeNode);
2471624716
}
2471724717
}
@@ -27595,9 +27595,34 @@ namespace ts {
2759527595
return returnType;
2759627596
}
2759727597

27598-
function checkDeprecatedSignature(signature: Signature, node: Node) {
27598+
function checkDeprecatedSignature(signature: Signature, node: CallLikeExpression) {
2759927599
if (signature.declaration && signature.declaration.flags & NodeFlags.Deprecated) {
27600-
errorOrSuggestion(/*isError*/ false, node, Diagnostics._0_is_deprecated, signatureToString(signature));
27600+
const suggestionNode = getDeprecatedSuggestionNode(node);
27601+
errorOrSuggestion(/*isError*/ false, suggestionNode, Diagnostics._0_is_deprecated, signatureToString(signature));
27602+
}
27603+
}
27604+
27605+
function getDeprecatedSuggestionNode(node: Node): Node {
27606+
node = skipParentheses(node);
27607+
switch (node.kind) {
27608+
case SyntaxKind.CallExpression:
27609+
case SyntaxKind.Decorator:
27610+
case SyntaxKind.NewExpression:
27611+
return getDeprecatedSuggestionNode((<Decorator | CallExpression | NewExpression>node).expression);
27612+
case SyntaxKind.TaggedTemplateExpression:
27613+
return getDeprecatedSuggestionNode((<TaggedTemplateExpression>node).tag);
27614+
case SyntaxKind.JsxOpeningElement:
27615+
case SyntaxKind.JsxSelfClosingElement:
27616+
return getDeprecatedSuggestionNode((<JsxOpeningLikeElement>node).tagName);
27617+
case SyntaxKind.ElementAccessExpression:
27618+
return (<ElementAccessExpression>node).argumentExpression;
27619+
case SyntaxKind.PropertyAccessExpression:
27620+
return (<PropertyAccessExpression>node).name;
27621+
case SyntaxKind.TypeReference:
27622+
const typeReference = <TypeReferenceNode>node;
27623+
return isQualifiedName(typeReference.typeName) ? typeReference.typeName.right : typeReference;
27624+
default:
27625+
return node;
2760127626
}
2760227627
}
2760327628

@@ -30992,8 +31017,7 @@ namespace ts {
3099231017
const symbol = getNodeLinks(node).resolvedSymbol;
3099331018
if (symbol) {
3099431019
if (some(symbol.declarations, d => isTypeDeclaration(d) && !!(d.flags & NodeFlags.Deprecated))) {
30995-
const diagLocation = isTypeReferenceNode(node) && isQualifiedName(node.typeName) ? node.typeName.right : node;
30996-
errorOrSuggestion(/* isError */ false, diagLocation, Diagnostics._0_is_deprecated, symbol.escapedName as string);
31020+
errorOrSuggestion(/* isError */ false, getDeprecatedSuggestionNode(node), Diagnostics._0_is_deprecated, symbol.escapedName as string);
3099731021
}
3099831022
if (type.flags & TypeFlags.Enum && symbol.flags & SymbolFlags.EnumMember) {
3099931023
error(node, Diagnostics.Enum_type_0_has_members_with_initializers_that_are_not_literals, typeToString(type));

‎tests/cases/fourslash/jsdocDeprecated_suggestion1.ts‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
//// export namespace foo {
66
//// /** @deprecated */
77
//// export function faff () { }
8-
//// [|faff()|]
8+
//// [|faff|]()
99
//// }
10-
//// const [|a|] = [|foo.faff()|]
10+
//// const [|a|] = foo.[|faff|]()
1111
//// foo[[|"faff"|]]
1212
//// const { [|faff|] } = foo
13-
//// [|faff()|]
13+
//// [|faff|]()
1414
//// /** @deprecated */
1515
//// export function bar () {
16-
//// [|foo?.faff()|]
16+
//// foo?.[|faff|]()
1717
//// }
18-
//// [|foo?.["faff"]?.()|]
19-
//// [|bar()|];
18+
//// foo?.[[|"faff"|]]?.()
19+
//// [|bar|]();
2020
//// /** @deprecated */
2121
//// export interface Foo {
2222
//// /** @deprecated */
@@ -37,8 +37,8 @@
3737
//// constructor() {
3838
//// }
3939
//// }
40-
//// var c = [|new C()|]
41-
//// [|c.m()|]
40+
//// var c = new [|C|]()
41+
//// c.[|m|]()
4242
//// c.[|m|]
4343
//// new [|D|]()
4444
//// C
@@ -51,26 +51,26 @@
5151
//// return <div></div>
5252
//// }
5353
//// [|Compi|];
54-
//// [|<Compi />|];
55-
//// [|<Compi {...props}>|]<div></div></[|Compi|]>;
54+
//// <[|Compi|] />;
55+
//// <[|Compi|] {...props}><div></div></[|Compi|]>;
5656
//// /** @deprecated */
5757
//// function ttf(_x: unknown) {
5858
//// }
59-
//// [|ttf``|]
59+
//// [|ttf|]``
6060
//// [|ttf|]
6161
//// /** @deprecated */
6262
//// function dec(_c: unknown) { }
6363
//// [|dec|]
64-
//// [|@dec|]
64+
//// @[|dec|]
6565
//// class K { }
6666

6767
// @Filename: b.ts
6868
//// // imports and aliases
6969
//// import * as f from './a';
7070
//// import { [|bar|], [|QW|] } from './a';
71-
//// [|f.bar()|];
72-
//// [|f.foo.faff()|];
73-
//// [|bar()|];
71+
//// f.[|bar|]();
72+
//// f.foo.[|faff|]();
73+
//// [|bar|]();
7474
//// type Z = [|QW|];
7575
//// type A = f.[|Foo|];
7676
//// type B = f.[|QW|];
@@ -79,7 +79,6 @@
7979

8080
goTo.file('a.ts')
8181
const ranges = test.ranges();
82-
8382
verify.getSuggestionDiagnostics([
8483
{
8584
"code": 6385,

‎tests/cases/fourslash/jsdocDeprecated_suggestion2.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
//// /** @deprecated */
66
//// declare function foo(): undefined;
77
//// declare function foo (a?: string): number | undefined;
8-
//// [|foo()|];
8+
//// [|foo|]();
99
//// foo('');
1010
//// foo;
1111

1212
//// /** @deprecated */
1313
//// declare function bar(): number;
14-
//// [|bar()|];
14+
//// [|bar|]();
1515
//// [|bar|];
1616

1717
//// /** @deprecated */
1818
//// declare function baz(): number;
1919
//// /** @deprecated */
2020
//// declare function baz(): number | undefined;
21-
//// [|baz()|];
21+
//// [|baz|]();
2222
//// [|baz|];
2323

2424
//// interface Foo {
@@ -27,7 +27,7 @@
2727
//// (a: number): void
2828
//// }
2929
//// declare const f: Foo;
30-
//// [|f()|];
30+
//// [|f|]();
3131
//// f(1);
3232

3333
//// interface T {
@@ -37,15 +37,15 @@
3737
//// }
3838
//// declare const t: T;
3939
//// t.createElement();
40-
//// [|t.createElement('xmp')|];
40+
//// t.[|createElement|]('xmp');
4141

4242
//// declare class C {
4343
//// /** @deprecated */
4444
//// constructor ();
4545
//// constructor(v: string)
4646
//// }
4747
//// C;
48-
//// const c = [|new C()|];
48+
//// const c = new [|C|]();
4949

5050
//// interface Ca {
5151
//// /** @deprecated */
@@ -61,10 +61,10 @@
6161
//// declare const cb: Cb;
6262
//// ca;
6363
//// cb;
64-
//// [|ca()|];
64+
//// [|ca|]();
6565
//// cb();
6666
//// new ca();
67-
//// [|new cb()|];
67+
//// new [|cb|]();
6868

6969
const ranges = test.ranges();
7070
verify.getSuggestionDiagnostics([

‎tests/cases/fourslash/jsdocDeprecated_suggestion3.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
//// declare function b(): void
1414
//// declare const tb: b;
1515
//// [|b|]
16-
//// [|b()|];
16+
//// [|b|]();
1717

1818
//// interface c { }
1919
//// /** @deprecated */
2020
//// declare function c(): void
2121
//// declare function c(a: number): void
2222
//// declare const tc: c;
2323
//// c;
24-
//// [|c()|];
24+
//// [|c|]();
2525
//// c(1);
2626

2727
//// /** @deprecated */
@@ -38,8 +38,8 @@
3838
//// /** @deprecated */
3939
//// declare function e(a: number): void
4040
//// [|e|];
41-
//// [|e()|];
42-
//// [|e(1)|];
41+
//// [|e|]();
42+
//// [|e|](1);
4343

4444
//// /** @deprecated */
4545
//// interface f { a: number }

0 commit comments

Comments
 (0)