Add sandbox setup cmd for VSCodium #2989
Conversation
|
The only reliable, cross-platform workaround to OpenVSX marketplace not having the vscode-tree-sitter-query plugin I could find was to just bundle it as part of the repository (in I'll add some details to the documentation about this, and then things should be ready for review! |
Required to smoothly show commands for both VSCode and VSCodium when they differ
|
Should be ready for review! |
rinOfTheStars
requested review from
saidelike,
fidgetingbits and
a team
as code owners
|
Not quite sure I'm following fully. The parse tree extension that Cursorless requires is already available on open vsx. |
|
|
Oh you mean you are missing a language definition for I'm not a big fan of bundling other extensions like this. Is it really that much of a problem to just install this dependency manually during initial setup for now? Hopefully the extension will be available on the marketplace in the future |
Yeah I'm not a fan either, fwiw. I can add to the docs how to manually install it instead if that would work better |
I think that would be best. |
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-vscode/src/scripts/initLaunchSandboxCodium.ts
Outdated
Show resolved
Hide resolved
- Consolidate initLaunchSandbox.ts and initLaunchSandboxCodium.ts into a single script which determines which editor-cli tool pair is installed automatically. - Remove pointers to now-removed initLaunchSandboxCodium.ts in package.json and packages/cursorless-vscode/package.json - Remove auto-installation of missing extension from VSCodium setup from .vsix file, add documentation on how to install it manually instead to CONTRIBUTING.mdx - Remove data/vsix dir and all files within due to above - Update CONTRIBUTING.mdx to note that running pnpm compile is not strictly required to contribute to Cursorless - Update CONTRIBUTING.mdx to remove reference to the specific version settings profiles were added, and instead just tell contributors to raise an issue if they're a problem for some reason - Fix odd line break at the top of CONTRIBUTING.mdx
| 3. Run the following in the terminal: | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm compile | ||
| ``` | ||
| Don't fret if `pnpm compile` fails! While required for running tests locally on your machine, you will still be able to run tests through GitHub Actions, and it will not prevent you from contributing otherwise. |
There was a problem hiding this comment.
This can be removed if it should go in a separate PR
There was a problem hiding this comment.
Why should compile fail locally?
There was a problem hiding this comment.
I wish I knew 😓 but as I noted in the talon slack, it fails locally on my machine despite seemingly having no reason to. Still trying to track down what's wrong with my setup (or if its a regression/bug that only occurs for new contributors).
There was a problem hiding this comment.
We should probably have a discord session about that. Not being able to compile locally is not a good developer experience.
There was a problem hiding this comment.
Seems like this is a known issue on the @types maintainers' end that fell through the cracks and never got fixed: DefinitelyTyped/DefinitelyTyped#43912
Adding "skipLibCheck": true to the base ts config (tsconfig.base.json) seems to fix this issue without causing any itself (running all tests seems to work fine); no clue why the bug happens on some systems but not others, however, or if there are potential major caveats to this fix. If there's some way to detect when a build fails due to the conflict between @types/mocha and @types/jest and only then pass this config argument, that would probably be better?
There was a problem hiding this comment.
Can I have a link to the discord, then? Idk if I want to do voice call stuff but seeing if other people can replicate this (bc it is extremely odd it only happens on my machine, and yet occurs regardless of install location) is probably best done there, yeah
There was a problem hiding this comment.
Certainly.
https://discord.gg/zGdVz2pD
That sounds like it might be a path or other environment variable interfering?
Anyhow I don't think we should have texts in the documentation expecting people not to be able to compile cursorless.
There was a problem hiding this comment.
Certainly. https://discord.gg/zGdVz2pD
That sounds like it might be a path or other environment variable interfering?
Anyhow I don't think we should have texts in the documentation expecting people not to be able to compile cursorless.
Yeah, fair enough honestly. I wish I had any clue as to what exactly is preventing pnpm compile from working, but honestly I'm entirely clueless at this point. My only guess is it has something to do with homebrew itself, or with the filesystem being used? I'm probably going to do a disk wipe + reinstall sometime soon anyway (I've got backups through a Time Machine external disk, so I'll manually restore stuff piecemeal when I need it) so if that doesn't fix this issue when running everything from as fresh of an install as possible, then I guess that'd could as reproduction?
There was a problem hiding this comment.
It's really strange. Let's do this. Can you run the below commands and give me the full log? You can do it on slack if you don't want to post it here.
node -v
npm -v
pnpm -v
pnpm run clean
pnpm install
pnpm compile
There was a problem hiding this comment.
https://gist.github.com/rinOfTheStars/522c9b95f28cc3d4b0b9d9b98eacfb95
Unless there's something going on with one of the node/npm/pnpm versions being used, nothing seems out of the ordinary until the pnpm compile failure at the end.
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Andreas Arvidsson <[email protected]>
Co-authored-by: Andreas Arvidsson <[email protected]>
Co-authored-by: Andreas Arvidsson <[email protected]>
packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.mdx
Outdated
Show resolved
Hide resolved
…G.mdx Co-authored-by: Andreas Arvidsson <[email protected]>
|
Further insights into whatever is going on with building cursorless on my machine: it works fine in a vm both with and without homebrew installed. Going to see if using the homebrew-sourced versions of pnpm, node, and typescript changes that (unlikely) Edit: yup, works fine regardless of how I install pnpm. |
change var to let at line 17
This implicitly requires
vscode-tree-sitter-queryto be published to the Open VSX Registry to not cause issues when running tests, as rn that plugin is commented out inpackages/common/src/extensionDependencies.tsdue to it not being present there. This PR will therefor need to be a draft until that plugin is uploaded to Open VSX; I'll probably also add to the documentation to note the differences in commands between VSCodium and VSCode at some point soon. There's also probably a cleaner way to do this with a variable passed topackages/cursorless-vscode/src/scripts/initLaunchSandbox.tsto swap between vscode and vscodium mode or something, but I'll look into that later as well.