diff --git a/AGENTS.md b/AGENTS.md index a039d59..df186d6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,7 +12,7 @@ - Bestehende Features dürfen nicht unbemerkt geändert oder ersetzt werden. - 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. + - Änderungen und/oder Erweiterungen müssen **immer** die `:help`-Dokumentation, die README.md und die `quick-help`-Ansicht (via `?`) automatisch aktualisieren. - Sprache der Hilfe ist wie die README.md immer **englisch**. ## Projektziel diff --git a/README.md b/README.md index b441a6f..c734bc8 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,7 @@ If no runner matches the current test file, test-samurai will show: - `TSamLast` -> `tl` - `TSamFailedOnly` -> `te` - `TSamShowOutput` -> `to` +- Help: `:help test-samurai` Additional keymaps: diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..d4194e9 --- /dev/null +++ b/doc/tags @@ -0,0 +1,9 @@ +test-samurai test-samurai.txt /*test-samurai* +test-samurai-commands test-samurai.txt /*test-samurai-commands* +test-samurai-default-keys test-samurai.txt /*test-samurai-default-keys* +test-samurai-quickhelp test-samurai.txt /*test-samurai-quickhelp* +test-samurai-req test-samurai.txt /*test-samurai-req* +test-samurai-runners test-samurai.txt /*test-samurai-runners* +test-samurai-setup test-samurai.txt /*test-samurai-setup* +test-samurai-ui test-samurai.txt /*test-samurai-ui* +test-samurai.txt test-samurai.txt /*test-samurai.txt* diff --git a/doc/test-samurai.txt b/doc/test-samurai.txt new file mode 100644 index 0000000..74e8406 --- /dev/null +++ b/doc/test-samurai.txt @@ -0,0 +1,83 @@ +*test-samurai.txt* Run tests with a unified UX + +INTRODUCTION *test-samurai* + +Test Samurai provides a unified UX to run tests across languages +and frameworks, backed by an extensible runner architecture. + + +REQUIREMENTS *test-samurai-req* + +Neovim 0.11.4 or later is required. + + +SETUP *test-samurai-setup* + +This plugin ships without built-in runners. Configure runner modules +in your setup so test commands and keymaps work properly: + +> + require("test-samurai").setup({ + runner_modules = { + "my-runners.go", + "my-runners.js", + }, + }) +< + + +COMMANDS *test-samurai-commands* + +:TSamNearest Run the nearest test. +:TSamFile Run all tests in the current file. +:TSamAll Run all tests in the project. +:TSamLast Re-run the last test command. +:TSamFailedOnly Re-run only previously failed tests. +:TSamShowOutput Reopen the Testing-Float output window. + + +DEFAULT KEYMAPS *test-samurai-default-keys* + +TSamNearest tn +TSamFile tf +TSamAll ta +TSamLast tl +TSamFailedOnly te +TSamShowOutput to + + +QUICK-HELP & FLOATS *test-samurai-quickhelp* + +In the Testing-Float, press ? to open the quick-help in the Detail-Float. + +Additional keymaps: + qn Close floats + jump to the first quickfix entry + nf Next [ FAIL ] in listing + pf Previous [ FAIL ] in listing + o Jump to test location + z Toggle Detail-Float full width + Focus Detail-Float (press l again for full) + Focus Test-Listing-Float + Close Testing-Float + Close Detail-Float (when focused) + + +OUTPUT UI *test-samurai-ui* + +Testing-Float: container floating window for output. +Test-Listing-Float: left subwindow listing test results. +Detail-Float: right subwindow showing detailed output for a test. + +After running a test command, the UI opens in listing mode (only the +Test-Listing-Float is visible). Press on a [ FAIL ] entry to open +the Detail-Float with a 20/80 split. ANSI colors are translated only +inside the Detail-Float. + + +RUNNER ARCHITECTURE *test-samurai-runners* + +Runners are standalone Lua modules that implement the full interface. +See README.md for the required functions and runner guidelines. + +============================================================================== +vim:ft=help