ktlint: Formatting does not converge when line is long and formatted code needs a trailing comma
- Lingua principale
- Java
- Stelle
- 5.6k
- Fork
- 559
- Merge medio
- 1g 14h
- PR unite (30g)
- 43
Descrizione
I originally filed this to ktlint at https://github.com/pinterest/ktlint/issues/1979 but it seems like it's likely a spotless issue. So copying in from there.
## Expected Behavior
Code formats
## Observed Behavior
Failure with `trailing-comma-on-call-site`
## Steps to Reproduce
```
errorprone {
excludedPaths.set(".*com.google.protobuf.util.*|.*org.curioswitch.common.protobuf.json.test.*")
}
```
If this line is too long based on editorconfig values, then it is supposed to reformat to split lines and have a trailing comma
```
errorprone {
excludedPaths.set(
".*com.google.protobuf.util.*|.*org.curioswitch.common.protobuf.json.test.*",
)
}
```
However, instead it gives an error
```
Step 'ktlint' found problem in 'build.gradle.kts':
Error on line: 64, column: 1
rule: trailing-comma-on-call-site
Missing trailing comma before ")"
```
It seems it is only applying the line length change without the trailing comma change. The error message is highly confusing too, because there is no expectation for a trailing comma in the original one-line code, only in the intermediate reformatted version.
We can see it in https://github.com/curioswitch/protobuf-jackson/pull/14, running `spotlessApply` in this repo with the change will still fail with that error message instead of reformatting.
If manually reformatting, then it passes. Had no idea where the error is, I guess the line number is also wrong, referring to the intermediate reformatted version and not the original?
## Your Environment
* Version of ktlint used:
Default in gradle-spotless-plugin
* Relevant parts of the `.editorconfig` settings
`max_line_length = 100`
* Name and version (or code for custom task) of integration used (Gradle plugin, Maven plugin, command line, custom Gradle task):
gradle-spotless-plugin: 6.18.0
* Version of Gradle used (if applicable): 7.3.3
* Operating System and version: Mac OS X 13.2.1
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Riproduci il problema in build.gradle.kts con Gradle Spotless 6.18.0, max_line_length = 100 e il bloc errorprone mostrato; inizia eseguendo spotlessApply e ispezionando l’integrazione ktlint trailing-comma-on-call-site. Il lavoro è completato quando una chiamata lunga viene riformattata con la relativa virgola finale in un solo passaggio, senza un errore fuorviante né un riferimento di riga errato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- kotlin
- Ambito
- build-system, tooling
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100