Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java linter defaults to sun style checks #636

Open
yuriylesyuk opened this issue Dec 31, 2022 · 0 comments
Open

Java linter defaults to sun style checks #636

yuriylesyuk opened this issue Dec 31, 2022 · 0 comments

Comments

@yuriylesyuk
Copy link
Collaborator

This ruleset is highly restrictive and insists on 80 columns line limit, which is counter-productive.

- Using [checkstyle v9.0.1] https://checkstyle.sourceforge.io
9113- Mega-Linter key: [JAVA_CHECKSTYLE]
9114- Rules config: [sun_checks.xml]

we need to switch to the google style set.

as a further incremental improvement, we can configure a google rule set from a google repository.

https://github.com/googleapis/google-api-java-client/blob/main/checkstyle.xml

We also would need to discuss and finetune specific rules.
Two I've encountered with not helpful defaults:

Error: /github/workspace/references/hashicorp-vault-integration/vault-facade-callout/src/main/java/com/exco/vaultkeystojwks/VaultKeysToJwks.java:77:3: Comment matches to-do format 'TODO:'. [TodoComment]

https://checkstyle.sourceforge.io/apidocs/com/puppycrawl/tools/checkstyle/checks/coding/HiddenFieldCheck.html

we are going to hit more in the future, thus it is better to be ready for it and have a process in place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant