Migrating from checkstyle to spotless for formatting (opensearch-proj…

…ect#648) * Adding spotless for checking and fixing formatting and removing checkstyle Signed-off-by: Vacha Shah <[email protected]> * Making build task depend on spotlessJavaCheck Signed-off-by: Vacha Shah <[email protected]> * Removing resources and documentation related to checkstyle Signed-off-by: Vacha Shah <[email protected]> * Running spotless for json, transport and util folders Signed-off-by: Vacha Shah <[email protected]> * Running spotless for samples Signed-off-by: Vacha Shah <[email protected]> * Removing commented code Signed-off-by: Vacha Shah <[email protected]> --------- Signed-off-by: Vacha Shah <[email protected]>
Xtansia · Oct 4, 2023 · 57dc5cf · 57dc5cf
1 parent aea607a
commit 57dc5cf
Show file tree

Hide file tree

Showing 92 changed files with 1,523 additions and 1,596 deletions.
diff --git a/.github/workflows/checkstyle.yml b/.github/workflows/checkstyle.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,6 +42,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Dependencies
 
 ### Changed
+- Migrated from checkstyle to spotless ([#648](https://github.com/opensearch-project/opensearch-java/pull/648))
 
 ### Deprecated
 

diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -97,11 +97,28 @@ Follow links in the [Java Tutorial](https://code.visualstudio.com/docs/java/java
 
 ## Java Language Formatting Guidelines
 
-Java files in the opensearch-java codebase are formatted with the [checkstyle plugin](https://docs.gradle.org/current/userguide/checkstyle_plugin.html). This plugin is configured using [checkstyle.xml](config/checkstyle/checkstyle.xml). To run the formatting checks:
+Java files in the OpenSearch codebase are formatted with the Eclipse JDT formatter, using the [Spotless Gradle](https://github.com/diffplug/spotless/tree/master/plugin-gradle) plugin. This plugin is configured on a project-by-project basis, via `build.gradle.kts`. So long as at least one project is configured, the formatting check can be run explicitly with:
 
-```
-./gradlew checkstyleMain checkstyleTest
-```
+    ./gradlew spotlessJavaCheck
+
+The code can be formatted with:
+
+    ./gradlew spotlessApply
+
+These tasks can also be run for specific subprojects, e.g.
+
+    ./gradlew :java-client:spotlessJavaCheck
+    ./gradlew :samples:spotlessJavaCheck
+
+Please follow these formatting guidelines:
+
+* Java indent is 4 spaces
+* Line width is 140 characters
+* Lines of code surrounded by `// tag::NAME` and `// end::NAME` comments are included in the documentation and should only be 76 characters wide not counting leading indentation. Such regions of code are not formatted automatically as it is not possible to change the line length rule of the formatter for part of a file. Please format such sections sympathetically with the rest of the code, while keeping lines to maximum length of 76 characters.
+* Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause the build to fail.
+* If *absolutely* necessary, you can disable formatting for regions of code with the `// tag::NAME` and `// end::NAME` directives, but note that these are intended for use in documentation, so please make it clear what you have done, and only do this where the benefit clearly outweighs the decrease in consistency.
+* Note that JavaDoc and block comments i.e. `/* ... */` are not formatted, but line comments i.e `// ...` are.
+* There is an implicit rule that negative boolean expressions should use the form `foo == false` instead of `!foo` for better readability of the code. While this isn't strictly enforced, if might get called out in PR reviews as something to change.
 
 ## Submitting Changes
 

diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-[![Checkstyle](https://github.com/opensearch-project/opensearch-java/actions/workflows/checkstyle.yml/badge.svg?branch=main)](https://github.com/opensearch-project/opensearch-java/actions/workflows/checkstyle.yml)
 [![Build](https://github.com/opensearch-project/opensearch-java/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/opensearch-project/opensearch-java/actions/workflows/build.yml)
 [![Integration Tests](https://github.com/opensearch-project/opensearch-java/actions/workflows/test-integration.yml/badge.svg?branch=main)](https://github.com/opensearch-project/opensearch-java/actions/workflows/test-integration.yml)
 ![Maven Central](https://img.shields.io/maven-central/v/org.opensearch.client/opensearch-java)
@@ -14,6 +13,7 @@ OpenSearch Java Client
 - [Project Resources](#project-resources)
 - [Code of Conduct](#code-of-conduct)
 - [User Guide](#user-guide)
+- [Snapshot Builds](#snapshot-builds)
 - [Compatibility with OpenSearch](#compatibility-with-opensearch)
 - [Security](#security)
 - [License](#license)

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -42,8 +42,6 @@ allprojects {
         mavenCentral()
         maven(url = "https://plugins.gradle.org/m2/")
     }
-
-    apply(plugin = "checkstyle")
 }
 
 // Find git information.

diff --git a/buildSrc/formatterConfig.xml b/buildSrc/formatterConfig.xml
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
diff --git a/config/checkstyle/checkstyle_suppressions.xml b/config/checkstyle/checkstyle_suppressions.xml
diff --git a/config/checkstyle/header.java.txt b/config/checkstyle/header.java.txt
diff --git a/java-client/build.gradle.kts b/java-client/build.gradle.kts
@@ -49,10 +49,10 @@ buildscript {
 plugins {
     java
     `java-library`
-    checkstyle
     `maven-publish`
     id("com.github.jk1.dependency-license-report") version "2.5"
     id("org.owasp.dependencycheck") version "8.4.0"
+    id("com.diffplug.spotless") version "6.22.0"
 }
 apply(plugin = "opensearch.repositories")
 apply(plugin = "org.owasp.dependencycheck")
@@ -63,10 +63,6 @@ configurations {
     }
 }
 
-checkstyle {
-    toolVersion = "10.12.3"
-}
-
 java {
     targetCompatibility = JavaVersion.VERSION_11
     sourceCompatibility = JavaVersion.VERSION_11
@@ -116,6 +112,10 @@ tasks.withType<Jar> {
     }
 }
 
+tasks.build {
+    dependsOn("spotlessJavaCheck")
+}
+
 tasks.test {
     systemProperty("tests.security.manager", "false")
 
@@ -269,6 +269,22 @@ tasks.withType<Jar> {
     }
 }
 
+spotless {
+  java {
+
+    target("**/json/**/*.java", "**/transport/**/*.java", "**/util/**/*.java")
+
+    // Use the default importOrder configuration
+    importOrder()
+    removeUnusedImports()
+
+    eclipse().configFile("../buildSrc/formatterConfig.xml")
+
+    trimTrailingWhitespace()
+    endWithNewline()
+  }
+}
+
 publishing {
     repositories{
         if (version.toString().endsWith("SNAPSHOT")) {

diff --git a/java-client/src/main/java/org/opensearch/client/json/AttributedJsonpMapper.java b/java-client/src/main/java/org/opensearch/client/json/AttributedJsonpMapper.java
@@ -72,7 +72,7 @@ public boolean ignoreUnknownFields() {
     @SuppressWarnings("unchecked")
     public <T> T attribute(String name) {
         if (this.name.equals(name)) {
-            return (T)this.value;
+            return (T) this.value;
         } else {
             return mapper.attribute(name);
         }

diff --git a/java-client/src/main/java/org/opensearch/client/json/BuildFunctionDeserializer.java b/java-client/src/main/java/org/opensearch/client/json/BuildFunctionDeserializer.java
@@ -33,7 +33,6 @@
 package org.opensearch.client.json;
 
 import jakarta.json.stream.JsonParser;
-
 import java.util.function.Function;
 
 /**

diff --git a/java-client/src/main/java/org/opensearch/client/json/DelegatingDeserializer.java b/java-client/src/main/java/org/opensearch/client/json/DelegatingDeserializer.java
@@ -33,7 +33,6 @@
 package org.opensearch.client.json;
 
 import jakarta.json.stream.JsonParser;
-
 import java.util.EnumSet;
 
 public abstract class DelegatingDeserializer<T, U> implements JsonpDeserializer<T> {
@@ -68,7 +67,7 @@ public T deserialize(JsonParser parser, JsonpMapper mapper, JsonParser.Event eve
      */
     public static JsonpDeserializer<?> unwrap(JsonpDeserializer<?> deserializer) {
         while (deserializer instanceof DelegatingDeserializer) {
-            deserializer = ((DelegatingDeserializer<?,?>) deserializer).unwrap();
+            deserializer = ((DelegatingDeserializer<?, ?>) deserializer).unwrap();
         }
         return deserializer;
     }