This extension pack includes tools for developing on the Salesforce platform in the lightweight, extensible VS Code editor. These tools provide features for working with development orgs (scratch orgs, sandboxes, and DE orgs), Apex, Aura components, and Visualforce.
Prerequisites
Before you set up Salesforce Extensions for VS Code, make sure that you have these essentials.
Setting up Visual Studio Code. Visual Studio Code is a great code editor and comes with lots of useful things out-of-the-box. However, to work with Salesforce, we will need to install the “Salesforce Extension Pack.” Open up Visual Studio Code and go to Extensions tab and search for “Salesforce Extension Pack.” Download and install. Code Builder, built on Microsoft’s Visual Studio Codespaces, is a web-based developer environment optimized for Salesforce. Building on the partnership we announced in November of last year, Code Builder has the potential to empower the Salesforce development ecosystem to be more productive by building apps how they want and where they want.
Salesforce CLI
Before you use Salesforce Extensions for VS Code, set up Salesforce CLI.A Salesforce DX projectOpen your Salesforce DX project in a directory that contains an
sfdx-project.json
file. Otherwise, some features don’t work.
If you don't already have a Salesforce DX project, create one with the SFDX: Create Project command (for development against scratch orgs) or the SFDX: Create Project with Manifest command (for development against sandboxes or DE orgs). Or, see create a Salesforce DX project for information about setting up a project using Salesforce CLI.Java Platform, Standard Edition Development Kit
Some features in Salesforce Extensions for VS Code depend upon the Java Platform, Standard Edition Development Kit (JDK). You need to have either version 8 or version 11 of the JDK installed.If you don’t already have version 8 or 11 of the JDK installed, you can install the latest version of the Java 8 JDK from Java SE Development Kit 8 Downloads or the latest version of the Java 11 JDK from Java SE Development Kit 11 Downloads.
If you also use other versions of the JDK, set your VS Code user setting
salesforcedx-vscode-apex.java.home
to point to the location where you installed Java 8 or 11.Visual Studio Code v1.26 or later
Documentation
For documentation, visit the Salesforce Extensions for Visual Studio Code documentation site.
Open Source
Visual Studio Code Salesforce
Bugs and Feedback
To report issues with Salesforce Extensions for VS Code, open a bug on GitHub. If you would like to suggest a feature, create a feature request on GitHub.
Included Extensions
Visual Studio Salesforce Cli Is Not Installed
The Salesforce Extension Pack extension installs these extensions.
Sfdx Vscode
- Salesforce CLI Integration
This extension (salesforcedx-vscode-core
) interacts with Salesforce CLI to provide core functionality. - Apex
This extension (salesforcedx-vscode-apex
) uses the Apex Language Server to provide features such as syntax highlighting and code completion. - Apex Interactive Debugger
This extension (salesforcedx-vscode-apex-debugger
) enables VS Code to use the real-time Apex Debugger with your scratch orgs or to use ISV Customer Debugger for your subscribers’ orgs. - Apex Replay Debugger
This extension (salesforcedx-vscode-apex-replay-debugger
) enables VS Code to replay Apex execution from Apex debug logs. - Lightning Web Components
This extension supports Lightning web component bundles. It uses the HTML language server from VS Code. - Aura Components
This extension (salesforcedx-vscode-lightning
) supports Aura component bundles. It uses the HTML language server from VS Code. - Visualforce
This extension (salesforcedx-vscode-visualforce
) supports Visualforce pages and components. It uses the Visualforce Language Server and the HTML language server from VS Code. - Salesforce Lightning Design System (SLDS) Validator
This extension (salesforcedx-vscode-slds
) simplifies working with the Salesforce Lightning Design System (SLDS). It provides code completion, syntax highlighting and validation with recommended tokens and utility classes.
What Is Visual Studio For
Currently, Visual Studio Code extensions are not signed or verified on the Microsoft Visual Studio Code Marketplace. Salesforce provides the Secure Hash Algorithm (SHA) of each extension that we publish. Consult Manually Verify the salesforcedx-vscode Extensions’ Authenticity to learn how to verify the extensions.