Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/complete-synthetic-key-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"hunkdiff": patch
---

Provide complete key event data to command matchers and programmatically invoked handlers.
20 changes: 20 additions & 0 deletions src/lib/commandKeys.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { describe, expect, test } from "bun:test";
import { KeyEvent } from "@opentui/core";
import { matchesKeyChord, parseKeyChord, synthesizeKeyEvent, toKeyChordList } from "./commandKeys";

/**
Expand All @@ -23,6 +24,25 @@ describe("synthesizeKeyEvent", () => {
expect(matchesKeyChord(parsed(chord), synthesizeKeyEvent(parsed(chord)))).toBe(true);
}
});

test("returns a complete key event", () => {
const event = synthesizeKeyEvent(parsed("ctrl+r"));

expect(event).toBeInstanceOf(KeyEvent);
expect({ eventType: event.eventType, source: event.source }).toEqual({
eventType: "press",
source: "raw",
});
event.preventDefault();
event.stopPropagation();
expect({
defaultPrevented: event.defaultPrevented,
propagationStopped: event.propagationStopped,
}).toEqual({
defaultPrevented: true,
propagationStopped: true,
});
});
});

describe("toKeyChordList", () => {
Expand Down
10 changes: 5 additions & 5 deletions src/lib/commandKeys.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { KeyEvent } from "@opentui/core";
import { KeyEvent } from "@opentui/core";
import { matchesKeyChord, parseKeyChord, type ParsedKeyChord } from "../extension-api/keys";

/**
Expand Down Expand Up @@ -39,7 +39,7 @@ export function synthesizeKeyEvent(parsed: ParsedKeyChord): KeyEvent {
? parsed.base.toUpperCase()
: parsed.base;

return {
return new KeyEvent({
name: isNamed || isLetter ? parsed.base : sequence,
sequence,
raw: sequence,
Expand All @@ -48,9 +48,9 @@ export function synthesizeKeyEvent(parsed: ParsedKeyChord): KeyEvent {
option: parsed.option,
shift: parsed.shift,
number: false,
preventDefault: () => {},
stopPropagation: () => {},
} as unknown as KeyEvent;
eventType: "press",
source: "raw",
});
}

/**
Expand Down