Prettier Apex
This is a code formatter for the Apex Programming Language,
used on the Salesforce development platform.
It uses the excellent Prettier engine for formatting,
and the jorje compiler from Salesforce for parsing.
Status
This project is production ready, and have been tested on multiple projects,
including a mix of open source/proprietary/Salesforce internal code bases.
Usage
Requirements
- Node >= 8
- Java Runtime Engine >= 1.8.0
How to use
First, install the library:
npm install --save-dev prettier prettier-plugin-apex
npm install --global prettier prettier-plugin-apex
If you install globally, run:
prettier --write "/path/to/project/**/*.{trigger,cls}"
If you install locally, you can add prettier as a script in package.json
:
{
"scripts": {
"prettier": "prettier"
}
}
Then in order to run it:
npm run prettier -- --write "/path/to/project/**/*.{trigger,cls}"
Tip
Initial run
If you are formatting a big code base for the first time,
please make sure that you have some form of version control in place,
so that you can revert any change if necessary.
You should also run Prettier with the --debug-check
argument.
For example:
prettier --debug-check "/path/to/project/**/*.{trigger,cls}"
This will guarantee that the behavior of your code will not change because of
the format.
If there are no errors, you can run prettier
with --write
next.
If there are errors, please file a bug report so that they can be fixed.
Anonymous Apex
You can also format anonymous Apex with this program by using the
--apex-anonymous
flag.
For example:
prettier --write "/path/to/project/anonymous/**/*.cls" --apex-anonymous
Note that Prettier will treat any Apex file that it finds using the glob above
as anonymous code blocks,
so it is recommended that you collect all of your anonymous Apex files into
one directory and limit the use of --apex-anonymous
only in that directory.
Ignoring lines
If there are lines in your Apex code that you do not want formatted by Prettier
(either because you don't agree with the formatting choice,
or there is a bug), you can instruct Prettier to ignore it by including the comment
// prettier-ignore
or /* prettier-ignore */
on the line before. For example:
// prettier-ignore
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
)
Configuration
This library follows the same configuration format as Prettier,
which is documented here.
The amount of configuration is very limited,
because this is intended to be a very opinionated formatter.
Here is the default configuration that can be overriden:
Editor integration
VScode
The official plugin prettier-vscode
doesn't support plugins out of the box yet, see this issue.
There are 2 workarounds to enable Apex support anyway:
- First way is to install the plugin into the plugin directory:
cd ~/.vscode/extensions/esbenp.prettier-vscode-1.8.1/
npm install prettier-plugin-apex
After restarting VScode the plugin should work as expected.
The downside is that you will need to do this every time the plugin gets updated.
Once either of them gets merged into the master
branch, the VSCode plugin will support prettier-plugin-apex
.
Performance Tips/3rd party integration
By default,
this library invokes a CLI application to get the AST of the Apex code.
However, since this CLI application is written in Java,
there is a heavy start up cost associated with it.
In order to alleviate this issue,
we also have an optional HTTP server
that makes sure the start up is invoked exactly once.
This is especially useful if this library is integrated in a 3rd party application.
In order to use this server,
you have to evoke it out of band before running Prettier,
as well as specifying a special flag when running Prettier:
start-apex-server
node /path/to/libary/bin/start-apex-server.js
prettier --apex-standalone-parser built-in --write "/path/to/project/**/*.{trigger,cls}"
stop-apex-server
node /path/to/libary/bin/stop-apex-server.js