Move some minimal nvim config to flix.nvim

[stormckey]

I have just created a simple nvim plugin https://github.com/stormckey/flix.nvim.

And move the most general part into the plugin. Things like how the user wants to refresh codelens or how to set up shortcuts is not included in the plugin.

If we adopt this way, the procedure to setup flix in neovim could be:

• install neovim
• install nvim-lspconfig
• install flix.nvim
• Add this minimal config:

-- Setup Code Lens Refesh
vim.api.nvim_create_autocmd({ "BufEnter", "CursorHold", "InsertLeave" }, {
	pattern = "<buffer>",
	callback = function()
		vim.lsp.codelens.refresh()
	end,
})

-- Setup Keybindings
local opts = { noremap = true, silent = true }
vim.keymap.set("n", "<leader>ca", vim.lsp.buf.code_action, opts)
vim.keymap.set("n", "<leader>cl", vim.lsp.codelens.run, opts)
vim.keymap.set("n", "<leader>rn", vim.lsp.buf.rename, opts)
vim.keymap.set("n", "gr", vim.lsp.buf.references, opts)
vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts)
vim.keymap.set("n", "gi", vim.lsp.buf.implementation, opts)
vim.keymap.set("n", "<leader>h", vim.lsp.buf.document_highlight, opts)
vim.keymap.set("n", "K", vim.lsp.buf.hover, opts)
vim.keymap.set("n", "<leader>d", vim.diagnostic.open_float, opts)

-- Setup flix.nvim
require("flix").setup({
	flix_jar_path = "flix.jar", -- flix jar file path relative to the root of the workspace
	enable_codelens = true,
})

What do you think? The plugin is still at an early stage and it could be part of the flix project later. But now it just works fine for me. You can also test with this config :)

[magnus-madsen]

Questions / Comments:

• Where should we host the plugin? We could of course put it in a GitHub repo under the Flix org,
• How do we get the plugin added to all the different nvim package managers? Seems like a lot of work.
• Can we not upstream this to nvim-lspconfig itself? I thought that was partially the point of that project?
• Might it not better to keep it simple? I am sure Neovim users want to configure everything themselves; by just having some code on doc.flix.dev that can be a good starting point for our users. After all, it is already a long install path...

[stormckey]

• Where should we host the plugin? We could of course put it in a GitHub repo under the Flix org,

I think the Flix org maybe.

• How do we get the plugin added to all the different nvim package managers? Seems like a lot of work.

Most nvim plugin manager is github-url based. For example lazy.nvim that I am using needs:

return {
  "stormckey/flix.nvim",
  dependencies = "neovim/nvim-lspconfig",
  opts = {},
}

• Can we not upstream this to nvim-lspconfig itself? I thought that was partially the point of that project?

It's possible, but I will need some time to rewrite it and make sure corner cases are processed properly without the help of nvim-lspconfig.

But for a users who wants to use flix in nvim with lsp support. It's reasonable to assume that they are using nvim-lspconfig already.

• Might it not better to keep it simple? I am sure Neovim users want to configure everything themselves; by just having some code on doc.flix.dev that can be a good starting point for our users. After all, it is already a long install path...

I'm not pretty sure. But the current setup doesn't quite fit into my lspconfig(I have some other lsp set up there, and I use mason to manage them).

The config will only determine the method to start the server(and determine the root dir), and command to be executed from code lens(now runMain). The user is still free to overwrite or extend them.