Improve S1874 (deprecation): Report deprecations from TypeScript compiler
#4122
Conversation
This file contains 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
yassin-kammoun-sonarsource
force-pushed
the
i4008
branch
from
4e8a805
to
17d2136
Compare
|
SonarQube Quality Gate
|
|
|
||
| import defaultImport, {deprecatedFunction, anotherDeprecatedFunction as aliasForDeprecated, notDeprecated1, notDeprecated2} from './cb.fixture.deprecations'; | ||
| import defaultImport, {deprecatedFunction, anotherDeprecatedFunction as aliasForDeprecated, notDeprecated1, notDeprecated2} from './cb.fixture.deprecations'; // Noncompliant 2 |
There was a problem hiding this comment.
TypeScript reports on imported deprecated symbols, which we didn't previously.
| @@ -81,7 +81,7 @@ let deprecatedVar; | |||
| const const1 = 1, | |||
| const2 = 2; | |||
|
|
|||
| h(const1 + const2); // Noncompliant | |||
| h(const1 + const2); // Noncompliant 2 | |||
There was a problem hiding this comment.
We had a false negative before on const2.
| @@ -93,7 +93,7 @@ function fn() { } | |||
|
|
|||
| fn<number>(); | |||
| fn(1); // Noncompliant | |||
| h(fn); // Noncompliant | |||
| h(fn); | |||
There was a problem hiding this comment.
TypeScript doesn't report deprecated symbols used as references, like here with fn.
Comment on lines
+164
to
+186
| /* i4008 */ | ||
|
|
||
| /** @deprecated */ function someDeprecated(a: string): string; | ||
| /** @param a */ function someDeprecated(a: number): number; | ||
| function someDeprecated(a: number | string): number | string { | ||
| if (typeof a === 'number') return a + 1; | ||
| return a; | ||
| } | ||
|
|
||
| someDeprecated('yolo'); // Noncompliant | ||
| someDeprecated(42); // OK | ||
| someDeprecated; // OK | ||
|
|
||
| /** @deprecated */ function allDeprecated(a: string): string; | ||
| /** @deprecated */ function allDeprecated(a: number): number; | ||
| function allDeprecated(a: number | string): number | string { | ||
| if (typeof a === 'number') return a + 1; | ||
| return a; | ||
| } | ||
|
|
||
| allDeprecated('yolo'); // Noncompliant | ||
| allDeprecated(42); // Noncompliant | ||
| allDeprecated; // OK |
There was a problem hiding this comment.
Taken from #4064
victor-diez-sonarsource
approved these changes
Aug 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #4008
Building from #4064, it turns out quite tricky to cover every single case of deprecated symbols that are used. In fact, after looking at TypeScript's codebase, there are many places where usages of deprecated APIs are detected and reported. This is due to several edge cases. Instead of replicating the logic for every single one, we propose to extract and propagate deprecation suggestions emitted by TypeScript's type checker. There are minor functional differences compared to our current implementation, like the fact that TypeScript reports on import statements. However, with these changes, we behave precisely like TypeScript compilers, thus reducing false positives and negatives.