Skip to content

Commit

Permalink
Consistency for macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
Greg Van Liew committed Apr 13, 2018
1 parent db44942 commit 2fab610
Show file tree
Hide file tree
Showing 37 changed files with 65 additions and 66 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ When you link to an image, the path and filename are case-sensitive. The conven
### Key bindings

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

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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you are looking for the VS Code product GitHub repository, you can find it [h

## Visual Studio Code

[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.
[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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ VS Code has some known accessibility issues depending on the platform.

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).

### Mac
### macOS

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

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/codebasics.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Place the cursor in one corner and then hold `kbstyle(Shift+Alt)` while dragging

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

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

Key|Command|Command id
---|-------|----------
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ To write your own debugger extension, visit:

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

**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.
**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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/extension-gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Once you've downloaded an extension, you can side load it by renaming the `.zip`
**A**: Extensions are installed in your extensions folders. Depending on your platform, the global location is in the following folders:

* **Windows** `%USERPROFILE%\.vscode\extensions`
* **Mac** `~/.vscode/extensions`
* **macOS** `~/.vscode/extensions`
* **Linux** `~/.vscode/extensions`

**Q: Can VS Code read TextMate bundles directly?**
Expand Down
4 changes: 2 additions & 2 deletions docs/editor/integrated-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,13 @@ This can be configured using the `terminal.integrated.rightClickBehavior` settin

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

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:
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:

```js
// Windows/Linux
{ "key": "ctrl+f", "command": "-workbench.action.terminal.focusFindWidget",
"when": "terminalFocus" },
// Mac
// macOS
{ "key": "cmd+f", "command": "-workbench.action.terminal.focusFindWidget",
"when": "terminalFocus" },
```
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/tasks-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ interface TaskConfiguration extends BaseTaskConfiguration {
windows?: BaseTaskConfiguration;

/**
* Mac specific task configuration
* macOS specific task configuration
*/
osx?: BaseTaskConfiguration;

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/tasks-v1-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ interface TaskConfiguration extends BaseTaskConfiguration {
windows?: BaseTaskConfiguration;

/**
* Mac specific task configuration
* macOS specific task configuration
*/
osx?: BaseTaskConfiguration;

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/tasks-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Below is an example that uses the Node.js executable as a command and is treated
}
```

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.
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.

In the example below:

Expand Down
2 changes: 1 addition & 1 deletion docs/editor/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ If you only need to tweak it for a specific task then add the OS specific comman
}
```

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.
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.

## Examples of tasks in action

Expand Down
4 changes: 2 additions & 2 deletions docs/editor/versioncontrol.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If there is no upstream branch configured and the Git repository has remotes set

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

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.
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.

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.

Expand Down Expand Up @@ -141,7 +141,7 @@ Here are the steps to do so:

1. Make sure you can run `code --help` from the command line and you get help.
* if you do not see help, please follow these steps:
* Mac: Select **Shell Command: Install 'Code' command in path** from the **Command Palette**.
* macOS: Select **Shell Command: Install 'Code' command in path** from the **Command Palette**.
* Windows: Make sure you selected **Add to PATH** during the installation.
* Linux: Make sure you installed Code via our new .deb or .rpm packages.
2. From the command line, run `git config --global core.editor "code --wait"`
Expand Down
2 changes: 1 addition & 1 deletion docs/editor/whyvscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ First and foremost, it is an editor that gets out of your way. The delightfully

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

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

## Edit, build, and debug with ease

Expand Down
4 changes: 2 additions & 2 deletions docs/extensionAPI/extension-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,13 @@ Contribute a key binding rule defining what command should be invoked when the u

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.

>**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.
>**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.
>**Note:** When a command is invoked (from a key binding or from the Command Palette), VS Code will emit an activationEvent `onCommand:${command}`.
### Example

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

```json
"contributes": {
Expand Down
9 changes: 3 additions & 6 deletions docs/extensionAPI/patterns-and-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Events in the VS Code API are exposed as functions which you call with a listene

```javascript
var listener = function(event) {
console.log("It happened", event);
console.log("It happened", event);
};

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

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

**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.
**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.

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.
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.

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**).



2 changes: 1 addition & 1 deletion docs/extensions/developing-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ compilation. When the compilation is complete with no errors, you must reload th
your changes. You have two options to do this:

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

## Profiling your extension

Expand Down
2 changes: 1 addition & 1 deletion docs/extensions/example-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ Create a file (**File** > **New File**), type some text and select it. When you
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:

* Windows: `%USERPROFILE%\.vscode\extensions`
* Mac/Linux: `$HOME/.vscode/extensions`
* macOS/Linux: `$HOME/.vscode/extensions`

## Publishing your extension

Expand Down
2 changes: 1 addition & 1 deletion docs/extensions/example-word-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ code .

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".

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)`).
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)`).

## Update the Status Bar

Expand Down
3 changes: 1 addition & 2 deletions docs/extensions/testing-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,7 @@ script:
- npm test --silent
```

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
a `before_install` configuration as above to enable Linux to start VS Code from the build.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/extensions/themes-snippets-colorizers.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ If you want to share user snippets, you'll need to package your snippet json fil
Depending on your platform, your user snippets file is located here:
- **Windows** `%APPDATA%\Code\User\snippets\(language).json`
- **Mac** `$HOME/Library/Application Support/Code/User/snippets/(language).json`
- **macOS** `$HOME/Library/Application Support/Code/User/snippets/(language).json`
- **Linux** `$HOME/.config/Code/User/snippets/(language).json`
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/extensions/yocode.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Once created, open VS Code on the created folder and run the extension to test t
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:

* **Windows** `%USERPROFILE%\.vscode\extensions`
* **Mac** `~/.vscode/extensions`
* **macOS** `~/.vscode/extensions`
* **Linux** `~/.vscode/extensions`

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`.
Expand Down
4 changes: 2 additions & 2 deletions docs/getstarted/keybindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Visual Studio Code lets you perform most tasks directly from the keyboard. This
## Keyboard Shortcuts Editor

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)
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)

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

Expand Down Expand Up @@ -110,7 +110,7 @@ The following modifiers are accepted:

Platform|Modifiers
--|---------
Mac|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(cmd+)`
macOS|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(cmd+)`
Windows|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(win+)`
Linux|`kbstyle(ctrl+)`, `kbstyle(shift+)`, `kbstyle(alt+)`, `kbstyle(meta+)`

Expand Down
4 changes: 2 additions & 2 deletions docs/getstarted/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Below is a [copy of the default settings](/docs/getstarted/settings.md#default-s
Depending on your platform, the user settings file is located here:

* **Windows** `%APPDATA%\Code\User\settings.json`
* **Mac** `$HOME/Library/Application Support/Code/User/settings.json`
* **macOS** `$HOME/Library/Application Support/Code/User/settings.json`
* **Linux** `$HOME/.config/Code/User/settings.json`

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

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

**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.
**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.

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

Expand Down
4 changes: 2 additions & 2 deletions docs/getstarted/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The current color theme is configured in the [settings](/docs/getstarted/setting

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.

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

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

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.

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

Expand Down
Loading

0 comments on commit 2fab610

Please sign in to comment.