feat: add support for additional key codes #151

conventoangelo · 2026-01-01T05:01:00Z

Summary by CodeRabbit

New Features
- Expanded keyboard support with many additional system, browser, media, and launch keys plus improved shift-aware key representations.
Chores
- Removed a debug logging statement related to key events.
Documentation
- Updated ignored-keys examples and added sections describing system, browser, and media keys.
Tests
- Minor whitespace cleanup in a unit test file.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

…rocessing

coderabbitai · 2026-01-01T05:01:09Z

📝 Walkthrough

Walkthrough

Adds many new key symbol-to-name mappings, introduces a shift-aware keyCode→display mapping, and removes a conditional debug log in the key event service; tests had only whitespace edits and docs were expanded/renamed for key examples.

Changes

Cohort / File(s)	Summary
Mapping & KeyCode additions `lib/models/mappings.dart`, `lib/utils/key_code.dart`	Added extensive key symbol → canonical name entries (media, browser, volume, app/launch, navigation, etc.). Introduced `defaultKeyCodeShiftMap` and shift-aware lookup logic to render shifted characters for key codes.
Service logging tweak `lib/services/key_event_service.dart`	Removed a conditional debug logging block that printed `ignoredKeys` on key press; existing ignored-key checks and early-return behavior remain.
Docs updates `docs/advanced/ignored-keys.md`, `docs/advanced/supported-keys.md`	Renamed/standardized key names in ignored-keys docs and added sections for System & Application, Browser, and Media keys (informational only).
Tests (whitespace) `test/user_config_test.dart`	Whitespace-only changes around test blocks; no behavioral changes.

Sequence Diagram(s)

(Skipped — changes are maps/docs/log removal and do not introduce a new multi-component sequential flow.)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

feat: add support for custom aliases #150 — also modifies lib/services/key_event_service.dart (adds custom-alias handling), which directly intersects with the logging/flow area changed here.

Poem

🐰 I hopped through maps of keys and codes,
I added shifts and widened roads,
A silent log I gently swept away,
Now keys sing clear from night to day —
🥕⏯️🔊✨

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately summarizes the main objective of the pull request: adding support for additional key codes across multiple files (mappings, key_code, and documentation).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 41994dd and b0a26fe.

📒 Files selected for processing (3)

docs/advanced/ignored-keys.md
docs/advanced/supported-keys.md
lib/models/mappings.dart

✅ Files skipped from review due to trivial changes (1)

docs/advanced/ignored-keys.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test

🔇 Additional comments (3)

docs/advanced/supported-keys.md (1)

99-140: LGTM! Comprehensive documentation for new key support.

The three new sections (System & Application Keys, Browser Keys, and Media Keys) are well-structured and consistent with the existing documentation format. The tables clearly list each key with its aliases, making it easy for users to reference when configuring their layouts.

lib/models/mappings.dart (2)

140-140: Minor fix: Added mapping for subscript equals symbol.

The addition of '₌': '=' ensures the subscript equals character maps correctly to the standard equals key.

141-188: Excellent addition of comprehensive key mappings with proper validation.

All 27 canonical key names are properly defined in lib/utils/key_code.dart, confirming these mappings correctly reference the underlying Windows virtual key codes. The new mappings cover system, browser, media, and utility keys with sensible aliases.

The code is well-organized and consistent with existing patterns. The inclusion of both text aliases (e.g., 'MUTE', 'VOLDN', 'PLAY') and emoji aliases (e.g., '🔇', '🔉', '⏯') provides flexibility for users.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

lib/models/mappings.dart (1)

180-180: Consider the ambiguity of mapping '?' to 'Help'.

The question mark character '?' is typically produced by Shift+/ on US keyboards. Mapping '?' to 'Help' in the configuration parser could confuse users who might expect '?' to represent the shifted '/' key rather than the Help key. Consider whether this mapping should be removed or documented to avoid ambiguity in user configurations.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9bcb385 and 41994dd.

📒 Files selected for processing (4)

lib/models/mappings.dart
lib/services/key_event_service.dart
lib/utils/key_code.dart
test/user_config_test.dart

💤 Files with no reviewable changes (1)

lib/services/key_event_service.dart

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test

🔇 Additional comments (2)

lib/models/mappings.dart (1)

141-188: Good expansion of key mappings.

The new mappings comprehensively cover media controls, browser navigation, volume controls, and application launch keys. The inclusion of emoji alternatives (🔇, 🔊, ⏭, ⏮, ⏹, ⏯, ⏸, ✉) and multiple text aliases (e.g., PRTSC/PRTSCRN/PRTSCR) provides user-friendly configuration options. The naming conventions are consistent with existing patterns.

lib/utils/key_code.dart (1)

102-128: The VK_ constants are standard Windows virtual-key codes properly exported by the win32 package. All constants used in this mapping (VK_PAUSE, VK_APPS, VK_SLEEP, VK_SNAPSHOT, VK_BROWSER_, VK_VOLUME_, VK_MEDIA_, VK_LAUNCH_, VK_HELP, VK_SELECT, VK_PRINT, VK_EXECUTE, VK_CLEAR) are included in win32 v5.5.4 and match the Microsoft Virtual-Key Codes specification. No compilation errors expected.

lib/utils/key_code.dart

codecov-commenter · 2026-01-01T05:07:30Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

…d media keys with aliases

conventoangelo added 5 commits January 1, 2026 11:56

feat: add additional key mappings for multimedia and browser keys

4b44f75

feat: add additional key mappings for mail, media, and application keys

d5fcebf

feat: add aliases for new key codes

9714c03

chore: remove redundant debug logging for ignored keys in key event p…

2c0e906

…rocessing

chore: run dart format

41994dd

fix: update ignored keys documentation to use correct key names

fae2c6b

coderabbitai bot reviewed Jan 1, 2026

View reviewed changes

lib/utils/key_code.dart Show resolved Hide resolved

feat: add mapping alias for BrowserHome key

2f1327c

docs: update supported-keys.md for additional system, application, an…

b0a26fe

…d media keys with aliases

conventoangelo merged commit 1935ff1 into main Jan 1, 2026
4 checks passed

conventoangelo deleted the feat/more-supported-keys branch January 1, 2026 16:33

This was referenced Jan 1, 2026

chore: release v0.3.3 #140

Merged

chore: release v0.3.4 #156

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add support for additional key codes #151

feat: add support for additional key codes #151

Uh oh!

conventoangelo commented Jan 1, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 1, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

codecov-commenter commented Jan 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat: add support for additional key codes #151

feat: add support for additional key codes #151

Uh oh!

Conversation

conventoangelo commented Jan 1, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov-commenter commented Jan 1, 2026

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

conventoangelo commented Jan 1, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 1, 2026 •

edited

Loading