Version 1.8.0

spotify · Jul 18, 2017 · c4c6aa3 · c4c6aa3
1 parent 65284a6
commit c4c6aa3
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -17,15 +17,15 @@ If you want your IDE to stick to the same format, check out [the available confi
 
 ### Standard pom.xml
 
-Add to your pom.xml
+To have your sources automatically formatted on each build, add to your pom.xml:
 
 ```xml
     <build>
         <plugins>
             <plugin>
                 <groupId>com.coveo</groupId>
                 <artifactId>fmt-maven-plugin</artifactId>
-                <version>1.7.0</version>
+                <version>1.8.0</version>
                 <executions>
                     <execution>
                         <goals>
@@ -38,6 +38,27 @@ Add to your pom.xml
     </build>
 ```
 
+If you prefer, you can only check formatting at build time using the `check` goal:
+
+```xml
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.coveo</groupId>
+                <artifactId>fmt-maven-plugin</artifactId>
+                <version>1.8.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+```
+
 ### Options
 
 `sourceDirectory` represents the directory where your Java sources that need to be formatted are contained. It defaults to `${project.build.sourceDirectory}`
@@ -57,7 +78,7 @@ example:
         <plugin>
             <groupId>com.coveo</groupId>
             <artifactId>fmt-maven-plugin</artifactId>
-            <version>1.7.0</version>
+            <version>1.8.0</version>
             <configuration>
                 <sourceDirectory>some/source/directory</sourceDirectory>
                 <testSourceDirectory>some/test/directory</testSourceDirectory>

diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>com.coveo</groupId>
     <artifactId>fmt-maven-plugin</artifactId>
-    <version>1.7.0-SNAPSHOT</version>
+    <version>1.8.0</version>
     <packaging>maven-plugin</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

diff --git a/src/main/java/com/coveo/FMT.java b/src/main/java/com/coveo/FMT.java
@@ -13,9 +13,7 @@
 @Mojo(name = "format", defaultPhase = LifecyclePhase.PROCESS_SOURCES)
 public class FMT extends AbstractFMT {
 
-  /**
-   * @deprecated Use the {@code fmt:check} goal instead.
-   */
+  /** @deprecated Use the {@code fmt:check} goal instead. */
   @Deprecated
   @Parameter(defaultValue = "false", property = "validateOnly")
   private boolean validateOnly;