add quick help within detail-float

This commit is contained in:
2026-01-07 17:19:29 +01:00
parent 4c2d585f2d
commit e9a7d2029b
4 changed files with 152 additions and 0 deletions

View File

@@ -11,6 +11,9 @@
- **Keine stillen Änderungen**: - **Keine stillen Änderungen**:
- Bestehende Features dürfen nicht unbemerkt geändert oder ersetzt werden. - Bestehende Features dürfen nicht unbemerkt geändert oder ersetzt werden.
- Notwendige Anpassungen zur Koexistenz mehrerer Features müssen klar erkennbar sein. - Notwendige Anpassungen zur Koexistenz mehrerer Features müssen klar erkennbar sein.
- **Hilfe-Ansicht aktuell halten**:
- Änderungen und/oder Erweiterungen müssen **immer** die neue Hilfe-Ansicht automatisch aktualisieren.
- Sprache der Hilfe ist wie die README.md immer **englisch**.
## Projektziel ## Projektziel
- Neovim Plugin: **test-samurai** - Neovim Plugin: **test-samurai**

View File

@@ -65,6 +65,7 @@ Additional keymaps:
- `<leader>qn` -> close the testing floats and jump to the first quickfix entry - `<leader>qn` -> close the testing floats and jump to the first quickfix entry
- `<leader>nf` -> jump to the next `[ FAIL ]` entry in the Test-Listing-Float (wraps to the first) - `<leader>nf` -> jump to the next `[ FAIL ]` entry in the Test-Listing-Float (wraps to the first)
- `<leader>pf` -> jump to the previous `[ FAIL ]` entry in the Test-Listing-Float (wraps to the last) - `<leader>pf` -> jump to the previous `[ FAIL ]` entry in the Test-Listing-Float (wraps to the last)
- `?` -> show help with TSam commands and standard keymaps in the Detail-Float
## Output UI ## Output UI

View File

@@ -43,6 +43,43 @@ local function disable_container_maps(buf)
vim.keymap.set("n", "<C-k>", "<Nop>", opts) vim.keymap.set("n", "<C-k>", "<Nop>", opts)
end end
local function help_lines()
return {
"Test-Samurai Help",
"",
"TSam Commands:",
" TSamNearest <leader>tn",
" TSamFile <leader>tf",
" TSamAll <leader>ta",
" TSamLast <leader>tl",
" TSamFailedOnly <leader>te",
" TSamShowOutput <leader>to",
"",
"Standard Keymaps:",
" <leader>qn Close floats + jump to first quickfix entry",
" <leader>nf Next [ FAIL ] in listing",
" <leader>pf Previous [ FAIL ] in listing",
"",
"Testing-Float (Listing):",
" <cr> Open Detail-Float for selected test",
" <esc><esc> Close Testing-Float",
" <C-l> Focus Detail-Float (press l again for full)",
" <C-h> Focus Test-Listing-Float",
" <leader>z Toggle Detail-Float full width",
" <leader>o Jump to test location",
" ? Show this help",
"",
"Testing-Float (Detail):",
" <esc><esc> Close Testing-Float",
" <C-h> Focus Test-Listing-Float",
" <C-w>h Focus Test-Listing-Float",
" <C-l> Focus Detail-Float",
" <leader>z Toggle Detail-Float full width",
" <C-c> Close Detail-Float",
" ? Show this help",
}
end
local function get_hardtime() local function get_hardtime()
local ok, hardtime = pcall(require, "hardtime") local ok, hardtime = pcall(require, "hardtime")
if not ok or type(hardtime) ~= "table" then if not ok or type(hardtime) ~= "table" then
@@ -626,6 +663,9 @@ local function create_output_win(initial_lines)
vim.keymap.set("n", "<leader>qn", function() vim.keymap.set("n", "<leader>qn", function()
jump_to_first_quickfix() jump_to_first_quickfix()
end, { buffer = buf, nowait = true, silent = true }) end, { buffer = buf, nowait = true, silent = true })
vim.keymap.set("n", "?", function()
M.show_help()
end, { buffer = buf, nowait = true, silent = true })
disable_container_maps(buf) disable_container_maps(buf)
state.last_win = listing state.last_win = listing
@@ -690,6 +730,9 @@ local function reopen_output_win()
vim.keymap.set("n", "<leader>qn", function() vim.keymap.set("n", "<leader>qn", function()
jump_to_first_quickfix() jump_to_first_quickfix()
end, { buffer = state.last_buf, nowait = true, silent = true }) end, { buffer = state.last_buf, nowait = true, silent = true })
vim.keymap.set("n", "?", function()
M.show_help()
end, { buffer = state.last_buf, nowait = true, silent = true })
disable_container_maps(state.last_buf) disable_container_maps(state.last_buf)
state.last_win = win state.last_win = win
@@ -1005,6 +1048,9 @@ local function ensure_detail_buf(lines)
vim.keymap.set("n", "<leader>qn", function() vim.keymap.set("n", "<leader>qn", function()
jump_to_first_quickfix() jump_to_first_quickfix()
end, { buffer = buf, nowait = true, silent = true }) end, { buffer = buf, nowait = true, silent = true })
vim.keymap.set("n", "?", function()
M.show_help()
end, { buffer = buf, nowait = true, silent = true })
disable_container_maps(buf) disable_container_maps(buf)
end end
local clean_lines, highlights = parse_ansi_lines(normalize_output_lines(lines)) local clean_lines, highlights = parse_ansi_lines(normalize_output_lines(lines))
@@ -1133,6 +1179,14 @@ function M.open_test_output_at_cursor()
open_detail_split(output, border_kind) open_detail_split(output, border_kind)
end end
function M.show_help()
if not (state.last_win and vim.api.nvim_win_is_valid(state.last_win)) then
vim.notify("[test-samurai] No test output window", vim.log.levels.WARN)
return
end
open_detail_split(help_lines(), "default")
end
function M.focus_listing() function M.focus_listing()
if state.last_win and vim.api.nvim_win_is_valid(state.last_win) then if state.last_win and vim.api.nvim_win_is_valid(state.last_win) then
if state.detail_win and vim.api.nvim_win_is_valid(state.detail_win) then if state.detail_win and vim.api.nvim_win_is_valid(state.detail_win) then

