Type-safe representation of key strokes
Open
Nobody has claimed this yet.
kind/refactor
- Dominant language
- TypeScript
- Stars
- 15.2k
- Forks
- 1.5k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
Currently, key strokes are stored and passed around as strings (like x, <Esc>, or <S-BS>). These are normalized up front, but there's enough room for inconsistency that there have been a number of bugs attributable to this lax approach.
There are two options here, I think:
- Continue storing them as strings, but use template literal types to gain some safety
- Store them as structs with the base key and any modifiers
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating where key strokes are normalized, stored, and passed around as strings, then compare the two proposed type-safety approaches. Done means the representation is consistently type-safe and the existing key-stroke behavior remains covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript, vscode
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100