Skip to content

Commit

Permalink
feat(vscode): add vscp alias (ohmyzsh#12092)
Browse files Browse the repository at this point in the history
Co-authored-by: Carlo Sala <[email protected]>
  • Loading branch information
AliSajid and carlosala authored Jan 17, 2024
1 parent c007497 commit c6ce22f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
28 changes: 17 additions & 11 deletions plugins/vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# VS Code

This plugin provides useful aliases to simplify the interaction between the command line and VS Code or VSCodium editor.
This plugin provides useful aliases to simplify the interaction between the command line and VS Code or
VSCodium editor.

To start using it, add the `vscode` plugin to your `plugins` array in `~/.zshrc`:

Expand All @@ -14,26 +15,30 @@ This plugin requires to have a flavour of VS Code installed and it's executable

You can install either:

* VS Code (code)
* VS Code Insiders (code-insiders)
* VSCodium (codium)
- VS Code (code)
- VS Code Insiders (code-insiders)
- VSCodium (codium)

### MacOS

While Linux installations will add the executable to PATH, MacOS users might still have to do this manually:

[For VS Code and VS Code Insiders](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line), open
the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
[For VS Code and VS Code Insiders](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line),
open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:

> Shell Command: Install 'code' command in PATH
[For VSCodium](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#how-do-i-open-vscodium-from-the-terminal), open
the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
[For VSCodium](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#how-do-i-open-vscodium-from-the-terminal),
open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:

> Shell Command: Install 'codium' command in PATH
## Using multiple flavours

If for any reason, you ever require to use multiple flavours of VS Code i.e. VS Code (stable) and VS Code Insiders, you can
manually specify the flavour's executable. Add the following line to the .zshrc file (between the `ZSH_THEME` and the `plugins=()` lines).
This will make the plugin use your manually defined executable.
If for any reason, you ever require to use multiple flavours of VS Code i.e. VS Code (stable) and VS Code
Insiders, you can manually specify the flavour's executable. Add the following line to the .zshrc file
(between the `ZSH_THEME` and the `plugins=()` lines). This will make the plugin use your manually defined
executable.

```zsh
ZSH_THEME=...
Expand Down Expand Up @@ -61,6 +66,7 @@ source $ZSH/oh-my-zsh.sh
| vscr | code --reuse-window | Force to open a file or folder in the last active window. |
| vscw | code --wait | Wait for the files to be closed before returning. |
| vscu `dir` | code --user-data-dir `dir` | Specifies the directory that user data is kept in. Can be used to open multiple distinct instances of Code. |
| vscp `profile` | code --profile `profile` | Specifies the profile to open Code with. |

## Extensions aliases

Expand Down
2 changes: 2 additions & 0 deletions plugins/vscode/vscode.plugin.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# https://github.com/MarsiBarsi (original author)
# https://github.com/babakks
# https://github.com/SteelShot
# https://github.com/AliSajid

# Verify if any manual user choice of VS Code exists first.
if [[ -n "$VSCODE" ]] && ! which $VSCODE &>/dev/null; then
Expand Down Expand Up @@ -38,6 +39,7 @@ alias vscn="$VSCODE --new-window"
alias vscr="$VSCODE --reuse-window"
alias vscw="$VSCODE --wait"
alias vscu="$VSCODE --user-data-dir"
alias vscp="$VSCODE --profile"

alias vsced="$VSCODE --extensions-dir"
alias vscie="$VSCODE --install-extension"
Expand Down

0 comments on commit c6ce22f

Please sign in to comment.