View File

@@ -148,4 +148,98 @@ describe("test-samurai core (no bundled runners)", function()
assert.equals(1, #last) assert.equals(1, #last)
assert.equals("TestA", last[1].text) assert.equals("TestA", last[1].text)
end) end)
it("shows help with TSam commands and keymaps in the detail float", function()
local runner = {
name = "test-runner-help",
}
function runner.is_test_file(_bufnr)
return true
end
function runner.find_nearest(bufnr, _row, _col)
return { file = vim.api.nvim_buf_get_name(bufnr), cwd = vim.loop.cwd(), test_name = "TestA" }
end
function runner.build_command(spec)
return { cmd = { "echo", "nearest" }, cwd = spec.cwd }
end
function runner.build_file_command(_bufnr)
return { cmd = { "echo", "file" } }
end
function runner.build_all_command(_bufnr)
return { cmd = { "echo", "all" } }
end
function runner.build_failed_command(last_command, _failures, _scope_kind)
return { cmd = { "echo", "failed" }, cwd = last_command and last_command.cwd or nil }
end
function runner.parse_results(_output)
return { passes = {}, failures = {}, skips = {} }
end
function runner.output_parser()
return {
on_line = function(_line, _state)
return nil
end,
on_complete = function(output, _state)
return runner.parse_results(output)
end,
}
end
function runner.parse_test_output(_output)
return {}
end
function runner.collect_failed_locations(_failures, _command, _scope_kind)
return {}
end
package.loaded["test-samurai-help-runner"] = runner
test_samurai.setup({ runner_modules = { "test-samurai-help-runner" } })
local bufnr = vim.api.nvim_create_buf(false, true)
vim.api.nvim_buf_set_name(bufnr, "/tmp/test_samurai_help.go")
vim.bo[bufnr].filetype = "go"
vim.api.nvim_set_current_buf(bufnr)
local orig_jobstart = vim.fn.jobstart
vim.fn.jobstart = function(_cmd, opts)
if opts.on_exit then
opts.on_exit(nil, 0, nil)
end
return 1
end
core.run_nearest()
local listing_buf = vim.api.nvim_get_current_buf()
local maps = vim.api.nvim_buf_get_keymap(listing_buf, "n")
local has_help = false
for _, map in ipairs(maps) do
if map.lhs == "?" then
has_help = true
break
end
end
assert.is_true(has_help)
core.show_help()
local detail_buf = vim.api.nvim_get_current_buf()
local lines = vim.api.nvim_buf_get_lines(detail_buf, 0, -1, false)
local joined = table.concat(lines, "\n")
assert.is_true(joined:find("TSamNearest", 1, true) ~= nil)
assert.is_true(joined:find("TSamShowOutput", 1, true) ~= nil)
assert.is_true(joined:find("<leader>tn", 1, true) ~= nil)
assert.is_true(joined:find("<leader>to", 1, true) ~= nil)
vim.fn.jobstart = orig_jobstart
end)
end) end)