Adding Spotless support framework (opensearch-project#1888)

* Adding spotless plugin to project build.gradle. Signed-off-by: Mitchell Gale <[email protected]> Remove commented out spotless changes. Signed-off-by: Mitchell Gale <[email protected]> Adding Spotless to DEVELOPER_GUIDE.rst Signed-off-by: Mitchell Gale <[email protected]> Added Google Java format to spotless. Signed-off-by: Mitchell Gale <[email protected]> Update DEVELOPER_GUIDE.rst Co-authored-by: Yury-Fridlyand <[email protected]> * Added apply false for spotless Signed-off-by: Mitchell Gale <[email protected]> * Adding ratchetFrom to build.gradle Signed-off-by: Mitchell Gale <[email protected]> * Adding license header to build.gradle for spotless. Signed-off-by: Mitchell Gale <[email protected]> * Uncommenting all changes to build.gradle for spotless. Signed-off-by: Mitchell Gale <[email protected]> * Commented out spotless checks. Signed-off-by: Mitchell Gale <[email protected]> * Add specific version for java format spotless (1.17.0) Signed-off-by: Mitchell Gale <[email protected]> --------- Signed-off-by: Mitchell Gale <[email protected]> Co-authored-by: Yury-Fridlyand <[email protected]>
Bit-Quill · Jul 24, 2023 · af12c02 · af12c02
1 parent 4102b58
commit af12c02
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/DEVELOPER_GUIDE.rst b/DEVELOPER_GUIDE.rst
@@ -113,8 +113,8 @@ Note that missing license header will be detected by Gradle license plugin and f
 Making Code Changes
 ===================
 
-Project Strucure
-----------------
+Project Structure
+-----------------
 
 The plugin codebase is in standard layout of Gradle project::
 
@@ -226,6 +226,10 @@ Most of the time you just need to run ./gradlew build which will make sure you p
      - Build plugin by run all tasks above (this takes time).
    * - ./gradlew pitest
      - Run PiTest mutation testing (see more info in `#1204 <https://github.com/opensearch-project/sql/pull/1204>`_)
+   * - ./gradlew spotlessCheck
+     - Runs Spotless to check for code style.
+   * - ./gradlew spotlessApply
+     - Automatically apply spotless code style changes.
 
 For integration test, you can use ``-Dtests.class`` “UT full path” to run a task individually. For example ``./gradlew :integ-test:integTest -Dtests.class="*QueryIT"``.
 

diff --git a/build.gradle b/build.gradle
@@ -65,6 +65,7 @@ plugins {
     id 'checkstyle'
     id "io.freefair.lombok" version "6.4.0"
     id 'jacoco'
+    id 'com.diffplug.spotless' version '6.19.0'
 }
 
 // import versions defined in https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/java/org/opensearch/gradle/OpenSearchJavaPlugin.java#L94
@@ -79,6 +80,25 @@ repositories {
     maven { url 'https://jitpack.io' }
 }
 
+// Spotless checks will be added as PRs are applied to resolve each style issue is approved.
+spotless {
+    java {
+//        target fileTree('.') {
+//            include '**/*.java', 'src/*/java/**/*.java'
+//            exclude '**/build/**', '**/build-*/**'
+//        }
+//        importOrder()
+//        licenseHeader("/*\n" +
+//                " * Copyright OpenSearch Contributors\n" +
+//                " * SPDX-License-Identifier: Apache-2.0\n" +
+//                " */\n\n\n")
+//        removeUnusedImports()
+//        trimTrailingWhitespace()
+//        endWithNewline()
+//        googleJavaFormat('1.17.0').reflowLongStrings().groupArtifact('com.google.googlejavaformat:google-java-format')
+    }
+}
+
 allprojects {
     version = opensearch_version.tokenize('-')[0] + '.0'
     if (buildVersionQualifier) {