aboutsummaryrefslogtreecommitdiff
path: root/test/functional/ui/screen.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-01-21 12:21:56 +0100
committerGitHub <noreply@github.com>2017-01-21 12:21:56 +0100
commit10864cd93920715dd7251fd160d6056135cebdaf (patch)
tree029055071cb87bbbf6b56fe5803e751c8fa6ec97 /test/functional/ui/screen.lua
parent030349d85239421fb44f00e01b833d2a12cfd40a (diff)
parentef753a76b95425e22638005f813cb2f22c6a0cfc (diff)
downloadrneovim-10864cd93920715dd7251fd160d6056135cebdaf.tar.gz
rneovim-10864cd93920715dd7251fd160d6056135cebdaf.tar.bz2
rneovim-10864cd93920715dd7251fd160d6056135cebdaf.zip
Merge #5977 from justinmk/tui-cursor-shape
tui: enable NVIM_TUI_ENABLE_CURSOR_SHAPE by default
Diffstat (limited to 'test/functional/ui/screen.lua')
-rw-r--r--test/functional/ui/screen.lua11
1 files changed, 7 insertions, 4 deletions
diff --git a/test/functional/ui/screen.lua b/test/functional/ui/screen.lua
index ef1f0783e7..bb82f11a58 100644
--- a/test/functional/ui/screen.lua
+++ b/test/functional/ui/screen.lua
@@ -68,7 +68,8 @@
-- })
-- screen:set_default_attr_ignore( {{}, {bold=true, foreground=NonText}} )
--
--- To help write screen tests, see screen:snapshot_util().
+-- To help write screen tests, see Screen:snapshot_util().
+-- To debug screen tests, see Screen:redraw_debug().
local helpers = require('test.functional.helpers')(nil)
local request, run, uimeths = helpers.request, helpers.run, helpers.uimeths
@@ -520,9 +521,11 @@ function Screen:_current_screen()
return table.concat(rv, '\n')
end
--- Utility to generate/debug tests. Call it where screen:expect() would be.
--- Waits briefly, then dumps the current screen state in the form of
--- screen:expect(). Use snapshot_util({},true) to generate a text-only test.
+-- Generates tests. Call it where Screen:expect() would be. Waits briefly, then
+-- dumps the current screen state in the form of Screen:expect().
+-- Use snapshot_util({},true) to generate a text-only (no attributes) test.
+--
+-- @see Screen:redraw_debug()
function Screen:snapshot_util(attrs, ignore)
self:sleep(250)
self:print_snapshot(attrs, ignore)