feat: show the file name where the match came from (#10)

* feat: show the file name where the match came from

* fixup! feat: show the file name where the match came from

integration-tests/cypress/e2e/cmp-rg/basic_spec.cy.ts

@@ -1,23 +1,31 @@
 describe("the basics", () => {
   it("shows words in other files as suggestions", () => {
     cy.visit("http://localhost:5173")
-    cy.startNeovim().then(() => {
+    cy.startNeovim().then((dir) => {
       // wait until text on the start screen is visible
       cy.contains("If you see this text, Neovim is ready!")
       cy.typeIntoTerminal(
         // clear the current line and enter insert mode
         "cc",
       )
 
-      // this will match "Hippopotamus123" from ../../../test-environment/other-file.txt
+      // this will match text from ../../../test-environment/other-file.txt
       //
       // If the plugin works, this text should show up as a suggestion.
-      cy.typeIntoTerminal("hip")
+      cy.typeIntoTerminal(
+        // NOTE: need to break it into parts so that this test file itself does
+        // not match the search :)
+        "hip" + "234",
+      )
 
-      cy.contains("Hippopotamus123 (rg)")
+      cy.contains("Hippopotamus" + "234 (rg)")
 
       // should show documentation with more details about the match
-      cy.contains("Hippopotamus123 is my password")
+      //
+      // should show the text for the matched line
+      cy.contains("Hippopotamus" + "234 was my previous password")
+      // should show the file name
+      cy.contains(dir.contents["other-file.txt"].name)
     })
   })
 })

integration-tests/test-environment/test-setup.lua

@@ -74,6 +74,8 @@ local plugins = {
         documentation = {
           auto_show = true,
           auto_show_delay_ms = 0,
+          -- file names need to fit the screen when testing
+          max_width = 200,
         },
       },
     },

lua/blink-cmp-rg/init.lua

@@ -71,6 +71,7 @@ function RgSource:get_completions(context, resolve)
     end
 
     local lines = vim.split(result.stdout, "\n")
+    local cwd = vim.uv.cwd()
 
     ---@type table<string, blink.cmp.CompletionItem>
     local items = {}
@@ -84,11 +85,28 @@ function RgSource:get_completions(context, resolve)
           "ripgrep output missing item.data.lines.text for item "
             .. vim.inspect(item)
         )
-        local documentation = item.data.lines.text or ""
+        assert(
+          item.data.path.text,
+          "ripgrep output missing item.data.path.text for item "
+            .. vim.inspect(item)
+        )
+        ---@type string
+        local path = item.data.path.text
+        if path:sub(1, #cwd) == cwd then
+          path = path:sub(#cwd + 2)
+        end
+
+        ---@type string[]
+        local documentation = {
+          item.data.lines.text,
+          " ", -- empty lines seem to do nothing, so just have something
+          path,
+        }
+
         for _, submatch in ipairs(item.data.submatches) do
           ---@diagnostic disable-next-line: missing-fields
           items[submatch.match.text] = {
-            documentation = documentation,
+            documentation = table.concat(documentation, "\n"),
             source_id = "blink-cmp-rg",
             label = submatch.match.text .. " (rg)",
             insertText = submatch.match.text,