@jayree/sfdx-plugin-prettier

@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
• Usage
• Configuration and Ignore Files

Install

$ sfdx plugins:install @jayree/sfdx-plugin-prettier
$ sfdx plugins
@jayree/sfdx-plugin-prettier 1.2.33

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
    }
  }
}

Changelog

1.2.33 (2023-03-17)

Bug Fixes

• deps: bump @oclif/core from 2.6.2 to 2.6.4 (#366) (601b8b2)
• deps: bump @salesforce/core from 3.33.6 to 3.34.1 (#361) (b5b51e9)