Removed CheckStyle code formatting plugin

[owaiskazi19]

Signed-off-by: Owais Kazi owaiskazi19@gmail.com

Description

Currently the project has two formatting tools Spotless and CheckStyle. Spotless itself can format the code and check the standard java code using spotlessApply and spotlessJavaCheck respectively. Both the plugins have different configuration for formatting which restrict us to run Spotless on all the subprojects. Removing CheckStyle will help to run a unified formatting on the codebase.

Issues Resolved

#1362

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

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.

[opensearch-ci-bot]

Can one of the admins verify this patch?

[opensearch-ci-bot]

✅   DCO Check Passed da79ad2f97df83b62bd6ca215100064b72bebeef

[opensearch-ci-bot]

✅   Gradle Wrapper Validation success da79ad2f97df83b62bd6ca215100064b72bebeef

[opensearch-ci-bot]

✅   Gradle Precommit success da79ad2f97df83b62bd6ca215100064b72bebeef

[VachaShah]

Between the time that we remove checkstyle and add spotless to the entire repo, would the modules excluded from spotless have no formatting standards?

[owaiskazi19]

Between the time that we remove checkstyle and add spotless to the entire repo, would the modules excluded from spotless have no formatting standards?

Good question. Few are already formatted with CheckStyle and Spotless and few are not formatted by any plugins is what I can think of. Once we apply Spotless on all the modules they'll follow https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/formatterConfig.xml.
Moreover, spotlessJavaCheck runs as a part of precommit and check. So, it'll take care of the formatting of the included modules.

[tlfeng]

start gradle check

[opensearch-ci-bot]

✅   Gradle Check success da79ad2f97df83b62bd6ca215100064b72bebeef
Log 694

Reports 694

[VachaShah]

Between the time that we remove checkstyle and add spotless to the entire repo, would the modules excluded from spotless have no formatting standards?

Good question. Few are already formatted with CheckStyle and Spotless and few are not formatted by any plugins is what I can think of. Once we apply Spotless on all the modules they'll follow https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/formatterConfig.xml. Moreover, spotlessJavaCheck runs as a part of precommit and check. So, it'll take care of the formatting of the included modules.

Yeah my concern is the new changes in the modules that are excluded and won't have neither checkstyle nor spotless running on them. Otherwise the PR looks fine to me.

[owaiskazi19]

Between the time that we remove checkstyle and add spotless to the entire repo, would the modules excluded from spotless have no formatting standards?

Good question. Few are already formatted with CheckStyle and Spotless and few are not formatted by any plugins is what I can think of. Once we apply Spotless on all the modules they'll follow https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/formatterConfig.xml. Moreover, spotlessJavaCheck runs as a part of precommit and check. So, it'll take care of the formatting of the included modules.

Yeah my concern is the modules that are excluded and won't have neither checkstyle nor spotless running on them. Otherwise the PR looks fine to me.

So those modules are already formatted with CheckStyle as far as I know until the time we apply Spotless to them.

[setiah]

Between the time that we remove checkstyle and add spotless to the entire repo, would the modules excluded from spotless have no formatting standards?

Good question. Few are already formatted with CheckStyle and Spotless and few are not formatted by any plugins is what I can think of. Once we apply Spotless on all the modules they'll follow https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/formatterConfig.xml. Moreover, spotlessJavaCheck runs as a part of precommit and check. So, it'll take care of the formatting of the included modules.

Yeah my concern is the modules that are excluded and won't have neither checkstyle nor spotless running on them. Otherwise the PR looks fine to me.

So those modules are already formatted with CheckStyle as far as I know until the time we apply Spotless to them.

Sorry about repeating this but not sure if I understood correctly. Have we made sure removing checkstyle does not create a gap with no styling checks on some modules which were previously checkstyle based?

[owaiskazi19]

As discussed with @setiah offline. We will be excluding few modules to run CheckStyle and will run Spotless on them to remove the gap of formatting. Let's hold this PR and merge this after all the 74 modules are sync with Spotless.

[opensearch-ci-bot]

✅   Gradle Wrapper Validation success da79ad2f97df83b62bd6ca215100064b72bebeef

[opensearch-ci-bot]

✅   DCO Check Passed da79ad2f97df83b62bd6ca215100064b72bebeef

[opensearch-ci-bot]

✅   Gradle Precommit success da79ad2f97df83b62bd6ca215100064b72bebeef

[opensearch-ci-bot]

✅   Gradle Wrapper Validation success 3e9db70

[opensearch-ci-bot]

✅   Gradle Precommit success 3e9db70

[opensearch-ci-bot]

❌   Gradle Check failure 3e9db70
Log 949

Reports 949

[tlfeng]

start gradle check

[saratvemulapalli]

Changes look good to me!

[opensearch-ci-bot]

✅   Gradle Check success 3e9db70
Log 953

Reports 953