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
Copy file name to clipboardExpand all lines: packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
+64-63Lines changed: 64 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,92 +17,93 @@ 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:
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
23
24
-
```bash
25
-
pnpm install
26
-
pnpm compile
27
-
```
28
-
29
-
4. Run the following in the terminal:
24
+
```bash
25
+
pnpm install
26
+
pnpm compile
27
+
```
30
28
31
-
<TabsgroupId="vsx">
32
-
<TabItemvalue="vscode"label="VSCode"default>
29
+
4. Run the following in the terminal:
33
30
34
-
```bash
35
-
code --profile=cursorlessDevelopment
36
-
```
31
+
<TabsgroupId="vsx">
32
+
<TabItemvalue="vscode"label="VSCode"default>
37
33
38
-
</TabItem>
39
-
<TabItemvalue="vscodium"label="VSCodium">
34
+
```bash
35
+
code --profile=cursorlessDevelopment
36
+
```
40
37
41
-
```bash
42
-
codium --profile=cursorlessDevelopment
43
-
```
38
+
</TabItem>
39
+
<TabItemvalue="vscodium"label="VSCodium">
44
40
45
-
</TabItem>
46
-
</Tabs>
41
+
```bash
42
+
codium --profile=cursorlessDevelopment
43
+
```
47
44
48
-
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
+
</TabItem>
46
+
</Tabs>
49
47
50
-
5. Run the following in the terminal:
48
+
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.
51
49
52
-
<TabsgroupId="vsx">
53
-
<TabItemvalue="vscode"label="VSCode">
50
+
5. Run the following in the terminal:
54
51
55
-
```bash
56
-
pnpm init-vscode-sandbox
57
-
```
52
+
<TabsgroupId="vsx">
53
+
<TabItemvalue="vscode"label="VSCode">
58
54
59
-
</TabItem>
60
-
<TabItemvalue="vscodium"label="VSCodium">
55
+
```bash
56
+
pnpm init-vscode-sandbox
57
+
```
61
58
62
-
```bash
63
-
pnpm init-vscode-sandbox --codium
64
-
```
59
+
</TabItem>
60
+
<TabItemvalue="vscodium"label="VSCodium">
65
61
66
-
VSCodium users will also need to
67
-
manually download and install the `jrieken:vscode-tree-sitter-query`
while manual installation instructions can be found directly
75
+
below—replace `some.extension` with the acquired `.vsix` file's path
76
+
instead of an extension id.
77
+
78
+
</TabItem>
79
+
</Tabs>
79
80
80
-
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:
81
+
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.
100
+
where `some.extension` is the id of the extension you'd like to install into the sandbox.
100
101
101
-
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.
102
+
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.
102
103
103
-
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.
104
+
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.
104
105
105
-
6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
106
+
6.Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
0 commit comments