You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -17,81 +17,102 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s
17
17
18
18
### Steps
19
19
20
-
1. Clone [`cursorless`](https://github.com/cursorless-dev/cursorless) locally. Note that it doesn't matter where you clone it, as long as you _**do not**_ clone it into your Talon user directory.
21
-
2. Open the newly created `cursorless` directory in VSCode. If you're on Windows, don't use WSL (see [#919](https://github.com/cursorless-dev/cursorless/issues/919) for discussion / workaround).
22
-
3. Run the following in the terminal:
23
-
24
-
```bash
25
-
pnpm install
26
-
pnpm compile
27
-
```
28
-
29
-
4. Run the following in the terminal:
30
-
31
-
<TabsgroupId="vsx">
32
-
<TabItemvalue="vscode"label="VSCode"default>
33
-
```bash
34
-
code --profile=cursorlessDevelopment
35
-
```
36
-
</TabItem>
37
-
<TabItemvalue="vscodium"label="VSCodium">
38
-
```bash
39
-
codium --profile=cursorlessDevelopment
40
-
```
41
-
</TabItem>
42
-
</Tabs>
43
-
44
-
and then close the window that opens (eg say `"window close"`). This step is necessary to create the [VSCode settings profile](https://code.visualstudio.com/updates/v1_72#_settings-profiles) that acts as a sandbox containing a specific set of VSCode extensions that will be run alongside Cursorless when you launch Cursorless in debug or test mode. Once https://github.com/microsoft/vscode/issues/172046 is resolved, we will be able to remove this step, as the profile can then automatically be created.
45
-
46
-
5. Run the following in the terminal:
47
-
48
-
<TabsgroupId="vsx">
49
-
<TabItemvalue="vscode"label="VSCode">
50
-
```bash
51
-
pnpm init-vscode-sandbox
52
-
```
53
-
</TabItem>
54
-
<TabItemvalue="vscodium"label="VSCodium">
55
-
```bash
56
-
pnpm init-vscode-sandbox --codium
57
-
```
58
-
59
-
VSCodium users will also need to
60
-
manually download and install the `jrieken:vscode-tree-sitter-query`
while manual installation instructions can be found directly
68
-
below—replace `some.extension` with the acquired `.vsix` file's path
69
-
instead of an extension id.
70
-
</TabItem>
71
-
</Tabs>
72
-
73
-
Said command adds extensions to the aforementioned settings profile that acts as a sandbox containing a specific set of VSCode extensions that will be run alongside Cursorless when you launch Cursorless in debug or test mode. This approach is [suggested](https://code.visualstudio.com/updates/v1_72#_extension-debugging-in-a-clean-environment) by the VSCode documentation. If you need to update any of the extension dependencies in the sandbox, you can add `--force` to the command. If you'd like to use additional extensions when debugging locally, you can use the following command:
where `some.extension` is the id of the extension you'd like to install into the sandbox.
89
-
90
-
Note that you do not need to install the Cursorless extension into the `cursorlessDevelopment` profile. A local development version of Cursorless will be automatically installed there every time you debug the extension, as described below.
91
-
92
-
Also note that if you are adding support for a new language that isn't in the default list of [language identifiers](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) supported by VSCode, you may need to add an extension dependency. See [Adding a new language](./adding-a-new-language.md#2-ensure-file-type-is-supported-by-vscode) for more details.
93
-
94
-
6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
20
+
1. Clone [`cursorless`](https://github.com/cursorless-dev/cursorless) locally. Note that it doesn't matter where you clone it, as long as you _**do not**_ clone it into your Talon user directory.
21
+
2. Open the newly created `cursorless` directory in VSCode. If you're on Windows, don't use WSL (see [#919](https://github.com/cursorless-dev/cursorless/issues/919) for discussion / workaround).
22
+
3. Run the following in the terminal:
23
+
24
+
```bash
25
+
pnpm install
26
+
pnpm compile
27
+
```
28
+
29
+
4. Run the following in the terminal:
30
+
31
+
<TabsgroupId="vsx">
32
+
33
+
<TabItemvalue="vscode"label="VSCode"default>
34
+
35
+
```bash
36
+
code --profile=cursorlessDevelopment
37
+
```
38
+
39
+
</TabItem>
40
+
41
+
<TabItemvalue="vscodium"label="VSCodium">
42
+
43
+
```bash
44
+
codium --profile=cursorlessDevelopment
45
+
```
46
+
47
+
</TabItem>
48
+
49
+
</Tabs>
50
+
51
+
and then close the window that opens (eg say `"window close"`). This step is necessary to create the [VSCode settings profile](https://code.visualstudio.com/updates/v1_72#_settings-profiles) that acts as a sandbox containing a specific set of VSCode extensions that will be run alongside Cursorless when you launch Cursorless in debug or test mode. Once https://github.com/microsoft/vscode/issues/172046 is resolved, we will be able to remove this step, as the profile can then automatically be created.
52
+
53
+
5. Run the following in the terminal:
54
+
55
+
<TabsgroupId="vsx">
56
+
57
+
<TabItemvalue="vscode"label="VSCode">
58
+
59
+
```bash
60
+
pnpm init-vscode-sandbox
61
+
```
62
+
63
+
</TabItem>
64
+
65
+
<TabItemvalue="vscodium"label="VSCodium">
66
+
67
+
```bash
68
+
pnpm init-vscode-sandbox --codium
69
+
```
70
+
71
+
VSCodium users will also need to
72
+
manually download and install the `jrieken:vscode-tree-sitter-query`
while manual installation instructions can be found directly
80
+
below—replace `some.extension` with the acquired `.vsix` file's path
81
+
instead of an extension id.
82
+
83
+
</TabItem>
84
+
85
+
</Tabs>
86
+
87
+
Said command adds extensions to the aforementioned settings profile that acts as a sandbox containing a specific set of VSCode extensions that will be run alongside Cursorless when you launch Cursorless in debug or test mode. This approach is [suggested](https://code.visualstudio.com/updates/v1_72#_extension-debugging-in-a-clean-environment) by the VSCode documentation. If you need to update any of the extension dependencies in the sandbox, you can add `--force` to the command. If you'd like to use additional extensions when debugging locally, you can use the following command:
where `some.extension` is the id of the extension you'd like to install into the sandbox.
110
+
111
+
Note that you do not need to install the Cursorless extension into the `cursorlessDevelopment` profile. A local development version of Cursorless will be automatically installed there every time you debug the extension, as described below.
112
+
113
+
Also note that if you are adding support for a new language that isn't in the default list of [language identifiers](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) supported by VSCode, you may need to add an extension dependency. See [Adding a new language](./adding-a-new-language.md#2-ensure-file-type-is-supported-by-vscode) for more details.
114
+
115
+
6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
95
116
96
117
## Running / testing extension locally
97
118
@@ -150,14 +171,18 @@ Once you have your package then you can install it into the sandbox using the fo
0 commit comments