redhat-developer / redhat-developer/vscode-java
java.completion.importOrder (even the default) takes precedence over checkstyle specs
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.3k
- Fork
- 546
- Merge medio
- 20h 1m
- PR unite (30g)
- 11
Descrizione
The java.completion.importOrder property, documented here
https://github.com/redhat-developer/vscode-java/blob/562afa80c0f705613c6ed3148b4d9eac82093b26/package.json#L519-L527
does not play well with checkstyle. If checkstyle specifies a different sort order for imports, the default importOrder setting will always be used instead. An unsatisfactory workaround is to attempt to specify a matching importOrder via this property. However, it's simply not as expressive as what is possible via Checkstyle, so finding an exact match is impossible.
This situation creates the highly likely event of imports being automatically sorted via the editor, and then the resulting code is in violation of checkstyle constraints, so a CI or regular build process will fail.
Here's an example of just such a sad situation: https://github.com/DSpace/DSpace/pull/8088/commits/23e93ff2857b7099ba8005d0b5b6c3b65f052f1c
Environment
- Operating System: OSX
- JDK version: openjdk version "11.0.2" 2019-01-15
- Visual Studio Code version: 1.63.2
- Java extension version: v1.3.0
Steps To Reproduce
- work on a Java project with a checkstyle configuration (one example: DSpace/DSspace)
- install a checkstyle plugin
- configure the checkstyle plugin to use the project configuration
- open a Java file
- click the yellow light bulb that appears over the Java file's imports, select 'organize imports'
- save the file
- validate the project against the custom checkstyle, it will fail, if the checkstyle specification for import order differs from the default value of the java.completion.importOrder property
Current Result
imports are always sorted to match the order specified by java.completion.importOrder
Expected Result
imports are sorted to match the order specified by checkstyle
Additional Informations
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla documentazione di java.completion.importOrder in package.json alle righe 519-527 e riproduci i passaggi di organize-imports usando un progetto con una configurazione personalizzata di Checkstyle. Confronta gli imports risultanti con l’ordine specificato da Checkstyle. Il lavoro è completato quando organize-imports non applica più incondizionatamente l’ordine predefinito quando Checkstyle ne specifica uno diverso.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, typescript
- Ambito
- developer-experience, 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