Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add vsix testing section to readme #51

Merged
merged 9 commits into from
Jun 16, 2022
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ npm i
npm run install-extension
```

## Test your changes on your local install of VS Code

Firstly, uninstall the official release of the extension and reload VS Code if you have it installed. You will need to do this step each time you want to re-install and test your local version.

```sh
cd sway-vscode-plugin
npm i
git checkout <branch>
vsce package # Generates a .vsix file, the version will be included in the file name
eureka-cpu marked this conversation as resolved.
Show resolved Hide resolved
code --install-extension sway-vscode-extension-$VERSION.vsix
```

## Testing in Debug mode

- In order to start the Debug mode, open `vscode-plugin` in Visual Studio Code, make sure that it is opened as root/main workspace - in order to avoid any problems.
Expand All @@ -32,4 +44,4 @@ npm run install-extension

- Install this extension -> [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)
- Repeat the steps outlined in "Testing in Debug mode", then go back `Run and Debug` Tab, from the dropdown menu
choose "Sway Server" which will attach the server in the debug mode as well.
choose "Sway Server" which will attach the server in the debug mode as well.