From 3a30eb5a84925ff3a4a98cdfa79151501e1212f7 Mon Sep 17 00:00:00 2001
From: Thomas Schafer <thomasschafer97@gmail.com>
Date: Fri, 28 Feb 2025 13:02:44 +0000
Subject: [PATCH] Add absolute file path command expansion value

---
 book/src/command-line.md    |  1 +
 helix-view/src/expansion.rs | 15 +++++++++++++++
 2 files changed, 16 insertions(+)

diff --git a/book/src/command-line.md b/book/src/command-line.md
index 7bf32bbda..d81613c29 100644
--- a/book/src/command-line.md
+++ b/book/src/command-line.md
@@ -46,6 +46,7 @@ The following variables are supported:
 | `cursor_line` | The line number of the primary cursor in the currently focused document, starting at 1. |
 | `cursor_column` | The column number of the primary cursor in the currently focused document, starting at 1. This is counted as the number of grapheme clusters from the start of the line rather than bytes or codepoints. |
 | `buffer_name` | The relative path of the currently focused document. `[scratch]` is expanded instead for scratch buffers. |
+| `file_path_absolute` | The absolute path of the currently focused document. For scratch buffers this will default to the current working directory. |
 | `line_ending` | A string containing the line ending of the currently focused document. For example on Unix systems this is usually a line-feed character (`\n`) but on Windows systems this may be a carriage-return plus a line-feed (`\r\n`). The line ending kind of the currently focused document can be inspected with the `:line-ending` command. |
 
 Aside from editor variables, the following expansions may be used:
diff --git a/helix-view/src/expansion.rs b/helix-view/src/expansion.rs
index 96a71b8e5..1c79af510 100644
--- a/helix-view/src/expansion.rs
+++ b/helix-view/src/expansion.rs
@@ -31,6 +31,9 @@ pub enum Variable {
     ///
     /// This corresponds to `crate::Document::display_name`.
     BufferName,
+    /// The absolute path of the currently focused document. For scratch buffers this will default
+    /// to the current working directory.
+    FilePathAbsolute,
     /// A string containing the line-ending of the currently focused document.
     LineEnding,
 }
@@ -40,6 +43,7 @@ impl Variable {
         Self::CursorLine,
         Self::CursorColumn,
         Self::BufferName,
+        Self::FilePathAbsolute,
         Self::LineEnding,
     ];
 
@@ -48,6 +52,7 @@ impl Variable {
             Self::CursorLine => "cursor_line",
             Self::CursorColumn => "cursor_column",
             Self::BufferName => "buffer_name",
+            Self::FilePathAbsolute => "file_path_absolute",
             Self::LineEnding => "line_ending",
         }
     }
@@ -57,6 +62,7 @@ impl Variable {
             "cursor_line" => Some(Self::CursorLine),
             "cursor_column" => Some(Self::CursorColumn),
             "buffer_name" => Some(Self::BufferName),
+            "file_path_absolute" => Some(Self::FilePathAbsolute),
             "line_ending" => Some(Self::LineEnding),
             _ => None,
         }
@@ -214,6 +220,15 @@ fn expand_variable(editor: &Editor, variable: Variable) -> Result<Cow<'static, s
                 Ok(Cow::Borrowed(crate::document::SCRATCH_BUFFER_NAME))
             }
         }
+        Variable::FilePathAbsolute => {
+            let path = match doc.path() {
+                Some(path) => path.to_owned(),
+                None => helix_stdx::env::current_working_dir(),
+            }
+            .to_string_lossy()
+            .to_string();
+            Ok(Cow::Owned(path))
+        }
         Variable::LineEnding => Ok(Cow::Borrowed(doc.line_ending.as_str())),
     }
 }