Add git_executable configuration parameter to setup() (#1)

Co-authored-by: cathyprime <115636257+cathyprime@users.noreply.github.com>

Author: 2 people

README.md

@@ -78,6 +78,8 @@ neogit.setup {
   disable_context_highlighting = false,
   -- Disables signs for sections/items/hunks
   disable_signs = false,
+  -- Path to git executable. Defaults to "git". Can be used to specify a custom git binary or wrapper script.
+  git_executable = "git",
   -- Offer to force push when branches diverge
   prompt_force_push = true,
   -- Changes what mode the Commit Editor starts in. `true` will leave nvim in normal mode, `false` will change nvim to

doc/neogit.txt

@@ -94,6 +94,8 @@ to Neovim users.
     disable_context_highlighting = false,
     -- Disables signs for sections/items/hunks
     disable_signs = false,
+    -- Path to git executable. Defaults to "git". Can be used to specify a custom git binary or wrapper script.
+    git_executable = "git",
     -- Offer to force push when branches diverge
     prompt_force_push = true,
     -- Changes what mode the Commit Editor starts in. `true` will leave nvim in normal mode, `false` will change nvim to

lua/neogit/config.lua

@@ -343,6 +343,7 @@ end
 ---@class NeogitConfig Neogit configuration settings
 ---@field filewatcher? NeogitFilewatcherConfig Values for filewatcher
 ---@field graph_style? NeogitGraphStyle Style for graph
+---@field git_executable? string Path to git executable (defaults to "git")
 ---@field commit_date_format? string Commit date format
 ---@field log_date_format? string Log date format
 ---@field disable_hint? boolean Remove the top hint in the Status buffer
@@ -436,6 +437,7 @@ function M.get_default_values()
       },
     },
     highlight = {},
+    git_executable = "git",
     disable_insert_on_commit = "auto",
     use_per_project_settings = true,
     remember_settings = true,
@@ -1182,6 +1184,7 @@ function M.validate_config()
     validate_type(config.disable_hint, "disable_hint", "boolean")
     validate_type(config.disable_context_highlighting, "disable_context_highlighting", "boolean")
     validate_type(config.disable_signs, "disable_signs", "boolean")
+    validate_type(config.git_executable, "git_executable", "string")
     validate_type(config.telescope_sorter, "telescope_sorter", "function")
     validate_type(config.use_per_project_settings, "use_per_project_settings", "boolean")
     validate_type(config.remember_settings, "remember_settings", "boolean")
@@ -1273,6 +1276,12 @@ function M.validate_config()
   return errors
 end
 
+---Get the configured git executable path
+---@return string The git executable path
+function M.get_git_executable()
+  return M.values.git_executable
+end
+
 ---@param name string
 ---@return boolean
 function M.check_integration(name)

lua/neogit/lib/git/cli.lua

@@ -4,6 +4,13 @@ local util = require("neogit.lib.util")
 local Path = require("plenary.path")
 local runner = require("neogit.runner")
 
+---Get the configured git executable path
+---@return string
+local function get_git_executable()
+  local config = require("neogit.config")
+  return config.get_git_executable()
+end
+
 ---@class GitCommandSetup
 ---@field flags table|nil
 ---@field options table|nil
@@ -983,7 +990,7 @@ local configurations = {
 ---@param dir string
 ---@return string Absolute path of current worktree
 local function worktree_root(dir)
-  local cmd = { "git", "-C", dir, "rev-parse", "--show-toplevel" }
+  local cmd = { get_git_executable(), "-C", dir, "rev-parse", "--show-toplevel" }
   local result = vim.system(cmd, { text = true }):wait()
 
   return Path:new(vim.trim(result.stdout)):absolute()
@@ -992,7 +999,7 @@ end
 ---@param dir string
 ---@return string Absolute path of `.git/` directory
 local function git_dir(dir)
-  local cmd = { "git", "-C", dir, "rev-parse", "--git-common-dir" }
+  local cmd = { get_git_executable(), "-C", dir, "rev-parse", "--git-common-dir" }
   local result = vim.system(cmd, { text = true }):wait()
 
   return Path:new(vim.trim(result.stdout)):absolute()
@@ -1001,7 +1008,7 @@ end
 ---@param dir string
 ---@return string Absolute path of `.git/` directory
 local function worktree_git_dir(dir)
-  local cmd = { "git", "-C", dir, "rev-parse", "--git-dir" }
+  local cmd = { get_git_executable(), "-C", dir, "rev-parse", "--git-dir" }
   local result = vim.system(cmd, { text = true }):wait()
 
   return Path:new(vim.trim(result.stdout)):absolute()
@@ -1010,7 +1017,7 @@ end
 ---@param dir string
 ---@return boolean
 local function is_inside_worktree(dir)
-  local cmd = { "git", "-C", dir, "rev-parse", "--is-inside-work-tree" }
+  local cmd = { get_git_executable(), "-C", dir, "rev-parse", "--is-inside-work-tree" }
   local result = vim.system(cmd):wait()
 
   return result.code == 0
@@ -1170,7 +1177,7 @@ local function new_builder(subcommand)
     -- stylua: ignore
     cmd = util.merge(
       {
-        "git",
+        get_git_executable(),
         "--no-pager",
         "--literal-pathspecs",
         "--no-optional-locks",

tests/specs/neogit/git_executable_spec.lua

@@ -0,0 +1,42 @@
+local config = require("neogit.config")
+
+describe("git_executable configuration", function()
+  before_each(function()
+    config.values = config.get_default_values()
+  end)
+
+  describe("default configuration", function()
+    it("should default to 'git'", function()
+      assert.are.equal("git", config.get_git_executable())
+    end)
+  end)
+
+  describe("custom git_executable", function()
+    it("should accept a custom git executable path", function()
+      config.setup({ git_executable = "/usr/local/bin/git" })
+      assert.are.equal("/usr/local/bin/git", config.get_git_executable())
+    end)
+
+    it("should accept a git wrapper script", function()
+      config.setup({ git_executable = "/path/to/custom-git" })
+      assert.are.equal("/path/to/custom-git", config.get_git_executable())
+    end)
+  end)
+
+  describe("validation", function()
+    it("should return invalid when git_executable is not a string", function()
+      config.values.git_executable = 123
+      assert.True(vim.tbl_count(config.validate_config()) ~= 0)
+    end)
+
+    it("should return valid when git_executable is a string", function()
+      config.values.git_executable = "/custom/git"
+      assert.True(vim.tbl_count(config.validate_config()) == 0)
+    end)
+
+    it("should return valid for default git_executable", function()
+      config.values.git_executable = "git"
+      assert.True(vim.tbl_count(config.validate_config()) == 0)
+    end)
+  end)
+end)