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

Migrating from checkstyle to spotless for formatting #645

Closed

Conversation

VachaShah
Copy link
Collaborator

Description

Adding spotless support in this repo in place of checkstyle so that we can get features for checking and applying the formatting using spotless. The rules used here are from the OpenSearch repo. spotlessJavaCheck is now part of the build task making it easier for developers to format their changes.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Vacha Shah <[email protected]>
@reta
Copy link
Collaborator

reta commented Oct 3, 2023

Sorry @VachaShah , it is impossible to review the PRs as large as those: what we did for security & core - migrate per packages, in chunks of pull requests of no more than 300 files, it adds up some work but at least is feasible to go through the changes.

@VachaShah
Copy link
Collaborator Author

Sorry @VachaShah , it is impossible to review the PRs as large as those: what we did for security & core - migrate per packages, in chunks of pull requests of no more than 300 files, it adds up some work but at least is feasible to go through the changes.

Yeah I thought about this after opening the PR 🙈 Let me break this down in multiple PRs without breaking the builds.

@VachaShah VachaShah closed this Oct 3, 2023
@dblock
Copy link
Member

dblock commented Oct 3, 2023

I wouldn't mind one massive PR as long as it's clear that the whole change is a couple of files and a separate "ran ./gradlew spotless:apply" kind of thing and all tests pass. The other option is to find a way where spotless is enabled, but some rules are disabled, and make PRs that enable them one-by-one.

@VachaShah
Copy link
Collaborator Author

Thank you @dblock! I started dividing this, first PR is #648 which includes support for spotless and enabling spotless for some modules. The subsequent PRs will enable for other folders.

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

Successfully merging this pull request may close these issues.

3 participants