Neovim support

[tiagovla]

Neovim users can now use it with nvim-lspconfig and mason.nvim.

[dklilley]

@tiagovla - Thanks for letting us know! It's exciting to see this being used in other IDEs!

Can you open a pull request to add this new support to the README under "Clients"?

[hamidingit]

@tiagovla - This is really great! as a new person to neovim, I tried to set it up and I got this now working on my windows machine! it took some pain but I have the functionality working (more in below)

I do however like the visuals and controls that you have in your setup. It would be great if there was a blog post or introduction by experts for new folks that want to adopt neovim and develop matlab code. Please consider contributing more to this cause.

My system and configuration for reference:

init.vim:

call plug#begin()

Plug 'nvim-lua/planetary.nvim'
Plug 'nvim-telescope/telescope.nvim', {'tag': '0.1.1'}
Plug 'williamboman/mason.nvim', { 'do': ':MasonUpdate' }
Plug 'williamboman/mason-lspconfig.nvim'
Plug 'neovim/nvim-lspconfig'

Plug 'hrsh7th/nvim-cmp'
Plug 'hrsh7th/cmp-nvim-lsp'
Plug 'L3MON4D3/LuaSnip'

Plug 'VonHeikemen/lsp-zero.nvim', {'branch': 'v2.x'}

call plug#end()

lua << EOF
require("mason").setup()
require("mason-lspconfig").setup()

local lsp = require('lsp-zero').preset({})
lsp.on_attach(function(client, bufnr)
lsp.default_keymaps({buffer = bufnr})
end)

lsp.setup()

require'lspconfig'.matlab_ls.setup {
settings = {
matlab = {
installPath = "C:\Program Files\MATLAB\R2021b"
}
}
}

EOF

[tiagovla]

I do however like the visuals and controls that you have in your setup. It would be great if there was a blog post or introduction by experts for new folks that want to adopt neovim and develop matlab code. Please consider contributing more to this cause.

@dklilley maybe a good place to put a minimal config setup would be in the wiki section?

[hamidingit]

I do however like the visuals and controls that you have in your setup. It would be great if there was a blog post or introduction by experts for new folks that want to adopt neovim and develop matlab code. Please consider contributing more to this cause.

@dklilley maybe a good place to put a minimal config setup would be in the wiki section?

@tiagovla , Thanks for the idea. we appreciate your help. if you provide such information, we can host it under the wiki so others can follow the steps to set up Neovim.

[contours6]

why can't I use it? I have tried various methods for a long time, but I still can't find the reason.Please you can tell me. I use Lazyvim as configuration manager and install matlab_ls by Mason. Then here is my configuration:

return {
  "neovim/nvim-lspconfig",

  opts = {
    servers = {
      -- Ensure mason installs the server
      clangd = {
        keys = {
          { "<leader>cR", "<cmd>ClangdSwitchSourceHeader<cr>", desc = "Switch Source/Header (C/C++)" },
        },
        root_dir = function(fname)
          return require("lspconfig.util").find_git_ancestor(fname)
            or require("lspconfig.util").root_pattern("compile_commands.json")(fname)
            or require("lspconfig.util").root_pattern("Makefile")(fname)
            or require("lspconfig.util").root_pattern("xmake.lua")(fname)
        end,
        capabilities = {
          offsetEncoding = { "utf-16" },
        },
        cmd = {
          "clangd",
          "--background-index",
          "--clang-tidy",
          "--header-insertion=iwyu",
          "--completion-style=detailed",
          "--function-arg-placeholders",
          "--fallback-style=llvm",
          "--log=verbose",
          "--all-scopes-completion",
          "--query-driver=/usr/bin/g++-*",
        },
        init_options = {
          usePlaceholders = true,
          completeUnimported = true,
          clangdFileStatus = true,
        },
      },
      matlab_ls = {
        cmd = { "matlab-language-server", "--stdio" },
        matlab = {
          indexWorkspace = true,
          installPath = "/opt/matlab2021b/",
        },
        root_dir = function(fname)
          return require("lspconfig.util").find_git_ancestor(fname)
            or require("lspconfig.util").root_pattern("compile_commands.json")(fname)
            or require("lspconfig.util").root_pattern("Makefile")(fname)
            or require("lspconfig.util").root_pattern("xmake.lua")(fname)
        end,

        single_file_support = true,
      },
    },
    setup = {
      clangd = function(_, opts)
        local clangd_ext_opts = require("lazyvim.util").opts("clangd_extensions.nvim")
        require("clangd_extensions").setup(vim.tbl_deep_extend("force", clangd_ext_opts or {}, { server = opts }))
        return true
      end,
    },
  },
}

[Gerb-Voogt]

@ZZT-console I am running into a very similar issue. I have configured the LSP more or less identically but it does not seem to attach to the buffer upon opening a matlab file. Biggest difference seems to be that I am using matlab2023a

