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, 59 insertions, 0 deletions

diff --git a/lsp/atlas.lua b/lsp/atlas.lua
new file mode 100644
index 00000000..f8747ae9
--- /dev/null
+++ b/lsp/atlas.lua
@@ -0,0 +1,59 @@
+---@brief
+---
+---https://github.com/ariga/atlas
+--
+-- Language server for Atlas config and scheme files.
+--
+-- You may also need to configure the filetype for *.hcl files:
+--
+-- `autocmd BufNewFile,BufRead atlas.hcl set filetype=atlas-config`
+-- `autocmd BufNewFile,BufRead *.my.hcl set filetype=atlas-schema-mysql`
+-- `autocmd BufNewFile,BufRead *.pg.hcl set filetype=atlas-schema-postgresql`
+-- `autocmd BufNewFile,BufRead *.lt.hcl set filetype=atlas-schema-sqlite`
+-- `autocmd BufNewFile,BufRead *.ch.hcl set filetype=atlas-schema-clickhouse`
+-- `autocmd BufNewFile,BufRead *.ms.hcl set filetype=atlas-schema-mssql`
+-- `autocmd BufNewFile,BufRead *.rs.hcl set filetype=atlas-schema-redshift`
+-- `autocmd BufNewFile,BufRead *.test.hcl set filetype=atlas-test`
+-- `autocmd BufNewFile,BufRead *.plan.hcl set filetype=atlas-plan`
+--
+-- or
+--
+-- ```lua
+-- vim.filetype.add({
+--   filename = {
+--     ['atlas.hcl'] = 'atlas-config',
+--   },
+--   pattern = {
+--     ['.*/*.my.hcl'] = 'atlas-schema-mysql',
+--     ['.*/*.pg.hcl'] = 'atlas-schema-postgresql',
+--     ['.*/*.lt.hcl'] = 'atlas-schema-sqlite',
+--     ['.*/*.ch.hcl'] = 'atlas-schema-clickhouse',
+--     ['.*/*.ms.hcl'] = 'atlas-schema-mssql',
+--     ['.*/*.rs.hcl'] = 'atlas-schema-redshift',
+--     ['.*/*.test.hcl'] = 'atlas-test',
+--     ['.*/*.plan.hcl'] = 'atlas-plan',
+--   },
+-- })
+-- ```
+--
+-- Optionally, tell treesitter to treat Atlas filetypes as HCL for better syntax highlighting:
+--
+-- ```lua
+-- vim.treesitter.language.register('hcl', 'atlas-config')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-mysql')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-postgresql')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-sqlite')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-clickhouse')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-mssql')
+-- vim.treesitter.language.register('hcl', 'atlas-schema-redshift')
+-- vim.treesitter.language.register('hcl', 'atlas-test')
+-- vim.treesitter.language.register('hcl', 'atlas-plan')
+-- ```
+--
+return {
+  cmd = { 'atlas', 'tool', 'lsp', '--stdio' },
+  filetypes = {
+    'atlas-*',
+  },
+  root_markers = { 'atlas.hcl' },
+}