Add spotless for common code style

jenkinsci · Oct 7, 2021 · de2394f · de2394f
1 parent 2b62356
commit de2394f
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,3 +65,18 @@ node {
 }
 ```
 
+## Development
+
+### Code Style
+
+This plugin tries to migrate to [Google Java Code Style], please try to adhere
+to that style whenever adding new files or making changes to existing files.
+The style is enforced using the [spotless] plugin, if the build fails because
+you were using the "wrong" style, you can fix it by running:
+
+    $ mvn spotless:apply
+
+to reformat Java code in the proper style.
+
+[Google Java Code Style]: https://google.github.io/styleguide/javaguide.html
+[spotless]: https://github.com/diffplug/spotless
diff --git a/pom.xml b/pom.xml
@@ -123,4 +123,31 @@
       <url>https://repo.jenkins-ci.org/public/</url>
     </pluginRepository>
   </pluginRepositories>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <version>2.17.0</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <!-- get better with time -->
+          <ratchetFrom>origin/master</ratchetFrom>
+          <java>
+            <endWithNewline />
+            <importOrder />
+            <removeUnusedImports />
+            <googleJavaFormat />
+          </java>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 </project>