[tiagovla]

Here's a minimal config with the lazy.nvim plugin manager:

-- ~/.config/$NVIM_APPNAME/init.lua
vim.lsp.set_log_level "debug"

-- Install the lazy.nvim plugin manager
vim.g.mapleader = " "
local lazypath = vim.fn.stdpath "data" .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
    vim.fn.system {
        "git",
        "clone",
        "--filter=blob:none",
        "https://github.com/folke/lazy.nvim.git",
        "--branch=stable", -- latest stable release
        lazypath,
    }
end
vim.opt.rtp:prepend(lazypath)

-- Install plugins: mason.nvim, nvim-lspconfig, nvim-cmp
require("lazy").setup {
    { "williamboman/mason.nvim", config = true },
    {
        "neovim/nvim-lspconfig",
        dependencies = {
            "hrsh7th/nvim-cmp",
        },
        config = function()
            require("lspconfig")["matlab_ls"].setup {
                capabilities = require("cmp_nvim_lsp").default_capabilities(),
                settings = {
                    MATLAB = {
                        indexWorkspace = true,
                        installPath = "/usr/local/MATLAB/R2023a", -- might need to change this
                        matlabConnectionTiming = "onStart",
                        telemetry = true,
                    },
                },
            }
        end,
    },
    {
        "hrsh7th/nvim-cmp",
        dependencies = {
            { "hrsh7th/cmp-nvim-lsp" },
            { "hrsh7th/cmp-path" }, --optional
        },
        opts = {
            sources = {
                { name = "nvim_lsp" },
                { name = "path" }, --optional
            },
        },
    },
}

-- Mappings
vim.api.nvim_create_autocmd("LspAttach", {
    callback = function(args)
        local buffer = args.buf
        vim.keymap.set("n", "K", vim.lsp.buf.hover, { buffer = buffer, desc = "Hover" })
        vim.keymap.set("n", "ga", vim.lsp.buf.code_action, { buffer = buffer, desc = "Code action" })
        vim.keymap.set("n", "gD", vim.lsp.buf.declaration, { buffer = buffer, desc = "Go to declaration" })
        vim.keymap.set("n", "gd", vim.lsp.buf.definition, { buffer = buffer, desc = "Go to definition" })
        vim.keymap.set("n", "gi", vim.lsp.buf.implementation, { buffer = buffer, desc = "Go to inplementation" })
        vim.keymap.set("n", "gr", vim.lsp.buf.rename, { buffer = buffer, desc = "Rename" })
        vim.keymap.set("n", "gT", vim.lsp.buf.type_definition, { buffer = buffer, desc = "Type definition" })
        vim.keymap.set("n", "gR", vim.lsp.buf.references, { buffer = buffer, desc = "References" })
        vim.keymap.set("n", "gk", vim.lsp.buf.signature_help, { buffer = buffer, desc = "Signature help" })
        vim.keymap.set("n", "]d", vim.diagnostic.goto_next, { buffer = buffer, desc = "Next diagnostic" })
        vim.keymap.set("n", "[d", vim.diagnostic.goto_prev, { buffer = buffer, desc = "Prev diagnostic" })
        vim.keymap.set("n", "gf", function()
            vim.lsp.buf.format {
                timeout_ms = 5000,
            }
        end, { buffer = 0, desc = "Format buffer" })
    end,
})

An example of how use it:

• Copy it to e.g. `~/.config/matlab_nvim/init.lua;
• Run NVIM_APPNAME=matlab_nvim nvim;
• Run :MasonInstall matlab-language-server;
• Create git repository inside the root of your project git init;
• Open file .m file;
• Check :LspInfo;
• Nvim logs:~/.local/state/matlab_nvim/lsp.log;
• Uninstall removing ~/.local/{state/share}/matlab_nvim.

[Gerb-Voogt]

An example of how use it:

* Copy it to e.g. `~/.config/matlab_nvim/init.lua;

* Run `NVIM_APPNAME=matlab_nvim nvim`;

* Run `:MasonInstall matlab-language-server`;

* Open file `.m` file;

* Check `:LspInfo`;

* Nvim logs:`~/.local/state/matlab_nvim/lsp.log`;

* Uninstall removing `~/.local/{state/share}/matlab_nvim`.

@tiagovla I tried doing this but still no luck. The LSP is not even starting as no log seems to be created at ~/.local/state/matlab_nvim/lsp.log

It seems like no matlab session is being launched either which vscode does do when it launches the matlab lsp. Any idea as to what might be happening?

[tiagovla]

@tiagovla I tried doing this but still no luck. The LSP is not even starting as no log seems to be created at ~/.local/state/matlab_nvim/lsp.log

