Introduction
In the “Salesforce DX – SFDX – Guide” article, we explained what it is and how to use SFDX. Generally, the Salesforce DX project has a specific project structure and source format. Source format uses a different set of files and file extensions from what you’re accustomed to when using Metadata API. But what if you want to use Visual Studio Code with the Salesforce CLI Integration plugin but your repository is in the Metadata format?
How to configure the project?
NOTE: This doesn’t work if you want to retrieve or deploy SObject definition (SObject configuration, fields, etc.) – you will need to use the ANT Migration tool for that (here is our guide).
Create a Salesforce DX project
- use Ctrl+Alt+P keyboard shortcut
- enter SFDX: Create Project
- choose Empty
- enter your project name
- choose project location
An empty project has been created in the source format.
Authorize your credentials
If you do not have the org authorized yet:
- use Ctrl+Alt+P keyboard shortcut
- enter SFDX: Authorize an Org
- choose the org type that you want to authorize
- enter an org alias
- log in to a destination org using the Salesforce login page
If you’ve already created the alias for your org:
- click on the “No Default Org Set” icon in the sidebar and choose the existing alias
You have been authorized.
Delete the force-app folder
Go to the project directory and clone the repository
The remote repository has been cloned.
Also, the Source Control has been initialized.
Update the sfdx-project.json file to the new project directory
- open the sfdx-project.json file
- change the “path” to the name of the project folder from repository
Verify if you can use the Salesforce CLI functions
Make a change to the file:
Compare the local file to the version in the org:
Deploy changes:
Was it helpful? Check out our other great posts here.
Resources
- https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_file_format.htm
- https://salesforceprofs.com/sfdx-guide/
