Skip to content

Commit d7d1b82

Browse files
committed
Add notes on testing the link
1 parent 96b8229 commit d7d1b82

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,28 @@ The `vscodessh` subcommand on the `coder` binary periodically flushes it's netwo
3131

3232
Coder Remote periodically reads the `network-info-dir + "/" + matchingSSHPID` file to display network information.
3333

34+
## Testing
35+
36+
There are a few ways you can test the "Open in VS Code" flow:
37+
38+
- Use the "VS Code Desktop" button from a Coder dashboard.
39+
- Manually open the link with `Developer: Open URL` from inside VS Code.
40+
- Use `code --open-url <link>` on the command line.
41+
42+
The link format is `vscode://coder.coder-remote/open?${query}`. For example:
43+
44+
```bash
45+
code --open-url 'vscode://coder.coder-remote/open?url=dev.coder.com&owner=my-username&workspace=my-ws&agent=my-agent'
46+
```
47+
48+
There are some unit tests as well:
49+
50+
```bash
51+
yarn test
52+
```
53+
54+
However, fully testing the plugin is blocked on switching back to the standard VS Code extension testing framework.
55+
3456
## Development
3557

3658
1. Run `yarn watch` in the background.

0 commit comments

Comments
 (0)