Skip to content

Commit 2fab610

Browse files
author
Greg Van Liew
committed
Consistency for macOS
Fixes microsoft#1561
1 parent db44942 commit 2fab610

37 files changed

+65
-66
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ When you link to an image, the path and filename are case-sensitive. The conven
135135
136136
### Key bindings
137137

138-
The VS Code portal is able to show the correct key bindings depending on the reader's operating system (Mac, Windows or Linux).
138+
The VS Code portal is able to show the correct key bindings depending on the reader's operating system (macOS, Windows or Linux).
139139

140140
To enable this for keyboard shortcuts, use the format `kb(workbench.action.files.openFile)` where the command name is included in parentheses.
141141

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you are looking for the VS Code product GitHub repository, you can find it [h
88

99
## Visual Studio Code
1010

11-
[VS Code](https://code.visualstudio.com/) is a lightweight but powerful development environment for building and debugging modern web and cloud applications. It is free and available on your favorite platform - Linux, Mac and Windows.
11+
[VS Code](https://code.visualstudio.com/) is a lightweight but powerful development environment for building and debugging modern web and cloud applications. It is free and available on your favorite platform - Linux, macOS and Windows.
1212

1313
If you landed here looking for other information about VS Code, head over to [our website](https://code.visualstudio.com) for additional information.
1414

docs/editor/accessibility.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ VS Code has some known accessibility issues depending on the platform.
9393

9494
You can not use the keyboard (right, left arrow keys) to move between top-level menu items (**File**, **Edit**, **View**, etc). This is due to Electron issue [#2504](https://github.com/atom/electron/issues/2504).
9595

96-
### Mac
96+
### macOS
9797

9898
There is limited screen reader support for the editor with VoiceOver.
9999

docs/editor/codebasics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Place the cursor in one corner and then hold `kbstyle(Shift+Alt)` while dragging
6363

6464
Note: This changes to `kbstyle(Shift+Ctrl/Cmd)` when using `kbstyle(Ctrl/Cmd)` as [multi-cursor modifier](#multi-cursor-modifier).
6565

66-
There are also default key bindings for column selection on Mac and Windows, but not on Linux.
66+
There are also default key bindings for column selection on macOS and Windows, but not on Linux.
6767

6868
Key|Command|Command id
6969
---|-------|----------

docs/editor/debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ To write your own debugger extension, visit:
384384

385385
**Q: What are the supported debugging scenarios?**
386386

387-
**A:** Debugging of Node.js based applications is supported on Linux, Mac, and Windows out of the box with VS Code. Many other scenarios are supported by [VS Code extensions](https://marketplace.visualstudio.com/vscode/Debuggers?sortBy=Downloads) available on the Marketplace.
387+
**A:** Debugging of Node.js based applications is supported on Linux, macOS, and Windows out of the box with VS Code. Many other scenarios are supported by [VS Code extensions](https://marketplace.visualstudio.com/vscode/Debuggers?sortBy=Downloads) available on the Marketplace.
388388

389389
**Q: I do not see any launch configurations in the debug view drop down, what is wrong?**
390390

docs/editor/extension-gallery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Once you've downloaded an extension, you can side load it by renaming the `.zip`
183183
**A**: Extensions are installed in your extensions folders. Depending on your platform, the global location is in the following folders:
184184

185185
* **Windows** `%USERPROFILE%\.vscode\extensions`
186-
* **Mac** `~/.vscode/extensions`
186+
* **macOS** `~/.vscode/extensions`
187187
* **Linux** `~/.vscode/extensions`
188188

189189
**Q: Can VS Code read TextMate bundles directly?**

docs/editor/integrated-terminal.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -158,13 +158,13 @@ This can be configured using the `terminal.integrated.rightClickBehavior` settin
158158

159159
The Integrated Terminal has basic find functionality which can be triggered with `kb(workbench.action.terminal.focusFindWidget)`.
160160

161-
If you want `Ctrl+F` to go to the shell instead of launching the Find widget on Linux and Windows, you will need to remove the keybinding like so:
161+
If you want `kbstyle(Ctrl+F)` to go to the shell instead of launching the Find widget on Linux and Windows, you will need to remove the keybinding like so:
162162

163163
```js
164164
// Windows/Linux
165165
{ "key": "ctrl+f", "command": "-workbench.action.terminal.focusFindWidget",
166166
"when": "terminalFocus" },
167-
// Mac
167+
// macOS
168168
{ "key": "cmd+f", "command": "-workbench.action.terminal.focusFindWidget",
169169
"when": "terminalFocus" },
170170
```

docs/editor/tasks-appendix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interface TaskConfiguration extends BaseTaskConfiguration {
2828
windows?: BaseTaskConfiguration;
2929

3030
/**
31-
* Mac specific task configuration
31+
* macOS specific task configuration
3232
*/
3333
osx?: BaseTaskConfiguration;
3434

docs/editor/tasks-v1-appendix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interface TaskConfiguration extends BaseTaskConfiguration {
2828
windows?: BaseTaskConfiguration;
2929

3030
/**
31-
* Mac specific task configuration
31+
* macOS specific task configuration
3232
*/
3333
osx?: BaseTaskConfiguration;
3434

docs/editor/tasks-v1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Below is an example that uses the Node.js executable as a command and is treated
191191
}
192192
```
193193

194-
Valid operating properties are `windows` for Windows, `linux` for Linux and `osx` for Mac. Properties defined in an operating system specific scope override properties defined in the global scope.
194+
Valid operating properties are `windows` for Windows, `linux` for Linux and `osx` for macOS. Properties defined in an operating system specific scope override properties defined in the global scope.
195195

196196
In the example below:
197197

docs/editor/tasks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ If you only need to tweak it for a specific task then add the OS specific comman
489489
}
490490
```
491491

492-
If the task is execute in `PowerShell` the command needs to read like this `chcp 866; more russian.txt`. Under Linux and Mac the `locale` command can be used to inspect the locale and tweak the necessary environment variables.
492+
If the task is execute in `PowerShell`, the command needs to read like this `chcp 866; more russian.txt`. On Linux and macOS, the `locale` command can be used to inspect the locale and tweak the necessary environment variables.
493493

494494
## Examples of tasks in action
495495

docs/editor/versioncontrol.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If there is no upstream branch configured and the Git repository has remotes set
5959

6060
**Staging** and **unstaging** can be done via contextual actions in the files or by drag-and-drop.
6161

62-
You can type a commit message above the changes and press `kbstyle(Ctrl+Enter)` (Mac: `kbstyle(⌘+Enter)`) to commit them. If there are any staged changes, only those will be committed, otherwise all changes will be committed.
62+
You can type a commit message above the changes and press `kbstyle(Ctrl+Enter)` (macOS: `kbstyle(⌘+Enter)`) to commit them. If there are any staged changes, only those will be committed, otherwise all changes will be committed.
6363

6464
We've found this to be a great workflow. For example, in the previous screenshot, only the `config.js` file will be included in the commit. A consecutive commit action would commit both `vinyl-zip.js` and `tests.js` in a separate commit.
6565

@@ -141,7 +141,7 @@ Here are the steps to do so:
141141

142142
1. Make sure you can run `code --help` from the command line and you get help.
143143
* if you do not see help, please follow these steps:
144-
* Mac: Select **Shell Command: Install 'Code' command in path** from the **Command Palette**.
144+
* macOS: Select **Shell Command: Install 'Code' command in path** from the **Command Palette**.
145145
* Windows: Make sure you selected **Add to PATH** during the installation.
146146
* Linux: Make sure you installed Code via our new .deb or .rpm packages.
147147
2. From the command line, run `git config --global core.editor "code --wait"`

docs/editor/whyvscode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ First and foremost, it is an editor that gets out of your way. The delightfully
1717

1818
Visual Studio Code supports macOS, Linux, and Windows - so you can hit the ground running, no matter the platform.
1919

20-
![Visual Studio Code runs on Mac, Linux and Windows](images/whyvscode/macwinlinux2.png)
20+
![Visual Studio Code runs on macOS, Linux and Windows](images/whyvscode/macwinlinux2.png)
2121

2222
## Edit, build, and debug with ease
2323

docs/extensionAPI/extension-points.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -215,13 +215,13 @@ Contribute a key binding rule defining what command should be invoked when the u
215215

216216
Contributing a key binding will cause the Default Keyboard Shortcuts to display your rule, and every UI representation of the command will now show the key binding you have added. And, of course, when the user presses the key combination the command will be invoked.
217217

218-
>**Note:** Because VS Code runs on Windows, Mac and Linux, where modifiers differ, you can use "key" to set the default key combination and overwrite it with a specific platform.
218+
>**Note:** Because VS Code runs on Windows, macOS and Linux, where modifiers differ, you can use "key" to set the default key combination and overwrite it with a specific platform.
219219
220220
>**Note:** When a command is invoked (from a key binding or from the Command Palette), VS Code will emit an activationEvent `onCommand:${command}`.
221221
222222
### Example
223223

224-
Defining that `kbstyle(Ctrl+F1)` under Windows and Linux and `kbstyle(Cmd+F1)` under Mac trigger the `"extension.sayHello"` command:
224+
Defining that `kbstyle(Ctrl+F1)` under Windows and Linux and `kbstyle(Cmd+F1)` under macOS trigger the `"extension.sayHello"` command:
225225

226226
```json
227227
"contributes": {

docs/extensionAPI/patterns-and-principles.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Events in the VS Code API are exposed as functions which you call with a listene
8383

8484
```javascript
8585
var listener = function(event) {
86-
console.log("It happened", event);
86+
console.log("It happened", event);
8787
};
8888

8989
// start listening
@@ -124,11 +124,8 @@ You can create a `.vscodeignore` file to exclude some files from being included
124124

125125
**Q: Can I use native Node.js modules with my extension?**
126126

127-
**A:** A Visual Studio Code extension package contains all of its dependencies. This means that if you develop your extension on Windows and depend on a native Node.js module when you publish that extension, the Windows compiled native dependency will be contained in your extension. Users on Mac or Linux won't be able to use the extension.
127+
**A:** A Visual Studio Code extension package contains all of its dependencies. This means that if you develop your extension on Windows and depend on a native Node.js module when you publish that extension, the Windows compiled native dependency will be contained in your extension. Users on macOS or Linux won't be able to use the extension.
128128

129-
The only way to make this work for now is to include binaries for all four platforms of VS Code (Windows x86 and x64, Linux, Mac) in your extension and have code that dynamically loads the right one.
129+
The only way to make this work for now is to include binaries for all four platforms of VS Code (Windows x86 and x64, Linux, macOS) in your extension and have code that dynamically loads the right one.
130130

131131
We don't recommend extensions use native `npm` modules as native modules bundled with an extension must be recompiled with every new version of VS Code against the same Node.js version that VS Code ships with. You can find the Node.js and module versions by running `process.versions` from the developer tools console (**Help** > **Toggle Developer Tools**).
132-
133-
134-

docs/extensions/developing-extensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ compilation. When the compilation is complete with no errors, you must reload th
8080
your changes. You have two options to do this:
8181

8282
* Click on the Debug view **Restart** action to relaunch the **Extension Development Host** window.
83-
* Press `kbstyle(Ctrl+R)` (Mac: `kbstyle(Cmd+R)`) in the Extension Development Host window.
83+
* Press `kbstyle(Ctrl+R)` (macOS: `kbstyle(Cmd+R)`) in the Extension Development Host window.
8484

8585
## Profiling your extension
8686

docs/extensions/example-hello-world.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Create a file (**File** > **New File**), type some text and select it. When you
247247
So far, the extension you have written only runs in a special instance of VS Code, the Extension Development instance. To get your extension running in all instances of VS Code, you need to copy it to a new folder under your local extensions folder:
248248

249249
* Windows: `%USERPROFILE%\.vscode\extensions`
250-
* Mac/Linux: `$HOME/.vscode/extensions`
250+
* macOS/Linux: `$HOME/.vscode/extensions`
251251

252252
## Publishing your extension
253253

docs/extensions/example-word-count.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ code .
4949

5050
Before we go on, we can run the extension to make sure everything works as expected by pressing `kb(workbench.action.debug.start)`. As you saw in the previous "Hello World" walkthrough, VS Code opens another window (the **[Extension Development Host]** window) in which your extension will be loaded. You should find the "Hello World" command in the Command Palette (press `kb(workbench.action.showCommands)`) and when you select it, you will see an information box at the top of the window saying "Hello World".
5151

52-
Now that you have confirmed that the extension is running properly, you can keep the extension development window open if you like. To test out any changes that you make to your extension, you can either press `kb(workbench.action.debug.continue)` again in the development window or reload the extension development window by pressing `kbstyle(Ctrl+R)` (Mac: `kbstyle(Cmd+R)`).
52+
Now that you have confirmed that the extension is running properly, you can keep the extension development window open if you like. To test out any changes that you make to your extension, you can either press `kb(workbench.action.debug.continue)` again in the development window or reload the extension development window by pressing `kbstyle(Ctrl+R)` (macOS: `kbstyle(Cmd+R)`).
5353

5454
## Update the Status Bar
5555

docs/extensions/testing-extensions.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,7 @@ script:
120120
- npm test --silent
121121
```
122122

123-
The script above will run the tests on both Linux and Mac. Note that in order to run the tests on Linux, you need to have
124-
a `before_install` configuration as above to enable Linux to start VS Code from the build.
123+
The script above will run the tests on both Linux and macOS. Note that in order to run the tests on Linux, you need to have a `before_install` configuration as above to enable Linux to start VS Code from the build.
125124

126125
There are some optional environment variables to configure the test runner:
127126

docs/extensions/themes-snippets-colorizers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ If you want to share user snippets, you'll need to package your snippet json fil
313313
Depending on your platform, your user snippets file is located here:
314314
315315
- **Windows** `%APPDATA%\Code\User\snippets\(language).json`
316-
- **Mac** `$HOME/Library/Application Support/Code/User/snippets/(language).json`
316+
- **macOS** `$HOME/Library/Application Support/Code/User/snippets/(language).json`
317317
- **Linux** `$HOME/.config/Code/User/snippets/(language).json`
318318
319319
where `(language).json` depends on the targeted language of the snippets (e.g. `markdown.json` for Markdown snippets). Create a new folder for your extension and copy your snippet file to a `snippets` subdirectory.

docs/extensions/yocode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Once created, open VS Code on the created folder and run the extension to test t
105105
To load an extension, you need to copy the files to your VS Code extensions folder `.vscode/extensions`. Depending on your platform, it is located in the following folders:
106106

107107
* **Windows** `%USERPROFILE%\.vscode\extensions`
108-
* **Mac** `~/.vscode/extensions`
108+
* **macOS** `~/.vscode/extensions`
109109
* **Linux** `~/.vscode/extensions`
110110

111111
If you want to load your extension each time VS Code runs, copy your project ('side loading') to a new folder under `.vscode/extensions`. For example: `~/.vscode/extensions/myextension`.

docs/getstarted/keybindings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Visual Studio Code lets you perform most tasks directly from the keyboard. This
1616
1717
## Keyboard Shortcuts Editor
1818

19-
Visual Studio Code provides a rich and easy keyboard shortcuts editing experience using **Keyboard Shortcuts** editor. It lists all available commands with and without keybindings and you can easily change / remove / reset their keybindings using the available actions. It also has a search box on the top that helps you in finding commands or keybindings. You can open this editor by going to the menu under **File** > **Preferences** > **Keyboard Shortcuts**. (**Code** > **Preferences** > **Keyboard Shortcuts** on Mac)
19+
Visual Studio Code provides a rich and easy keyboard shortcuts editing experience using **Keyboard Shortcuts** editor. It lists all available commands with and without keybindings and you can easily change / remove / reset their keybindings using the available actions. It also has a search box on the top that helps you in finding commands or keybindings. You can open this editor by going to the menu under **File** > **Preferences** > **Keyboard Shortcuts**. (**Code** > **Preferences** > **Keyboard Shortcuts** on macOS)
2020

2121
![Keyboard Shortcuts](images/keybinding/keyboard-shortcuts.gif)
2222

@@ -110,7 +110,7 @@ The following modifiers are accepted:
110110

111111
Platform|Modifiers
112112
--|---------
113-
Mac|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(cmd+)`
113+
macOS|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(cmd+)`
114114
Windows|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(win+)`
115115
Linux|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(meta+)`
116116

docs/getstarted/settings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Below is a [copy of the default settings](/docs/getstarted/settings.md#default-s
6666
Depending on your platform, the user settings file is located here:
6767

6868
* **Windows** `%APPDATA%\Code\User\settings.json`
69-
* **Mac** `$HOME/Library/Application Support/Code/User/settings.json`
69+
* **macOS** `$HOME/Library/Application Support/Code/User/settings.json`
7070
* **Linux** `$HOME/.config/Code/User/settings.json`
7171

7272
The workspace setting file is located under the `.vscode` folder in your root folder.
@@ -1558,7 +1558,7 @@ Below are the Visual Studio Code default settings and their values. You can also
15581558

15591559
**Q: VS Code says "Unable to write settings."**
15601560

1561-
**A:** If you try to change a setting (for example turning on Auto Save or selecting a new Color Theme) and you see "Unable to write settings. Please open User Settings to correct errors/warnings in the file and try again.", it means your `settings.json` file is ill-formed or has errors. The errors can be as simple as a missing comma or setting value. Open the Settings editor **File** > **Preferences** > **Settings** (**Code** > **Preferences** > **Settings** on Mac) (`kb(workbench.action.openGlobalSettings)`) and you should see the error highlighted with red squiggles.
1561+
**A:** If you try to change a setting (for example turning on Auto Save or selecting a new Color Theme) and you see "Unable to write settings. Please open User Settings to correct errors/warnings in the file and try again.", it means your `settings.json` file is ill-formed or has errors. The errors can be as simple as a missing comma or setting value. Open the Settings editor **File** > **Preferences** > **Settings** (**Code** > **Preferences** > **Settings** on macOS) (`kb(workbench.action.openGlobalSettings)`) and you should see the error highlighted with red squiggles.
15621562

15631563
**Q: When does it make sense to use workspace settings?**
15641564

docs/getstarted/themes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The current color theme is configured in the [settings](/docs/getstarted/setting
2525

2626
However, there is no need to edit the settings directly. It's easier to use the Color Theme Picker to preview and select a theme.
2727

28-
1. Open the Color Theme picker with **File** > **Preferences** > **Color Theme**. (**Code** > **Preferences** > **Color Theme** on Mac)
28+
1. Open the Color Theme picker with **File** > **Preferences** > **Color Theme**. (**Code** > **Preferences** > **Color Theme** on macOS)
2929
2. Use the cursor keys to preview the colors of the theme.
3030
3. Select the theme you want and hit `kbstyle(Enter)`.
3131

@@ -108,7 +108,7 @@ The current File Icon theme is persisted in your user [settings](/docs/getstarte
108108

109109
There is no need to edit the `settings.json` file directly. It is better to use the File Icon Theme picker to preview and select a theme.
110110

111-
1. Open the Icon Theme picker with **File** > **Preferences** > **File Icon Theme**. (**Code** > **Preferences** > **File Icon Theme** on Mac)
111+
1. Open the Icon Theme picker with **File** > **Preferences** > **File Icon Theme**. (**Code** > **Preferences** > **File Icon Theme** on macOS)
112112
2. Use the cursor keys to preview the icons of the theme.
113113
3. Select the theme you want and hit `kbstyle(Enter)`.
114114

0 commit comments

Comments
 (0)