Update installation instruction for 'ocaml.nvim.#3421
Conversation
Lucccyo
changed the title
ocaml.nvim in the setup getting started
| There are two main ways to install and manage LSP servers. | ||
| - A newer, more recommended way is to use the new Neovim LSP API for versions newer than v0.11.0 via `vim.lsp`. | ||
| - A more traditional way is to use `nvim-lspconfig`. For more info, `kickstart.nvim` has a great example setup. |
There was a problem hiding this comment.
Should we still mention these ? Are they needed for the new plugin to work ? If not we should at least put the new plugin information first.
There was a problem hiding this comment.
It can be useful as it removes the need to configure the lsp yourself (it provides configuration files ). However this is generic to lsp so it might not need to be included in the ocaml.nvim documentation.
|
|
||
| ### Installing `ocaml.nvim` | ||
|
|
||
| You can install this plugin easily using [lazy.nvim](https://github.com/folke/lazy.nvim) by adding the following to your `ocaml.nvim` setup. |
There was a problem hiding this comment.
Is everyone expected to use lazy.nvim ? If not we should also provide standalone installation instructions.
There was a problem hiding this comment.
The majority of existing Neovim plugins provide only installation instructions with lazy.nvim.
What do you think @maiste?
There was a problem hiding this comment.
I agree most of the NeoVIM plugins I know tend to provide the lazy.nvim installation. I don't recall any plugin providing the standalone installation. The NeoVIM ecosystem is still maturing as NeoVIM is not yet stable. They are starting to provide a built-in package manager but it is not yet mature (maybe at some built it will be the default).
There was a problem hiding this comment.
There's also the new built-in plugin manager (inspired by mini) that's going to be the standard going forward. Generally, I think it's better to at least mention it as well.
| ```lua | ||
| require("lazy").setup({ | ||
| {"tarides/ocaml.nvim", | ||
| config = function() |
There was a problem hiding this comment.
the simple instruction is:
require('lazy').setup({
{"tarides/ocaml.nvim"},
opts = {
-- add your options here, or leave empty
-- to use the default one
},
})
|
My two cents are that https://github.com/tarides/ocaml.nvim already has great docs, so probably we should just point people to it and not repeat so much of the instructions. This reduces the likelihood that they would drift apart over time. |
6 participants
No description provided.