diff --git a/README.md b/README.md index 52cb4b05d7..f5b81e7a88 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,14 @@ to format all Java code. To reformat the code run Yes it's a mouthful but unfortunately the [prettier-maven-plugin](https://github.com/HubSpot/prettier-maven-plugin) does not work due to an [outstanding issue](https://github.com/HubSpot/prettier-maven-plugin/issues/79). -An easier way to reformat code is to set IntelliJ to do it on save. Go to -`Settings -> Language & Frameworks -> JavaScript -> Prettier` and then check -`Automatic Prettier Configuration`, set `Run for files` to `**/*.{java}`, -and finally check `Run on save`. +The formatting is validated by CI, but you should do it beforehand with a simple `./mvnw verify -pl .`. + +### Making IntelliJ format for you For this to work you also need to have [Node.js](https://nodejs.org) installed and configured under `Settings -> Language & Frameworks -> Node.js` and the file you're saving *must* be able to compile otherwise no formatting can be performed. -The formatting is validated by CI, but you should do it beforehand with a simple `./mvnw verify -pl .`. +Go to `Settings -> Language & Frameworks -> JavaScript -> Prettier` and then check +`Automatic Prettier Configuration`, set `Run for files` to `**/*.{java}`, +and finally check `Run on save`.