Fix string-template for dot-expression from which the toString() is removed #1026
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
…g is removed (pinterest#996) The no-unused-imports rule fails on the existence of the dot-expression node but for which the actual call to the toString method was removed.
|
This might fix #1019 although this is not sure as the issue could not be reproduced. |
romtsn
reviewed
Dec 20, 2020
| (node.lastChildNode as LeafPsiElement).rawReplaceWithText("") // entry end | ||
| val leftCurlyBraceNode = node.findChildByType(LONG_TEMPLATE_ENTRY_START) | ||
| val rightCurlyBraceNode = node.findChildByType(LONG_TEMPLATE_ENTRY_END) | ||
| if (node.children().count() == 3 && leftCurlyBraceNode != null && rightCurlyBraceNode != null) { |
There was a problem hiding this comment.
Could you elaborate on why count is 3 exactly? I guess I am missing a bit of context :)
There was a problem hiding this comment.
It is a bit of defensive programma. The block above is surrounded by the following if-statement:
if (node.text.startsWith("${'$'}{") &&
node.text.let { it.substring(2, it.length - 1) }.all { it.isPartOfIdentifier() } &&
(entryExpression is KtNameReferenceExpression || entryExpression is KtThisExpression) &&
node.treeNext.let { nextSibling ->
nextSibling.elementType == CLOSING_QUOTE ||
(
nextSibling.elementType == LITERAL_STRING_TEMPLATE_ENTRY &&
!nextSibling.text[0].isPartOfIdentifier()
)
}
) {
I was not 100% sure that this statement really covers the situation of a prefix-node, content-node and a suffix-node. In case that also prefix-node, content-node-1, ..., content-node-n, suffix-node can match this statement then I do think it is not a valid to prefix only the first node with the '$'. So line 74 guards the autocorrect to patterns which can be corrected safely.
romtsn
added a commit
to paul-dingemans/ktlint
that referenced
this pull request
Mar 7, 2021
…emoved (pinterest#1026) * Fix string-template for dot-expression of which the redundant toString is removed (pinterest#996) The no-unused-imports rule fails on the existence of the dot-expression node but for which the actual call to the toString method was removed. * Update changelog * Fix code style violation Co-authored-by: Paul Dingemans <pdingemans@bol.com> Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
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.
Given code example below:
Formatting with autocorrect of this code fails on the no-unused-imports rule as the dot-expression node still exists but the toString invocation was already removed.
Resolves #996