Add simple usage stats to cheatsheet #2116
Closed
+2,410
−1,804
Conversation
This file contains 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
- Removed copied over typing info (but added a new dependency to engine :D ) - Added dummy comments identifying code to possibly change / participating code
pokey
reviewed
Dec 11, 2023
- Cleaning up some of my notes - Using real default spoken form info for debugging purposes instead of dummy data that doesn't help debugging the usage stats in cheat sheet feature
bra1nDump
force-pushed
the
cheatsheet-usage-stats
branch
from
d57add0 to
b0262ef
Compare
Co-authored-by: Pokey Rule <[email protected]>
…a (basic stats extraction)
- extracting stats from command history with a big switch + generators
- added run action to vscode to run the cheatsheet-local build + open generated html in browser
- in webpack debug build injecting default (real dev data!! Will be checked in! is this ok?)
- did super basic ui for the stats - appears along the command
- discovered many single modifiers represent multiple versions in the spoken form (e.g. "[scope] forward" and "[scope] backward" are backed by the same modifier relativeScope on the extension side)
- removed flat mapping and sorting alphabetically
- Also removed section sorting - TODO: Actually put this one back
- I think we should sort from basic -> advanced
- I also think we should maintain sections - for example relativeScope versions should be groupped together
- TODO: discuss how to track usage of tricky modifiers. My suggestion is to ignore this and just track the overall modifier usage
- TODO: Add setting to the extension to toggle usage showing in cheatsheet off/on. Also include the setting in the cheatsheet itself
- TODO: Like figma - have a toggle to higlight things unused completely
|
I'm curious what you expect to gain by this feature. Are you interested in finding actions / scopes you're not using? |
|
@pokey Yes, the original idea is to discover features I'm not using. For new users this can serve as gamification for tracking their progress. While implementing this I think a more impactful contribution is to improve cheat sheet contents
Call me lazy, but I just want the cheatsheet to be my one stop shop for pretty much anything after I learned the basics from documentation / watching YouTube videos |
|
I think we decided to hold off on this direction for now, right? Any reason not to close this one out for now? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Dependency: Command history logging #2115
As an avid cheatsheet user, it is the most intuitive place for me to show aggregate usage and would help me identify gaps.
Implementation
usageStatisticssimilar to how we injectcheatsheetInfoin https://github.com/pokey/cursorless-vscode/blob/main/packages/cursorless-engine/src/core/Cheatsheet.ts'UI
Discussions
Checklist
[Outside the scope of this PR]
Would be most effective when combined with a re-work of the cheatsheet structure. Grouping by what commands do, popularity, common non-obvious commands, for instance 'change tree instances' etc. I imagine there have been a number of discussions on this already.