Add string array support to open_mapping setting.
#557
Conversation
This file contains 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
akinsho
requested changes
Apr 19, 2024
README.md
Outdated
| @@ -126,7 +126,7 @@ I'm also going to be pretty conservative about what I add. | |||
|
|
|||
| This plugin must be explicitly enabled by using `require("toggleterm").setup{}` | |||
|
|
|||
| Setting the `open_mapping` key to use for toggling the terminal(s) will set up mappings for _normal_ mode. | |||
| Setting the `open_mapping` key to use for toggling the terminal(s) will set up mappings for _normal_ mode. The `open_mappint` can be a key string or an array of key strings. | |||
There was a problem hiding this comment.
Suggested change
| Setting the `open_mapping` key to use for toggling the terminal(s) will set up mappings for _normal_ mode. The `open_mappint` can be a key string or an array of key strings. | |
| Setting the `open_mapping` key to use for toggling the terminal(s) will set up mappings for _normal_ mode. The `open_mapping` can be a key string or an array of key strings. |
doc/toggleterm.txt
Outdated
| last toggled terminal will be opened. In case there are multiple terminals | ||
| opened they’ll all be closed, and on the next mapping key they’ll be | ||
| restored. | ||
| mappings for _normal_ mode. The `open_mappint` can be a key string or an array |
There was a problem hiding this comment.
Suggested change
| mappings for _normal_ mode. The `open_mappint` can be a key string or an array | |
| mappings for _normal_ mode. The `open_mapping` can be a key string or an array |
lua/toggleterm.lua
Outdated
|
|
||
| -- Key mapping function | ||
| ---@param key string | ||
| local map = function(key) |
There was a problem hiding this comment.
I prefer the style
Suggested change
| local map = function(key) | |
| local function map(key) |
lua/toggleterm.lua
Outdated
| desc = "Toggle Terminal", | ||
| silent = true, | ||
| }) | ||
| end | ||
| end | ||
|
|
||
| if type(mapping) == "string" then map(mapping) end |
There was a problem hiding this comment.
Although it's impossible (🤞🏾) I'd rather this was an if then else if I feel uncomfortable with the idea that it could possible fall into the next clause even though it can't
lua/toggleterm/terminal.lua
Outdated
Comment on lines
135
to
148
|
|
||
| -- Key mapping function | ||
| ---@param key string | ||
| local map = function(key) | ||
| vim.keymap.set("t", key, "<Cmd>ToggleTerm<CR>", { buffer = bufnr, silent = true }) | ||
| end | ||
|
|
||
| if config.terminal_mappings then | ||
| if type(mapping) == "string" then map(mapping) end | ||
| if type(mapping) == "table" then | ||
| for _, key in pairs(mapping) do | ||
| map(key) | ||
| end | ||
| end |
There was a problem hiding this comment.
Looks to me like this logic is just being repeated maybe it's best to do this once in utils.lua generically and use that helper function in both of the places you've made this change
|
@akinsho |
akinsho
approved these changes
Apr 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I sometime use a Japanese keyboard, and it don't have the
\key, instead it have a¥key.It would be helpful for people like me who what to bind multiple keys for toggle terminal. So I modified the
open_mappingsetting to also take an array of string as parameter.