Skip to content

Fix deprecated accessors in JSDoc #63047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ThanhNguyxn wants to merge 2 commits into
base: main
Choose a base branch
from
+72 −8
Open

Fix deprecated accessors in JSDoc #63047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a12c21
Handle accessor deprecation in checker
ThanhNguyxn Jan 25, 2026
1829148
Surface accessor deprecation in services and add test
ThanhNguyxn Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2599,12 +2599,18 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
}

function isDeprecatedSymbol(symbol: Symbol) {
const parentSymbol = getParentOfSymbol(symbol);
if (parentSymbol && length(symbol.declarations) > 1) {
return parentSymbol.flags & SymbolFlags.Interface ? some(symbol.declarations, isDeprecatedDeclaration) : every(symbol.declarations, isDeprecatedDeclaration);
const declarations = symbol.declarations;
if (length(declarations)) {
if (symbol.flags & SymbolFlags.Accessor) {
return some(declarations, isDeprecatedDeclaration);
}
const parentSymbol = getParentOfSymbol(symbol);
if (parentSymbol && length(declarations) > 1) {
return parentSymbol.flags & SymbolFlags.Interface ? some(declarations, isDeprecatedDeclaration) : every(declarations, isDeprecatedDeclaration);
}
}
return !!symbol.valueDeclaration && isDeprecatedDeclaration(symbol.valueDeclaration)
|| length(symbol.declarations) && every(symbol.declarations, isDeprecatedDeclaration);
|| length(declarations) && every(declarations, isDeprecatedDeclaration);
}

function isDeprecatedDeclaration(declaration: Declaration) {
Expand Down
11 changes: 9 additions & 2 deletions src/services/completions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6085,8 +6085,15 @@ function symbolCanBeReferencedAtTypeLocation(symbol: Symbol, checker: TypeChecke
}

function isDeprecated(symbol: Symbol, checker: TypeChecker) {
const declarations = skipAlias(symbol, checker).declarations;
return !!length(declarations) && every(declarations, isDeprecatedDeclaration);
const targetSymbol = skipAlias(symbol, checker);
const declarations = targetSymbol.declarations;
if (!length(declarations)) {
return false;
}
if (targetSymbol.flags & SymbolFlags.Accessor) {
return some(declarations, isDeprecatedDeclaration);
}
return every(declarations, isDeprecatedDeclaration);
}

/**
Expand Down
10 changes: 8 additions & 2 deletions src/services/symbolDisplay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,13 +216,19 @@ function getSymbolKindOfConstructorPropertyMethodAccessorFunctionOrVar(typeCheck
function getNormalizedSymbolModifiers(symbol: Symbol) {
if (symbol.declarations && symbol.declarations.length) {
const [declaration, ...declarations] = symbol.declarations;
const isAccessor = !!(symbol.flags & SymbolFlags.Accessor);
const hasDeprecatedDeclaration = some(symbol.declarations, isDeprecatedDeclaration);
// omit deprecated flag if some declarations are not deprecated
const excludeFlags = length(declarations) && isDeprecatedDeclaration(declaration) && some(declarations, d => !isDeprecatedDeclaration(d))
const excludeFlags = length(declarations) && isDeprecatedDeclaration(declaration) && some(declarations, d => !isDeprecatedDeclaration(d)) && !isAccessor
? ModifierFlags.Deprecated
: ModifierFlags.None;
const modifiers = getNodeModifiers(declaration, excludeFlags);
if (modifiers) {
return modifiers.split(",");
const modifierList = modifiers.split(",");
if (isAccessor && hasDeprecatedDeclaration && !modifierList.includes(ScriptElementKindModifier.deprecatedModifier)) {
modifierList.push(ScriptElementKindModifier.deprecatedModifier);
}
return modifierList;
}
}
return [];
Expand Down
45 changes: 45 additions & 0 deletions tests/cases/fourslash/jsdocDeprecated_accessors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
//// class C {
//// /** @deprecated getter deprecated */
//// get value() { return 1; }
//// set value(v: number) { void v; }
//// }
//// const c = new C();
//// c.[|value|];
//// c.[|value|] = 2;
////
//// class D {
//// get other() { return 1; }
//// /** @deprecated setter deprecated */
//// set other(v: number) { void v; }
//// }
//// const d = new D();
//// d.[|other|];
//// d.[|other|] = 3;

const ranges = test.ranges();
verify.getSuggestionDiagnostics([
{
message: "'value' is deprecated.",
code: 6385,
range: ranges[0],
reportsDeprecated: true,
},
{
message: "'value' is deprecated.",
code: 6385,
range: ranges[1],
reportsDeprecated: true,
},
{
message: "'other' is deprecated.",
code: 6385,
range: ranges[2],
reportsDeprecated: true,
},
{
message: "'other' is deprecated.",
code: 6385,
range: ranges[3],
reportsDeprecated: true,
},
]);