Skip to content

Commit 21ff762

Browse files
author
Greg Van Liew
committed
Small edits to api get-started
1 parent 096308d commit 21ff762

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

api/get-started/extension-anatomy.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
---
33

4-
# Extension Anatomy
4+
# Visual Studio Code Extension Anatomy
55

6-
In the last topic, we were able to get a basic extension running. How does it work under the hood?
6+
In the last topic, you were able to get a basic Visual Studio Code extension running. How does it work under the hood?
77

88
The `Hello Code` extension does 3 things:
99

1010
- Registers the [`onCommand`](/api/references/activation-events#activationEvents.onCommand) [**Activation Event**](/api/references/activation-events): `onCommand:extension.helloCode`, so the extension becomes activated when user runs the `Hello Code` command.
11-
- Uses the [`contributes.commands`](/api/references/contribution-points#contributes.commands) [**Contribution Point**](/api/references/contribution-points) to make the command `Hello Code` available in the command palette, and bind it to a command ID `extension.helloCode`.
11+
- Uses the [`contributes.commands`](/api/references/contribution-points#contributes.commands) [**Contribution Point**](/api/references/contribution-points) to make the command `Hello Code` available in the Command Palette, and bind it to a command ID `extension.helloCode`.
1212
- Uses the [`commands.registerCommand`](/api/references/vscode-api#commands.registerCommand) [**VS Code API**](/api/references/vscode-api) to bind a function to the registered command ID `extension.helloCode`.
1313

1414
Understanding these three concepts is crucial to writing VS Code Extensions:
@@ -36,11 +36,11 @@ Let's take a closer look of `Hello Code` sample's source code and see how these
3636
├── tsconfig.json // TypeScript configuration
3737
```
3838

39-
You can read more about the config files:
39+
You can read more about the configuration files:
4040

41-
- `launch.json`: https://code.visualstudio.com/Docs/editor/debugging
42-
- `tasks.json`: https://code.visualstudio.com/Docs/editor/tasks
43-
- `tsconfig.json`: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
41+
- `launch.json` used to configure VS Code [Debugging](/docs/editor/debugging.md)
42+
- `tasks.json` for defining VS Code [Tasks](/docs/editor/tasks.md)
43+
- `tsconfig.json` consult the TypeScript [Handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)
4444

4545
However, let's focus on `package.json` and `extensions.ts`, which are essential to understanding the `Hello Code` extension.
4646

api/get-started/your-first-extension.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
---
33

4-
# Your First Extension
4+
# Your First Visual Studio Code Extension
55

6-
In this section, we'll teach you fundamental concepts for building VS Code extensions. Make sure you have [Node.js](https://nodejs.org/en/) and [Git](https://git-scm.com/) installed, then install [Yeoman](http://yeoman.io/) and [VS Code Extension Generator](https://www.npmjs.com/package/generator-code) with:
6+
In this topic, we'll teach you the fundamental concepts for building Visual Studio Code extensions. Make sure you have [Node.js](https://nodejs.org/en/) and [Git](https://git-scm.com/) installed, then install [Yeoman](http://yeoman.io/) and [VS Code Extension Generator](https://www.npmjs.com/package/generator-code) with:
77

88
```bash
99
npm install -g yo generator-code
@@ -25,13 +25,13 @@ yo code
2525
code ./hello-code
2626
```
2727

28-
Then, inside the editor, press F5, and run the `Hello Code` command in the new window:
28+
Then, inside the editor, press `kb(workbench.action.debug.start)`, and run the `Hello Code` command from the Command Palette (`kb(workbench.action.showCommands)`) in the new **Extension Development Host** window:
2929

3030
<video autoplay loop muted playsinline controls>
3131
<source src="/api/get-started/your-first-extension/launch.mp4" type="video/mp4">
3232
</video>
3333

34-
You should see the `Hello Code` information dialog showing up. Success!
34+
You should see the `Hello Code` notification showing up. Success!
3535

3636
## Developing the extension
3737

@@ -49,8 +49,8 @@ You should see the updated message showing up.
4949

5050
Here are some ideas for you to try:
5151

52-
- Give `Hello Code` command a new name.
53-
- [Contribute](/api/references/contribution-points) another command `Goodbye Code`
52+
- Give the `Hello Code` command a new name.
53+
- [Contribute](/api/references/contribution-points) another command such as `Goodbye Code`
5454
- Replace the `vscode.window.showInformationMessage` with another [VS Code API](/api/references/vscode-api) call to show a warning message.
5555

5656
## Debugging the extension
@@ -61,7 +61,7 @@ The debugger and debug console allow you stop the program and inspect variables
6161
<source src="/api/get-started/your-first-extension/debug.mp4" type="video/mp4">
6262
</video>
6363

64-
You can learn more about debugging Node apps in VS Code at the [Node.js Debugging Topic](/docs/nodejs/nodejs-debugging).
64+
You can learn more about debugging Node.js apps in VS Code at the [Node.js Debugging Topic](/docs/nodejs/nodejs-debugging).
6565

6666
## Next Steps
6767

@@ -71,4 +71,4 @@ You can find the source code of this tutorial at: https://github.com/Microsoft/v
7171

7272
### Using JavaScript
7373

74-
In this guide, we mainly describe how to develop VS Code extension with TypeScript because we believe TypeScript offers the best experience for developing VS Code extension. However, if you prefer JavaScript, you can still follow along using [hellocode-minimal-sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/hellocode-minimal-sample).
74+
In this guide, we mainly describe how to develop VS Code extension with TypeScript because we believe TypeScript offers the best experience for developing VS Code extensions. However, if you prefer JavaScript, you can still follow along using [hellocode-minimal-sample](https://github.com/Microsoft/vscode-extension-samples/tree/master/hellocode-minimal-sample).

0 commit comments

Comments
 (0)