Commit `1d5593eadf`

1d5593eadf032a1cc3c0eb3230ceecd7e4fc151c

parent: 36627fe7d3

Verified · cmc

cmc <hello@cleberg.net> · 2026-10-08 03:37 UTC

Report unknown keymap modes and commands

A binding whose mode isn't normal, insert or visual, or whose command
the editor doesn't have, is skipped and listed in the load problems.

Layout: unified · split

Sources/OrgApp/KeymapLoader.swift +4 −3

     public static var userFile: URL { UserConfig.file("keymap.toml") }
     /// The preset with the user's file on top, and the problems found in the file. A missing
-    /// file adds nothing; a file that isn't valid TOML adds nothing and is reported.
+    /// file adds nothing; a file that isn't valid TOML adds nothing and is reported. With
-    public static func load(_ preset: KeymapPreset, userFile: URL = userFile) -> (keymap: Keymap, problems: [String]) {
+    /// `commands`, bindings of other command ids are reported and skipped.
+    public static func load(_ preset: KeymapPreset, userFile: URL = userFile, commands: Set<String>? = nil) -> (keymap: Keymap, problems: [String]) {
         guard let text = try? String(contentsOf: userFile, encoding: .utf8) else { return (preset.keymap, []) }
         var problems: [String] = []
         do {
-            let user = try Keymap(toml: text, problems: &problems)
+            let user = try Keymap(toml: text, problems: &problems, commands: commands)
             return (.layered([preset.keymap, user]), problems)
         } catch {
             return (preset.keymap, ["\(error)"])

Sources/OrgCore/Keymap/Keymap.swift +16 −3

     }
     public var unbinds: Bool { command == "none" }
+    /// Modal states a binding's `mode` can name.
+    public static let modes: Set<String> = ["normal", "insert", "visual"]
 }
 /// Bindings in priority order: later bindings win over earlier ones for the same keys.
     }
     /// Reads `[[bind]]` tables. Entries that can't be used are skipped and reported in
-    /// `problems`; a file that isn't valid TOML throws.
+    /// `problems`; a file that isn't valid TOML throws. With `commands`, a command id outside
-    public init(toml: String, problems: inout [String]) throws {
+    /// it (other than `none`) is such an entry.
+    public init(toml: String, problems: inout [String], commands: Set<String>? = nil) throws {
         bindings = []
         for table in try TOML.parse(toml) where !(table.name.isEmpty && table.values.isEmpty) {
             guard table.name == "bind", table.isArrayElement else {
                 problems.append("line \(table.line): missing command")
                 continue
             }
+            if let commands, command != "none", !commands.contains(command) {
+                problems.append("line \(table.line): unknown command \(command)")
+                continue
+            }
             let when = table.values["when"]?.string
             if let when, !KeyContext.names.contains(when) {
                 problems.append("line \(table.line): unknown context \(when)")
                 continue
             }
-            bindings.append(KeyBinding(keys: keys, command: command, when: when, mode: table.values["mode"]?.string))
+            let mode = table.values["mode"]?.string
+            if let mode, !KeyBinding.modes.contains(mode) {
+                problems.append("line \(table.line): unknown mode \(mode)")
+                continue
+            }
+            bindings.append(KeyBinding(keys: keys, command: command, when: when, mode: mode))
         }
     }

Sources/Orgstar/ContentView.swift +1 −1

	@@ -498,7 +498,7 @@ struct ContentView: View {
498	}	498	}
499		499
500	private func loadKeymap() {	500	private func loadKeymap() {
501	let loaded = KeymapLoader.load(preset)	501	let loaded = KeymapLoader.load(preset, commands: Set(EditorCommands.all.map(\.id)))
502	keymap = loaded.keymap	502	keymap = loaded.keymap
503	commands.keymap = loaded.keymap	503	commands.keymap = loaded.keymap
504	commands.modal = preset.isModal	504	commands.modal = preset.isModal

Tests/OrgCoreTests/KeymapTests.swift +27

	@@ -71,6 +71,33 @@ struct KeymapTests {
71	#expect(problems.count == 3)	71	#expect(problems.count == 3)
72	}	72	}
73		73
		74	@Test func reportsUnknownModesAndCommands() throws {
		75	var problems: [String] = []
		76	let keymap = try Keymap(toml: """
		77	[[bind]]
		78	keys = "g x"
		79	command = "org.todo.cycle"
		80	mode = "visual-line"
		81	[[bind]]
		82	keys = "g y"
		83	command = "org.todo.cycel"
		84	mode = "normal"
		85	[[bind]]
		86	keys = "g z"
		87	command = "none"
		88	mode = "visual"
		89	[[bind]]
		90	keys = "C-c x"
		91	command = "org.todo.cycle"
		92	""", problems: &problems, commands: ["org.todo.cycle"])
		93	#expect(problems == ["line 1: unknown mode visual-line", "line 5: unknown command org.todo.cycel"])
		94	#expect(keymap.bindings.map(\.command) == ["none", "org.todo.cycle"])
		95	// Without a command list, ids aren't checked.
		96	problems = []
		97	_ = try Keymap(toml: "[[bind]]\nkeys = \"x\"\ncommand = \"anything\"\nmode = \"insert\"\n", problems: &problems)
		98	#expect(problems.isEmpty)
		99	}
		100
74	@Test func laterLayersWinAndCanUnbind() throws {	101	@Test func laterLayersWinAndCanUnbind() throws {
75	let preset = KeymapPreset.emacs.keymap	102	let preset = KeymapPreset.emacs.keymap
76	let (user, _) = try map("""	103	let (user, _) = try map("""

Tests/OrgEditorAppKitTests/ModalTests.swift +12

	@@ -160,3 +160,15 @@ struct ModalTests {
160	#expect(h.textView.selectedRange().location == 23)	160	#expect(h.textView.selectedRange().location == 23)
161	}	161	}
162	}	162	}
		163
		164	struct PresetCommandTests {
		165	/// Every command a preset binds is one the editor runs, and every mode is a state.
		166	@Test func presetsBindKnownCommands() throws {
		167	let known = Set(EditorCommands.all.map(\.id))
		168	for preset in KeymapPreset.allCases {
		169	var problems: [String] = []
		170	_ = try Keymap(toml: preset.toml, problems: &problems, commands: known)
		171	#expect(problems.isEmpty, "\(preset): \(problems)")
		172	}
		173	}
		174	}

Commit 1d5593eadf

Commit `1d5593eadf`