build: change checkstyle to google code format, plus adding spotless #1121
Conversation
We are regularly fighting with codestyles in pullrequests, which is annoying to the contributors, as well as the maintainers. There are tools out there, like spotless, which can automate those processes. We could define an own codestyle, but in fact there is already one widely used codestyle from google (google java format). There are plugins to help us within intellij and vscode to follow this code style. Hence the overall experience can improve by switching to this defitinion. Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
github-actions
bot
assigned aepfli, ajhelsby, beeme1mr, justinabrahms, Kavindu-Dodan, laliconfigcat, liran2000, madhead, markphelps and matthewelwell
There was a problem hiding this comment.
Seems.. fine? No question from me that style should be enforced by robots.
From the slack thread, I expected the rule changes to be more significant. Is the real problem here "The checkstyle that we had before is under-specified and we need to use more modules; Also... add spotless plugin"?
The check style changes are more related to be fact that i wanted to use spotless to ease the pain. But our check style configuration was not compatible with the default settings. As I favor simplicity over custom specification, I thought it is easier to migrate to google check style and a adapt the full java code Format configuration, rather than making spotless work with our current check style config. |
aepfli
force-pushed
the
build/add_spotless_for_autoformatting
branch
2 times, most recently
from
61112ba to
fefce1b
Compare
|
Thanks so much for adding this! |
aepfli
force-pushed
the
build/add_spotless_for_autoformatting
branch
from
fefce1b to
871c825
Compare
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
aepfli
force-pushed
the
build/add_spotless_for_autoformatting
branch
from
871c825 to
b820457
Compare
|
open-feature/java-sdk#1264 - sibling pr for java-sdk |
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
added a section, with a detailed explanation |
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
We regularly fight with code styles in pull requests, which is annoying to both the contributors and the maintainers.
There are tools out there, like Spotless, that can automate those processes. We could define our code style, but there is already one widely used code style from Google (Google Java format).
Existing plugins help us follow this code style within IntelliJ and Visual Studio Code. Switching to this definition can improve the overall experience.
This supersedes the pull request with
.editorconfignotes
Disclaimer
This pull request should be used to discuss this; most people do not have significant opinions regarding code styles as long as there are tools to enforce them. Now we have a maven target,
spotless:apply, which will inform you about violations and fix them.