Support @deprecated on namespace aliases (ImportEqualsDeclaration) #62904
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes microsoft#62340 When a namespace re-exports a type using `export import Bar = example.Bar` with a `@deprecated` JSDoc comment, the deprecation warning was not being reported when accessing `JSX.Bar` as a type. The issue was that in `checkTypeReferenceOrImport`, the `resolvedSymbol` is the resolved target of the alias, not the alias itself. To detect deprecation on the alias, we now also resolve the entity name without resolving aliases and check if the alias symbol itself is deprecated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #62340
Problem
When using
@deprecatedon a namespace alias like:Accessing
JSX.Baras a type did not show a deprecation warning, even though the alias itself is marked as deprecated.Root Cause
In
checkTypeReferenceOrImport, theresolvedSymbolis the resolved target of the alias (e.g.,example.Bar), not the alias symbol itself. Since the alias (theImportEqualsDeclaration) was not being checked, its@deprecatedJSDoc was ignored.Fix
Added code to also resolve the entity name without resolving aliases (
dontResolveAlias: true) and check if the alias symbol itself is deprecated usingisDeprecatedSymbol().Test
Added
tests/cases/fourslash/jsdocDeprecated_namespaceAlias.tscovering:@deprecated(already worked)ImportEqualsDeclarationwith@deprecated(the bug being fixed)ImportEqualsDeclarationaliasing a deprecated type (already worked)