Skip to content

Commit

Permalink
Merge pull request #1 from microsoft/master
Browse files Browse the repository at this point in the history
Merge from master
  • Loading branch information
bwateratmsft authored Mar 27, 2020
2 parents 19f3a15 + 49f70be commit fe5dbc5
Show file tree
Hide file tree
Showing 330 changed files with 5,676 additions and 2,681 deletions.
2 changes: 1 addition & 1 deletion api/advanced-topics/extension-host.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code.
Expand Down
10 changes: 5 additions & 5 deletions api/advanced-topics/remote-extensions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide to adding Visual Studio Code Remote Development and Visual Studio Online support to extensions
Expand Down Expand Up @@ -51,7 +51,7 @@ Follow these steps:

5. While VS Online's cloud-based environments should have all the needed prerequisites for most extensions, you can install any other required dependencies (for example using `yarn install` or `apt-get`) in a new VS Code terminal window (`kb(workbench.action.terminal.new)`).

6. Finally, press `kb(workbench.action.debug.start)` or use the **Debug view** to launch the extension inside in the Visual Studio Online environment.
6. Finally, press `kb(workbench.action.debug.start)` or use the **Run view** to launch the extension inside in the Visual Studio Online environment.

> **Note:** You will not be able to open the extension source code folder in the window that appears, but you can open a sub-folder or somewhere else in the environment.
Expand All @@ -75,7 +75,7 @@ Follow these steps:

5. Run `yarn install` or `npm install` in a new VS Code terminal window (`kb(workbench.action.terminal.new)`) to ensure the Linux versions Node.js native dependencies are install. You can also install other OS or runtime dependencies, but you may want to add these to `.devcontainer/Dockerfile` as well so they are available if you rebuild the container.

6. Finally, press `kb(workbench.action.debug.start)` or use the **Debug view** to launch the extension inside this same container and attach the debugger.
6. Finally, press `kb(workbench.action.debug.start)` or use the **Run view** to launch the extension inside this same container and attach the debugger.

> **Note:** You will not be able to open the extension source code folder in the window that appears, but you can open a sub-folder or somewhere else in the container.
Expand All @@ -91,7 +91,7 @@ Follow steps:

3. Install any required dependencies that might be missing (for example using `yarn install` or `apt-get`) in a new VS Code terminal window (`kb(workbench.action.terminal.new)`).

4. Finally, press `kb(workbench.action.debug.start)` or use the **Debug view** to launch the extension inside on the remote host and attach the debugger.
4. Finally, press `kb(workbench.action.debug.start)` or use the **Run view** to launch the extension inside on the remote host and attach the debugger.

> **Note:** You will not be able to open the extension source code folder in the window that appears, but you can open a sub-folder or somewhere else on the SSH host.
Expand All @@ -109,7 +109,7 @@ Follow these steps:
3. Install any required dependencies that might be missing (for example using `apt-get`) in a new VS Code terminal window (`kb(workbench.action.terminal.new)`). You will at least want to run `yarn install` or `npm install` to ensure Linux versions of native Node.js dependencies are available.

4. Finally, press `kb(workbench.action.debug.start)` or use the **Debug view** to launch the extension and attach the debugger as you would locally.
4. Finally, press `kb(workbench.action.debug.start)` or use the **Run view** to launch the extension and attach the debugger as you would locally.

> **Note:** You will not be able to open the extension source code folder in the window that appears, but you can open a sub-folder or somewhere else in WSL.
Expand Down
10 changes: 5 additions & 5 deletions api/advanced-topics/tslint-eslint-migration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide to migrating extension projects from the TSLint linter to ESLint.
Expand All @@ -19,13 +19,13 @@ npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslin

The command above adds ESLint, adds a parser that makes ESLint understand TypeScript, and adds some TypeScript-specific rules.

