How to config nvim_lspconfig to work with markdown & quarto files using lazyvim as template?

[hopezh]

1. Objective

I'm using lazyvim as a template to create my own neovim config oatLazyVim, and I want to make it work for quarto .qmd files to enjoy all the lsp functions for markdown and python codes.

2. What I tried

I mentioned in a previous discussion that I've managed "to make marksman work for both markdown md and quarto qmd files. Both symbols-outline.nvim and nvim-navbuddy can recognize the headings in qmd files without including the comment symbol # in a code block", as shown by the code below.

return {
    -- add pyright and marksman to lspconfig
    {
        "neovim/nvim-lspconfig",

        ---@class PluginLspOpts
        opts = {
            ---@type lspconfig.options
            servers = {
                -- pyright will be automatically installed with mason and loaded with lspconfig
                pyright = {},
                marksman = {},
            },
        },

        -- add marksman support for markdown and quoarto files
        config = function()
            local lspconfig = require("lspconfig")
            local cmp_nvim_lsp = require("cmp_nvim_lsp")
            local util = require("lspconfig.util")

            local on_attach2 = function(client, bufnr)
                local function buf_set_keymap(...)
                    vim.api.nvim_buf_set_keymap(bufnr, ...)
                end
                local function buf_set_option(...)
                    vim.api.nvim_buf_set_option(bufnr, ...)
                end

                buf_set_option("omnifunc", "v:lua.vim.lsp.omnifunc")
                local opts = { noremap = true, silent = true }

                buf_set_keymap("n", "gh", "<cmd>lua vim.lsp.buf.signature_help()<CR>", opts)
                buf_set_keymap("n", "gi", "<cmd>Telescope lsp_implementations<CR>", opts)
                buf_set_keymap("n", "[d", "<cmd>lua vim.diagnostic.goto_prev()<CR>", opts)
                buf_set_keymap("n", "]d", "<cmd>lua vim.diagnostic.goto_next()<CR>", opts)
                buf_set_keymap("n", "<leader>ll", "<cmd>lua vim.lsp.codelens.run()<cr>", opts)
                client.server_capabilities.document_formatting = true
            end

            local capabilities = vim.lsp.protocol.make_client_capabilities()
            capabilities = cmp_nvim_lsp.default_capabilities(capabilities)
            capabilities.textDocument.completion.completionItem.snippetSupport = true

            -- also need to add the following to $home/.config/marksman/config.toml :
            -- [core]
            -- markdown.file_extensions = ["md", "markdown", "qmd"]
            lspconfig.marksman.setup({
                on_attach = on_attach2,
                capabilities = capabilities,
                filetypes = { "markdown", "quarto" },
                root_dir = util.root_pattern(".git", ".marksman.toml", "_quarto.yml"),
            })
        end,
    },
}

3. The problem

However, this config seemed to interfere with and wash away some of the default nvim-lspconfig settings came with lazyvim, especially some of the keybindings.

4. My question

I want to ask how to add configs of marksman for markdown and quarto files in nvim-lspconfig in "lazyvim's way", without affecting the default settings of nvim-lspconfig came with lazyvim installation.

More specifically, I noticed the marksman related settings as shown in the quarto.lua file in quarto-nvim-kickstarter, such as the following block of codes that involves the use of variables such as on_attach and capabilities:

      lspconfig.marksman.setup {
        on_attach = on_attach_qmd,
        capabilities = capabilities,
        filetypes = { 'markdown', 'quarto' },
        root_dir = util.root_pattern(".git", ".marksman.toml", "_quarto.yml"),
      }

So, how to achieve the same in the marksman related section in the lua/plugins/nvim_lspconfig.lua file in a lazyvim config, as shown below, without messing up the default settings and keymaps of nvim-lspconfig?

return {
    -- add pyright and marksman to lspconfig
    {
        "neovim/nvim-lspconfig",

        ---@class PluginLspOpts
        opts = {
            ---@type lspconfig.options
            servers = {
                -- pyright will be automatically installed with mason and loaded with lspconfig
                pyright = {},
                marksman = {
                    filetypes = { "markdown", "quarto" },
                },
            },
        },
    },
}

