feat(context): display full file paths instead of filenames only

  Show complete file paths when adding files to context instead of
  just the basename. This enables LLMs to:

  - Use file paths correctly when calling tools/functions
  - Understand semantic meaning from directory structure
  - Distinguish between files with identical names in different
    locations

Author: munen

gptel-context.el

@@ -77,9 +77,9 @@ Asynchronous: A callback to call with the result, and the context alist.
 The context alist is structured as follows:
 
  ((buffer1 . (overlay1 overlay2)
-  (\"path/to/file\")
+  ("path/to/file")
   (buffer2 . (overlay3 overlay4 overlay5))
-  (\"path/to/image/file\" :mime \"image/jpeg\")))
+  ("path/to/image/file" :mime "image/jpeg")))
 
 Each gptel \"context\" is either a file path or an overlay in a
 buffer.  Each overlay covers a buffer region containing the
@@ -100,11 +100,11 @@ context chunk.  This is accessible as, for example:
           (kill-region (point-min) (point-max))
         (goto-char (point-max))
         (unless (bobp)
-          (insert "\n----\n")))
+          (insert "\n----\n"))))))
       (insert kill)
       (gptel-context--add-region (current-buffer)
                                  (point-min) (point-max))
-      (message "*current-kill* has been added as context."))))
+      (message "*current-kill* has been added as context.")))))
 
 (defun gptel-context-add (&optional arg confirm)
   "Add context to gptel in a DWIM fashion.
@@ -221,7 +221,7 @@ ACTION should be either `add' or `remove'."
                      (gptel-context--add-binary-file file)
                    (gptel-context--add-text-file file)))
                 ('remove
-                 (setf (alist-get file gptel-context--alist nil 'remove #'equal) nil)))))
+                 (setf (alist-get file gptel-context--alist nil 'remove #'equal) nil))))))
           files)
     (when (eq action 'remove)
       (message "Directory \"%s\" removed from context." path))))
@@ -260,12 +260,12 @@ If CONTEXT is a directory, recursively removes all files in it."
     (if (file-directory-p context)
         (gptel-context--add-directory context 'remove)
       (setf (alist-get context gptel-context--alist nil 'remove #'equal) nil)
-      (message "File \"%s\" removed from context." context)))
+      (message "File \"%s\" removed from context." context))))
    ((region-active-p)
     (when-let* ((contexts (gptel-context--in-region (current-buffer)
                                                     (region-beginning)
                                                     (region-end))))
-      (cl-loop for ctx in contexts do (delete-overlay ctx))))
+      (cl-loop for ctx in contexts do (delete-overlay ctx)))))
    (t
     (when-let* ((ctx (gptel-context--at-point)))
       (delete-overlay ctx)))))
@@ -284,7 +284,7 @@ afterwards."
        if (bufferp source) do           ;Buffers and buffer regions
        (mapc #'gptel-context-remove ovs)
        else do (gptel-context-remove source) ;files or other types
-       finally do (setq gptel-context--alist nil)))
+       finally do (setq gptel-context--alist nil))))
     (when verbose (message "Removed all gptel context sources."))))
 
 (defun gptel-context--make-overlay (start end &optional advance)
@@ -348,9 +348,9 @@ This modifies the buffer."
              (concat "[\n[:blank:]]*"
                      (and-let* ((prefix (gptel-prompt-prefix-string))
                                 ((not (string-empty-p prefix))))
-                       (concat "\\(?:" (regexp-quote prefix) "\\)?"))))
+                       (concat "\(?:" (regexp-quote prefix) "\)?"))))
             (delete-region (match-beginning 0) (match-end 0)))
-       (insert "\n" context-string "\n\n")))))
+       (insert "\n" context-string "\n\n"))))))
 
 (defun gptel-context--collect-media (&optional contexts)
   "Collect media CONTEXTS.
@@ -402,11 +402,19 @@ START and END signify the region delimiters."
                  else collect (list buf) into elements
                  finally return elements)))
 
