feat: migrate to vim.lsp.config #3659

Problem:
Nvim 0.11 has vim.lsp.config, which mostly replaces the legacy
nvim-lspconfig "framework".

Solution:
Migrate all configs to `lsp/*` variants. The old configs in
`lua/lspconfig/` are "frozen".

The new configs include these changes:
- `commands` field became raw calls to
  `vim.api.nvim_buf_create_user_command` inside `on_attach`.
- `root_dir` became:
  - `root_markers` whenever the file list was simple didn't need to mach `*`
  - if the logic was complicated, or needed to match something like
    '\*.c', it was defined as a vim.lsp.Config `root_dir` callback.
- `on_config_change` became `before_init`. I don't actually know if this
  is the correct approach, but looking around the documentation of
  `nvim-lspconfig` a saw that it was defined as the function that gets
  called as soon as the config have `root_dir`, and so I thought
  `before_init` might be the closest alternative.
- `docs.description` became a luadoc `@brief` docstring.
- `single_file_support = false`?

Co-authored-by: Aliou Diallo <aliou@users.noreply.github.com>
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>

1 files changed, 40 insertions, 0 deletions

diff --git a/lsp/solidity.lua b/lsp/solidity.lua
new file mode 100644
index 00000000..c4912acc
--- /dev/null
+++ b/lsp/solidity.lua
@@ -0,0 +1,40 @@
+---@brief
+---
+---https://github.com/qiuxiang/solidity-ls
+--
+-- npm i solidity-ls -g
+--
+-- Make sure that solc is installed and it's the same version of the file.  solc-select is recommended.
+--
+-- Solidity language server is a LSP with autocomplete, go to definition and diagnostics.
+--
+-- If you use brownie, use this root_markers:
+-- root_markers = { 'brownie-config.yaml', '.git' }
+--
+-- on includePath, you can add an extra path to search for external libs, on remapping you can remap lib <> path, like:
+--
+-- ```lua
+-- { solidity = { includePath = '/Users/your_user/.brownie/packages/', remapping = { ["@OpenZeppelin/"] = 'OpenZeppelin/openzeppelin-contracts@4.6.0/' } } }
+-- ```
+--
+-- **For brownie users**
+-- Change the root_markers to:
+--
+-- ```lua
+-- root_markers = { 'brownie-config.yaml', '.git' }
+-- ```
+--
+-- The best way of using it is to have a package.json in your project folder with the packages that you will use.
+-- After installing with package.json, just create a `remappings.txt` with:
+--
+-- ```
+-- @OpenZeppelin/=node_modules/OpenZeppelin/openzeppelin-contracts@4.6.0/
+-- ```
+--
+-- You can omit the node_modules as well.
+return {
+  cmd = { 'solidity-ls', '--stdio' },
+  filetypes = { 'solidity' },
+  root_markers = { '.git', 'package.json' },
+  settings = { solidity = { includePath = '', remapping = {} } },
+}