feat(lsp)!: remove .vscode/settings.json support in favour of codesettings.nvim (#938)

Author: mrcjkb

README.md

@@ -906,14 +906,13 @@ end
 
 ### How to dynamically load different `rust-analyzer` settings per project
 
-By default, this plugin will look for a `.vscode/settings.json`[^2]
-file and attempt to load it.
-If the file does not exist, or it can't be decoded,
-the `server.default_settings` will be used.
+You can use the [codesettings.nvim](https://github.com/mrjones2014/codesettings.nvim),
+which supports loading project-local LSP from `.vscode/settings.json`[^2],
+among others.
+If it is installed, rustaceanvim will try to invoke it automatically.
 
 [^2]: See [this example](https://github.com/rust-analyzer/rust-project.json-example/blob/master/.vscode/settings.json)
       and the rust-analyzer [configuration manual](https://rust-analyzer.github.io/book/configuration).
-      Note that JSON5 is currently not supported by Neovim.
 
 Another option is to use `:h exrc`.
 

doc/rustaceanvim.txt

@@ -169,8 +169,8 @@ vim.g.rustaceanvim = {
 Notes:
 
  - `vim.g.rustaceanvim` can also be a function that returns a |rustaceanvim.Opts| table.
- - You can also configure the rust-analyzer LSP client using a `.vscode/settings.json` file
-   or via |vim.lsp.config()| (using the `'rust-analyzer'` key).
+ - You can also configure the rust-analyzer LSP client via |vim.lsp.config()|
+   (using the `'*'` or `'rust-analyzer'` key).
 
 
 rustaceanvim.Opts                                            *rustaceanvim.Opts*

lua/rustaceanvim/config/init.lua

@@ -39,8 +39,8 @@
 ---Notes:
 ---
 --- - `vim.g.rustaceanvim` can also be a function that returns a |rustaceanvim.Opts| table.
---- - You can also configure the rust-analyzer LSP client using a `.vscode/settings.json` file
----   or via |vim.lsp.config()| (using the `'rust-analyzer'` key).
+--- - You can also configure the rust-analyzer LSP client via |vim.lsp.config()|
+---   (using the `'*'` or `'rust-analyzer'` key).
 ---
 ---@brief ]]
 
@@ -219,11 +219,6 @@ vim.g.rustaceanvim = vim.g.rustaceanvim
 ---The path to the rust-analyzer log file.
 ---@field logfile? string
 ---
----Whether to search (upward from the buffer) for rust-analyzer settings in .vscode/settings json.
----If found, loaded settings will override configured options.
----Default: `true`
----@field load_vscode_settings? boolean
----
 ---Server status warning level to notify at.
 ---Default: 'error'
 ---@field status_notify_level? rustaceanvim.server.status_notify_level

lua/rustaceanvim/config/internal.lua

@@ -317,8 +317,6 @@ local RustaceanDefaultConfig = {
       --- @type table
       ['rust-analyzer'] = {},
     },
-    ---@type boolean Whether to search (upward from the buffer) for rust-analyzer settings in .vscode/settings json.
-    load_vscode_settings = true,
     ---@type rustaceanvim.server.status_notify_level
     status_notify_level = 'error',
   },

lua/rustaceanvim/config/json.lua

@@ -37,41 +37,16 @@ local function is_in_workspace(client, root_dir)
   return false
 end
 
----Searches upward for a .vscode/settings.json that contains rust-analyzer
----settings and returns them.
----@param bufname string
----@return table server_settings or an empty table if no settings were found
-local function find_vscode_settings(bufname)
-  local settings = {}
-  local found_dirs = vim.fs.find({ '.vscode' }, { upward = true, path = vim.fs.dirname(bufname), type = 'directory' })
-  if vim.tbl_isempty(found_dirs) then
-    return settings
-  end
-  local vscode_dir = found_dirs[1]
-  local results = vim.fn.glob(vim.fs.joinpath(vscode_dir, 'settings.json'), true, true)
-  if vim.tbl_isempty(results) then
-    return settings
-  end
-  local content = os.read_file(results[1])
-  return content and require('rustaceanvim.config.json').silent_decode(content) or {}
-end
-
 ---Generate the settings from config and vscode settings if found.
 ---settings and returns them.
----@param bufname string
 ---@param root_dir string | nil
 ---@param client_config table
 ---@return table server_settings or an empty table if no settings were found
-local function get_start_settings(bufname, root_dir, client_config)
+local function get_start_settings(root_dir, client_config)
   local settings = client_config.settings
   local evaluated_settings = type(settings) == 'function' and settings(root_dir, client_config.default_settings)
     or settings
 
-  if config.server.load_vscode_settings then
-    local json_settings = find_vscode_settings(bufname)
-    require('rustaceanvim.config.json').override_with_rust_analyzer_json_keys(evaluated_settings, json_settings)
-  end
-
   return evaluated_settings
 end
 
@@ -199,7 +174,7 @@ Starting rust-analyzer client in detached/standalone mode (with reduced function
     root_dir = os.normalize_path_on_windows(root_dir)
     lsp_start_config.root_dir = root_dir
 
-    lsp_start_config.settings = get_start_settings(bufname, root_dir, client_config)
+    lsp_start_config.settings = get_start_settings(root_dir, client_config)
     configure_file_watcher(lsp_start_config)
 
     -- Check if a client is already running and add the workspace folder if necessary.
@@ -244,7 +219,7 @@ Starting rust-analyzer client in detached/standalone mode (with reduced function
     end
 
     -- special case: rust-analyzer has a `rust-analyzer.server.path` config option
-    -- that allows you to override the path via .vscode/settings.json
+    -- that allows you to override the path.
     local server_path = vim.tbl_get(lsp_start_config.settings, 'rust-analyzer', 'server', 'path')
     if type(server_path) == 'string' then
       if type(rust_analyzer_cmd) == 'table' then
@@ -361,7 +336,7 @@ M.reload_settings = function(bufnr)
   local clients = rust_analyzer.get_active_rustaceanvim_clients(bufnr)
   ---@cast clients vim.lsp.Client[]
   for _, client in ipairs(clients) do
-    local settings = get_start_settings(vim.api.nvim_buf_get_name(bufnr), client.config.root_dir, config.server)
+    local settings = get_start_settings(client.config.root_dir, config.server)
     ---@diagnostic disable-next-line: inject-field
     client.settings = settings
     client:notify('workspace/didChangeConfiguration', {
@@ -403,7 +378,7 @@ function M.set_config(bufnr, ra_settings)
   local clients = rust_analyzer.get_active_rustaceanvim_clients(bufnr)
   ---@cast clients vim.lsp.Client[]
   for _, client in ipairs(clients) do
-    local settings = get_start_settings(vim.api.nvim_buf_get_name(bufnr), client.config.root_dir, config.server)
+    local settings = get_start_settings(client.config.root_dir, config.server)
     ---@diagnostic disable-next-line: inject-field
     settings['rust-analyzer'] = vim.tbl_deep_extend('force', settings['rust-analyzer'], ra_settings)
     client.settings = settings