+(defun gptel-context--format-buffer-name (buffer)
+  "Format buffer name with file path if applicable."
+  (let ((buffer-name (buffer-name buffer))
+        (file-name (buffer-file-name buffer)))
+    (if file-name
+        (format "%s (%s)" buffer-name (abbreviate-file-name file-name))
+      buffer-name)))
+
 (defun gptel-context--insert-buffer-string (buffer contexts)
   "Insert at point a context string from all CONTEXTS in BUFFER."
     (let ((is-top-snippet t)
           (previous-line 1))
-      (insert (format "In buffer `%s`:" (buffer-name buffer))
+      (insert (format "In buffer `%s`:" (gptel-context--format-buffer-name buffer))
               "\n\n```" (gptel--strip-mode-suffix (buffer-local-value
                                                    'major-mode buffer))
               "\n")
@@ -433,11 +441,19 @@ START and END signify the region delimiters."
             (unless (zerop column) (insert " ..."))
             (if is-top-snippet
                 (setq is-top-snippet nil)
-              (unless (= previous-line lineno) (insert "\n"))))
+              (unless (= previous-line lineno) (insert "\n")))))
           (insert content)))
       (unless (>= (overlay-end (car (last contexts))) (point-max))
         (insert "\n..."))
-      (insert "\n```")))
+      (insert "\n```"))))
+
+(defun gptel-context--insert-file-string (path)
+  "Insert at point the contents of the file at PATH as context."
+  (insert (format "In file `%s`:" (abbreviate-file-name path))
+          "\n\n```\n")
+  (insert-file-contents path)
+  (goto-char (point-max))
+  (insert "\n```\n"))
 
 (defun gptel-context--string (context-alist)
   "Format the aggregated gptel context as annotated markdown fragments.
@@ -449,14 +465,14 @@ context overlays, see `gptel-context--alist'."
              if (bufferp buf)
              do (gptel-context--insert-buffer-string buf ovs)
              else if (not (plist-get ovs :mime))
-             do (gptel--insert-file-string buf) end
+             do (gptel-context--insert-file-string buf) end
              do (insert "\n\n")
              finally do
              (skip-chars-backward "\n\t\r ")
              (delete-region (point) (point-max))
              (unless (bobp)
                (goto-char (point-min))
-               (insert "Request context:\n\n"))
+               (insert "Request context:\n\n")))
              finally return
               (and (> (buffer-size) 0)
                    (buffer-string)))))
@@ -486,12 +502,12 @@ context overlays, see `gptel-context--alist'."
       (setq header-line-format
             (substitute-command-keys
              (concat
-              "\\[gptel-context-flag-deletion]: Mark/unmark deletion, "
-              "\\[gptel-context-next]/\\[gptel-context-previous]: next/previous, "
-              "\\[gptel-context-visit]: visit, "
-              "\\[gptel-context-confirm]: apply, "
-              "\\[gptel-context-quit]: cancel, "
-              "\\[quit-window]: quit")))
+              "\[gptel-context-flag-deletion]: Mark/unmark deletion, "
+              "\[gptel-context-next]/\[gptel-context-previous]: next/previous, "
+              "\[gptel-context-visit]: visit, "
+              "\[gptel-context-confirm]: apply, "
+              "\[gptel-context-quit]: cancel, "
+              "\[quit-window]: quit"))))
       (save-excursion
         (let ((contexts gptel-context--alist))
           (if (length> contexts 0)
@@ -504,7 +520,7 @@ context overlays, see `gptel-context--alist'."
                           (setq l1 (line-number-at-pos (overlay-start source-ov))
                                 l2 (line-number-at-pos (overlay-end source-ov))))
                         (insert (propertize (format "In buffer %s (lines %d-%d):\n\n"
-                                                    (buffer-name buf) l1 l2)
+                                                    (gptel-context--format-buffer-name buf) l1 l2)
                                             'face 'bold))
                         (setq beg (point))
                         (insert-buffer-substring
@@ -516,7 +532,7 @@ context overlays, see `gptel-context--alist'."
                         (overlay-put ov 'evaporate t)
                         (insert "\n" (make-separator-line) "\n"))
                     ;; BUF is a file path, not a buffer
-                    (insert (propertize (format "In file %s:\n\n" (file-name-nondirectory buf))
+                    (insert (propertize (format "In file %s:\n\n" (abbreviate-file-name buf))
                                         'face 'bold))
                     (setq beg (point))
                     (if-let* ((mime (plist-get ovs :mime)))
@@ -527,16 +543,16 @@ context overlays, see `gptel-context--alist'."
                           (insert
                            buf " " (propertize "(No preview for binary file)"
                                                'face '(:inherit shadow :slant italic))))
-                      (insert-file-contents buf))
+                      (insert-file-contents buf)))
                     (goto-char (point-max))
                     (insert "\n")
                     (setq ov (make-overlay beg (point)))
                     (overlay-put ov 'gptel-context buf)
                     (overlay-put ov 'gptel-overlay t)
                     (overlay-put ov 'evaporate t)
-                    (insert "\n" (make-separator-line) "\n")))
-                (goto-char (point-min)))
-            (insert "There are no active gptel contexts.")))))
+                    (insert "\n" (make-separator-line) "\n"))))
+                (goto-char (point-min))))
+            (insert "There are no active gptel contexts."))))
     (display-buffer (current-buffer)
                     `((display-buffer-reuse-window
                        display-buffer-reuse-mode-window
@@ -561,7 +577,7 @@ If non-nil, indicates backward movement.")
             (overlay-put highlight-overlay 'face nil))
           (when context-overlay
             (overlay-put context-overlay 'face 'highlight))
-          (setq highlight-overlay context-overlay))))))
+          (setq highlight-overlay context-overlay)))))))
 
 (defun gptel-context-visit ()
   "Display the location of this gptel context chunk in its original buffer."
@@ -588,7 +604,7 @@ If non-nil, indicates backward movement.")
     (when (and (/= (point-max) next-start) ov-here)
       ;; We were inside the overlay, so we want the next overlay change, which
       ;; would be the start of the next overlay.
-      (setq next-start (next-overlay-change next-start)))
+      (setq next-start (next-overlay-change next-start))))
     (when (/= next-start (point-max))
       (setq gptel-context--buffer-reverse nil)
       (goto-char next-start)
@@ -598,9 +614,9 @@ If non-nil, indicates backward movement.")
   "Move to previous gptel context chunk."
   (interactive)
   (let ((ov-here (car (overlays-at (point)))))
-    (when ov-here (goto-char (overlay-start ov-here)))
+    (when ov-here (goto-char (overlay-start ov-here))))
     (let ((previous-context-pos (previous-overlay-change
-                                 (previous-overlay-change (point)))))
+                                 (previous-overlay-change (point))))))
       ;; Prevent point from jumping to the start of the buffer.
       (unless (= previous-context-pos (point-min))
         (goto-char previous-context-pos)
@@ -626,7 +642,7 @@ If non-nil, indicates backward movement.")
             (overlay-put deletion-ov 'gptel-context (overlay-get ov 'gptel-context))
             (overlay-put deletion-ov 'priority -80)
             (overlay-put deletion-ov 'face 'gptel-context-deletion-face)
-            (overlay-put deletion-ov 'gptel-context-deletion-mark t)))))
+            (overlay-put deletion-ov 'gptel-context-deletion-mark t))))))
     (if (use-region-p)
         (deactivate-mark)
       (if gptel-context--buffer-reverse
@@ -652,8 +668,8 @@ If non-nil, indicates backward movement.")
                           (overlays-in (point-min) (point-max))))))
     (mapc #'gptel-context-remove deletion-marks)
     (gptel-context--collect)           ;Update contexts and revert buffer (#482)
-    (revert-buffer))
+    (revert-buffer)))
   (gptel-context-quit))
 
 (provide 'gptel-context)
-;;; gptel-context.el ends here.
+;;; gptel-context.el ends here.