Update README.md

This commit is contained in:
Joan Rieu
2019-10-31 20:33:10 -04:00
committed by GitHub
parent 51d8bfd132
commit 2a221320d4

View File

@ -1,5 +1,28 @@
# Document Editing Sample
This sample shows
This is an example that shows you how to create a command which makes changes to the document in the active editor.
- How to update document in current active editor through commands.
## Demo
![demo](demo.gif)
## VS Code API
### `vscode` module
- [`commands.registerCommand`](https://code.visualstudio.com/api/references/vscode-api#commands.registerCommand)
- [`window.activeTextEditor`](https://code.visualstudio.com/api/references/vscode-api#window.activeTextEditor)
- [`TextDocument.getText`](https://code.visualstudio.com/api/references/vscode-api#TextDocument.getText)
- [`TextEditor.edit`](https://code.visualstudio.com/api/references/vscode-api#TextEditor.edit)
- [`TextEditorEdit`](https://code.visualstudio.com/api/references/vscode-api#TextEditorEdit)
### Contribution Points
- [`contributes.commands`](https://code.visualstudio.com/api/references/contribution-points#contributes.commands)
## Running the Sample
- Run `npm install` in terminal to install dependencies
- Run the `Run Extension` target in the Debug View. This will:
- Start a task `npm: watch` to compile the code
- Run the extension in a new VS Code window