ktlint: Formatting does not converge when line is long and formatted code needs a trailing comma
- Langage dominant
- Java
- Étoiles
- 5.7k
- Forks
- 561
- Merge moyen
- 1 j 14 h
- PR mergées (30 j)
- 43
Description
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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Reproduisez le problème dans build.gradle.kts avec Gradle Spotless 6.18.0, max_line_length = 100 et le bloc errorprone montré ; commencez par exécuter spotlessApply et inspectez l’intégration ktlint trailing-comma-on-call-site. Le travail est terminé lorsqu’un appel long est reformaté avec sa virgule finale en une seule passe, sans échec trompeur ni référence de ligne incorrecte.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- kotlin
- Domaine
- build-system, tooling
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100