Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

prettier-plugin-apex

Package Overview
Dependencies
Maintainers
2
Versions
57
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

prettier-plugin-apex

Salesforce Apex plugin for Prettier

  • 1.0.0
  • npm
  • Socket score

Version published
Weekly downloads
74K
increased by1.99%
Maintainers
2
Weekly downloads
 
Created
Source

Prettier Apex Build Status npm NPM codecov Join the chat at https://gitter.im/prettier-plugin-apex/community

Prettier Banner

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:

# Install locally
npm install --save-dev prettier prettier-plugin-apex

# Or install globally
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 parser.

For example:

prettier --write "/path/to/project/anonymous/**/*.cls" --parser 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:

NameDefaultDescription
printWidth80Same as in Prettier (see prettier docs)
tabWidth2Same as in Prettier (see prettier docs)
useTabsfalseSame as in Prettier (see prettier docs)
requirePragmafalseSame as in Prettier (see prettier docs)
insertPragmafalseSame as in Prettier (see prettier docs)
apexInsertFinalNewlinetrueWhether a newline is added as the last thing in the output
apexStandaloneParsernoneIf set to built-in, Prettier uses the built in standalone parser for better performance. See Performance Tip.
If set to none, Prettier invokes the CLI parser for every file.
apexStandalonePort2117The port that the standalone Apex parser listens on.
Only applicable if apexStandaloneParser is built-in.

Editor integration

VScode

Follow this tutorial from Salesforce in order to use this plugin in VSCode.

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 the server (if installed globally)
start-apex-server
# Or if installed locally
node /path/to/library/bin/start-apex-server.js

# In a separate console
prettier --apex-standalone-parser built-in --write "/path/to/project/**/*.{trigger,cls}"

# After you are done, stop the server (if installed globally)
stop-apex-server
# Or if installed locally
node /path/to/library/bin/stop-apex-server.js

Keywords

FAQs

Package last updated on 05 Oct 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc