fix(fvm/monorepo): better project root detection and monorepo support for fvm

Author: kaerumm

ftplugin/dart/init.lua

@@ -2,8 +2,6 @@
 if vim.b.flutter_tools_did_ftplugin then return end
 vim.b.flutter_tools_did_ftplugin = 1
 
-require("flutter-tools.lsp").attach()
-
 vim.opt_local.comments = [[sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/,:///,://]]
 vim.opt_local.commentstring = [[//%s]]
 vim.opt.includeexpr = "v:lua.require('flutter-tools.resolve_url').resolve_url(v:fname)"

lua/flutter-tools.lua

@@ -116,6 +116,13 @@ local function setup_autocommands()
     pattern = { "*" },
     callback = function() dev_tools.stop() end,
   })
+  autocmd({ "BufReadPost", "BufFilePost", "BufEnter" }, {
+    group = AUGROUP,
+    pattern = { "*.dart" },
+    callback = function()
+      lsp.attach()
+    end
+  })
 end
 
 ---@param opts flutter.ProjectConfig

lua/flutter-tools/commands.lua

@@ -12,6 +12,7 @@ local debugger_runner = lazy.require("flutter-tools.runners.debugger_runner") --
 local path = lazy.require("flutter-tools.utils.path") ---@module "flutter-tools.utils.path"
 local dev_log = lazy.require("flutter-tools.log") ---@module "flutter-tools.log"
 local parser = lazy.require("flutter-tools.utils.yaml_parser")
+local config_utils = lazy.require("flutter-tools.utils.config_utils") ---@module "flutter-tools.utils.config_utils"
 
 local M = {}
 
@@ -189,34 +190,6 @@ local function get_device_from_args(args)
   end
 end
 
-local function get_absolute_path(input_path)
-  -- Check if the provided path is an absolute path
-  if
-      vim.fn.isdirectory(input_path) == 1
-      and not input_path:match("^/")
-      and not input_path:match("^%a:[/\\]")
-  then
-    -- It's a relative path, so expand it to an absolute path
-    local absolute_path = vim.fn.fnamemodify(input_path, ":p")
-    return absolute_path
-  else
-    -- It's already an absolute path
-    return input_path
-  end
-end
-
----@param project_conf flutter.ProjectConfig?
-local function get_cwd(project_conf)
-  if project_conf and project_conf.cwd then
-    local resolved_path = get_absolute_path(project_conf.cwd)
-    if not vim.loop.fs_stat(resolved_path) then
-      return ui.notify("Provided cwd does not exist: " .. resolved_path, ui.ERROR)
-    end
-    return resolved_path
-  end
-  return lsp.get_lsp_root_dir()
-end
-
 --@return table?
 local function parse_yaml(str)
   local ok, yaml = pcall(parser.parse, str)
@@ -276,7 +249,7 @@ local function run(opts, project_conf, launch_config)
         project_conf.pre_run_callback(callback_args)
       end
     end
-    local cwd = get_cwd(project_conf)
+    local cwd = config_utils.get_cwd(project_conf)
     -- To determinate if the project is a flutter project we need to check if the pubspec.yaml
     -- file has a flutter dependency in it. We need to get cwd first to pick correct pubspec.yaml file.
     local is_flutter_project = has_flutter_dependency_in_pubspec(cwd)
@@ -322,7 +295,7 @@ local function attach(opts)
     local args = opts.cli_args or opts.args or {}
     if not use_debugger_runner() then table.insert(args, 1, "attach") end
 
-    local cwd = get_cwd()
+    local cwd = config_utils.get_cwd()
     ui.notify("Attaching flutter project...")
     runner = use_debugger_runner() and debugger_runner or job_runner
     runner:attach(paths, args, cwd, on_run_data, on_run_exit)
@@ -435,7 +408,7 @@ function M.pub_get()
         command = cmd,
         args = { "pub", "get" },
         -- stylua: ignore
-        cwd = lsp.get_lsp_root_dir() --[[@as string]],
+        cwd = lsp.get_project_root_dir() --[[@as string]],
       })
       pub_get_job:after_success(vim.schedule_wrap(function(j)
         on_pub_get(j:result())
@@ -471,7 +444,7 @@ function M.pub_upgrade(cmd_args)
         command = cmd,
         args = args,
         -- stylua: ignore
-        cwd = lsp.get_lsp_root_dir() --[[@as string]],
+        cwd = lsp.get_project_root_dir() --[[@as string]],
       })
       pub_upgrade_job:after_success(vim.schedule_wrap(function(j)
         ui.notify(utils.join(j:result()), nil, { timeout = notify_timeout })
@@ -579,7 +552,7 @@ function M.install()
           command = cmd,
           args = args,
           -- stylua: ignore
-          cwd = lsp.get_lsp_root_dir() --[[@as string]],
+          cwd = lsp.get_project_root_dir() --[[@as string]],
         })
         install_job:after_success(vim.schedule_wrap(function(j)
           ui.notify(utils.join(j:result()), nil, { timeout = notify_timeout })
@@ -610,7 +583,7 @@ function M.uninstall()
           command = cmd,
           args = args,
           -- stylua: ignore
-          cwd = lsp.get_lsp_root_dir() --[[@as string]],
+          cwd = lsp.get_project_root_dir() --[[@as string]],
         })
         uninstall_job:after_success(vim.schedule_wrap(function(j)
           ui.notify(utils.join(j:result()), nil, { timeout = notify_timeout })

lua/flutter-tools/executable.lua

@@ -3,11 +3,10 @@ local utils = lazy.require("flutter-tools.utils") ---@module "flutter-tools.util
 local path = lazy.require("flutter-tools.utils.path") ---@module "flutter-tools.utils.path"
 local ui = lazy.require("flutter-tools.ui") ---@module "flutter-tools.ui"
 local config = lazy.require("flutter-tools.config") ---@module "flutter-tools.config"
+local fvm_utils = lazy.require("flutter-tools.lsp.fvm_utils") ---@module "flutter-tools.lsp.fvm_utils"
 local Job = require("plenary.job")
 
 local fn = vim.fn
-local fs = vim.fs
-local luv = vim.loop
 
 local M = {}
 
@@ -49,9 +48,10 @@ local function _flutter_sdk_dart_bin(flutter_sdk)
 end
 
 ---Get paths for flutter and dart based on the binary locations
----@return table<string, string>
+---@return table<string, string>?
 local function get_default_binaries()
   local flutter_bin = fn.resolve(fn.exepath("flutter"))
+  if #flutter_bin <= 0 then return nil end
   return {
     flutter_bin = flutter_bin,
     dart_bin = fn.resolve(fn.exepath("dart")),
@@ -66,7 +66,7 @@ function M.reset_paths() _paths = nil end
 
 ---Execute user's lookup command and pass it to the job callback
 ---@param lookup_cmd string
----@param callback fun(p: string, t: table<string, string>?)
+---@param callback fun(t: table<string, string>?)
 ---@return table<string, string>?
 local function path_from_lookup_cmd(lookup_cmd, callback)
   local paths = {}
@@ -99,28 +99,21 @@ local function path_from_lookup_cmd(lookup_cmd, callback)
   job:start()
 end
 
-local function _flutter_bin_from_fvm()
-  local fvm_root =
-    fs.dirname(fs.find(".fvm", { path = luv.cwd(), upward = true, type = "directory" })[1])
-  local binary_name = path.is_windows and "flutter.bat" or "flutter"
-  local flutter_bin_symlink = path.join(fvm_root, ".fvm", "flutter_sdk", "bin", binary_name)
-  flutter_bin_symlink = fn.exepath(flutter_bin_symlink)
-  local flutter_bin = luv.fs_realpath(flutter_bin_symlink)
-  if path.exists(flutter_bin_symlink) and path.exists(flutter_bin) then return flutter_bin end
-end
+
 
 ---Fetch the paths to the users binaries.
 ---@param callback fun(paths: table<string, string>)
 ---@return nil
 function M.get(callback)
   if _paths then return callback(_paths) end
   if config.fvm then
-    local flutter_bin = _flutter_bin_from_fvm()
-    if flutter_bin then
+    local fvm_root = fvm_utils.find_fvm_root()
+    local flutter_bin = fvm_utils.flutter_bin_from_fvm(fvm_root)
+    if fvm_root and flutter_bin then
       _paths = {
         flutter_bin = flutter_bin,
         flutter_sdk = _flutter_sdk_root(flutter_bin),
-        fvm = true,
+        fvm_dir = fvm_root,
       }
       _paths.dart_sdk = _dart_sdk_root(_paths)
       _paths.dart_bin = _flutter_sdk_dart_bin(_paths.flutter_sdk)
@@ -144,8 +137,9 @@ function M.get(callback)
     end)
   end
 
-  if not _paths then
-    _paths = get_default_binaries()
+  local paths = get_default_binaries()
+  if not _paths and paths then
+    _paths = paths
     _paths.dart_sdk = _dart_sdk_root(_paths)
     if _paths.flutter_sdk then _paths.dart_bin = _flutter_sdk_dart_bin(_paths.flutter_sdk) end
   end

lua/flutter-tools/lsp/fvm_utils.lua

@@ -0,0 +1,32 @@
+local M = {}
+
+local lazy = require("flutter-tools.lazy")
+
+local fn = vim.fn
+local luv = vim.loop
+
+local lsp_utils = lazy.require("flutter-tools.lsp.utils") ---@module "flutter-tools.lsp.utils"
+local path = lazy.require("flutter-tools.utils.path") ---@module "flutter-tools.utils.path"
+local config_utils = lazy.require("flutter-tools.utils.config_utils") ---@module "flutter-tools.utils.config_utils"
+
+
+--- Gets the FVM root directory by traversing upwards
+--- @returns string?
+function M.find_fvm_root()
+  local current_path = path.current_buffer_path();
+  local search_path = lsp_utils.is_valid_path(current_path) and current_path or config_utils.get_cwd()
+  return search_path and path.find_root({ ".fvm" }, search_path)
+end
+
+--- Gets the flutter binary from fvm root folder
+--- @param fvm_root string fvm root folder
+--- @return string?
+function M.flutter_bin_from_fvm(fvm_root)
+  local binary_name = path.is_windows and "flutter.bat" or "flutter"
+  local flutter_bin_symlink = path.join(fvm_root, ".fvm", "flutter_sdk", "bin", binary_name)
+  flutter_bin_symlink = fn.exepath(flutter_bin_symlink)
+  local flutter_bin = luv.fs_realpath(flutter_bin_symlink)
+  if path.exists(flutter_bin_symlink) and path.exists(flutter_bin) then return flutter_bin end
+end
+
+return M

lua/flutter-tools/lsp/init.lua

@@ -3,11 +3,11 @@ local utils = lazy.require("flutter-tools.utils") ---@module "flutter-tools.util
 local path = lazy.require("flutter-tools.utils.path") ---@module "flutter-tools.utils.path"
 local color = lazy.require("flutter-tools.lsp.color") ---@module "flutter-tools.lsp.color"
 local lsp_utils = lazy.require("flutter-tools.lsp.utils") ---@module "flutter-tools.lsp.utils"
+local fvm_utils = lazy.require("flutter-tools.lsp.fvm_utils") ---@module "flutter-tools.lsp.fvm_utils"
 
 local api = vim.api
 local lsp = vim.lsp
 local fmt = string.format
-local fs = vim.fs
 
 local FILETYPE = "dart"
 
@@ -166,9 +166,16 @@ function M.restart()
 end
 
 ---@return string?
-function M.get_lsp_root_dir()
-  local client = lsp_utils.get_dartls_client()
-  return client and client.config.root_dir or nil
+function M.get_project_root_dir()
+  local conf = require("flutter-tools.config")
+  local current_buffer_path = lsp_utils.current_buffer_path_if_valid()
+
+  if (current_buffer_path == nil) then
+    local client = lsp_utils.get_dartls_client()
+    return client and client.config.root_dir or nil
+  end
+
+  return path.find_root(conf.root_patterns, current_buffer_path) or current_buffer_path
 end
 
 -- FIXME: I'm not sure how to correctly wait till a server is ready before
@@ -200,7 +207,7 @@ function M.dart_lsp_super()
       uri = vim.uri_from_bufnr(0), -- gets URI of current buffer
     },
     position = {
-      line = lsp_line, -- 0-based line number
+      line = lsp_line,     -- 0-based line number
       character = lsp_col, -- 0-based character position
     },
   }