[jmbuhr]

I made a version of kickstarter based on LazyVim for this very purpose.
https://github.com/jmbuhr/lazyvim-starter-for-quarto/blob/main/lua/plugins/quarto.lua
should contain everything you need.

Incidentally, the on_attach things are not necessary there because LazyVim uses the LspAttach autocommand, which runs before on_attach, so I was able to add my own autocommand right inside of quarto/otter (here: https://github.com/quarto-dev/quarto-nvim/blob/main/ftplugin/quarto.lua). If quarto is configured after lspconfig (determined via the dependencies), it's keybindings should win out. This should be the case in the example.

[hopezh]

@jmbuhr Thank you very much. The lazyvim-starter-for-quarto is very helpful.

I modifed my oatLazyVim config accordingly in a new branch for test.

I didn't add any keymap for quarto-nvim, like those specified in your quarto.lua file in the lazyvim-starter-for-quarto, except for using <leader>qp for Quarto Preview, in my /lua/plugins/quarto.lua :

    {
        "quarto-dev/quarto-nvim",

        dev = false,
        ft = "quarto",

        -- dependencies = {
        --     "neovim/nvim-lspconfig",
        -- },

        opts = {
            lspFeatures = {
                languages = { "r", "python", "julia", "bash", "lua", "html" },
            },
        },

        keys = {
            {
                "<leader>qp",
                "<CMD>QuartoPreview<CR>",
                desc = "Quarto Preview",
            },
        },
    },

However, when I press the <leader> key, the which-key prompt is different from that of lazyvim's default when editing a qmd file.

Firstly, the l key is changed to prefix, rather than for Lazy.

which-key prompt when editing qmd file:

which-key prompt when edting a python file:

Secondly, the keymap for rename is changed to <leader>lR for require'otter'.ask_rename(), and lazyvim's keymap <leader>cr is not working anymore:

I want to ask:
Where and when is the keymap <leader>lR for require'otter'.ask_rename() defined, because I didn't add it in my config, and I didn't add the /quarto-nvim/ftplugin/quarto.lua file, either?

[jmbuhr]

It is set here: https://github.com/quarto-dev/quarto-nvim/blob/main/ftplugin/quarto.lua and comes from the quarto.nvim config (

quarto-nvim/lua/quarto/init.lua

Lines 8 to 34 in 35f8603

	M.defaultConfig = {
	debug = false,
	closePreviewOnExit = true,
	lspFeatures = {
	enabled = true,
	chunks = 'curly',
	languages = { 'r', 'python', 'julia', 'bash', 'html' },
	diagnostics = {
	enabled = true,
	triggers = { "BufWritePost" }
	},
	completion = {
	enabled = true,
	},
	},
	keymap = {
	hover = 'K',
	definition = 'gd',
	type_definition = 'gD',
	rename = '<leader>lR',
	references = 'gr',
	document_symbols = 'gS',
	}
	}
	-- use defaultConfig if not setup
	M.config = M.defaultConfig

), so you can change the keybinding on setup.

[hopezh]

Thanks, @jmbuhr

I've edited my config and the /lua/plugins/quarto.lua in which I specified <leader>cr for rename in the keymap section of opts:

    {
        "quarto-dev/quarto-nvim",

        dev = false,
        ft = "quarto",

        dependencies = {
            "neovim/nvim-lspconfig",
            "jmbuhr/otter.nvim",
            "hrsh7th/nvim-cmp",
        },

        opts = {
            lspFeatures = {
                languages = { "r", "python", "julia", "bash", "lua", "html" },
            },
            keymap = {
                -- rename = '<leader>lR', -- default of quarto-nvim
                rename = "<leader>cr",
            },
        },

        keys = {
            {
                "<leader>qp",
                "<CMD>QuartoPreview<CR>",
                desc = "Quarto Preview",
            },
        },
    },

