File size: 13,667 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 | import { plural } from '../utils/stringUtils.js'
import { chordToString, parseChord, parseKeystroke } from './parser.js'
import {
getReservedShortcuts,
normalizeKeyForComparison,
} from './reservedShortcuts.js'
import type {
KeybindingBlock,
KeybindingContextName,
ParsedBinding,
} from './types.js'
/**
* Types of validation issues that can occur with keybindings.
*/
export type KeybindingWarningType =
| 'parse_error'
| 'duplicate'
| 'reserved'
| 'invalid_context'
| 'invalid_action'
/**
* A warning or error about a keybinding configuration issue.
*/
export type KeybindingWarning = {
type: KeybindingWarningType
severity: 'error' | 'warning'
message: string
key?: string
context?: string
action?: string
suggestion?: string
}
/**
* Type guard to check if an object is a valid KeybindingBlock.
*/
function isKeybindingBlock(obj: unknown): obj is KeybindingBlock {
if (typeof obj !== 'object' || obj === null) return false
const b = obj as Record<string, unknown>
return (
typeof b.context === 'string' &&
typeof b.bindings === 'object' &&
b.bindings !== null
)
}
/**
* Type guard to check if an array contains only valid KeybindingBlocks.
*/
function isKeybindingBlockArray(arr: unknown): arr is KeybindingBlock[] {
return Array.isArray(arr) && arr.every(isKeybindingBlock)
}
/**
* Valid context names for keybindings.
* Must match KeybindingContextName in types.ts
*/
const VALID_CONTEXTS: KeybindingContextName[] = [
'Global',
'Chat',
'Autocomplete',
'Confirmation',
'Help',
'Transcript',
'HistorySearch',
'Task',
'ThemePicker',
'Settings',
'Tabs',
'Attachments',
'Footer',
'MessageSelector',
'DiffDialog',
'ModelPicker',
'Select',
'Plugin',
]
/**
* Type guard to check if a string is a valid context name.
*/
function isValidContext(value: string): value is KeybindingContextName {
return (VALID_CONTEXTS as readonly string[]).includes(value)
}
/**
* Validate a single keystroke string and return any parse errors.
*/
function validateKeystroke(keystroke: string): KeybindingWarning | null {
const parts = keystroke.toLowerCase().split('+')
for (const part of parts) {
const trimmed = part.trim()
if (!trimmed) {
return {
type: 'parse_error',
severity: 'error',
message: `Empty key part in "${keystroke}"`,
key: keystroke,
suggestion: 'Remove extra "+" characters',
}
}
}
// Try to parse and see if it fails
const parsed = parseKeystroke(keystroke)
if (
!parsed.key &&
!parsed.ctrl &&
!parsed.alt &&
!parsed.shift &&
!parsed.meta
) {
return {
type: 'parse_error',
severity: 'error',
message: `Could not parse keystroke "${keystroke}"`,
key: keystroke,
}
}
return null
}
/**
* Validate a keybinding block from user config.
*/
function validateBlock(
block: unknown,
blockIndex: number,
): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
if (typeof block !== 'object' || block === null) {
warnings.push({
type: 'parse_error',
severity: 'error',
message: `Keybinding block ${blockIndex + 1} is not an object`,
})
return warnings
}
const b = block as Record<string, unknown>
// Validate context - extract to narrowed variable for type safety
const rawContext = b.context
let contextName: string | undefined
if (typeof rawContext !== 'string') {
warnings.push({
type: 'parse_error',
severity: 'error',
message: `Keybinding block ${blockIndex + 1} missing "context" field`,
})
} else if (!isValidContext(rawContext)) {
warnings.push({
type: 'invalid_context',
severity: 'error',
message: `Unknown context "${rawContext}"`,
context: rawContext,
suggestion: `Valid contexts: ${VALID_CONTEXTS.join(', ')}`,
})
} else {
contextName = rawContext
}
// Validate bindings
if (typeof b.bindings !== 'object' || b.bindings === null) {
warnings.push({
type: 'parse_error',
severity: 'error',
message: `Keybinding block ${blockIndex + 1} missing "bindings" field`,
})
return warnings
}
const bindings = b.bindings as Record<string, unknown>
for (const [key, action] of Object.entries(bindings)) {
// Validate key syntax
const keyError = validateKeystroke(key)
if (keyError) {
keyError.context = contextName
warnings.push(keyError)
}
// Validate action
if (action !== null && typeof action !== 'string') {
warnings.push({
type: 'invalid_action',
severity: 'error',
message: `Invalid action for "${key}": must be a string or null`,
key,
context: contextName,
})
} else if (typeof action === 'string' && action.startsWith('command:')) {
// Validate command binding format
if (!/^command:[a-zA-Z0-9:\-_]+$/.test(action)) {
warnings.push({
type: 'invalid_action',
severity: 'warning',
message: `Invalid command binding "${action}" for "${key}": command name may only contain alphanumeric characters, colons, hyphens, and underscores`,
key,
context: contextName,
action,
})
}
// Command bindings must be in Chat context
if (contextName && contextName !== 'Chat') {
warnings.push({
type: 'invalid_action',
severity: 'warning',
message: `Command binding "${action}" must be in "Chat" context, not "${contextName}"`,
key,
context: contextName,
action,
suggestion: 'Move this binding to a block with "context": "Chat"',
})
}
} else if (action === 'voice:pushToTalk') {
// Hold detection needs OS auto-repeat. Bare letters print into the
// input during warmup and the activation strip is best-effort —
// space (default) or a modifier combo like meta+k avoid that.
const ks = parseChord(key)[0]
if (
ks &&
!ks.ctrl &&
!ks.alt &&
!ks.shift &&
!ks.meta &&
!ks.super &&
/^[a-z]$/.test(ks.key)
) {
warnings.push({
type: 'invalid_action',
severity: 'warning',
message: `Binding "${key}" to voice:pushToTalk prints into the input during warmup; use space or a modifier combo like meta+k`,
key,
context: contextName,
action,
})
}
}
}
return warnings
}
/**
* Detect duplicate keys within the same bindings block in a JSON string.
* JSON.parse silently uses the last value for duplicate keys,
* so we need to check the raw string to warn users.
*
* Only warns about duplicates within the same context's bindings object.
* Duplicates across different contexts are allowed (e.g., "enter" in Chat
* and "enter" in Confirmation).
*/
export function checkDuplicateKeysInJson(
jsonString: string,
): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
// Find each "bindings" block and check for duplicates within it
// Pattern: "bindings" : { ... }
const bindingsBlockPattern =
/"bindings"\s*:\s*\{([^{}]*(?:\{[^{}]*\}[^{}]*)*)\}/g
let blockMatch
while ((blockMatch = bindingsBlockPattern.exec(jsonString)) !== null) {
const blockContent = blockMatch[1]
if (!blockContent) continue
// Find the context for this block by looking backwards
const textBeforeBlock = jsonString.slice(0, blockMatch.index)
const contextMatch = textBeforeBlock.match(
/"context"\s*:\s*"([^"]+)"[^{]*$/,
)
const context = contextMatch?.[1] ?? 'unknown'
// Find all keys within this bindings block
const keyPattern = /"([^"]+)"\s*:/g
const keysByName = new Map<string, number>()
let keyMatch
while ((keyMatch = keyPattern.exec(blockContent)) !== null) {
const key = keyMatch[1]
if (!key) continue
const count = (keysByName.get(key) ?? 0) + 1
keysByName.set(key, count)
if (count === 2) {
// Only warn on the second occurrence
warnings.push({
type: 'duplicate',
severity: 'warning',
message: `Duplicate key "${key}" in ${context} bindings`,
key,
context,
suggestion: `This key appears multiple times in the same context. JSON uses the last value, earlier values are ignored.`,
})
}
}
}
return warnings
}
/**
* Validate user keybinding config and return all warnings.
*/
export function validateUserConfig(userBlocks: unknown): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
if (!Array.isArray(userBlocks)) {
warnings.push({
type: 'parse_error',
severity: 'error',
message: 'keybindings.json must contain an array',
suggestion: 'Wrap your bindings in [ ]',
})
return warnings
}
for (let i = 0; i < userBlocks.length; i++) {
warnings.push(...validateBlock(userBlocks[i], i))
}
return warnings
}
/**
* Check for duplicate bindings within the same context.
* Only checks user bindings (not default + user merged).
*/
export function checkDuplicates(
blocks: KeybindingBlock[],
): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
const seenByContext = new Map<string, Map<string, string>>()
for (const block of blocks) {
const contextMap =
seenByContext.get(block.context) ?? new Map<string, string>()
seenByContext.set(block.context, contextMap)
for (const [key, action] of Object.entries(block.bindings)) {
const normalizedKey = normalizeKeyForComparison(key)
const existingAction = contextMap.get(normalizedKey)
if (existingAction && existingAction !== action) {
warnings.push({
type: 'duplicate',
severity: 'warning',
message: `Duplicate binding "${key}" in ${block.context} context`,
key,
context: block.context,
action: action ?? 'null (unbind)',
suggestion: `Previously bound to "${existingAction}". Only the last binding will be used.`,
})
}
contextMap.set(normalizedKey, action ?? 'null')
}
}
return warnings
}
/**
* Check for reserved shortcuts that may not work.
*/
export function checkReservedShortcuts(
bindings: ParsedBinding[],
): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
const reserved = getReservedShortcuts()
for (const binding of bindings) {
const keyDisplay = chordToString(binding.chord)
const normalizedKey = normalizeKeyForComparison(keyDisplay)
// Check against reserved shortcuts
for (const res of reserved) {
if (normalizeKeyForComparison(res.key) === normalizedKey) {
warnings.push({
type: 'reserved',
severity: res.severity,
message: `"${keyDisplay}" may not work: ${res.reason}`,
key: keyDisplay,
context: binding.context,
action: binding.action ?? undefined,
})
}
}
}
return warnings
}
/**
* Parse user blocks into bindings for validation.
* This is separate from the main parser to avoid importing it.
*/
function getUserBindingsForValidation(
userBlocks: KeybindingBlock[],
): ParsedBinding[] {
const bindings: ParsedBinding[] = []
for (const block of userBlocks) {
for (const [key, action] of Object.entries(block.bindings)) {
const chord = key.split(' ').map(k => parseKeystroke(k))
bindings.push({
chord,
action,
context: block.context,
})
}
}
return bindings
}
/**
* Run all validations and return combined warnings.
*/
export function validateBindings(
userBlocks: unknown,
_parsedBindings: ParsedBinding[],
): KeybindingWarning[] {
const warnings: KeybindingWarning[] = []
// Validate user config structure
warnings.push(...validateUserConfig(userBlocks))
// Check for duplicates in user config
if (isKeybindingBlockArray(userBlocks)) {
warnings.push(...checkDuplicates(userBlocks))
// Check for reserved/conflicting shortcuts - only check USER bindings
const userBindings = getUserBindingsForValidation(userBlocks)
warnings.push(...checkReservedShortcuts(userBindings))
}
// Deduplicate warnings (same key+context+type)
const seen = new Set<string>()
return warnings.filter(w => {
const key = `${w.type}:${w.key}:${w.context}`
if (seen.has(key)) return false
seen.add(key)
return true
})
}
/**
* Format a warning for display to the user.
*/
export function formatWarning(warning: KeybindingWarning): string {
const icon = warning.severity === 'error' ? '✗' : '⚠'
let msg = `${icon} Keybinding ${warning.severity}: ${warning.message}`
if (warning.suggestion) {
msg += `\n ${warning.suggestion}`
}
return msg
}
/**
* Format multiple warnings for display.
*/
export function formatWarnings(warnings: KeybindingWarning[]): string {
if (warnings.length === 0) return ''
const errors = warnings.filter(w => w.severity === 'error')
const warns = warnings.filter(w => w.severity === 'warning')
const lines: string[] = []
if (errors.length > 0) {
lines.push(
`Found ${errors.length} keybinding ${plural(errors.length, 'error')}:`,
)
for (const e of errors) {
lines.push(formatWarning(e))
}
}
if (warns.length > 0) {
if (lines.length > 0) lines.push('')
lines.push(
`Found ${warns.length} keybinding ${plural(warns.length, 'warning')}:`,
)
for (const w of warns) {
lines.push(formatWarning(w))
}
}
return lines.join('\n')
}
|