Now, to make the actual migration simpler, install the [tslint-to-eslint-config](https://github.com/typescript-eslint/tslint-to-eslint-config) utility. This tool will take your TSLint configuration and create the "closest" ESLint configuration from it.
Now, to make the actual migration simpler, run the [tslint-to-eslint-config](https://github.com/typescript-eslint/tslint-to-eslint-config) utility. This tool will take your TSLint configuration and create the "closest" ESLint configuration from it.

```bash
npx tslint-to-eslint-config
```

The first line installs the utility, the second runs the migration. For further options, check the utility's [usage guide](https://github.com/typescript-eslint/tslint-to-eslint-config#usage).
This command [downloads and executes](https://www.npmjs.com/package/npx) the utility to perform the migration. For further options, check the utility's [usage guide](https://github.com/typescript-eslint/tslint-to-eslint-config#usage).

There should now be a new `.eslintrc.js` file, a log file (`tslint-to-eslint-config.log`), and likely changes to other files, like `.vscode/settings.json`. Carefully review the changes, especially those made to existing files, and check the log file.

Expand All @@ -46,14 +46,14 @@ It is time to lint! Use this command: `eslint -c .eslintrc.js --ext .ts <mySrcFo
To integrate ESLint with Visual Studio Code, do the following:

* Install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
* Create a task via the **Tasks: Configure Task** command and select **npm**.
* Create a task via the **Tasks: Configure Task** command and select **npm: lint**.
* In the resulting `tasks.json` file, configure the problem matcher to be `$eslint-stylish`.

**Hint**: ESLint is sometimes "more correct" in how it does things and you may see warnings that you didn't have before, for example calling out missing semicolons. Try the `--fix` option to let ESLint clean up things up for you.

## TSLint: Removal

Congratulations. You should now have a working ESLint setup and it's time to clean up.
Congratulations. You should now have a working ESLint setup and it's time to clean up.

The removal of TSLint depends on your project, but usually these are the steps:

Expand Down
2 changes: 1 addition & 1 deletion api/advanced-topics/using-proposed-api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Use Visual Studio Code's Proposed API
Expand Down
2 changes: 1 addition & 1 deletion api/extension-capabilities/common-capabilities.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
Expand Down
2 changes: 1 addition & 1 deletion api/extension-capabilities/extending-workbench.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Explain how to extend Visual Studio Code's workbench area with custom UI components
Expand Down
2 changes: 1 addition & 1 deletion api/extension-capabilities/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn the details of what's possible with Visual Studio Code's rich extension (plug-in) API.
Expand Down
2 changes: 1 addition & 1 deletion api/extension-capabilities/theming.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn how to add custom themes for colors and icons in Visual Studio Code.
Expand Down
4 changes: 2 additions & 2 deletions api/extension-guides/color-theme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 113b458a-3692-4ccf-a181-048bd572a120
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide to creating Color Theme in Visual Studio Code
Expand Down Expand Up @@ -103,7 +103,7 @@ Changes to the theme file are applied live in the `Extension Development Host` w

If you'd like to share your new theme with the community, you can publish it to the [Extension Marketplace](/docs/editor/extension-gallery). Use the [vsce publishing tool](/api/working-with-extensions/publishing-extension) to package your theme and publish it to the VS Code Marketplace.

> **Tip:** To make it easy for users to find your theme, include the word "theme" in the extension description and set the `Category` to `Theme` in your `package.json`.
> **Tip:** To make it easy for users to find your theme, include the word "theme" in the extension description and set the `Category` to `Themes` in your `package.json`.
We also have recommendations on how to make your extension look great on the VS Code Marketplace, see [Marketplace Presentation Tips](/api/references/extension-manifest#marketplace-presentation-tips).

Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/command.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 995c7085-5fc0-44e0-a171-30a759c0b7da
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide to using commands programmatically in Visual Studio Code extensions (plug-ins)
Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/custom-data-extension.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: d40b8849-6a4e-428c-b463-c8d61f18136f
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn how to extend Visual Studio Code's HTML and CSS language support.
Expand Down
6 changes: 3 additions & 3 deletions api/extension-guides/debugger-extension.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 49EF49AD-8BE6-4D46-ADC8-D678BDC04E85
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn how to provide debugger extensions (plug-ins) for Visual Studio Code through a Debug Adapter.
Expand Down Expand Up @@ -82,7 +82,7 @@ To try Mock Debug:

- Create a new empty folder `mock test` and open it in VS Code.
- Create a file `readme.md` and enter several lines of arbitrary text.
- Switch to the Debug view and press the gear icon.
- Switch to the Run view and press the gear icon.
- VS Code will let you select an "environment" in order to create a default launch configuration. Pick "Mock Debug".
- Press the green Start button and then Enter to confirm the suggested file `readme.md`.

Expand Down Expand Up @@ -298,7 +298,7 @@ Since VS Code runs on different platforms, we have to make sure that the DA prog

**configurationAttributes** declares the schema for the `launch.json` attributes that are available for this debugger. This schema is used for validating the `launch.json` and supporting IntelliSense and hover help when editing the launch configuration.

The **initialConfigurations** define the initial content of the default `launch.json` for this debugger. This information is used when a project does not have a `launch.json` and a user starts a debug session or clicks on the gear icon in the debug viewlet. In this case VS Code lets the user pick a debug environment and then creates the corresponding `launch.json`:
The **initialConfigurations** define the initial content of the default `launch.json` for this debugger. This information is used when a project does not have a `launch.json` and a user starts a debug session or clicks on the gear icon in the Run view. In this case VS Code lets the user pick a debug environment and then creates the corresponding `launch.json`:

![Debugger Quickpick](images/debugger-extension/debug-init-config.png)

Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/icon-theme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: f470466d-89b0-4115-ab7a-2448023b0a6d
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide to creating Icon Theme in Visual Studio Code
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions api/extension-guides/images/tree-view/view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion api/extension-guides/markdown-extension.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 1664249a-ba7a-4a53-b3f0-9d757cff7d27
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn how to extend Visual Studio Code's built-in Markdown preview.
Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: B32601A8-27ED-4D97-BA83-F1C8C945C635
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn from Visual Studio Code extension guides and code samples
Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/scm-provider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 79996489-8D16-4C0A-8BE8-FF4B1E9C223A
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: A guide illustrating how to use Source Control API.
Expand Down
2 changes: 1 addition & 1 deletion api/extension-guides/task-provider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# DO NOT TOUCH — Managed by doc writer
ContentId: 49744351-83ef-4ef6-99e7-2485e6e9c79f
DateApproved: 2/5/2020
DateApproved: 3/9/2020

# Summarize the whole topic in less than 300 characters for SEO purpose
MetaDescription: Learn how to contribute tasks to Visual Studio Code through an extension (plug-in).
Expand Down
Loading

0 comments on commit fe5dbc5

Please sign in to comment.