cb13cc539fa87f1c8f57dbbaefa3d3dcbaa85099
- Author
- Adam Alston <aalston9@gmail.com>
- Committer
- GitHub <noreply@github.com>
- Date
Message
docs(vscode): align README with current CLI behavior (#13653)
Diff
This diff is truncated to protect this page.
1diff --git a/plugins/vscode/README.md b/plugins/vscode/README.md
2index 4661057a85a89b32a9dd165d241e78ee6d95f4cd..43581a8cee72b4718403e1fc006807565b20cc0b 100644
3--- a/plugins/vscode/README.md
4+++ b/plugins/vscode/README.md
5@@ -1,6 +1,6 @@
6 # VS Code
7
8-This plugin provides useful aliases to simplify the interaction between the command line and VS Code, VSCodium, or Cursor editor.
9+This plugin provides useful aliases to simplify interaction between the command line and VS Code, VSCodium, or Cursor.
10
11 To start using it, add the `vscode` plugin to your `plugins` array in `~/.zshrc`:
12
13@@ -10,46 +10,45 @@ plugins=(... vscode)
14
15 ## Requirements
16
17-This plugin requires to have a flavour of VS Code installed and its executable available in PATH.
18+This plugin requires one of the supported editors to be installed and its executable to be available in `PATH`.
19
20-You can install either:
21+You can install one of the following:
22
23-- VS Code (code)
24-- VS Code Insiders (code-insiders)
25-- VSCodium (codium)
26-- Cursor (cursor)
27+- VS Code (`code`)
28+- VS Code Insiders (`code-insiders`)
29+- VSCodium (`codium`)
30+- Cursor (`cursor`)
31
32-### MacOS
33+### macOS
34
35-While Linux installations will add the executable to PATH, MacOS users might still have to do this manually:
36+While Linux installations usually add the executable to `PATH`, macOS users might still have to do this manually:
37
38 [For VS Code and VS Code Insiders](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line),
39-open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
40+open the Command Palette with `F1` or `Shift+Cmd+P`, then search for the following command:
41
42 > Shell Command: Install 'code' command in PATH
43
44 [For VSCodium](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#how-do-i-open-vscodium-from-the-terminal),
45-open the Command Palette via (F1 or ⇧⌘P) and type shell command to find the Shell Command:
46+open the Command Palette with `F1` or `Shift+Cmd+P`, then search for the following command:
47
48 > Shell Command: Install 'codium' command in PATH
49
50-For Cursor, open the Command Palette via (F1 or ⌘⇧P) and type shell command to find the Shell Command:
51+For Cursor, open the Command Palette with `F1` or `Cmd+Shift+P`, then search for the following command:
52
53 > Shell Command: Install 'cursor' command in PATH
54
55-## Using multiple flavours
56+## Choosing an editor
57
58-If for any reason, you ever require to use multiple flavours of VS Code i.e. VS Code (stable) and VS Code
59-Insiders, you can manually specify the flavour's executable. Add the following line to the .zshrc file
60-(between the `ZSH_THEME` and the `plugins=()` lines). This will make the plugin use your manually defined
61-executable.
62+If you have multiple supported editors installed, e.g., VS Code (stable) and VS Code Insiders, you can manually
63+specify which executable the plugin should use. Add the following line to `~/.zshrc` between the `ZSH_THEME`
64+and `plugins=()` lines. This makes the plugin use your manually defined executable.
65
66 ```zsh
67 ZSH_THEME=...
68
69-# Choose between one [code, code-insiders, codium, or cursor]
70-# The following line will make the plugin to open VS Code Insiders
71-# Invalid entries will be ignored, no aliases will be added
72+# Choose one of `code`, `code-insiders`, `codium`, or `cursor`.
73+# The following line makes the plugin open VS Code Insiders.
74+# Invalid entries are ignored and no aliases are added.
75 VSCODE=code-insiders
76
77 plugins=(... vscode)
78@@ -61,29 +60,29 @@ source $ZSH/oh-my-zsh.sh
79
80 | Alias | Command | Description |
81 | ----------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
82-| vsc | code . | Open the current folder in VS code |
83-| vsc `dir` | code `dir` | Open passed folder in VS code |
84-| vsca `dir` | code --add `dir` | Add folder(s) to the last active window |
85+| vsc | code . | Open the current folder in VS Code |
86+| vsc `[args ...]` | code `[args ...]` | Pass arguments through to VS Code, e.g., a file, folder, or CLI flags. |
87+| vsca `dir` | code --add `dir` | Add one or more folders to the last active window. |
88 | vscd `file` `file` | code --diff `file` `file` | Compare two files with each other. |
89 | vscg `file:line[:char]` | code --goto `file:line[:char]` | Open a file at the path on the specified line and character position. |
90-| vscn | code --new-window | Force to open a new window. |
91-| vscr | code --reuse-window | Force to open a file or folder in the last active window. |
92+| vscn | code --new-window | Force opening in a new window. |
93+| vscr | code --reuse-window | Force opening a file or folder in the last active window. |
94 | vscw | code --wait | Wait for the files to be closed before returning. |
95-| 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. |
96+| vscu `dir` | code --user-data-dir `dir` | Specifies the directory where user data is stored. Can be used to open multiple distinct instances of Code. |
97 | vscp `profile` | code --profile `profile` | Specifies the profile to open Code with. |
98
99-## Extensions aliases
100+## Extension aliases
101
102-| Alias | Command | Description |
103-| ----------------------- | ---------------------------------------------------------------- | --------------------------------- |
104-| vsced `dir` | code --extensions-dir `dir` | Set the root path for extensions. |