Whitespace is shown in Neovim's snacks dashboard (such as with LazyVim)

[nickjj]

Here's what it looks like:

As soon as you click into the buffer then it disappears but how can you prevent showing it to begin with?

Here's the steps I tried:

• I ran set ft and confirmed the filetype of this buffer is snacks_dashboard

Then I tried let g:better_whitespace_filetypes_blacklist=["snacks_dashboard"] which had no effect, the same result happened.

Then I tried:

vim.api.nvim_create_autocmd({ "BufNewFile", "BufRead" }, {
  pattern = { "snacks_dashboard" },
  callback = function()
    vim.cmd([[DisableWhitespace]])
  end,
})

This also had no effect, the same result happened.

[Kamilcuk]

Hi. Also happens with astronvim, overall happens with snacks.vim. I wasn't able to find out why.

I added a "echoe &ft" to s:ShouldHighlight() https://github.com/ntpeters/vim-better-whitespace/blob/master/plugin/better-whitespace.vim#L129 function and it prints an empty string. I.e. at the time the vim-better-whitespace detects filetype, the filetype is not set and is set to empty. You can actually do let g:better_whitespace_filetypes_blacklist=[""] to disable the highlight.

This is ok, but then later at https://github.com/folke/snacks.nvim/blob/bc0630e43be5699bb94dadc302c0d21615421d93/lua/snacks/dashboard.lua#L1048 when the filetype is set, but it does not re-trigger the autocmd? I do not know why, I think "autocmd FileType * call SetupAutoCommands()` should do it. Thanks.

[Kamilcuk]

Hi, this works:

      vim.api.nvim_create_autocmd("User", {
        pattern = "SnacksDashboardOpened",
        callback = function() vim.cmd [[DisableWhitespace]] end,
      })

[nickjj]

Hi, thanks for the replies.

If I make no other adjustments and add this from your latest comment:

      vim.api.nvim_create_autocmd("User", {
        pattern = "SnacksDashboardOpened",
        callback = function() vim.cmd [[DisableWhitespace]] end,
      })

This still shows the whitespace. Was it expected to also set the other options from your previous comment?

[Kamilcuk]

It works for me on astronvim:

  {
    "ntpeters/vim-better-whitespace",
    lazy = false,
    init = function()
      vim.api.nvim_create_autocmd("User", {
        pattern = "SnacksDashboardOpened",
        callback = function() vim.cmd [[DisableWhitespace]] end,
      })
    end,
  },

Was it expected to also set the other options from your previous comment?

No.

[nickjj]

Interesting, yeah with LazyVim this doesn't apply. I do see a reference to that auto command in Snack's source code too.

I put it in LazyVim's autocmds.lua file, but I also tried it in the same way you did like this. I have slightly more configuration in there already but it doesn't look like anything that would be an issue?

return {
  {
    "ntpeters/vim-better-whitespace",
    init = function()
      vim.g.strip_whitespace_confirm = false
      vim.g.strip_whitelines_at_eof = true
      vim.g.strip_whitespace_on_save = true
      vim.g.better_whitespace_filetypes_blacklist = {}

      vim.api.nvim_create_autocmd("FileType", {
        pattern = { "markdown" },
        callback = function()
          vim.cmd([[DisableStripWhitespaceOnSave]])
        end,
      })

      vim.api.nvim_create_autocmd("User", {
        pattern = "SnacksDashboardOpened",
        callback = function()
          vim.cmd([[DisableWhitespace]])
        end,
      })
    end,
  },
}

[Kamilcuk]

The call in snack.nvim is here: https://github.com/folke/snacks.nvim/blob/main/lua/snacks/dashboard.lua#L229

  self.fire("Opened")

function D.fire(event)
  vim.api.nvim_exec_autocmds("User", { pattern = "SnacksDashboard" .. event, modeline = false })
end

[AmrElsayyad]

You can set the plugin to activate only on the BufRead event, which is triggered when a buffer is read from a file. This should prevent the plugin from loading for the dashboard.

return {
    "ntpeters/vim-better-whitespace",
    event = "BufRead",
}

Let me know if this works for your setup!