Add GoToRelevantFile functionality

[jenny-codes]

Motivation

A stab at #2966. We can now click the "Go to relevant file" from the commands menu and from the explorer view.

Instruction here for those that want to use in in neovim

In the LspAttach event callback, add the following

    vim.api.nvim_create_autocmd('LspAttach', {
      callback = function(event)
        local client = vim.lsp.get_client_by_id(event.data.client_id)

        -- Check that the current server has the go_to_relevant_file capability
        if client and client.server_capabilities.experimental and client.server_capabilities.experimental['go_to_relevant_file'] then
          local go_to_relevant_file = function()
            local params = vim.lsp.util.make_position_params()
            -- Make the go_to_relevant_file request to the lsp server 
            client.request('experimental/goToRelevantFile', params, function(err, result)
              if err then
                vim.notify('Error in GoToRelevantFile: ' .. err.message, vim.log.levels.ERROR)
                return
              end

              if not result or vim.tbl_isempty(result) or #result.locations == 0 then
                vim.notify('No relevant file found', vim.log.levels.INFO)
                return
              end

              -- Goto the file location if only one location is returned
              if #result.locations == 1 then
                vim.cmd('edit ' .. result.locations[1])
                return
              end

              -- If more than one locations are returned, open a selection menu 
              -- If not using fzf, change to telescope or vim.ui.select  
              require('fzf-lua').files {
                cwd = vim.fn.getcwd(),
                cmd = "echo '" .. table.concat(result.locations, '\n') .. "'",
              }
            end)
          end
        end
      end,
    })

and then you can bind go_to_relevant_file() to a keymap

Implementation

Implementing it as a custom request for now until vscode starts supporting it officially.

I've studied a few different implementations and after some internet browsing decided to use the Jacaard similarity here to find the most likely path to the desired filename.

Some future opportunities–

• Right now only the locations with the highest similarity score are returned, but we can perhaps adjust it so we return all the results that has passed a certain threshold (with this particular algorithm the coefficient is between 0 and 1, with 1 meaning the two paths are identical)
• Right now the only relevant file that we try to find is test file <> source file, but in the future we can perhaps extend it so it returns other kinds of relevant files as well.

Automated Tests

Included

Manual Tests

goto-relevant-file-demo.mp4

[st0012]

Sorry for the delay in reviewing. Can you rebase this against the main branch?

[jenny-codes]

@st0012 @andyw8 thanks for the feedback!
@st0012 yes of course I will rebase. No need to apologize–I have not marked it as ready for review (still writing some tests)

[andyw8]

I tried tophatting on code-db for the file shopify_slack_bot/client.rb and it didn't seem to be working.

[andyw8]

For the CI spelling failures, you can add those terms to project-words.

[jenny-codes]

I tried tophatting on code-db for the file shopify_slack_bot/client.rb and it didn't seem to be working.

@andyw8 can you share your tophatting steps? I tried it on both vscode and nvim and both work as expected. For what's worth I've also been using it on shopify/shopify for a while now and have not encountered issues.

[andyw8]

@andyw8 can you share your tophatting steps? I tried it on both vscode and nvim and both work as expected. For what's worth I've also been using it on shopify/shopify for a while now and has not encountered issues.

Just tried again and it's working, I must have missed something before.

[jenny-codes]

@st0012 @andyw8 I've addressed your comments in the latest commit a871787:

1. Use GlobalState#workspace_path instead of Dir.pwd.
2. Make (1) a param passed to the class so the tests don't have to stub Dir.pwd.
3. Constantize test keyword patterns
4. Add a comment to the Jaccard algorithm
5. Remove duplicate handling of @path

I also updated the sigs to rbs syntax

[st0012]

I tested against Ruby LSP and Core and both worked 👍
Is there any plan to add a UI element to trigger the command too?
@vinistock I think we can release this first while waiting for VS Code finishing its spec as it's a highly requested feature.

[andyw8]

Nitpick, but can we fix 'goto' to be two words. 🙏

[st0012]

@jenny-codes What's the plan wrt this?

Is there any plan to add a UI element to trigger the command too?

[jenny-codes]

@st0012 sorry missed that question. I can look into adding that if it's desirable?