DMC/scipro
7
0
Fork 0
Code Issues35 Pull Requests5 Actions Projects1 Releases Wiki Activity

Update instructions for how to get Prettier to format on save ()

Browse Source 
IntelliJ requires Node.js to be installed for it to be able to run Prettier and format the code.

Co-authored-by: Nico Athanassiadis <nico@dsv.su.se>
Reviewed-on: 
Reviewed-by: Nico Athanassiadis <nico@dsv.su.se>
Co-authored-by: Andreas Svanberg <andreass@dsv.su.se>
Co-committed-by: Andreas Svanberg <andreass@dsv.su.se>
This commit is contained in:
Andreas Svanberg 2024-12-16 13:26:19 +01:00 committed by Nico Athanassiadis
parent f67f37ecdd
commit 89c8a4f8a2
1 changed files with 9 additions and 4 deletions

13
README.md

@ -19,9 +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
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.
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 .`.