Skip to content

Remove contributing.mdx from prettierignore #3074

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Aug 25, 2025
Merged

Remove contributing.mdx from prettierignore #3074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1f898f
Remove contributing.mdx from prettierignore
AndreasArvidsson Aug 25, 2025
93356bd
Ran prettier
AndreasArvidsson Aug 25, 2025
56cdf52
Once again
AndreasArvidsson Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,3 @@
pnpm-lock.yaml

.github/PULL_REQUEST_TEMPLATE.md
# Formatting breaks code blocks nested within tabs
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
175 changes: 100 additions & 75 deletions packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,81 +17,102 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s

### Steps

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.
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).
3. Run the following in the terminal:

```bash
pnpm install
pnpm compile
```

4. Run the following in the terminal:

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode" default>
```bash
code --profile=cursorlessDevelopment
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
```bash
codium --profile=cursorlessDevelopment
```
</TabItem>
</Tabs>

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.

5. Run the following in the terminal:

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">
```bash
pnpm init-vscode-sandbox
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
```bash
pnpm init-vscode-sandbox --codium
```

VSCodium users will also need to
manually download and install the `jrieken:vscode-tree-sitter-query`
extension, as it is [currently not
avalible](https://github.com/jrieken/vscode-tree-sitter-query/issues/28)
on the OpenVSX Marketplace. Instructions on how to manually download the
extension can be found [in this Stack Overflow
post](https://stackoverflow.com/a/79565372)
([archived](https://web.archive.org/web/20250421130639/https://stackoverflow.com/questions/79359919/how-can-i-manually-download-vsix-files-now-that-the-vs-code-marketplace-no-long/79565372#79565372)),
while manual installation instructions can be found directly
below—replace `some.extension` with the acquired `.vsix` file's path
instead of an extension id.
</TabItem>
</Tabs>

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:

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">
```bash
code --profile=cursorlessDevelopment --install-extension some.extension
```
</TabItem>
<TabItem value="vscodium" label="VSCodium">
```bash
codium --profile=cursorlessDevelopment --install-extension some.extension
```
</TabItem>
</Tabs>

where `some.extension` is the id of the extension you'd like to install into the sandbox.

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.

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.

6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.
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.
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).
3. Run the following in the terminal:

```bash
pnpm install
pnpm compile
```

4. Run the following in the terminal:

<Tabs groupId="vsx">

<TabItem value="vscode" label="VSCode" default>

```bash
code --profile=cursorlessDevelopment
```

</TabItem>

<TabItem value="vscodium" label="VSCodium">

```bash
codium --profile=cursorlessDevelopment
```

</TabItem>

</Tabs>

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.

5. Run the following in the terminal:

<Tabs groupId="vsx">

<TabItem value="vscode" label="VSCode">

```bash
pnpm init-vscode-sandbox
```

</TabItem>

<TabItem value="vscodium" label="VSCodium">

```bash
pnpm init-vscode-sandbox --codium
```

VSCodium users will also need to
manually download and install the `jrieken:vscode-tree-sitter-query`
extension, as it is [currently not
avalible](https://github.com/jrieken/vscode-tree-sitter-query/issues/28)
on the OpenVSX Marketplace. Instructions on how to manually download the
extension can be found [in this Stack Overflow
post](https://stackoverflow.com/a/79565372)
([archived](https://web.archive.org/web/20250421130639/https://stackoverflow.com/questions/79359919/how-can-i-manually-download-vsix-files-now-that-the-vs-code-marketplace-no-long/79565372#79565372)),
while manual installation instructions can be found directly
below—replace `some.extension` with the acquired `.vsix` file's path
instead of an extension id.

</TabItem>

</Tabs>

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:

<Tabs groupId="vsx">

<TabItem value="vscode" label="VSCode">

```bash
code --profile=cursorlessDevelopment --install-extension some.extension
```

</TabItem>

<TabItem value="vscodium" label="VSCodium">

```bash
codium --profile=cursorlessDevelopment --install-extension some.extension
```

</TabItem>

</Tabs>

where `some.extension` is the id of the extension you'd like to install into the sandbox.

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.

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.

6. Copy / symlink [`cursorless-talon-dev`](../../cursorless-talon-dev) into your Talon user directory for some useful voice commands for developing Cursorless.

## Running / testing extension locally

Expand Down Expand Up @@ -150,14 +171,18 @@ Once you have your package then you can install it into the sandbox using the fo

<Tabs groupId="vsx">
<TabItem value="vscode" label="VSCode">

```bash
code --profile=cursorlessDevelopment --install-extension bundle.vsix
```

</TabItem>
<TabItem value="vscodium" label="VSCodium">

```bash
codium --profile=cursorlessDevelopment --install-extension bundle.vsix
```

</TabItem>
</Tabs>

Expand Down
Loading