Search Salesforce Developer Documentation entries in VSCode, and open them in your browser (or with experimental features: in VSCode itself!).
Please Note: this is a community-made plugin, and is not affiliated with Salesforce. If the extension breaks, please open a github issue to let me know, there's a chance Salesforce may change its doc approach, necessitating an update to the plugin
Repository Home: https://github.com/Oblongmana/vscode-salesforce-doc-lookup
VSCode Marketplace Install: https://marketplace.visualstudio.com/items?itemName=Oblongmana.vscode-salesforce-doc-lookup
Table of Contents
- Current Features
- Choose a documentation type, and type in your search
- Search dev documentation for a word or selection in your editor
- Experimental Features
- EXPERIMENTAL: Load Documentation in VSCode
- EXPERIMENTAL: New Command: "Salesforce Reference: LWC and Aura Component Library (EXPERIMENTAL)"
- In VSCode or the Extension Marketplace
- Manually (with use cases/caveats)
- Known Issues
- Adblockers and loading links in Browser - NOFIX:
- Notable Differences to the original Sublime Text 3 version
- Release Notes
- Design Notes
Choose a documentation type, and type in your search
The following new commands allow you to search Salesforce Dev documentation in VSCode, and be taken directly to the corresponding entries in your browser (or with the experimental setting enabled, view it in a WebView in VSCode itself):
- Salesforce Reference: Apex
- Salesforce Reference: Visualforce
- Salesforce Reference: Lightning Console
- Salesforce Reference: Classic Console
- Salesforce Reference: Metadata API
- Salesforce Reference: Object Reference
- Salesforce Reference: REST API
- Salesforce Reference: SOAP API
- Salesforce Reference: SFDX CLI
- Salesforce Reference: LWC and Aura Component Library (EXPERIMENTAL)
The first time you call any of these commands, the Extension will call out to Salesforce to get an index of that documentation type. This will be cached, and future uses of the command will be instant.
If you need to invalidate the cache for any reason, there is a command for doing so:
- Salesforce Reference: Invalidate Cache
Search dev documentation for a word or selection in your editor
With your cursor over a word in your editor, or with something in your editor selected, you can choose a documentation type and search for that string, using the new command:
- Salesforce Reference: Search for current word or selection
EXPERIMENTAL: Load Documentation in VSCode
Load documentation directly in VSCode. Enable the "Use WebView" option in your Settings to use this. Please note this is in active development, and is not fully supported. If you encounter bugs, please post an issue on github.
EXPERIMENTAL: New Command: "Salesforce Reference: LWC and Aura Component Library (EXPERIMENTAL)"
This is a very experimental reference type - the LWC/Aura Component Library is built on an Aura app, quite different to the Angular App and ToC JSON underpinning other documentation. Report any bugs on github if you see them!