-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create DEVELOPING.md file for extension development information
The README.md in the root of the extension is used for the readme of the extension when it is packaged. So we have removed the development information to another DEVELOPING.md file and reference it inside the extensions readme. NDISC-0000
- Loading branch information
Showing
2 changed files
with
54 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
## Running the Extension | ||
|
||
To run and debug the extension directly within VS Code, follow these steps: | ||
|
||
1. **Open the Extension Directory**: Make sure that the vscode-extension directory is open in Visual Studio Code and set as the root of the workspace. | ||
|
||
2. **Start the Extension**: | ||
|
||
- Press 'F5' to launch a new Extension Development Host instance of VS Code with your extension loaded. | ||
- Alternatively, you can go to the "Run and Debug" sidebar and click the green play button to start the extension. | ||
|
||
## Testing | ||
|
||
The extension uses Mocha for testing | ||
|
||
To run the tests: | ||
|
||
```bash | ||
npm run test | ||
``` | ||
|
||
To Gather coverage: | ||
|
||
```bash | ||
npm run coverage | ||
``` | ||
|
||
## Style (linting & formatting) | ||
|
||
Linting is done via [ESLint](https://eslint.org/docs/user-guide/getting-started); consistent formatting for a variety of source code files is being enforced using [Prettier](https://prettier.io/docs/en/index.html). ESLint and Prettier work in conjunction. | ||
|
||
Check style: | ||
|
||
```bash | ||
npm run style:check | ||
``` | ||
|
||
Autofix issues: | ||
|
||
```bash | ||
npm run style:fix | ||
``` | ||
|
||
## Packaging the extension | ||
|
||
The extension is packaged and stored as an artifakt on our github repo but should you want to package the extension manually you can run: | ||
|
||
```bash | ||
npm run vscode:pack | ||
``` | ||
|
||
This will create a `.vsix` file within the vscode-extension project folder. That is the extension. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters