prefix-unused-parameter-with-_ codefix now works in jsdoc @param #36152
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
…name JSDoc @param. Fix test for quick fix "Prefix all unused declarations with '_' where possible". Fixes microsoft#33021.
|
|
andrewbranch
requested changes
Apr 1, 2020
sandersn
changed the title
|
@sergeir82 do you intend to keep working on this? Let us know if we can help -- I started tracking community PRs a couple of months ago so we don't forget to review ones like this. |
|
Yes, I will try to fix it. |
…l to more ligher call of getJSDocParameterTags when searching for a parameter in jsdoc.
|
Hi! Changes were done. You may check it. |
| @@ -154,6 +154,13 @@ namespace ts.codefix { | |||
| } | |||
| if (isIdentifier(token) && canPrefix(token)) { | |||
| changes.replaceNode(sourceFile, token, createIdentifier(`_${token.text}`)); | |||
| if (isParameter(token.parent)) { | |||
| getJSDocParameterTags(token.parent).forEach((tag) => { | |||
There was a problem hiding this comment.
Don’t you need to do this only for the JSDoc parameter tags whose name is the same as token.text? Try adding this test:
/**
* @param a
* @param b
*/
function f(a, b) {
const x = a;
}to ensure that b gets renamed but a does not.
There was a problem hiding this comment.
Ah, I see getJSDocParameterTags already handles that. My bad. Thanks for adding the test anyway.
andrewbranch
approved these changes
Apr 17, 2020
| @@ -154,6 +154,13 @@ namespace ts.codefix { | |||
| } | |||
| if (isIdentifier(token) && canPrefix(token)) { | |||
| changes.replaceNode(sourceFile, token, createIdentifier(`_${token.text}`)); | |||
| if (isParameter(token.parent)) { | |||
| getJSDocParameterTags(token.parent).forEach((tag) => { | |||
There was a problem hiding this comment.
Ah, I see getJSDocParameterTags already handles that. My bad. Thanks for adding the test anyway.
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 #33021