clean up and add some ducumentation

lua/lazygit/utils.lua

@@ -5,17 +5,17 @@ local lazygit_visited_git_repos = {}
 
 -- TODO:check if the repo isa git repo
 local function append_git_repo_path(repo_path)
-    if repo_path == nil or not fn.isdirectory(repo_path) then
-        return
-    end
+  if repo_path == nil or not fn.isdirectory(repo_path) then
+    return
+  end
 
-    for _, path in ipairs(lazygit_visited_git_repos) do
-        if path == repo_path then
-            return
-        end
+  for _, path in ipairs(lazygit_visited_git_repos) do
+    if path == repo_path then
+      return
     end
+  end
 
-    table.insert(lazygit_visited_git_repos, tostring(repo_path))
+  table.insert(lazygit_visited_git_repos, tostring(repo_path))
 end
 
 
@@ -26,25 +26,25 @@ end
 
 
 local function get_root()
-    local cwd = vim.loop.cwd()
-    local status, job = pcall(require, 'plenary.job')
-    if not status then
-        local gitdir = fn.system('git rev-parse --show-toplevel')
-    end
+  local cwd = vim.loop.cwd()
+  local status, job = pcall(require, 'plenary.job')
+  if not status then
+    return fn.system('git rev-parse --show-toplevel')
+  end
 
-    local gitroot_job = job:new({
-        'git',
-        'rev-parse',
-        '--show-toplevel',
-        cwd=cwd
-    })
+  local gitroot_job = job:new({
+    'git',
+    'rev-parse',
+    '--show-toplevel',
+    cwd=cwd
+  })
 
-    local _, code = gitroot_job:sync()
-    if (code ~= 0) then
-        return nil
-    end
+  local path, code = gitroot_job:sync()
+  if (code ~= 0) then
+    return nil
+  end
 
-    return fn.getcwd(0, 0)
+  return table.concat(path, "")
 end
 
 --- Get project_root_dir for git repository
@@ -52,13 +52,17 @@ local function project_root_dir()
   -- always use bash on Unix based systems.
   local oldshell = vim.o.shell
   if vim.fn.has('win32') == 0 then
-      vim.o.shell = 'bash'
+    vim.o.shell = 'bash'
   end
 
   local root = get_root()
+  if root == nil then
+    return nil
+  end
+
+  local cmd = string.format('cd "%s" && git rev-parse --show-toplevel', fn.fnamemodify(fn.resolve(fn.expand('%:p')), ':h'), root)
   -- try symlinked file location instead
-  local gitdir = fn.system(
-               'cd "' .. fn.fnamemodify(fn.resolve(fn.expand('%:p')), ':h') .. '" && git rev-parse --show-toplevel')
+  local gitdir = fn.system(cmd)
   local isgitdir = fn.matchstr(gitdir, '^fatal:.*') == ''
 
   if isgitdir then
@@ -89,9 +93,9 @@ end
 
 
 return {
-    get_root = get_root,
-    project_root_dir = project_root_dir,
-    lazygit_visited_git_repos = lazygit_visited_git_repos,
-    is_lazygit_available = is_lazygit_available,
-    is_symlink = is_symlink,
+  get_root = get_root,
+  project_root_dir = project_root_dir,
+  lazygit_visited_git_repos = lazygit_visited_git_repos,
+  is_lazygit_available = is_lazygit_available,
+  is_symlink = is_symlink,
 }