Support for Wrokspace Folders + embedded projects #178

kkrime · 2025-01-07T05:24:05Z

No description provided.

Some LSP clients can have more than one workspace folder, which can be added via [`workspace/didChangeWorkspaceFolders`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#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_folder`s, and then falling back to the `config.root_dir` if no matching workspace folder is found.

…mbedded in another + unit tests

ro0gr · 2025-01-08T00:16:15Z

lua/tests/project_lsp_get_buf_root_spec.lua

+describe('M._get_buf_root()):', function()
+  it("testing M._get_buf_root() returns correct buf_root for embedded projects", function()
+    local outter_project = "/Users/kkrime/outter_project"
+    local inner_project = "/Users/kkrime/outter_project/inner_project"


unsure if it really matters, but it seems some more universal paths like /tmp/outer_project could work better

It really doesn't make any difference, you can change it you feel strongly about it, no problem with me

magnusriga · 2025-03-03T11:08:41Z

@kkrime Quick question: I tried this plugin, via LazyVim, but the list of recent projects remains empty. Is it broken and no longer maintained? Are your PRs being merged here or in another fork?

Thank you!

kkrime · 2025-03-03T11:11:24Z

@magnusriga I'm not sure what's happening with this project tbh, it hasn't been touched by the maintainer in a while, it's looking like it's been abandoned.

I'm not sure what you mean by the list of recent projects remains empty ?

magnusriga · 2025-03-03T11:19:55Z

@magnusriga I'm not sure what's happening with this project tbh, it hasn't been touched by the maintainer in a while, it's looking like it's been abandoned.

I'm not sure what you mean by the list of recent projects remains empty ?

@kkrime Thank you for the quick reply. I tried to run get_recent_projects(), but that table is just empty.

Does that table fill up on your end, when you open files and LSP clients attach?

kkrime · 2025-03-03T11:43:22Z

@magnusriga Ya, it works for me, did you configure detection_methods and patterns?

magnusriga · 2025-03-03T12:51:29Z

@kkrime I am using lazy.nvim and did:

  {
    "kkrime/project.nvim",
    opts = { },
    event = "VeryLazy",
    config = function(_, opts)
      require("project_nvim").setup(opts)
    end,
}

Does it need any other config?

Edit: It is supposed to set detection_methods and patterns automatically, but I also tried adding them explicitly to opts without any effect (get_recent_projects still returns an empty table).

kkrime · 2025-03-03T13:02:07Z

@magnusriga try coping my config https://github.com/kkrime/home/blob/02bf84d93431d4345e0bf07f3a5f6282df9cb257/.config/nvim/lua/plugins/telescope.lua#L10

Also make sure your lsp is running :LspInfo

magnusriga · 2025-03-03T18:15:30Z

@kkrime Thanks for helping me. I found the issue:

copilot.nvim uses cwd as LSP client root, which results in project.nvim never updating its list. That is wrong, in my opinion, so I filed an Issue at that repo. When I added a temporary fix for that root directory, this repo also started working as it should. I also noticed that I could have excluded copilot LSP client witht the ignore_client setting, but decided to instead try to fix that LSP client.
As a side note, I tried your fork but realized that when you fixed the filetype bug in the original repo, the whitelist made it so that no filetypes were accepted. As sucn, I went back to the original repo, which now works as expected due to (1).

Hope that is helpful to others in the future. Thanks again for being so responsive.

DrKJeff16 · 2025-08-11T18:53:43Z

@kkrime , @magnusriga

It looks like the maintainer hasn't been active for two years. I created a fork I'm actively maintaining and would love to have your enhancement.

That is, of course, if you want to.

DrKJeff16 · 2025-08-11T18:58:02Z

@kkrime I am using lazy.nvim and did:
  {
    "kkrime/project.nvim",
    opts = { },
    event = "VeryLazy",
    config = function(_, opts)
      require("project_nvim").setup(opts)
    end,
}
Does it need any other config?

Edit: It is supposed to set detection_methods and patterns automatically, but I also tried adding them explicitly to opts without any effect (get_recent_projects still returns an empty table).

@magnusriga ~~I am unsure whether you have this issue, but I've found Lazy-Loading this plugin can lead to buggy behaviour.~~

Lazy-Loading seems to be fixed in my fork.

kkrime · 2025-08-12T08:22:06Z

@kkrime , @magnusriga

It looks like the maintainer hasn't been active for two years. I created a fork I'm actively maintaining and would love to have your enhancement.

That is, of course, if you want to.

Hey @DrKJeff16, sure feel free to use my code, no worries

@kkrime I am using lazy.nvim and did:
  {
    "kkrime/project.nvim",
    opts = { },
    event = "VeryLazy",
    config = function(_, opts)
      require("project_nvim").setup(opts)
    end,
}
Does it need any other config?
Edit: It is supposed to set detection_methods and patterns automatically, but I also tried adding them explicitly to opts without any effect (get_recent_projects still returns an empty table).
@magnusriga I am unsure whether you have this issue, but I've found Lazy-Loading this plugin can lead to buggy behaviour.

I'm not sure what the issue yoru facing is, but here's how I run it;

      {
        'ahmedkhalf/project.nvim',
        config = function()
          require("project_nvim").setup({
            -- line below commented out due to - https://github.com/ahmedkhalf/project.nvim/issues/169
            detection_methods = { "lsp", "pattern" },
            patterns = { ".git", ".gitignore", "README.md", "go.mod", "Makefile" },

            silent_chdir = false,
          })
        end
      },

I would remove event = "VeryLazy", that might be preventing the plugin from loading which might just be the issue.

Good luck 👍

DrKJeff16 · 2025-08-12T08:49:23Z

Hey @DrKJeff16, sure feel free to use my code, no worries

@kkrime
Awesome! Will credit you for it, needless to say.

I'm not sure what the issue yoru facing is, but here's how I run it;

      {
        'ahmedkhalf/project.nvim',
        config = function()
          require("project_nvim").setup({
            -- line below commented out due to - https://github.com/ahmedkhalf/project.nvim/issues/169
            detection_methods = { "lsp", "pattern" },
            patterns = { ".git", ".gitignore", "README.md", "go.mod", "Makefile" },

            silent_chdir = false,
          })
        end
      },

I would remove event = "VeryLazy", that might be preventing the plugin from loading which might just be the issue.

Funny thing is I just did some new refactoring today that seemingly fixes that behaviour. Not intentionally, lol.

I'm honestly not sure yet about what piece of code is involved in this.

Essentially, event = 'VeryLazy' appears to be fine now 👀

magnusriga · 2025-08-12T10:38:59Z

Hey guys,

I can't remember what I ended up doing here. I think I moved to the same solution that LazyVim uses, which might have been some snacks.nvim submodule or similar.

I will check back in if it stops working.

Thanks for the effort and input 🥇🚀

lua/project_nvim/project.lua

DrKJeff16 · 2025-08-12T21:00:39Z

lua/project_nvim/project.lua

+local buf_name_to_file_path_map = {}
+
+vim.api.nvim_create_autocmd("BufDelete", {
+  pattern = "*",


It's really convenient to use augroups:

local group = vim.api.nvim_create_augroup("ProjectTest", { clear = true }) vim.api.nvim_create_autocmd("BufDelete", { group = group, pattern = "*", --- ...

What would the value in using augroups be?

Mostly bundling augroups into categories. Makes them easier to find (i.e. when using vim.api.nvim_exec_autocmds() and so on.

For example if you want to run an autocmd through the cmdline,
you don't want to run ALL the, say, "BufAdd" autocmds. You might want to run just the ones related to, let's say, gitsigns as an arbitrary example.

DrKJeff16 · 2025-08-12T21:07:02Z

lua/project_nvim/project.lua

 M.last_project = nil

+---@alias buf_name string this is the name of the buffer (the path/filename that is opened in the buffer)
+---@alias buf_file_location string this is the buf_name minus the filename (just the path)


Why not document the values that use this alias instead of "wrapping" an alias type around string? I get what you want to do but in the long run it might confuse people.

DrKJeff16 · 2025-08-12T21:10:18Z

lua/project_nvim/project.lua

+
+--- regex is relatively expensive, so store buf_file_path in map
+---@type table<buf_name, buf_file_location>
+local buf_name_to_file_path_map = {}


Having ad-hoc types, in my personal opinion, could be an issue for understanding code.

DrKJeff16 · 2025-08-13T19:18:40Z

lua/project_nvim/project.lua

+local buf_name_to_file_path_map = {}
+
+vim.api.nvim_create_autocmd("BufDelete", {
+  pattern = "*",


Mostly bundling augroups into categories. Makes them easier to find (i.e. when using vim.api.nvim_exec_autocmds() and so on.

For example if you want to run an autocmd through the cmdline,
you don't want to run ALL the, say, "BufAdd" autocmds. You might want to run just the ones related to, let's say, gitsigns as an arbitrary example.

DrKJeff16 · 2025-08-13T19:43:11Z

lua/project_nvim/project.lua

+          root_dir = folder_name
+        elseif #folder_name > #root_dir then
+          root_dir = folder_name
+        end


I suggest two alternatives:

Simple Conditional

if not (root_dir and #folder_name <= #root_dir) then root_dir = folder_name end

Using Ternary Operators

root_dir = not (root_dir and #folder_name <= #root_dir) and folder_name or root_dir

This one acts like a ternary operator.¹

The reason I'm doing not (root_dir and #folder_name <= #root_dir) is a simple grouping of logical conditions.

Expanding it would look like not root_dir or not #folder_name <= #root_dir.

The inverse of not #folder_name <= #root_dir is #folder_name > #root_dir.

Footnotes

https://stackoverflow.com/questions/5525817/inline-conditions-in-lua-a-b-yes-no#answer-72021612 ↩

DrKJeff16 · 2025-08-13T19:51:56Z

lua/project_nvim/project.lua

+
+  -- Fall back to root_dir
+  return client.config.root_dir
+end


An alternative is to kill the if root_dir then code block and use this return statement:

return not (root_dir) and client_config.root_dir or root_dir end

DrKJeff16 · 2025-08-13T19:56:29Z

lua/project_nvim/project.lua

-  local clients = vim.lsp.buf_get_clients()
+  local buf_ft = vim.api.nvim_get_option_value('filetype', { buf = 0 })
+  local buf_name = vim.api.nvim_buf_get_name(0)
+  local clients = vim.lsp.get_clients({ bufnr = 0 })


I don't recommend using 0 as bufnr inside a function. An alternative:

local bufnr = vim.api.nvim_get_current_buf() local buf_ft = vim.api.nvim_get_option_value('filetype', { buf = bufnr }) local buf_name = vim.api.nvim_buf_get_name(bufnr) local clients = vim.lsp.get_clients({ bufnr = bufnr })

DrKJeff16 · 2025-08-13T19:58:31Z

lua/project_nvim/project.lua

      if not vim.tbl_contains(config.options.ignore_lsp, client.name) then
-        return client.config.root_dir, client.name
+        local lsp_root = M._lsp_get_buf_root(client, buf_name)
+        return lsp_root, client.name


Suggestion:

return M._lsp_get_buf_root(client, buf_name), client.name

DrKJeff16 · 2025-08-13T20:03:03Z

lua/project_nvim/project.lua

+  if client.workspace_folders then
+    for _, workspace_folder in pairs(client.workspace_folders) do
+      local folder_name = vim.uri_to_fname(workspace_folder.uri)
+      if folder_name and vim.startswith(buf_file_path, folder_name) then


I suggest inverting this conditional to reduce the complexity:

if not (folder_name or vim.startswith(buf_file_path, folder_name)) then --- Fail case end

DrKJeff16 · 2025-08-13T20:09:47Z

@kkrime

Are you interested in recreating this PR in my fork? This repo's author seems unavailable for the foreseeable future.

Also some of the suggested fixes have been adressed there, hopefully making your integration easier to write.

kkrime · 2025-08-16T10:18:04Z

@kkrime

Are you interested in recreating this PR in my fork? This repo's author seems unavailable for the foreseeable future.

Also some of the suggested fixes have been adressed there, hopefully making your integration easier to write.

Ya sure, I noticed you've done a lot of refactoring, so I might have a few questions, but ya, I'll get on to it when I get time

Marc Jakobi and others added 2 commits January 2, 2025 07:53

fix(lsp): added code to handle corner case when we have one project e…

a984d27

…mbedded in another + unit tests

This was referenced Jan 7, 2025

fix(lsp): prioritise workspace_folders for root directory detection #147

Closed

Workspace folders #172

Closed

ro0gr reviewed Jan 8, 2025

View reviewed changes

kkrime force-pushed the corner_case_embedded_projects branch from 72c6c5b to c11869a Compare January 8, 2025 01:18

updated deprecated vim function calls

a6a0763

kkrime force-pushed the corner_case_embedded_projects branch from c11869a to a6a0763 Compare January 8, 2025 01:19

kkrime mentioned this pull request Jan 8, 2025

updated decrepicated vim.api.nvim_buf_get_option() and vim.lsp.buf_ge… #170

Closed

DrKJeff16 reviewed Aug 12, 2025

View reviewed changes

lua/project_nvim/project.lua Show resolved Hide resolved

DrKJeff16 reviewed Aug 12, 2025

View reviewed changes

kkrime added 3 commits August 13, 2025 09:31

improved BufDelete autocommand

0ee8587

fixup! improved BufDelete autocommand

087fd32

fixup! fixup! improved BufDelete autocommand

71d0091

DrKJeff16 suggested changes Aug 13, 2025

View reviewed changes

Support for Wrokspace Folders + embedded projects #178

Are you sure you want to change the base?

Support for Wrokspace Folders + embedded projects #178

Uh oh!

Conversation

kkrime commented Jan 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

magnusriga commented Mar 3, 2025

Uh oh!

kkrime commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

magnusriga commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkrime commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

magnusriga commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkrime commented Mar 3, 2025

Uh oh!

magnusriga commented Mar 3, 2025

Uh oh!

DrKJeff16 commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrKJeff16 commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkrime commented Aug 12, 2025

Uh oh!

DrKJeff16 commented Aug 12, 2025

Uh oh!

magnusriga commented Aug 12, 2025

Uh oh!

Uh oh!

DrKJeff16 Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Simple Conditional

Using Ternary Operators

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DrKJeff16 commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkrime commented Aug 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

kkrime commented Mar 3, 2025 •

edited

Loading

magnusriga commented Mar 3, 2025 •

edited

Loading

kkrime commented Mar 3, 2025 •

edited

Loading

magnusriga commented Mar 3, 2025 •

edited

Loading

DrKJeff16 commented Aug 11, 2025 •

edited

Loading

DrKJeff16 commented Aug 11, 2025 •

edited

Loading

DrKJeff16 Aug 12, 2025 •

edited

Loading

DrKJeff16 commented Aug 13, 2025 •

edited

Loading