Skip to content

Commit

Permalink
Merge pull request #25 from jonarrien/refactor/run-selection
Browse files Browse the repository at this point in the history
refactor: use enter to pick completion element
  • Loading branch information
jonarrien authored Oct 12, 2024
2 parents 1c6a169 + bbcf630 commit cc739b1
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 17 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,39 +77,43 @@ You can customise cmdline settings in telescope configuration.

```lua
require("telescope").setup({
...
-- ...
extensions = {
cmdline = {
-- Adjust telescope picker size and layout
picker = {
layout_config = {
width = 120,
height = 25,
}
},
-- Adjust your mappings
mappings = {
complete = '<Tab>',
run_selection = '<C-CR>',
run_input = '<CR>',
},
-- Triggers any shell command using overseer.nvim (`:!`)
overseer = {
enabled = true,
},
},
}
...
-- ...
})
```

> Default configuration can be found in `lua/cmdline/config.lua` file.
## Mappings

- `<CR>` Run user input if entered, otherwise run first selection
- `<CR>` Runs selected command from completion, otherwise runs user input
- `<TAB>` complete current selection into input (useful for :e, :split, :vsplit, :tabnew)
- `<C-CR>`Run selection directly
- `<C-e>` edit current selection in prompt

Cmdline can be executed using `:Telescope cmdline<CR>`, but it doesn't
include any mapping by default. Normally I use ':' to trigger it, but
it's true there are some caveats or edge cases.

include any mapping by default. Normally I suggest using ':' to
trigger it, but it's true there are some caveats or edge cases.
Please, configure the mapping which suits best for you:

```lua
Expand Down
17 changes: 13 additions & 4 deletions lua/cmdline/actions.lua
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ local run = function(cmd)
end

-- System command
if config.values.overseer.enabled and string.sub(cmd, 1, 1) == '!' then
vim.api.nvim_exec2('OverseerRunCmd ' .. cmd:sub(2), {})
vim.api.nvim_exec2('OverseerOpen', {})
if string.sub(cmd, 1, 1) == '!' then
if config.values.overseer.enabled then
vim.api.nvim_exec2('OverseerRunCmd ' .. cmd:sub(2), {})
vim.api.nvim_exec2('OverseerOpen', {})
else
vim.cmd.split("term://" .. cmd:sub(2))
end
return
end

-- Run command and get output
local data = vim.api.nvim_exec2(cmd, { output = true })
local executed, data = pcall(vim.api.nvim_exec2, cmd, { output = true })
if not executed then
vim.notify('Error executing command: ' .. cmd, vim.log.levels.ERROR, {})
return
end
-- local data = vim.api.nvim_exec2(cmd, { output = true })
local output = data.output

-- Skip output on silent or custom commands
Expand Down
6 changes: 3 additions & 3 deletions lua/cmdline/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ local defaults = {
},
mappings = {
complete = '<Tab>',
run_selection = '<C-CR>',
run_input = '<CR>',
run_selection = '<CR>',
run_input = '<C-CR>',
},
overseer = {
enabled = true,
enabled = false,
},
output_pane = {
enabled = false,
Expand Down
10 changes: 7 additions & 3 deletions lua/telescope/_extensions/cmdline.lua
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,14 @@ local make_picker = function(opts)
finder = make_finder(config),
sorter = sorter(opts),
attach_mappings = function(_, map)
map("i", config.mappings.complete, action.complete_input) -- <Tab>
map("i", config.mappings.run_input, action.run_input) -- <CR>
map("i", config.mappings.run_selection, action.run_selection) -- <C-CR>
-- Autocomplete using <Tab>
map("i", config.mappings.complete, action.complete_input)
-- Run selection with <CR>
map("i", config.mappings.run_selection, action.run_selection)
-- Run command from input field with <C-CR> (special cases) ??
map("i", config.mappings.run_input, action.run_input)
map("i", "<C-e>", action.edit)

require("telescope.actions").close:enhance {
post = function()
cmdline.preview.clean(vim.api.nvim_win_get_buf(0))
Expand Down

0 comments on commit cc739b1

Please sign in to comment.