Skip to content

Maintenance: Add code linter and formatter to the project #1290

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 of 2 tasks
jeromevdl opened this issue Jul 16, 2023 · 2 comments
Closed
1 of 2 tasks

Maintenance: Add code linter and formatter to the project #1290

jeromevdl opened this issue Jul 16, 2023 · 2 comments
Assignees
@jeromevdl
Labels
good-first-issue Good for newcomers maintenance priority:3 Neutral - not a core feature or affects less than 40% of users triage

Comments

@jeromevdl
Copy link
Contributor

Summary

Add a linter (checkstyle, sonarqube?) and a formatter that works with the linter.

Why is this needed?

  • When contributing to the project, we need to make sure the code is not modified by contributors' own formatters.
  • Linter will also help following best practices (google checks)

Which area does this relate to?

Governance

Solution

Sonarqube (sonarlint) would be my preference as usable both in the IDE and on GitHub.

Acknowledgment
@jeromevdl jeromevdl added good-first-issue Good for newcomers priority:3 Neutral - not a core feature or affects less than 40% of users labels Jul 17, 2023
@jeromevdl jeromevdl self-assigned this Jul 18, 2023
@jeromevdl
Copy link
Contributor Author

sonar is actually not for linting/formatting...

https://github.com/diffplug/spotless/tree/main/plugin-maven#google-java-format could be a good way to enforce a formatting

This was referenced Jul 26, 2023
Closed
Merged
@jeromevdl
Copy link
Contributor Author

closing, fixed with #1316
contributing guide is also being updated to reflect this: #1334

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jeromevdl jeromevdl

Labels
good-first-issue Good for newcomers maintenance priority:3 Neutral - not a core feature or affects less than 40% of users triage
Projects
Powertools for AWS Lambda (Java)
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeromevdl