aqua-vscode/vsc-extension-quickstart.md

34 lines
1.6 KiB
Markdown
Raw Normal View History

2021-05-20 19:05:53 +03:00
# Welcome to your VS Code Extension
## What's in the folder
2022-05-17 15:06:52 +03:00
- This folder contains all of the files necessary for your extension.
- `package.json` - this is the manifest file in which you declare your language support and define the location of the
grammar file that has been copied into your extension.
- `syntaxes/aqua.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization.
- `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and
brackets.
2021-05-20 19:05:53 +03:00
## Get up and running straight away
2022-05-17 15:06:52 +03:00
- Make sure the language configuration settings in `language-configuration.json` are accurate.
- Press `F5` to open a new window with your extension loaded.
- Create a new file with a file name suffix matching your language.
- Verify that syntax highlighting works and that the language configuration settings are working.
2021-05-20 19:05:53 +03:00
## Make changes
2022-05-17 15:06:52 +03:00
- You can relaunch the extension from the debug toolbar after making changes to the files listed above.
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
2021-05-20 19:05:53 +03:00
## Add more language features
2022-05-17 15:06:52 +03:00
- To add features such as intellisense, hovers and validators check out the VS Code extenders documentation
at https://code.visualstudio.com/docs
2021-05-20 19:05:53 +03:00
## Install your extension
2022-05-17 15:06:52 +03:00
- To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and
restart Code.
- To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.