-
-
Notifications
You must be signed in to change notification settings - Fork 84
Generate Examples -- Continued #2272
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.
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
base: main
Are you sure you want to change the base?
Conversation
8baf3e5
to
25adbca
Compare
Thanks for picking this up! If you need any help figuring out what I was doing let me know. I can answer questions but completely have no time to code outside of work commitments 😞 |
All good, happy to see you're well :) I'm definitely curious about the decisions you made to choose these libraries and what your vision was for how you wanted this feature to end up. Recently I was looking for more opportunities for to learn what Cursorless can do and wanted a series of gifs that could demo its capabilities. We've already got all these test files so that seemed like a good place to start, and it turns out you already are plenty of the way there! |
I think we just had the same desire, while I was learning Cursorless at the start I just wanted something like a "library" of examples of what each command could do. My overall thinking was just a "search command/scope/etc, see examples" type app, but never got past the "just make the HTML work" stage. I don't think there was anything really "deep" in my decision-making, |
I think one of my main questions is where this will end up residing. Eg is it gonna be available locally via something like the cheat sheet or is it only online via the docs. That might be a better question if Andreas or Pokey, but I think it affects how I would explore building this. My first inclination was to see if anything could be reused from the Docusaurus space:
If it's going to reside in the cheat sheet then there's no established components, theme etc to start from and something like shiki seems like the right choice. I honestly have no idea though. |
Sorry can't help you there, definitely a question for Pokey or Andreas as I didn't really figure out with them where was best. |
With the caveat that I haven't really read through the previous pull request we definitely want code examples in the online documentation. We might link from the cheat sheet to the online docs, but I don't think we should actually cram all the documentation into the cheat sheet itself. |
A package is the way to go, but I'd recommend starting from a clean checkout of
I'm not sure Fwiw you might want to look at the For local testing / experimentation, I'd just add a dummy page to our Once you have a working react component, we can look into getting it into docusaurus using mdx Lmk if any of the above doesn't make sense, and feel free to drop into another meet-up if you get stuck! |
2aec397
to
8fbb8b0
Compare
I wanted to keep the commit record from @SimeonC if possible so I reconfigured a few things and it should be working properly. The code still builds in the same way it use to. Still working on getting a test page to render similar to |
ok no worries; looks like you managed to remove all the unnecessary nx stuff so that's fine 👍. I'd move all the |
Moved files from Though, that same pattern is in # find . -type d
./cheatsheet
./cheatsheet/node_modules
./cheatsheet/node_modules/@types
./cheatsheet/node_modules/.bin
./cheatsheet/node_modules/@fortawesome
./cheatsheet/node_modules/@testing-library
./cheatsheet/src
./cheatsheet/src/lib
./cheatsheet/src/lib/components
./cheatsheet/src/lib/sampleSpokenFormInfos
./cheatsheet/src/lib/hooks |
Oh interesting. I wonder why we do that there. Probably same reason tbh; was migrated from the old nx semi-mono-repo and never changed |
I've been working on mirroring the format of the I was also having a few issues just trying to understand how everything worked together by running I couldn't get anything to change e.g.:
|
could you possibly elaborate? not sure I follow
Strange. I could have sworn that used to work 🤔. But yes I confirmed it's not working for me either. Here's a fix #2286 |
e7e56d1
to
f793231
Compare
Test case component sounds good |
fwiw #2286 now merged so hot reload should work once you do a git merge |
I see there's a conflict in your lockfile. Generally easiest to just revert the lockfile to main and then do a |
Haven't made that much progress on this since last check in. Got content to render from I do my best to copy the
import {
TestCaseComponentPage
} from "@cursorless/test-case-component";
// ~~~~~~~~~~~~~~~~~~~~~~~~~
import Head from "next/head";
// Cannot find module '@cursorless/test-case-component' or its corresponding type declarations. I originally thought this was blocking me from getting the |
fb05cec
to
6e3c9cd
Compare
Thanks for taking some extra time before you all hopped off todays call :) Notescursorless-org/component-sheet page
Test file
|
just to clarify this one: |
Yes that makes sense
|
660d2a1
to
bb4e62b
Compare
…_examples_current
Copied from packages/cursorless-vscode/package.json colors list
4bdf662
to
1091c71
Compare
This is following on from the work of #940
Might resolve:
This is currently a draft PR
Latest updates
colors
field inpackage-json
finalState
ToDos Immediate
ToDos IceBox
block
andinline-block
displayinitialState
,during
, andfinalState
How to test
/packages/cursorless-org/
pnpm dev
localhost:{PORT NUMBER}/component-sheet
Screenshots 2025-04-19
Current issues
The
during
step that shows selection for deletion isn't being hitloadFixtures.ts
)Color scheme is very bad, will need to pick something better eventually
I have added tests
I have updated the docs and cheatsheet
I have not broken the cheatsheet