@@ -210,12 +217,14 @@ end
 function M.dart_reanalyze() lsp.buf_request(0, "dart/reanalyze") end
 
 ---@param user_config table
----@param callback fun(table)
+---@param callback fun(table, table)
 local function get_server_config(user_config, callback)
   local config = utils.merge({ name = lsp_utils.SERVER_NAME }, user_config, { "color" })
   local executable = require("flutter-tools.executable")
+  executable.reset_paths()
   --- TODO: if a user specifies a command we do not need to call executable.get
   executable.get(function(paths)
+    if paths == nil then return end
     local defaults = get_defaults({ flutter_sdk = paths.flutter_sdk })
     local root_path = paths.dart_sdk
     local debug_log = create_debug_log(user_config.debug)
@@ -233,20 +242,22 @@ local function get_server_config(user_config, callback)
     config.on_init = function(client, _)
       return client.notify("workspace/didChangeConfiguration", { settings = config.settings })
     end
-    callback(config)
+    -- TODO: flag something such that we only call attach on exit that has been flagged to
+    -- re attach.
+    config.on_exit = function()
+      if not M.pending_reattach then
+        return
+      end
+      M.pending_reattach = false
+      -- vim.schedule does not work, it executes attach too soon and
+      -- instead of creating a new client, the lsp implementation tries
+      -- to use the old, stopped client.
+      vim.defer_fn(M.attach, 0)
+    end
+    callback(config, paths)
   end)
 end
 
