gitcommit ft and builtins.code_actions.gitsigns

[konart]

Right now with null_ls.builtins.code_actions.gitsigns enabled I get the following error message when trying to enter a git commit message in gitcommit buffer:

Error detected while processing CursorHold Autocommands for "*":
method textDocument/documentHighlight is not supported by any of the servers registered for the current buffer

The reason is, I assume, is this code in my config:

local on_attach = function(client, bufnr)
	if client.resolved_capabilities.document_highlight then
		vim.api.nvim_create_autocmd("CursorHold", {
			callback = vim.lsp.buf.document_highlight,
			desc = "Highlight lsp references",
		})

		vim.api.nvim_create_autocmd("CursorHoldI", {
			callback = vim.lsp.buf.document_highlight,
			desc = "Highlight lsp references",
		})

		vim.api.nvim_create_autocmd("CursorMoved", {
			callback = vim.lsp.buf.clear_references,
			desc = "Clear references",
		})
		vim.api.nvim_create_autocmd("CursorMovedI", {
			callback = vim.lsp.buf.clear_references,
			desc = "Clear references",
		})
	end

	vim.api.nvim_buf_set_option(bufnr, "omnifunc", "v:lua.vim.lsp.omnifunc")

	local opts = { silent = true }
	vim.api.nvim_buf_set_keymap(bufnr, "n", "K", "<cmd>lua vim.lsp.buf.hover()<CR>", opts)
end

and the fact that null-ls broadcasts all capabilities as mentioned here:

null-ls.nvim/lua/null-ls/client.lua

Line 47 in b66946a

-- null-ls broadcasts all capabilities on launch, so this lets us have finer control

This happens only if I have another buffer with null-ls attached open. For example a *.go file.

I can disable this builtin for certain filetypes as mentioned here #297 but this seems like a bad solution. Is there anyway to just "unresolve" document_highlight for gitsigns?

Looks like it should be possible but I can't figure out how:

null-ls.nvim/lua/null-ls/client.lua

Line 49 in b66946a

-- allow users to specifically disable capabilities

[jose-elias-alvarez]

The meaning of the comment is that null-ls broadcasts capabilities for the methods it supports, and textDocument/documentHighlight is not one of them.

I can't replicate your issue, but you could try changing if client.resolved_capabilities.document_highlight to if client.supportsMethod("textDocument/documentHighlight") (which is the correct way of checking capabilities). If that doesn't help, please follow the steps in the issue template, make sure that you can isolate the issue to null-ls, and then open an issue with reproduction steps.

[konart]

Sorry, I should've been more clear. on_attach function in question is in fact used in lspconfig setup. So the client is actually something that on_attach receives from lspconfig during setup.

[jose-elias-alvarez]

Yes, I understand. I am pretty confident that this an issue with your LSP setup and not null-ls (you can easily verify that the condition is not true for null-ls by adding print(vim.inspect(client.resolved_capabilities)) to your callback). If I'm wrong and you are able to isolate this to null-ls alone, please open an issue and provide steps I can use to reproduce from a minimal config.

[fitrh]

That is because you create autocmd for all buffers

For LSP thing, you have to specify which buffer (which is why we have access to bufnr in on_attach) you want to add LSP-specific features (keymap, autocmd, user-command, etc.)

You can try to convert your on_attach like this

local on_attach = function(client, bufnr)
    local support = client.supports_method
    local augroup = vim.api.nvim_create_augroup
    local autocmd = vim.api.nvim_create_autocmd

    if support("textDocument/documentHighlight") then
        -- It is always recommended to put autocmd in a augroup
        local highlight_on_cursor = augroup("HighlightOnCursor", { clear = false })

        autocmd({ "CursorHold", "CursorHoldI" }, {
            callback = vim.lsp.buf.document_highlight,
            buffer = bufnr,
            group = highlight_on_cursor,
        })

        autocmd({ "CursorMoved", "CursorMovedI" }, {
            callback = vim.lsp.buf.clear_references,
            buffer = bufnr,
            group = highlight_on_cursor,
        })
    end
end

[konart]

Thank you! For some reason I totally missed buffer there