Skip to content

Commit

Permalink
docs: update tips and tricks topic (#5571)
Browse files Browse the repository at this point in the history
* docs: update tips and tricks topic

Update to the topic based on Gordon and Cristy's TDX preso.

* docs: commit 2

acrolinx.

* docs: settings.md update

also update settings topic.

* Update docs/_articles/en/vscode-desktop/tips-and-tricks.md

Co-authored-by: Cristina Cañizales <[email protected]>

* Update docs/_articles/en/vscode-desktop/tips-and-tricks.md

Co-authored-by: Cristina Cañizales <[email protected]>

* Update settings.md

* Update docs/_articles/en/vscode-desktop/tips-and-tricks.md

Co-authored-by: mleonardsfdc <[email protected]>

* Update tips-and-tricks.md

---------

Co-authored-by: Cristina Cañizales <[email protected]>
Co-authored-by: mleonardsfdc <[email protected]>
  • Loading branch information
3 people authored May 7, 2024
1 parent 45a3915 commit cf8e20c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
13 changes: 6 additions & 7 deletions docs/_articles/en/vscode-desktop/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ title: Settings
lang: en
---

## Workspace Settings
To edit your workspace settings, select **File** > **Preferences** > **Settings** (Windows or Linux) or **Code** > **Preferences** > **Settings** (macOS). For information about configuring your settings, see [User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings) in the Visual Studio Code docs.
Edit your user, workspace and extension pack settings.

## Extension Settings
We use extension settings to provide access to beta features and other customizations.
## User and Workspace Settings

## Stop CLI Success Messages
To stop Salesforce CLI success messages from showing as pop-up information messages, click **Show Only in Status Bar** in a success message. This button overrides the `salesforcedx-vscode-core.show-cli-success-msg` value in your default settings. It changes the Workspace Settings value to `false`. Setting this value to `false` makes the success messages appear in the status bar (in VS Code’s footer) instead of as information messages. If you decide that you liked the information messages after all, change the value back to `true`.
To edit your workspace settings, select **File** > **Preferences** > **Settings** (Windows or Linux) or **Code** > **Settings...** > **Settings** (macOS). For information about configuring your settings, see [User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings) in the Visual Studio Code documentation.

To see the other settings for this extension pack, search the settings for `salesforcedx-vscode`.
## Extension Pack Settings

The Salesforce extensions pack contributes to its own settings, which you can review under the Extensions section of the Settings editor. To list all the settings for this extension pack, search the settings for `salesforcedx-vscode`. We use some extension settings to provide access to beta features and other customizations.
26 changes: 23 additions & 3 deletions docs/_articles/en/vscode-desktop/tips-and-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ lang: en

## Organize Your VS Code Extensions by Development Task

> **NOTE**: Because Code Builder is a web-based, these tips are not of relevance if Code Builder is your development environment of choice.
> **NOTE**: Because Code Builder is a web-based, this tip isn’t of relevance if Code Builder is your development environment of choice.
Organizing your VS Code extensions by development task can help you avoid having extensions provide functionality that’s not useful for the task at hand. Having only the extensions that you need helps minimize the VS Code startup time and ensures that shortcut keys don’t interfere with one another. Here’s how to set up VS Code to launch with only the extensions for working with Salesforce.

1. Add a `code-sfdx` alias to your shell’s startup script.

- Windows
- **Windows**

1. When you install VS Code, install `code` as part of your prompt. See [Visual Studio Code on Windows](https://code.visualstudio.com/docs/setup/windows#_installation) in the Visual Studio Code docs for details.
2. Open Git Bash. (Git Bash is installed as part of Salesforce CLI.)
Expand All @@ -20,7 +20,7 @@ Organizing your VS Code extensions by development task can help you avoid having
4. Add this line to your `.bashrc` file.
`alias code-sfdx='code --extensions-dir ~/.sfdx-code'`

- macOS or Linux
- **macOS or Linux**

1. Open VS Code.
2. To open the Command Palette, press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Linux).
Expand Down Expand Up @@ -52,3 +52,23 @@ Organizing your VS Code extensions by development task can help you avoid having
6. The next time you’re working on a Salesforce DX project, you can launch VS Code using `code-sfdx` and all your extensions will be there.

You can have as many aliases as you want, with as many `extensions-dir` directories as you need to help organize your extensions.

## Create Keyboard Shortcuts for Common Tasks
If using keyboard shortcuts is your jam, you'll appreciate the rich keyboard shortcut editing experience with the Keyboard Shortcuts editor that VS Code provides. Open the editor from **Code > Settings > Keyboard Shortcuts** or from **Preferences: Open Keyboard Shortcuts** command (⌘K ⌘S). See [Key Bindings for Visual Studio Code](https://code.visualstudio.com/docs/getstarted/keybindings) for details.

## Use Quick Open
Quickly search and open files using the keyboard shortcut ⌘P.

## Commands for Salesforce Development
Open the Command Palette using the keyboard shortcut ⌘⇧P. Type "SFDX" to view a list of commands available in your Salesforce project.

## Use the Extensions View
Bring up the Extensions view by clicking the Extensions icon in the Activity Bar on the side of VS Code or run the **View: Extensions** command (⌘⇧X). Search for an extension. On an extension's details page you can look up a lot of information such as its dependencies, feature details, settings, and change log.

## Some Useful Commands

**Show Running Extensions**
Open the Command Palette and type "show running..." and find and run the **Developer:Show Running Extensions** command to view all the extensions currently running in your VS Code session. You can see the start-up time for each extension. Right click an extension and select **Report Issue** to quickly create an issue on the extension's GitHub repository.
**Toogle Developer Tools**
Run **Developer:Toggle Tools** to view and understand the underpinnings of your VS Code sessions. From here you can grab any error messages that you'd like to include in an issue or a communication.

0 comments on commit cf8e20c

Please sign in to comment.