---- Checks if buffer path is valid for attaching LSP
-local function is_valid_path(buffer_path)
-  if buffer_path == "" then return false end
-
-  local start_index, _, uri_prefix = buffer_path:find("^(%w+://).*")
-  -- Do not attach LSP if file URI prefix is not file.
-  -- For example LSP will not be attached for diffview:// or fugitive:// buffers.
-  return not start_index or uri_prefix == "file://"
-end
-
 ---This was heavily inspired by nvim-metals implementation of the attach functionality
 function M.attach()
   local conf = require("flutter-tools.config")
@@ -255,16 +266,15 @@ function M.attach()
   debug_log("attaching LSP")
 
   local buf = api.nvim_get_current_buf()
+  if lsp_utils.get_dartls_client(buf) ~= nil then return end
+
   local buffer_path = api.nvim_buf_get_name(buf)
 
-  if not is_valid_path(buffer_path) then return end
+  if not lsp_utils.is_valid_path(buffer_path) then return end
 
-  get_server_config(user_config, function(c)
-    c.root_dir = M.get_lsp_root_dir()
-      or fs.dirname(fs.find(conf.root_patterns, {
-        path = buffer_path,
-        upward = true,
-      })[1])
+  get_server_config(user_config, function(c, paths)
+    c.root_dir = paths.fvm_dir
+        or M.get_project_root_dir()
     vim.lsp.start(c)
   end)
 end

lua/flutter-tools/lsp/utils.lua

@@ -1,14 +1,33 @@
 local M = {}
 
+local lazy = require("flutter-tools.lazy")
+
 local lsp = vim.lsp
 
+local get_clients = vim.fn.has("nvim-0.10") == 1 and lsp.get_clients or lsp.get_active_clients
+local utils = lazy.require("flutter-tools.utils") ---@module "flutter-tools.utils"
+
 M.SERVER_NAME = "dartls"
 
 -- TODO: Remove after compatibility with Neovim=0.9 is dropped
-local get_clients = vim.fn.has("nvim-0.10") == 1 and lsp.get_clients or lsp.get_active_clients
 
 ---@param bufnr number?
 ---@return vim.lsp.Client?
-function M.get_dartls_client(bufnr) return get_clients({ name = M.SERVER_NAME, bufnr = bufnr })[1] end
+function M.get_dartls_client(bufnr)
+  local clients = get_clients({ name = M.SERVER_NAME, bufnr = bufnr })
+  return utils.find(clients, function(c) return not c:is_stopped() end)
+end
+
+--- Checks if buffer path is valid for attaching LSP
+--- @param buffer_path string
+--- @return boolean
+function M.is_valid_path(buffer_path)
+  if buffer_path == "" then return false end
+
+  local start_index, _, uri_prefix = buffer_path:find("^(%w+://).*")
+  -- Do not attach LSP if file URI prefix is not file.
+  -- For example LSP will not be attached for diffview:// or fugitive:// buffers.
+  return not start_index or uri_prefix == "file://"
+end
 
 return M