xysfdx README
xysfdx is a Rapid development tool for Salesforce SFDX Development. Metadata diff with server, retrieve standard sobject.
Features
- Less than 100k.
- Use oauth2.
- Retrieve Metadata by select.
- Metadata diff with server(any sfdc organization).
- Retrieve standard sobject.
- Quick open sfdc link.
- auto run
.apex
file after save. - auto save to sfdc server
- pretty code: pretty
.cmp
,.page
,.component
,.trigger
,.cls
file - Support using WSL/git bash/Msys2/MingW64/MingW32 to develope sfdx .
- No need to config anything.
Shortkey
shortkey: ctrl+shift+j
Requirements
Usage
Create a project
force:project:create
Retrieve metadata
force:source:retrieve:metadata
Diff metadata
force:source:diff:metadata
You can diff with any sfdc organization.
diff source
diff profile
Authentication
force:auth:web:login
Deploy metadata
force:source:deploy:metadata
force:source:deploy:current_file
Option Features
How to config option features
You can also open the Settings editor from the Command Palette (Ctrl+Shift+P
) with Preferences: Open Settings or use the keyboard shortcut (Ctrl+,
).
search xysfdx
Build-in Option Features
xysfdx.optionFeatures
config:
- use_advanced_command: show advanced command
- auto_run_apex_anonymous: run
.apex
file after save it - auto_save_to_sfdc: auto deploy to
.trigger
,.cls
,.component
,.page
file to sfdc - pretty_vf_page: pretty
.cmp
,.page
,.component
file - pretty_apex_anonymous: pretty
.apex
file - pretty_apex: pretty
.trigger
,.cls
file
config:
{
"xysfdx.optionFeatures": [
// show advanced command
//"use_advanced_command",
// auto deploy to `.trigger`, `.cls`, `.component`, `.page` file to sfdc
// "auto_save_to_sfdc",
// pretty `.cmp`, `.page`, `.component` file
// "pretty_vf_page",
// pretty `.trigger`, `.cls` file
// "pretty_apex",
// run `.apex` file after save it, default active
"auto_run_apex_anonymous",
// pretty `.apex` file
"pretty_apex_anonymous"
]
}
show advanced command
-
Advanced:force:source:deploy:current_file
: Select Authenticated server and deploy file -
Advanced:force:source:retrieve:current_file
: Select Authenticated server and retrieve file
auto run apex anonymous code
auto_run_apex_anonymous
auto save to sfdc server
auto_save_to_sfdc
pretty code
- pretty_apex: pretty
.cmp
,.page
,.component
file - pretty_vf_page: pretty
.trigger
,.cls
file - pretty_apex_anonymous : pretty
.apex
file
you need to install
java
and prettier and prettier-plugin-apex
npm install --global prettier prettier-plugin-apex
sudo apt install openjdk-8-jdk
read more about prettier-plugin-apex
For Windows user
use wsl/git bash/Msys2 bash to develope sfdx.
Open cmd/wsl/bash
use wsl
open wslmode
{
"xysfdx.shellMode": "wsl",
"xysfdx.shellPath": "C:\\Windows\\System32\\bash.exe"
}
use msys2 bash
{
"xysfdx.shellMode": "bash",
"xysfdx.shellPath": "C:\\msys64\\usr\\bin\\bash.exe"
}
use git bash
{
"xysfdx.shellMode": "bash",
"xysfdx.shellPath": "C:\\Program Files\\Git\\git-bash.exe"
}
Enjoy it!