Skip to content

Commit cab31d1

Browse files
Fix CONTRIBUTING.MDX formatting snafu introduced in PR 2989 (#3073)
From what I understand, the auto-formatting/prettifier plugin used by Cursorless really didn't like how CONTRIBUTING.MDX needed to be formatted to have the separation between vscode and vscodium specific commands show properly, and as a result broke a bunch of the code blocks, transforming them from ```bash echo hello yes this is dog ``` to `bash echo hello yes this is dog` though ofc the commands were actual commands and not an echo example. I forget if any other formatting was broken, it has been a while since I actually finished the work on this and I just forgot to make a PR for it, sorry (been busy with getting ready for the new semester, health nonsense, and non-CS hobbies). This PR fixes the aforementioned issue and excludes CONTRIBUTING.MDX from being processed by the auto-formatting plugin, allowing it to contain all of the weird extended markdown jank the plugin seems to really not like. If there's a more elegant way to do this (changing the rules the plugin follows?) please lmk and commit it if you have the time, this is very much not my usual wheelhouse. --------- Co-authored-by: Andreas Arvidsson <[email protected]>
1 parent 36a8d60 commit cab31d1

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@
77
pnpm-lock.yaml
88

99
.github/PULL_REQUEST_TEMPLATE.md
10+
# Formatting breaks code blocks nested within tabs
11+
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx

packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,14 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s
3030

3131
<Tabs groupId="vsx">
3232
<TabItem value="vscode" label="VSCode" default>
33-
`bash code --profile=cursorlessDevelopment`
33+
```bash
34+
code --profile=cursorlessDevelopment
35+
```
3436
</TabItem>
3537
<TabItem value="vscodium" label="VSCodium">
36-
`bash codium --profile=cursorlessDevelopment`
38+
```bash
39+
codium --profile=cursorlessDevelopment
40+
```
3741
</TabItem>
3842
</Tabs>
3943

@@ -43,10 +47,16 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s
4347

4448
<Tabs groupId="vsx">
4549
<TabItem value="vscode" label="VSCode">
46-
```bash pnpm init-vscode-sandbox```
50+
```bash
51+
pnpm init-vscode-sandbox
52+
```
4753
</TabItem>
4854
<TabItem value="vscodium" label="VSCodium">
49-
`bash pnpm init-vscode-sandbox --codium` VSCodium users will also need to
55+
```bash
56+
pnpm init-vscode-sandbox --codium
57+
```
58+
59+
VSCodium users will also need to
5060
manually download and install the `jrieken:vscode-tree-sitter-query`
5161
extension, as it is [currently not
5262
avalible](https://github.com/jrieken/vscode-tree-sitter-query/issues/28)
@@ -64,12 +74,14 @@ Welcome! So glad you've decided to help make Cursorless better. You'll want to s
6474

6575
<Tabs groupId="vsx">
6676
<TabItem value="vscode" label="VSCode">
67-
`bash code --profile=cursorlessDevelopment --install-extension
68-
some.extension`
77+
```bash
78+
code --profile=cursorlessDevelopment --install-extension some.extension
79+
```
6980
</TabItem>
7081
<TabItem value="vscodium" label="VSCodium">
71-
`bash codium --profile=cursorlessDevelopment --install-extension
72-
some.extension`
82+
```bash
83+
codium --profile=cursorlessDevelopment --install-extension some.extension
84+
```
7385
</TabItem>
7486
</Tabs>
7587

@@ -138,11 +150,14 @@ Once you have your package then you can install it into the sandbox using the fo
138150

139151
<Tabs groupId="vsx">
140152
<TabItem value="vscode" label="VSCode">
141-
`bash code --profile=cursorlessDevelopment --install-extension bundle.vsix`
153+
```bash
154+
code --profile=cursorlessDevelopment --install-extension bundle.vsix
155+
```
142156
</TabItem>
143157
<TabItem value="vscodium" label="VSCodium">
144-
`bash codium --profile=cursorlessDevelopment --install-extension
145-
bundle.vsix`
158+
```bash
159+
codium --profile=cursorlessDevelopment --install-extension bundle.vsix
160+
```
146161
</TabItem>
147162
</Tabs>
148163

0 commit comments

Comments
 (0)