[bug]: enableOnVimEnter prevents manpage parsing from happening when neovim loads

[lorentzforces]

Description

When using neovim as a manpage viewer via the +Man! command line argument, no-neck-pain somehow interferes with the parsing of the manpage, and typical manpage-mode functions do not work.

This only happens (as the configuration option would suggest) when first entering neovim. If one is already inside a running instance of neovim, calling up a manpage via the K keybind will work correctly. If one is viewing a garbled manpage as happens when this option is enabled, running :Man! from that buffer will also correctly load the buffer as parsed manpage.

Happy to perform additional troubleshooting if necessary.

I've confirmed this occurs in both the latest (dev) version of no-neck-pain and in the stable version, although I only noticed this happening within the last month.

Neovim version

0.10.3

Steps to reproduce

1. Configure no-neck-pain and set enableOnVimEnter = true in the config table.
2. Configure neovim as the manpage viewer, via setting the MANPAGER environment variable. Ex: export MANPAGER="nvim +Man!"
3. View a man page via man. Ex: man man
4. Observe that no-neck-pain is loaded, that the manpage buffer is showing unparsed terminal escape sequences, that the buffer is not read-only, and gO does not open a location list of the manpage outline.

Screenshot of what the buffer looks like with unparsed escape sequences.

Relevant log output

[no-neck-pain.nvim@enable_on_vim_enter] calling enable for tab 1
[no-neck-pain.nvim@set_tab] registered new tab 1
[no-neck-pain.nvim@enable_on_vim_enter] computed columns: 0 - 1
[no-neck-pain.nvim@enable_on_vim_enter] init called on tab 1 for current window 1000
[no-neck-pain.nvim@get_side_width:left] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:left] 126/255 after splits - final 64
[no-neck-pain.nvim@get_side_width:right] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:right] 126/255 after splits - final 64
[no-neck-pain.nvim@colors.init] skipping color initialization for side left
[no-neck-pain.nvim@colors.init] skipping color initialization for side right
[no-neck-pain.nvim@left] resizing 1001 with padding 64
[no-neck-pain.nvim@right] resizing 1002 with padding 64
[no-neck-pain.nvim@enable_on_vim_enter] rerouting focus of 1002 to 1000
[no-neck-pain.nvim@enable_on_vim_enter] computed columns: 1 - 3
[no-neck-pain.nvim@enable_on_vim_enter] init called on tab 1 for current window 1000
[no-neck-pain.nvim@get_side_width:left] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:left] 126/255 after splits - final 64
[no-neck-pain.nvim@get_side_width:right] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:right] 126/255 after splits - final 64
[no-neck-pain.nvim@left] resizing 1001 with padding 64
[no-neck-pain.nvim@right] resizing 1002 with padding 64
[no-neck-pain.nvim@enable_on_vim_enter] rerouting focus of 1001 to 1000
[no-neck-pain.nvim@enable_on_vim_enter] >> debouncer triggered
[no-neck-pain.nvim@enable_on_vim_enter] init called on tab 1 for current window 1000
[no-neck-pain.nvim@get_side_width:left] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:left] 126/255 after splits - final 64
[no-neck-pain.nvim@get_side_width:right] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:right] 126/255 after splits - final 64
[no-neck-pain.nvim@left] resizing 1001 with padding 64
[no-neck-pain.nvim@right] resizing 1002 with padding 64
Error executing luv callback:
vim/_editor.lua:0: E5560: nvim_echo must not be called in a lua loop callback
stack traceback:
        [C]: in function 'nvim_echo'
        vim/_editor.lua: in function 'notify'
        ...vim/lazy/no-neck-pain.nvim/lua/no-neck-pain/util/log.lua:40: in function 'debug'
        ...vim/lazy/no-neck-pain.nvim/lua/no-neck-pain/util/api.lua:108: in function <...vim/lazy/no-neck-pain.nvim/lua/no-neck-pain/util/api.lua:104>
        [C]: in function 'wait'
        /usr/share/nvim/runtime/lua/vim/_system.lua:99: in function 'wait'
        /usr/share/nvim/runtime/lua/man.lua:22: in function 'system'
        /usr/share/nvim/runtime/lua/man.lua:254: in function 'get_path'
        /usr/share/nvim/runtime/lua/man.lua:803: in function 'init'
        /usr/share/nvim/runtime/lua/man.lua:815: in main chunk
        [C]: in function 'require'
        /usr/share/nvim/runtime/plugin/man.lua:7: in function </usr/share/nvim/runtime/plugin/man.lua:6>
