redhat-developer / redhat-developer/vscode-java
java.completion.importOrder (even the default) takes precedence over checkstyle specs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the java.completion.importOrder documentation in package.json at lines 519-527 and reproduce the organize-imports steps using a project with a custom Checkstyle configuration. Compare the resulting imports with the Checkstyle-specified order. Done means organize imports no longer unconditionally applies the default order when Checkstyle specifies a different one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript
- Domain
- developer-experience, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100