@jayree/sfdx-plugin-prettier
A Salesforce CLI plugin containing a hook that uses prettier to format Salesforce metadata source files retrieved or pulled from Salesforce orgs.
sfdx-plugin-prettier
is an sfdx plugin to format Salesforce metadata source files. It is triggered by the postsourceupdate hook after running force:source:retrieve
or force:source:pull
.
Install
$ npm install -g @jayree/sfdx-plugin-prettier
$ sfdx COMMAND
running command...
$ sfdx (--version)
@jayree/sfdx-plugin-prettier/1.3.21 linux-x64 node-v18.17.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
Usage
Use force:source:retrieve
or force:source:pull
to tirgger the hook. The formatting is performed on the retrieved source files.
Configuration and Ignore Files
sfdx-plugin-prettier
uses the .prettierrc
, .prettierignore
, and .editorconfig
files in the sfdx project folder.
When the hook is executed for the first time, a sfdx-plugin-prettier
setting is added to the sfdx-project.json
file. Here you can enable or disable the hook by setting enabled
to true
or false
(default). If you want the hook to remain disabled for a project, you can remove the setting again.
{
"plugins": {
"sfdx-plugin-prettier": {
"enabled": true
}
}
}