Now, <leader>cr is shown as r -> require 'otter'.ask_rename() in which-key prompt:

However, when I applied this keymap to rename the variable r in the python code in a hello.qmd test file I got the following error, and I was unable to rename the variable.

Error executing vim.schedule lua callback: ...ocal/share/OatLazyVim/lazy/otter.nvim/lua/otter/init.lua:185: bad argument #1 to 'pairs' (table expected, got nil)
stack traceback:
	[C]: in function 'pairs'
	...ocal/share/OatLazyVim/lazy/otter.nvim/lua/otter/init.lua:185: in function 'filter'
	...al/share/OatLazyVim/lazy/otter.nvim/lua/otter/keeper.lua:340: in function 'handler'
	...r/neovim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp.lua:1499: in function 'cb'
	vim/_editor.lua:324: in function <vim/_editor.lua:323>

Seems it's related to otter settings, but I don't know the exact where it went wrong...

Can you kindly advise what I might have missed here that leads to this error?

Thanks.

[jmbuhr]

You haven't missed anything, that's actually a bug in otter.nvim that I haven't managed to pin down exactly, yet. I think something changed about the way I'm supposed to pass the current variable name to the prompt that asks for the new name in neovim or lspconfig.

[hopezh]

Hi @jmbuhr, may I ask if the error related to renaming a python variable in qmd file as reported above has been resolved?

[jmbuhr]

yes, It should be fixed in https://github.com/jmbuhr/otter.nvim/releases/tag/v1.0.2
Do let me know if you find a counter example.

[hopezh]

yes, It should be fixed in https://github.com/jmbuhr/otter.nvim/releases/tag/v1.0.2 Do let me know if you find a counter example.

Hi @jmbuhr, thank you.

However, after I updated quarto and otter plugins in my config, I'm getting the following error while trying to rename a variable in python:

Error executing vim.schedule lua callback: ...vim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/util.lua:496: bad argument #1 to 'gsub' (string expected, got nil)
stack traceback:
	[C]: in function 'gsub'
	...vim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/util.lua:496: in function 'apply_text_edits'
	...vim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/util.lua:655: in function 'apply_text_document_edit'
	...vim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/util.lua:916: in function 'apply_workspace_edit'
	...HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/handlers.lua:305: in function <...HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp/handlers.lua:299>
	...al/share/OatLazyVim/lazy/otter.nvim/lua/otter/keeper.lua:346: in function 'handler'
	...r/neovim/HEAD-e59cf3b/share/nvim/runtime/lua/vim/lsp.lua:1499: in function 'cb'
	vim/_editor.lua:324: in function <vim/_editor.lua:323>

My quarto.lua file is in this oatLazyVim config.

I used this hello.qmd file to test renaming the variable "r" in the python code block.

[hopezh]

My nvim version is:

NVIM v0.10.0-dev-575+ge59cf3b3a-Homebrew
Build type: Release
LuaJIT 2.1.0-beta3

I have no problem using lazyvim's default keybinding <leader>cr for rename when editing a pure python script.

I only have such issue with "rename" when editing python code block in a qmd file, using the same "cr" keybinding, and the which-key prompt for it changed to "r -> require'otter'.ask_rename()".

[jmbuhr]

I your quarto document part of a python project?

[jmbuhr]

Found the problem. The LazyVim distro has a plugin enabled by default that overwrites the vim.ui.input method (to place it next to the cursor instead of in the command line), but that doesn't play nicely with otter.nvim (something is happening asynchronously that shouldn't be, I believe).
For now I fixed it by simply disabling the offending plugin: https://github.com/jmbuhr/lazyvim-starter-for-quarto/commit/79cbe55ff5c094db3577f1baad603aa0ab231a8c#diff-ae0a74392a85a01dcf65a8b24a487b6035159ab5a5801df01320e45706ecd32c

[jmbuhr]

Thanks for catching this bug :)

[hopezh]

Yes, disabling dressing.nvim works like a charm.

Thank you @jmbuhr for the prompt fix.