https://github.com/spotify/fmt-maven-plugin
Opinionated Maven Plugin that formats your Java code.
https://github.com/spotify/fmt-maven-plugin
Last synced: about 1 year ago
JSON representation
Opinionated Maven Plugin that formats your Java code.
- Host: GitHub
- URL: https://github.com/spotify/fmt-maven-plugin
- Owner: spotify
- License: mit
- Created: 2016-03-17T16:56:30.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T07:06:33.000Z (over 1 year ago)
- Last Synced: 2025-03-31T15:07:56.295Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 279 KB
- Stars: 348
- Watchers: 10
- Forks: 68
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/spotify/fmt-maven-plugin/actions/workflows/ci.yml?query=branch%3Amain)
[](https://github.com/spotify/fmt-maven-plugin/blob/main/LICENSE)
[](https://maven-badges.herokuapp.com/maven-central/com.spotify.fmt/fmt-maven-plugin)
## fmt-maven-plugin
**UPDATE 2022-02-14:** This plugin has moved from [coveooss](https://github.com/coveooss/) to the [spotify](https://github.com/spotify/) Github org. The new groupId will be `com.spotify.fmt`, and the `master` branch has been renamed to `main`.
Formats your code using [google-java-format](https://github.com/google/google-java-format) which follows [Google's code styleguide](https://google.github.io/styleguide/javaguide.html).
The format cannot be configured by design.
If you want your IDE to stick to the same format, google-java-format also includes integrations for IntelliJ and Eclipse IDE's, following the installation instructions on the [README](https://github.com/google/google-java-format/blob/master/README.md#using-the-formatter).
## Usage
### Standard pom.xml
To have your sources automatically formatted on each build, add to your pom.xml:
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
format
```
If you prefer, you can only check formatting at build time using the `check` goal:
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
check
```
#### Overriding the Default Lifecycle Phase
Both goals have a [Maven lifecycle phase](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#lifecycle-reference) configured by default.
| Goal | Default Phase |
|-----------|-------------------|
| `format` | `process-sources` |
| `check` | `verify` |
You may prefer to run these goals in a different phase instead.
Maven allows you to override the default phase by specifying a `` for the ``.
For example, you may prefer that the `check` goal is performed in an earlier phase such as `validate`:
```xml
validate
check
```
### Options
`sourceDirectory` represents the directory where your Java sources that need to be formatted are contained. It defaults to `${project.build.sourceDirectory}`
`testSourceDirectory` represents the directory where your test's Java sources that need to be formatted are contained. It defaults to `${project.build.testSourceDirectory}`
`additionalSourceDirectories` represents a list of additional directories that contains Java sources that need to be formatted. It defaults to an empty list.
`verbose` is whether the plugin should print a line for every file that is being formatted. It defaults to `false`.
`filesNamePattern` represents the pattern that filters files to format. The defaults value is set to `.*\.java`.
`skip` is whether the plugin should skip the operation.
`skipSortingImports` is whether the plugin should skip sorting imports.
`skipSourceDirectory` is whether the plugin should skip formatting/checking the `sourceDirectory`. It defaults to `false`.
`skipTestSourceDirectory` is whether the plugin should skip formatting/checking the `testSourceDirectory`. It defaults to `false`.
`style` sets the formatter style to be `google` or `aosp`. By default this is `google`. Projects using Android conventions may prefer `aosp`.
`forkMode` lets you specify whether to run google-java-format in a fork or in-process. Also adds JVM arguments to expose JDK internal javac APIs. Value `default` (which is the default) will fork (to avoid warnings for JDK9+ and to be able to run at all for JDK16+), `never` runs in-process, regardless of JDK version and `always` will always fork.
example:
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
some/source/directory
some/test/directory
true
.*\.java
some/dir
some/other/dir
false
false
false
false
google
format
```
### check Options
`displayFiles` default = true. Display the list of the files that are not compliant.
`displayLimit` default = 100. Number of files to display that are not compliant.
`failOnError` default = true. Fail the build if non-compliant files are found.
example to not display the non-compliant files:
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
false
check
```
example to limit the display up to 10 files
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
10
check
```
example to only warn about non-compliant files instead of failing the build
```xml
com.spotify.fmt
fmt-maven-plugin
VERSION
false
check
```
### Command line
You can also use it on the command line
`mvn com.spotify.fmt:fmt-maven-plugin:format`
You can pass parameters via standard `-D` syntax.
`mvn com.spotify.fmt:fmt-maven-plugin:format -Dverbose=true`
`-Dfmt.skip` is whether the plugin should skip the operation.
### Using with Java 8
Starting from version 1.8, Google Java Formatter requires Java 11 to run. Incidently, all versions of this plugin starting from 2.10 inclusively also require this Java version to properly function. The 2.9.x release branch is the most up-to-date version that still runs on Java 8.
### Deploy
- `git checkout main && git pull`
- `mvn release:prepare` - use x.y format for release version and x.y.z for SCM tag. (You can only do this as admin of the repo)
- `mvn release:perform -P release` (make sure to use Maven settings which include credentials for the Sonatype staging repo)
- `git fetch` - to make sure your local repo is up to date with the commits from the release plugin.
- Create a GitHub release with merged PRs and other information.
- Check that the release is available in [Sonatype staging](https://oss.sonatype.org/#nexus-search;quick~com.spotify.fmt)
- Wait for the release to be available in [Maven Central](https://repo1.maven.org/maven2/com/spotify/fmt/fmt-maven-plugin/)
- Update version used for actual formatting in the POM.