It seems like no matlab session is being launched either which vscode does do when it launches the matlab lsp. Any idea as to what might be happening?

What's your neovim version? I'm using nightly 0.10.

Check if the matlab-language-server is installed after :MasonInstall matlab-language-server:

• It should be here ~/.local/share/$NVIM_APPNAME/mason/packages/matlab-language-server;
• It should also be shown as installed with :Mason.

Check if all plugins were installed using :Lazy.

After opening a matlab .m file:

• Check if the filetype is correct using :set ft?. Or set it with :set ft=matlab;
• Run :LspInfo, it should be shown as configured server and hopefully as attached to this buffer. Could you share a screenshot of LspInfo?
• Also, you need to be inside a git repo, that's how lspconfig detects the root of the project.

[contours6]

@tiagovla
I'm sorry for not having time to reply you until now.I think I should have understood your configuration, and now I will modify my configuration as follows：

return {
  {
    "neovim/nvim-lspconfig",
    opts = {
      servers = {
        -- Ensure mason installs the server
        clangd = {
          root_dir = function(fname)
            return require("lspconfig.util").find_git_ancestor(fname)
              or require("lspconfig.util").root_pattern("compile_commands.json")(fname)
              or require("lspconfig.util").root_pattern("Makefile")(fname)
              or require("lspconfig.util").root_pattern("xmake.lua")(fname)
          end,
          cmd = {
            "clangd",
            "--background-index",
            "--clang-tidy",
            "--header-insertion=iwyu",
            "--completion-style=detailed",
            "--function-arg-placeholders",
            "--fallback-style=llvm",
            "--log=verbose",
            "--all-scopes-completion",
            "--query-driver=/usr/bin/g++-*",
          },
        },
        matlab_ls = {
          settings = {
            matlab = {
              capabilities = require("cmp_nvim_lsp").default_capabilities(),
              indexWorkspace = true,
              installPath = "/opt/matlab2021b/",
              matlabConnectionTiming = "onStart",
              telemetry = true,
            },
          },
          -- root_dir = function(fname)
          --   return require("lspconfig.util").find_git_ancestor(fname)
          --     or require("lspconfig.util").root_pattern("xmake.lua")(fname)
          --     or require("lspconfig.util").root_pattern("compile_commands.json")(fname)
          --     or require("lspconfig.util").root_pattern("Makefile")(fname)
          -- end,
          single_file_support = true,
        },
      },
    },
  },
  {
    "hrsh7th/nvim-cmp",
    dependencies = {
      { "hrsh7th/cmp-nvim-lsp" },
      { "hrsh7th/cmp-path" }, --optional
    },
    opts = {
      sources = {
        { name = "nvim_lsp" },
        { name = "path" }, --optional
      },
    },
  },
}

The result is still the same. I try to use command:LspInfo and get this result.

[contours6]

@dklilley
I checked other Lsp server carefully. I think my matlab_ls maybe config custom handlers. That's probably why.

[Gerb-Voogt]

@tiagovla So the issue turned out to be that my files were not contained inside a git repository, thank you very much for your help! Didn't know about this particular detail regarding lspconfig.

[tiagovla]

@tiagovla So the issue turned out to be that my files were not contained inside a git repository, thank you very much for your help! Didn't know about this particular detail regarding lspconfig.

Glad you found the issue! That's usually the default behavior of most servers on lspconfig https://github.com/neovim/nvim-lspconfig/blob/a27356f1ef9c11e1f459cc96a3fcac5c265e72d6/lua/lspconfig/server_configurations/matlab_ls.lua#L7 . You can also change it to detect the root on custom conditions.

[tiagovla]

@ZZT-console, you're facing the same issue as mentioned above. Your screenshot indicates that the root directory wasn't detected.

Previously, your configuration looked like this:

root_dir = function(fname)
    return require("lspconfig.util").find_git_ancestor(fname)
        or require("lspconfig.util").root_pattern("xmake.lua")(fname)
        or require("lspconfig.util").root_pattern("compile_commands.json")(fname)
        or require("lspconfig.util").root_pattern("Makefile")(fname)
end,

In this setup, Neovim checks if your current working directory is a Git repository, if it contains an xmake.lua file, if there's a compile_commands.json file, or if it has a Makefile. If any of these conditions are met, Neovim launches the LSP server using that root directory. This configuration is suitable for C/C++ LSP servers.

The default configuration for the matlab-language-server only checks if it's inside a Git repository (as mentioned in my previous comment). To resolve your issue, you can initialize a Git repository within your folder using git init, or you can create custom detection conditions based on your needs.

[contours6]

@tiagovla
I did what you said, and I initialized the git repository in my project root directory. But I still can't use matlab_ls.
I think it may be my environment issue. I use NVIM v0.10.0-dev-1025+g0e11bf0e1 and Linux Mint 21.2 Cinnamon.