feat(advanced_lsp): migrate more of the documentation to use the new LSP configuration settings for the vim.lsp.config API

Author: mehalter

src/content/docs/recipes/advanced_lsp.mdx

@@ -7,9 +7,9 @@ LSP configuration is mostly done through the help of [AstroLSP](https://github.c
 
 ## Configuring Language Servers
 
-Our main tool for configuring and setting up language servers is with the [nvim-lspconfig plugin](https://github.com/neovim/nvim-lspconfig). This plugin provides configurations for many common language servers (A full list can be found in [nvim-lspconfig server configurations documentation](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md)). These baseline configuration options are not always sufficient to meet everyone's needs. For the complete set of options that can be used when configuraing language servers, check out `:h lsp-config` in your editor.
+Our main tool for configuring and setting up language servers is with the [nvim-lspconfig plugin](https://github.com/neovim/nvim-lspconfig). This plugin provides configurations for many common language servers (A full list can be found in [nvim-lspconfig server configurations documentation](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md) or `:h lspconfig-all`). These baseline configuration options are not always sufficient to meet everyone's needs. For the complete set of options that can be used when configuraing language servers, check out `:h lsp-config` in your editor.
 
-AstroLSP automatically enables language servers installed through Mason and for servers specified manually (See [LSP Setup Without Installer](#lsp-setup-without-installer)). Neovim allows for easy language server customization within the `lsp/` folder in the root of your configuration (Check out `:h lsp-config`). While the `lsp/` directory is the recommended way to configurat language servers, AstroLSP also provides a simple `config` table in the plugin's options for extending the built in server configurations provided by `nvim-lspconfig`. This can be helpful if you want to conditionally make modifications in your plugin configuration.
+AstroLSP automatically enables language servers installed through Mason and for servers specified manually (See [LSP Setup Without Installer](#lsp-setup-without-installer)). Neovim allows for easy language server customization within the `after/lsp/` folder in the root of your configuration (Check out `:h lsp-config`). While the `after/lsp/` directory is the recommended way to configurat language servers, AstroLSP also provides a simple `config` table in the plugin's options for extending the built in server configurations provided by `nvim-lspconfig`. This can be helpful if you want to conditionally make modifications in your plugin configuration.
 
 ```lua title="lsp/clangd.lua"
 return {
@@ -325,7 +325,7 @@ Many of these can be found pre-configured in the [AstroNvim Community Repository
 
 :::
 
-There are some plugins available for doing advanced setup of language servers that require the user to not use the `lspconfig` setup call and instead use their own plugin setup for handling this. AstroNvim provides a nice way to do this while still using `mason.nvim` for installing the language servers. You can use the `setup_handlers` table for specifying how language servers should be setup such as using a language specific plugin. This function for each handler has two parameters, the first is the name of the server and the second is the options we would be passing to the `lspconfig` setup call. These options include things such as our built in `capabilities`, `on_attach`, as well as the user defined options in the `config` table. Here are a couple examples for some common LSP plugins:
+There are some plugins available for doing advanced setup of language servers that require the user to not use the `lspconfig` setup call and instead use their own plugin setup for handling this. AstroNvim provides a nice way to do this while still using `mason.nvim` for installing the language servers. You can use the `handlers` table for specifying how language servers should be setup such as using a language specific plugin. This function for each handler can take a single parameter which is the name of the server. The current lsp configuration settings can be retried with `vim.lsp.config[server_name]`. These options include things such as our built in `capabilities`, `on_attach`, as well as the user defined options in and `lsp/<server_name>.lua` and `after/lsp/<server_name>.lua` files the `config` table. Here are a couple examples for some common LSP plugins:
 
 ### Deno ([deno-nvim](https://github.com/sigmaSd/deno-nvim))
 
@@ -349,10 +349,10 @@ return {
     "AstroNvim/astrolsp",
     ---@type AstroLSPOpts
     opts = {
-      setup_handlers = {
+      handlers = {
         -- add custom handler
-        denols = function(_, opts)
-          require("deno-nvim").setup({ server = opts })
+        denols = function()
+          require("deno-nvim").setup({ server = vim.lsp.config.denols })
         end,
       },
     },
@@ -383,30 +383,26 @@ return {
 
 :::
 
-To conditionally enable `tsserver`/`denols` based on the presence of `package.json`/`deno.json`, add the following plugin specs:
+To conditionally enable `tsserver`/`denols` based on the presence of `package.json`/`deno.json`, put the following LSP definitions in your `after/lsp/` directory:
 
-```lua title="lua/plugins/typescript_deno.lua"
+```lua title="after/lsp/denols.lua"
+---@type vim.lsp.Config
 return {
-  "AstroNvim/astrolsp",
-  ---@param opts AstroLSPOpts
-  opts = function(plugin, opts)
-    require("astrocore").extend_tbl(opts, {
-      config = {
-        denols = {
-          root_dir = require("lspconfig.util").root_pattern(
-            "deno.json",
-            "deno.jsonc"
-          ),
-        },
-        tsserver = {
-          root_dir = require("lspconfig.util").root_pattern("package.json"),
-        },
-        -- eslint = {
-        --   root_dir = require("lspconfig.util").root_pattern("package.json", ".eslintrc.json", ".eslintrc.js"),
-        -- },
-      },
-    })
-  end,
+  root_markers = { "deno.json", "deno.jsonc" },
+}
+```
+
+```lua title="after/lsp/tsserver.lua"
+---@type vim.lsp.Config
+return {
+  root_markers = { "package.json" },
+}
+```
+
+```lua title="after/lsp/eslint.lua"
+---@type vim.lsp.Config
+return {
+  root_markers = { "package.json", ".eslintrc.json", ".eslintrc.js" },
 }
 ```
 
@@ -475,30 +471,23 @@ return {
 
 :::
 
-```lua title="lua/plugins/clangd.lua"
+```lua title="after/lsp/clangd.lua"
+---@type vim.lsp.Config
 return {
-  {
-    "AstroNvim/astrolsp",
-    ---@type AstroLSPOpts
-    opts = {
-      config = {
-        clangd = {
-          capabilities = {
-            offsetEncoding = "utf-8",
-          },
-        },
-      },
-    },
+  capabilities = {
+    offsetEncoding = "utf-8",
   },
+}
+```
+
+```lua title="lua/plugins/clangd.lua"
+return {
   {
     "p00f/clangd_extensions.nvim", -- install lsp plugin
     lazy = true,
     init = function()
       -- load clangd extensions when clangd attaches
-      local augroup =
-        vim.api.nvim_create_augroup("clangd_extensions", { clear = true })
       vim.api.nvim_create_autocmd("LspAttach", {
-        group = augroup,
         desc = "Load clangd_extensions with clangd",
         callback = function(args)
           if
@@ -507,7 +496,7 @@ return {
           then
             require("clangd_extensions")
             -- add more `clangd` setup here as needed such as loading autocmds
-            vim.api.nvim_del_augroup_by_id(augroup) -- delete auto command since it only needs to happen once
+            return true -- delete the autocommand once the plugin is loaded
           end
         end,
       })
@@ -539,37 +528,38 @@ return {
 
 :::
 
+```lua title="after/lsp/dartls.lua"
+---@type vim.lsp.Config
+return {
+  config = {
+    dartls = {
+      -- any changes you want to make to the LSP setup, for example
+      color = {
+        enabled = true,
+      },
+      settings = {
+        showTodos = true,
+        completeFunctionCalls = true,
+      },
+    },
+  },
+}
+```
+
 ```lua title="lua/plugins/flutter-tools.lua"
 return {
   { "akinsho/flutter-tools.nvim", lazy = true }, -- add lsp plugin
   {
     "AstroNvim/astrolsp",
-    ---@param opts AstroLSPOpts
-    opts = function(plugin, opts)
-      opts.servers = opts.servers or {}
-      table.insert(opts.servers, "dartls")
-
-      opts = require("astrocore").extend_tbl(opts, {
-        setup_handlers = {
-          -- add custom handler
-          dartls = function(_, dartls_opts)
-            require("flutter-tools").setup({ lsp = dartls_opts })
-          end,
-        },
-        config = {
-          dartls = {
-            -- any changes you want to make to the LSP setup, for example
-            color = {
-              enabled = true,
-            },
-            settings = {
-              showTodos = true,
-              completeFunctionCalls = true,
-            },
-          },
-        },
-      })
-    end,
+    ---@type AstroLSPOpts
+    opts = {
+      servers = { "dartls" },
+      handlers = {
+        dartls = function()
+          require("flutter-tools").setup({ lsp = vim.lsp.config.dartls })
+        end,
+      },
+    },
   },
 }
 ```
@@ -596,18 +586,13 @@ return {
     version = "^5",
     lazy = false, -- This plugin is already lazy
     opts = function(_, opts)
-      local astrolsp_avail, astrolsp = pcall(require, "astrolsp")
-      local astrolsp_opts = (
-        astrolsp_avail and astrolsp.lsp_opts("rust_analyzer")
-      ) or {}
+      local server_opts = vim.lsp.config.rust_analyzer
       local server = {
         ---@type table | (fun(project_root:string|nil, default_settings: table|nil):table) -- The rust-analyzer settings or a function that creates them.
         settings = function(project_root, default_settings)
-          local astrolsp_settings = astrolsp_opts.settings or {}
-
           local merge_table = require("astrocore").extend_tbl(
             default_settings or {},
-            astrolsp_settings
+            server_opts.settings or {}
           )
           local ra = require("rustaceanvim.config.server")
           -- load_rust_analyzer_settings merges any found settings with the passed in default settings table and then returns that table
@@ -617,7 +602,7 @@ return {
           })
         end,
       }
-      return { server = require("astrocore").extend_tbl(astrolsp_opts, server) }
+      return { server = require("astrocore").extend_tbl(server_opts, server) }
     end,
     -- configure `rustaceanvim` by setting the `vim.g.rustaceanvim` variable
     config = function(_, opts)
@@ -658,69 +643,10 @@ return {
 
 ```lua title="lua/plugins/jdtls.lua"
 return {
-  { "mfussenegger/nvim-jdtls", lazy = true }, -- load jdtls on module
   {
     "AstroNvim/astrolsp",
-    ---@type AstroLSPOpts
-    opts = {
-      setup_handlers = {
-        -- add custom handler
-        jdtls = function(_, opts)
-          vim.api.nvim_create_autocmd("Filetype", {
-            pattern = "java", -- autocmd to start jdtls
-            callback = function()
-              if opts.root_dir and opts.root_dir ~= "" then
-                require("jdtls").start_or_attach(opts)
-              end
-            end,
-          })
-        end,
-      },
-      config = {
-        -- set jdtls server settings
-        jdtls = function()
-          -- use this function notation to build some variables
-          local root_markers =
-            { ".git", "mvnw", "gradlew", "pom.xml", "build.gradle" }
-          local root_dir = require("jdtls.setup").find_root(root_markers)
-
-          -- calculate workspace dir
-          local project_name = vim.fn.fnamemodify(vim.fn.getcwd(), ":p:h:t")
-          local workspace_dir = vim.fn.stdpath("data")
-            .. "/site/java/workspace-root/"
-            .. project_name
-          os.execute("mkdir " .. workspace_dir)
-
-          -- get the mason jdtls path
-          local jdtls_files = vim.fn.expand("$MASON/share/jdtls")
-
-          -- return the server config
-          return {
-            cmd = {
-              "java",
-              "-Declipse.application=org.eclipse.jdt.ls.core.id1",
-              "-Dosgi.bundles.defaultStartLevel=4",
-              "-Declipse.product=org.eclipse.jdt.ls.core.product",
-              "-Dlog.protocol=true",
-              "-Dlog.level=ALL",
-              "-javaagent:" .. jdtls_files .. "/lombok.jar",
-              "-Xms1g",
-              "--add-modules=ALL-SYSTEM",
-              "--add-opens",
-              "java.base/java.util=ALL-UNNAMED",
-              "--add-opens",
-              "java.base/java.lang=ALL-UNNAMED",
-              "-jar",
-              jdtls_files .. "/plugins/org.eclipse.equinox.launcher.jar",
-              "-configuration",
-              jdtls_files .. "/config",
-              "-data",
-              workspace_dir,
-            },
-            root_dir = root_dir,
-          }
-        end,
-      },
+    dependencies = {
+      { "mfussenegger/nvim-jdtls" }, -- load jdtls before loading language servers
     },
   },
   {
@@ -789,8 +715,7 @@ return {
     autocmds = {
       no_insert_inlay_hints = {
         -- only create for language servers that support inlay hints
-        -- (and only if vim.lsp.inlay_hint is available)
-        cond = vim.lsp.inlay_hint and "textDocument/inlayHint" or false,
+        cond = "textDocument/inlayHint",
         {
           -- when going into insert mode
           event = "InsertEnter",