Show file location when querying bindings with bind#12221
Open
ritoban23 wants to merge 4 commits intofish-shell:masterfrom
Open
Show file location when querying bindings with bind#12221ritoban23 wants to merge 4 commits intofish-shell:masterfrom
ritoban23 wants to merge 4 commits intofish-shell:masterfrom
Conversation
krobelus
reviewed
Jan 3, 2026
|
|
||
| // Show where the binding was defined | ||
| if let Some(def_file) = definition_file { | ||
| out.push_str(" # defined in "); |
Contributor
There was a problem hiding this comment.
I guess this should be push_utfstr(wgettext!(...)) so it's translated
| }; | ||
| self.input_mappings | ||
| .add(key_seq, key_name_style, cmds, mode, sets_mode, user); | ||
| let definition_file = parser.current_filename(); |
Contributor
There was a problem hiding this comment.
Looking at some example output
bind --preset \; self-insert expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
bind --preset \| self-insert expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
bind --preset \& self-insert expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
bind --preset \> self-insert expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
bind --preset \< self-insert expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
...
bind --preset shift-enter 'commandline -i \\n (commandline --search-field >/dev/null && echo --search-field)' expand-abbr # defined in embedded:functions/__fish_shared_key_bindings.fish
...
bind --preset alt-backspace 'if fish_in_macos_terminal; commandline -f backward-kill-word; else commandline -f backward-kill-token; end' # defined in embedded:functions/__fish_per_os_bind.fish
I notice that
- there's a lot of noisy repetition
- the file names are private implementation files (denoted by the leading
__),
which we should avoid exposing to the user. - the __fish_per_os_bind.fish is a helper file that's called from default/shared key bindings
I'm not sure yet what we should do, but
- to address 1, we could group bindings by filename, and on
# Defined in embedded:functions/fish_default_key_bindings.fish
bind --preset \; self-insert expand-abbr
bind --preset \| self-insert expand-abbr
bind --preset \& self-insert expand-abbr
bind --preset \> self-insert expand-abbr
bind --preset \< self-insert expand-abbr
# Defined in ~/.config/fish/config.fish
bind ...
i'm not yet sure if that messes with semantics;
historically we list bindings in definition order but
IIRC that order is not used to determine priority at all.
So that should be fine..
- to address 2 and 3, we could maybe rework the way our default bindings work.
For example we could have__fish_shared_key_bindingsonly outputbindcommands,
and then havefish_default_key_bindings.fishandfish_vi_key_bindings.fishcalleval "$(__fish_shared_key_bindings)".
| self.opts.sets_bind_mode.to_owned(), | ||
| self.opts.user, | ||
| parser, | ||
| streams, |
Contributor
There was a problem hiding this comment.
(unrelated: parser and streams should be the first two arguments like for the top-level builtin functions)
| } | ||
|
|
||
| // Like add(), but takes a single command. | ||
| #[allow(clippy::too_many_arguments)] |
Contributor
There was a problem hiding this comment.
FWIW every commit should ideally pass all tests & lints, so squash these commits if possible
| bind | string match -v '*\e\\[*' # Hide raw bindings. | ||
| bind --user --preset | string match -v '*\e\\[*' | ||
| bind | string match -v '*\e\\[*' | string replace -r ' # defined in .*' '' # Hide raw bindings. | ||
| bind --user --preset | string match -v '*\e\\[*' | string replace -r ' # defined in .*' '' |
Contributor
There was a problem hiding this comment.
rather than repeating the same string replace command everywhere,
how about extracting a function to
tests/test_functions/test-bind.fish or tests/test_functions/bind-list.fish
that does it by default, for brevity?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR enhances the
bindbuiltin to display the file in which a key binding was defined when querying existing bindings, similar to howfunctions -qandtypeshow the definition location.definition_filefield to theInputMappingstruct to track the source file for each binding.bindoutput to append# defined in <filename>when a binding was created from a file.Fixes issue #12215
TODOs: