vsc-extension-quickstart.md

Tue, 12 May 2020 09:25:23 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Tue, 12 May 2020 09:25:23 -0500
changeset 1
6c4986d204ac
parent 0
aa9fc390ce91
permissions
-rw-r--r--

README improvements

0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
1 # Welcome to your VS Code Extension
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
2
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
3 ## What's in the folder
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
4
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
5 * This folder contains all of the files necessary for your extension.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
6 * `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.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
7 * `syntaxes/latex.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
8 * `language-configuration.json` - this is the language configuration, defining the tokens that are used for comments and brackets.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
9
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
10 ## Get up and running straight away
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
11
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
12 * Make sure the language configuration settings in `language-configuration.json` are accurate.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
13 * Press `F5` to open a new window with your extension loaded.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
14 * Create a new file with a file name suffix matching your language.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
15 * Verify that syntax highlighting works and that the language configuration settings are working.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
16
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
17 ## Make changes
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
18
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
19 * You can relaunch the extension from the debug toolbar after making changes to the files listed above.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
20 * You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
21
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
22 ## Add more language features
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
23
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
24 * To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at https://code.visualstudio.com/docs
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
25
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
26 ## Install your extension
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
27
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
28 * To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
29 * To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.

mercurial