[no-neck-pain.nvim@WinEnter:1000] computed columns: 3 - 3
[no-neck-pain.nvim@enable_on_vim_enter] init called on tab 1 for current window 1000
[no-neck-pain.nvim@get_side_width:left] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:left] 126/255 after splits - final 64
[no-neck-pain.nvim@get_side_width:right] 0/255 after integrations - 1 columns remaining
[no-neck-pain.nvim@get_side_width:right] 126/255 after splits - final 64
[no-neck-pain.nvim@left] resizing 1001 with padding 64
[no-neck-pain.nvim@right] resizing 1002 with padding 64
[no-neck-pain.nvim@enable_on_vim_enter] >> debouncer triggered

Self-service

• I'd be willing to fix this bug myself.

[lorentzforces]

I had a look through other issues - based on timing, the fix for #433 did NOT cause this, although they might share an initial inciting event?

[lorentzforces]

I haven't had time to debug it properly, but this option also appears to interfere with the built-in diff mode in neovim. I'll do some troubleshooting in the near future and see if I can get repro steps or any other more detailed debug info for you.

[shortcuts]

Hey @lorentzforces thanks a lot for using the plugin and the thorough issue!

So far from your screenshot it seems like it's a filetype issue, we might somehow override the default behavior, I'm taking a look

[shortcuts]

Hello! Would you mind trying this branch https://github.com/shortcuts/no-neck-pain.nvim/tree/feat/integrations and letting me know if you can still encounter this issue? Thanks a lot!

[lorentzforces]

Thanks for checking in on this!

So I updated my config and re-enabled the setting with this config:

require('no-neck-pain').setup({
	debug = true,
	width = 126,
	autocmds = {
		enableOnVimEnter = true,
	},
})

What I found surprised me.

So on the stable branch, this actually now appears to work as expected.

I'm testing this by running man man | nvim +Man! in the terminal.

On stable branch

[nnp@enable_on_vim_enter:false:true] calling enable for tab 1
[nnp@set_tab] registered new tab 1
[nnp@enable_on_vim_enter:false:true] computed columns: 0 - 1
[nnp@enable_on_vim_enter:false:true] init called on tab 1 for current window 1000
[nnp@get_side_width:left] defined width in config is bigger than the current ui 126/125
[nnp@get_side_width:right] defined width in config is bigger than the current ui 126/125
[nnp@enable_on_vim_enter:false:true] computed columns: 1 - 1
[nnp@enable_on_vim_enter:false:true] >> debouncer triggered

No errors, opens the man page view as expected and with no-neck-pain enabled with the buffer centered. The filetype is set correctly.

On the integration branch (feat/integrations)

[public_api_enable:enable_on_vim_enter:false:true] calling enable for tab 1
[set_tab] registered new tab 1
[public_api_enable:enable_on_vim_enter:false:true] computed columns: 0 - 1
[public_api_enable:enable_on_vim_enter:false:true] init called on tab 1 for current window 1000
[get_side_width:left] 253 width available, 1 vsplit columns
[get_side_width:left] 253/253 after integrations - 1 columns remaining
[get_side_width:left] 127/253 after vsplits - 0 columns remaining
[get_side_width:right] 253 width available, 1 vsplit columns
[get_side_width:right] 253/253 after integrations - 1 columns remaining
[get_side_width:right] 127/253 after vsplits - 0 columns remaining
[colors.init] skipping color initialization for side left
[colors.init] skipping color initialization for side right
[get_side_width:left] 253/253 after integrations - -1 columns remaining
[get_side_width:left] 253/253 after vsplits - -1 columns remaining
[ui.create_side_buffers:left] Checking side: padding=126, minWidth=10, should_close=false
[ui.create_side_buffers:left] Keeping side window (padding >= minWidth)
[get_side_width:right] 253/253 after integrations - -1 columns remaining
[get_side_width:right] 253/253 after vsplits - -1 columns remaining
[ui.create_side_buffers:right] Checking side: padding=126, minWidth=10, should_close=false
[ui.create_side_buffers:right] Keeping side window (padding >= minWidth)
[public_api_enable:enable_on_vim_enter:false:true] computed columns: 1 - 3
[public_api_enable:enable_on_vim_enter:false:true] skip: is_active_tab_registered
[VimEnter:skip_entering] rerouted focus of 1001 to 1000
[enable_on_vim_enter:false:true:cleanup] >> debouncer triggered

Buffer opens with no highlight groups, and does not set the buffer to readonly like expected with the man filetype. (the filetype is actually blank in this case) Like in my experience before, running the command :Man! in-editor after the buffer is loaded like this does subsequently seem to set things appropriately. Also should note that the no-neck-pain padding buffers do appear and work as expected in this case.

So in summary... I'm not really sure what the problem might be, but it does seem to behave properly on the stable branch, which was not the case when I initially filed this issue.

Let me know if there is any additional debugging I can do for you.