Suport partial formatting of code #2629
Milestone
Comments
paul-dingemans
added a commit
that referenced
this issue
Apr 11, 2024
Allows API consumers like the 'ktlint-intellij-plugin' to format a block of code inside the given code (for example a file) without autocorrect the given code entirely.
The start offset of the node on which a rule can detect a lint violation should be inside the range which is to be formatted. This has some unexpected side effects for some rules. In most cases it is to be expected that the user won't notice those side effects. And if it happens, the most likely way the user responds is widening the range which is to be formatted, and try to format again.
For example, the given code might contain the when-statement below:
```
// code with lint violations
when(foobar) {
FOO -> "Single line"
BAR ->
"""
Multi line
""".trimIndent()
else -> null
}
// more code with lint violations
```
The `blank-line-between-when-conditions` rule requires blank lines to be added between the conditions. If the when-keyword above is included in the range which is to be formatted then the blank lines before the conditions are added. If only the when-conditions itself are selected, but not the when-keyword, then the blank lines are not added.
This unexpected behavior is a side effect of the way the partial formatting is implemented currently. The side effects can be prevented by delaying the decision to autocorrect as late as possible and the exact offset of the error is known. This however would cause a breaking change, and needs to wait until Ktlint V2.x.
Closes #2629
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently the
KtlintRuleEngine.format(..)function applies formatting on the entire file or code snippet. For thektlint-intellij-plugin(nbadal/ktlint-intellij-plugin#385) it is preferred that it possible to only format a selection of the file or code snippet. By passing a range of offsets (start and end offset) the KtlintRuleEngine can apply the autocorrect mode only on nodes for which the startoffset of the node is within the given range of offsets.The text was updated successfully, but these errors were encountered: