git.iko.soy/vs-code-ormolu
on 4ca3282 help sign in
vs-code-ormolu/vsc-extension-quickstart.md
42 lines 2.6 kB history raw
1# Welcome to your VS Code Extension
3## What's in the folder
5* This folder contains all of the files necessary for your extension.
6* `package.json` - this is the manifest file in which you declare your extension and command.
7 * The sample plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
8* `src/extension.ts` - this is the main file where you will provide the implementation of your command.
9 * The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
10 * We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
12## Get up and running straight away
14* Press `F5` to open a new window with your extension loaded.
15* Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
16* Set breakpoints in your code inside `src/extension.ts` to debug your extension.
17* Find output from your extension in the debug console.
19## Make changes
21* You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
22* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
25## Explore the API
27* You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`.
29## Run tests
31* Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
32* Press `F5` to run the tests in a new window with your extension loaded.
33* See the output of the test result in the debug console.
34* Make changes to `src/test/suite/extension.test.ts` or create new test files inside the `test/suite` folder.
35 * The provided test runner will only consider files matching the name pattern `**.test.ts`.
36 * You can create folders inside the `test` folder to structure your tests any way you want.
38## Go further
40 * Reduce the extension size and improve the startup time by [bundling your extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
41 * [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VSCode extension marketplace.
42 * Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).