BREAKING: Rename focus_location -> peek_location

Avoids confusion with other uses of 'focus'.
This commit is contained in:
hedy
2023-11-02 21:13:30 +08:00
parent f8c1ff33e3
commit fe98a8cf8a
3 changed files with 15 additions and 6 deletions

View File

@@ -30,6 +30,9 @@ I do not merge PRs from the original repo that I don't personally need.
## 🛑 Breaking changes ## 🛑 Breaking changes
- **Config**: `keymaps.focus_location` -> `keymaps.peek_location` to avoid
confusion with focus window commands.
- **Behaviour**: Removed hover floating window from `toggle_preview`. - **Behaviour**: Removed hover floating window from `toggle_preview`.
- Instead, you can set `open_hover_on_preview=true` (true by default) so that - Instead, you can set `open_hover_on_preview=true` (true by default) so that
the `hover_symbol` action can be triggered when `toggle_preview`is the `hover_symbol` action can be triggered when `toggle_preview`is
@@ -274,7 +277,8 @@ require("symbols-outline").setup({})
- **Node**: An item in the outline view - **Node**: An item in the outline view
- **Fold**: Collapse a collapsible node - **Fold**: Collapse a collapsible node
- **Location**: Where in the source file a node is from - **Location**: Where in the source file a node is from
- **Preview**: Peek the location of a node in code using a floating window - **Preview**: Show the location of a node in code using a floating window
- **Peek**: Go to corresponding location in code without leaving outline window
- **Hover**: Cursor currently on the line of a node - **Hover**: Cursor currently on the line of a node
- **Hover symbol**: Displaying a floating window to show symbol information - **Hover symbol**: Displaying a floating window to show symbol information
provided by provider. provided by provider.
@@ -320,7 +324,7 @@ local opts = {
border = 'single', border = 'single',
-- Behaviour changed in this fork: -- Behaviour changed in this fork:
-- Auto close the outline window if goto_location is triggered and not for -- Auto close the outline window if goto_location is triggered and not for
-- focus_location -- peek_location
auto_close = false, auto_close = false,
-- Vim options for the outline window -- Vim options for the outline window
@@ -355,8 +359,9 @@ local opts = {
-- It can auto close the outline window when triggered, see -- It can auto close the outline window when triggered, see
-- 'auto_close' option above. -- 'auto_close' option above.
goto_location = "<Cr>", goto_location = "<Cr>",
-- Jump to symbol under cursor but keep focus on outline window -- Jump to symbol under cursor but keep focus on outline window.
focus_location = "o", -- Renamed in this fork!
peek_location = "o",
hover_symbol = "<C-space>", hover_symbol = "<C-space>",
-- Preview symbol under cursor -- Preview symbol under cursor
toggle_preview = "K", toggle_preview = "K",

View File

@@ -259,9 +259,13 @@ local function setup_keymaps(bufnr)
M._goto_location(true) M._goto_location(true)
end) end)
-- goto_location of symbol but stay in outline -- goto_location of symbol but stay in outline
map(config.options.keymaps.focus_location, function() map(config.options.keymaps.peek_location, function()
M._goto_location(false) M._goto_location(false)
end) end)
-- -- goto_location of symbol but stay in outline
-- map(config.options.keymaps.down_and_goto, function()
-- M._move_and_goto(false)
-- end)
-- hover symbol -- hover symbol
map( map(
config.options.keymaps.hover_symbol, config.options.keymaps.hover_symbol,

View File

@@ -35,7 +35,7 @@ M.defaults = {
show_help = '?', show_help = '?',
close = { '<Esc>', 'q' }, close = { '<Esc>', 'q' },
goto_location = '<Cr>', goto_location = '<Cr>',
focus_location = 'o', peek_location = 'o',
hover_symbol = '<C-space>', hover_symbol = '<C-space>',
toggle_preview = 'K', toggle_preview = 'K',
rename_symbol = 'r', rename_symbol = 'r',