fix(lsp): prioritise workspace_folders for root directory detection

[mrcjkb]

Some LSP clients can have more than one workspace folder, which can be added via
workspace/didChangeWorkspaceFolders.

This is especially useful for resource-hungry clients, like rust-analyzer or haskell-language-server, in order to avoid spawning multiple clients.

Using lsp.Client.config.root_dir as the source of truth results in this plugin detecting the wrong project root in this scenario.

This PR fixes that, by first searching through the lsp.Client.workspace_folders,
and then falling back to the config.root_dir if no matching workspace folder is found.

[kkrime]

@mrcjkb I implemented something smiliar before I found out about this PR; #172

Quick questoin, how would your code deal with embedded projects?

As in a project inside another project, would it take the inner project as the root or the outter? Beucase both would be in client.workspace_folders?

[mrcjkb]

Oh wow I forgot about this PR. It's quite a while ago and I don't use project.nvim anymore (because I use tmux sessions instead).
Looking at the code, it just takes the first one it finds.
If #172 solves the problem this PR solves, then I'd suggest just to close this PR.
I had a brief look, but it's so long ago that I don't remember exactly what the problem was.

By the way, I noticed you're using goto statements. In case you're not aware: That limits this plugin to Neovim built with luajit. On some systems (e.g. termux on Android), Neovim is built with Lua 5.1, which doesn't support goto statements.

[kkrime]

@mrcjkb I think your code is neater and more conciuse, so if it's cool with you, I might just extend what you've already built?

Thanks for the heads up about the goto statement and lua (I'm really new to the world of lua and nvim plugins)

Probably worth letting @ahmedkhalf know this and #172 are duplicates

[kkrime]

@mrcjkb FYI - I extended your work to include code to cover a corner case (embedded projects) - I left in your original comment https://github.com/ahmedkhalf/project.nvim/pull/178/commits

@ahmedkhalf please use this for Workspace Folders Support: #178, I added unit tests too.

[mrcjkb]

@mrcjkb FYI - I extended your work to include code to cover a corner case (embedded projects) - I left in your original comment https://github.com/ahmedkhalf/project.nvim/pull/178/commits

@ahmedkhalf please use this for Workspace Folders Support: #178, I added unit tests too.

awesome, thanks for taking over 🙏