huncholaneA simpler way to view django projects
| 1 | # Welcome to your VS Code Extension |
| 2 | |
| 3 | ## What's in the folder |
| 4 | |
| 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`. |
| 11 | |
| 12 | ## Get up and running straight away |
| 13 | |
| 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. |
| 18 | |
| 19 | ## Make changes |
| 20 | |
| 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. |
| 23 | |
| 24 | ## Explore the API |
| 25 | |
| 26 | * You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`. |
| 27 | |
| 28 | ## Run tests |
| 29 | |
| 30 | * Install the [Extension Test Runner](https://marketplace.visualstudio.com/items?itemName=ms-vscode.extension-test-runner) |
| 31 | * Run the "watch" task via the **Tasks: Run Task** command. Make sure this is running, or tests might not be discovered. |
| 32 | * Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey `Ctrl/Cmd + ; A` |
| 33 | * See the output of the test result in the Test Results view. |
| 34 | * Make changes to `src/test/extension.test.ts` or create new test files inside the `test` 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. |
| 37 | |
| 38 | ## Go further |
| 39 | |
| 40 | * [Follow UX guidelines](https://code.visualstudio.com/api/ux-guidelines/overview) to create extensions that seamlessly integrate with VS Code's native interface and patterns. |
| 41 | * Reduce the extension size and improve the startup time by [bundling your extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension). |
| 42 | * [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace. |
| 43 | * Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration). |