prettier-maven-plugin

Maven plugin for running prettier-java during a build. Node, prettier, and prettier-java are bundled into the plugin.

There is a check goal which (optionally) fails the build if code isn't formatted correctly, and a write goal which rewrites the source code in place. A common setup might be to use the write goal during local builds, and the check goal during CI builds.

Example Usage

This example will run the check goal inside of Travis CI, and the write goal outside of Travis CI. You can update the profile activation conditions based on the CI tool you use.

<properties>
  <!-- By default just re-write code with prettier -->
  <plugin.prettier.goal>write</plugin.prettier.goal>
</properties>

<build>
  <plugins>
    <plugin>
      <groupId>com.hubspot.maven.plugins</groupId>
      <artifactId>prettier-maven-plugin</artifactId>
      <version>0.7</version>
      <configuration>
        <printWidth>90</printWidth>
        <tabWidth>2</tabWidth>
        <useTabs>false</useTabs>
        <ignoreConfigFile>true</ignoreConfigFile>
        <ignoreEditorConfig>true</ignoreEditorConfig>
      </configuration>
      <executions>
        <execution>
          <phase>validate</phase>
          <goals>
            <goal>${plugin.prettier.goal}</goal>
          </goals>
        </execution>
      </executions>      
    </plugin>
  </plugins>
</build>

<profiles>
  <profile>
    <id>travis</id>
    <activation>
      <property>
        <name>env.TRAVIS</name>
      </property>
    </activation>
    <properties>
      <!-- But in our CI environment we want to validate that code is formatted -->
      <plugin.prettier.goal>check</plugin.prettier.goal>
    </properties>
  </profile>
</profiles>

You can also run in a one-off fashion via the commandline:
mvn prettier:check
or
mvn prettier:write

Configuration

If you want to customize the behavior of prettier, you can use a normal prettier configuration file. Alternatively, you can configure prettier directly via the Maven plugin using the following options:

Name	-D property name	Default Value	Description
skip	N/A	false	If set to true, plugin execution will be skipped
fail	N/A	true	Only appplies to `check` goal. If set to true, the plugin execution will fail if any unformatted files are found
generateDiff	N/A	false	Only appplies to `check` goal. Be sure to have to sh and diff in your PATH. If set to true, a diff will be generated between the current code and the prettier-formatted code.
diffGenerator	prettier.diffGenerator	_	Only appplies to `check` goal. Can be used to supply a custom implementation of `DiffGenerator`
nodeVersion	prettier.nodeVersion	12.13.0	Controls version of Node used to run prettier-java. Valid values can be found here
prettierJavaVersion	prettier.prettierJavaVersion	0.7.0	Controls version of prettier-java that is used. Valid values can be found here
printWidth	prettier.printWidth	`null`	If set, will be passed to prettier as `--print-width`. More information here
tabWidth	prettier.tabWidth	`null`	If set, will be passed to prettier as `--tab-width`. More information here
useTabs	prettier.useTabs	`null`	If set, will be passed to prettier as `--use-tabs`. More information here
endOfLine	prettier.endOfLine	`null`	If set, will be passed to prettier as `--end-of-line`. More information here
ignoreConfigFile	prettier.ignoreConfigFile	`false`	If set to true, pretter will be invoked with `--no-config`. More information here
ignoreEditorConfig	prettier.ignoreEditorConfig	`false`	If set to true, pretter will be invoked with `--no-editorconfig`. More information here

Developing the plugin

For convenience, this plugin bundles Node, prettier, and prettier-java. Over time, these bundled dependencies will need to be kept up to date. Below are some directions for adding new versions of Node and prettier-java.

Adding new versions of node

You can download binaries for Linux/OSX/Windows from here: https://nodejs.org/en/about/releases/

Make a new folder located at src/main/binaries/node/{node-version} and drop the binaries in there using the existing name formatting.
Update the pom.xml to attach these new binaries

Adding new versions of prettier-java