Show webview about missing installation dependencies#2720
Merged
Conversation
AndreasArvidsson
requested review from
fidgetingbits and
saidelike
as code owners
phillco
reviewed
Jan 14, 2025
packages/cursorless-vscode/resources/installationDependencies.js
Outdated
Show resolved
Hide resolved
packages/cursorless-vscode/resources/installationDependencies.js
Outdated
Show resolved
Hide resolved
phillco
requested changes
Jan 14, 2025
Member
phillco
left a comment
phillco
left a comment
There was a problem hiding this comment.
Rather than building up the HTML manually with JavaScript, since our layout is quite simple, let's just move this to a HTML file that the script can load and hydrate. I think the result will be more maintainable.
We don't have access to a templating library, but since we only have a couple of variables to inject we can just do this manually. There can still be some dynamic JavaScript as necessary but we don't need to build the entire template that way.
This also makes it easier to use a CSS block in rather than inlining all the styles for each block. We could also consider putting that in its own dedicated file and have the script load and inject it, although the style is pretty simple that it may not be worth it.
It would be nice if you could just open the html file locally (file://) to iterate on the design, and this code would just make it work within the VS Code webview context.
phillco
reviewed
Jan 14, 2025
Co-authored-by: Phil Cohen <phillip@phillip.io>
Co-authored-by: Phil Cohen <phillip@phillip.io>
phillco
reviewed
Jan 18, 2025
packages/cursorless-vscode/resources/installationDependencies.html
Outdated
Show resolved
Hide resolved
packages/cursorless-vscode/resources/installationDependencies.html
Outdated
Show resolved
Hide resolved
…html Co-authored-by: Phil Cohen <phillip@phillip.io>
…html Co-authored-by: Phil Cohen <phillip@phillip.io>
phillco
approved these changes
Jan 18, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 18, 2025
Came up during #2720; if you land on the README it doesn't actually tell you what to do. ## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet
cursorless-bot
pushed a commit
to cursorless-dev/cursorless-talon
that referenced
this pull request
Jan 18, 2025
Came up during cursorless-dev/cursorless#2720; if you land on the README it doesn't actually tell you what to do. ## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet
cursorless-bot
pushed a commit
that referenced
this pull request
Jan 18, 2025
Came up during #2720; if you land on the README it doesn't actually tell you what to do. ## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
If the user is missing some installation dependencies. eg talon, cursorless-talon, command server, we now show a web view informing them
Fixes #1953
Fixes #528
Checklist