User keybindings not respected

[oaahmad]

Summary

I can't use my configured keybindings.

Description

I have defined some keybindings. Here is my ~/.config/zed/keymap.json file:

[
  {
    "context": "Workspace",
    "bindings": {
      "cmd-enter": "command_palette::Toggle"
    }
  },
  {
    "bindings": {
      "cmd-right": "editor::GoToNextChange"
    }
  },
  {
    "bindings": {
      "cmd-left": "editor::GoToPreviousChange"
    }
  }
]

None of those keybindings function. For example, typing cmd-enter adds a line to the open document instead of opening the command palette.

I am using a stable release of Zed:

Zed 0.197.5 
c0f25b7549c8c0e9cec95e7475e17e8475b11921

I am on a MacBook Pro with Apple Silicon.

Steps to reproduce:

1. Replace the contents of ~/.config/zed/keymap.json with the above JSON
2. Open any Zed window
3. Type cmd-enter

Expected Behavior:
The command palette opens.

Actual Behavior:
A line is entered into the document.

Zed Version and System Specs

Zed: v0.197.5 (Zed)
OS: macOS 15.6.0
Memory: 16 GiB
Architecture: aarch64

[oaahmad]

I don't know if this is a regression or not because I just started using Zed

[bmurgic]

I can second this. I am trying to change the keybindings through the menus, and if I delete or change a keybinding the old one is still there. When deleting it creates a null action with the deleted keybinding and the old one is still there.

[notpeter]

Hi folks,

The keymap editor is a new feature that may not (yet) current reflect the complexity of remapping keys in Zed. Here is some documentation: https://zed.dev/docs/key-bindings

Three things you can spaw from the command palette (cmd-shift-p) which might help:

• zed: open default keymap (json of the default keymap)
• zed: open keymap (json of your user keymap)
• dev: open key context view

@oaahmad The context for your keybinds is not specific enough, so there are keybinds with more specific context which are taking precedence.

For example:

  {
    "context": "Editor && mode == full",
    "bindings": {
      "cmd-right": "editor::GoToNextChange"
    }
  },
  {
    "context": "Editor && mode == full",
    "bindings": {
      "cmd-left": "editor::GoToPreviousChange"
    }
  },

cmd-enter is a bit harder but maybe this:

  {"bindings": {"cmd-enter": "command_palette::Toggle"}},
  {"context": "Editor && mode == full", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "BufferSearchBar && in_replace > Editor", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "ProjectSearchBar && in_replace > Editor", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "ProjectSearchBar && !in_replace", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "GitDiff > Editor", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "CommitEditor > Editor", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "GitPanel", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "GitCommit > Editor", "bindings": { "cmd-enter": "command_palette::Toggle" }},
  {"context": "ConfigureContextServerModal > Editor","bindings": { "cmd-enter": "command_palette::Toggle" }},

[oaahmad]

Thank you for taking the time to come up with these settings, and for linking to the docs.

If no "context" is set the bindings are always active.

I should have read the docs before. If I get rid of context completely, it just works (so I don't need to specify every case).

For the go to next / previous change command, it would be nice if it wrapped around when you got to the first / last change (eg. the GoToNextChange command would go to the first change if you are on the last change), but I guess that's a separate issue / feature request.

[feraxhp]

@oaahmad i think is is related to an issue with the base default keymap, because when i try to change some keymap in the base keymap that has no context, it overides any keymap i create with some context, because of the precedence.

[notpeter]

Also wanted to mention I also discovered the new Keymap Editor has a "Show Matching Keybinding" (cmd-t) which can make it easier to see the potential conflicts and things in the default keymaps which you might have to override.

It's still a bit of a PITA, especially for something with as many binds as cmd-enter but it definitely it better than just trial and error searching the default json.