break!: searchFileHistory setting restructured, see README

README.md

@@ -277,10 +277,15 @@ local defaultConfig = {
 		mergedPR = "🟪",
 		closedPR = "🟥",
 	},
-	searchFileHistory = {
-		diffPopupWidth = 0.8, -- float, 0 to 1
-		diffPopupHeight = 0.8, -- float, 0 to 1
-		diffPopupBorder = "single",
+	historySearch = {
+		diffPopup = {
+			width = 0.8, -- float, 0 to 1
+			height = 0.8,
+			border = "single",
+		},
+		-- if trying to call `git log` on a shallow repository, automatically
+		-- unshallow the repo by running `git fetch --unshallow`
+		autoUnshallowIfNeeded = false,
 	},
 }
 ```

lua/tinygit/config.lua

@@ -21,12 +21,11 @@ local M = {}
 ---@field spellcheck boolean
 ---@field openReferencedIssue boolean
 
----@class searchFileHistoryConfig 
----@field diffPopupWidth number
----@field diffPopupHeight number
----@field diffPopupBorder "single"|"double"|"rounded"|"solid"|"none"|"shadow"|string[]
+---@class historySearchConfig
+---@field diffPopup { width: number, height: number, border: "single"|"double"|"rounded"|"solid"|"none"|"shadow"|string[]}
+---@field autoUnshallowIfNeeded boolean
 
----@class pushConfig 
+---@class pushConfig
 ---@field preventPushingFixupOrSquashCommits boolean
 ---@field confirmationSound boolean
 
@@ -55,7 +54,7 @@ local defaultConfig = {
 
 		-- enable vim's builtin spellcheck for the commit message input field.
 		-- (configured to ignore capitalization and correctly consider camelCase)
-		spellcheck = false, 
+		spellcheck = false,
 
 		-- if commit message references issue/PR, open it in the browser
 		openReferencedIssue = false,
@@ -71,11 +70,16 @@ local defaultConfig = {
 		mergedPR = "🟪",
 		closedPR = "🟥",
 	},
-	searchFileHistory = {
-		diffPopupWidth = 0.8,
-		diffPopupHeight = 0.8,
-		diffPopupBorder = "single",
-	} 
+	historySearch = {
+		diffPopup = {
+			width = 0.8, -- float, 0 to 1
+			height = 0.8,
+			border = "single",
+		},
+		-- if trying to call `git log` on a shallow repository, automatically
+		-- unshallow the repo by running `git fetch --unshallow`
+		autoUnshallowIfNeeded = false,
+	},
 }
 
 --------------------------------------------------------------------------------

lua/tinygit/pickaxe.lua

@@ -2,7 +2,7 @@ local M = {}
 local fn = vim.fn
 local u = require("tinygit.utils")
 local a = vim.api
-local config = require("tinygit.config").config.searchFileHistory
+local config = require("tinygit.config").config.historySearch
 --------------------------------------------------------------------------------
 
 ---@class currentRun saves metadata for the current pickaxe operation
@@ -62,8 +62,8 @@ local function showDiff(commitIdx, type)
 	a.nvim_buf_set_option(bufnr, "modifiable", false)
 
 	-- open new win for the buff
-	local width = math.min(config.diffPopupWidth, 0.99)
-	local height = math.min(config.diffPopupHeight, 0.99)
+	local width = math.min(config.diffPopup.width, 0.99)
+	local height = math.min(config.diffPopup.height, 0.99)
 
 	local winnr = a.nvim_open_win(bufnr, true, {
 		relative = "win",
@@ -74,7 +74,7 @@ local function showDiff(commitIdx, type)
 		col = math.floor((1 - width) * a.nvim_win_get_width(0) / 2),
 		title = (" %s (%s) "):format(shortMsg, date),
 		title_pos = "center",
-		border = config.diffPopupBorder,
+		border = config.diffPopup.border,
 		style = "minimal",
 		zindex = 1, -- below nvim-notify floats
 	})
@@ -235,7 +235,7 @@ function M.functionHistory()
 	if u.notInGitRepo() then return end
 
 	-- TODO figure out how to query treesitter for function names, and use
-	-- treesitter instead
+	-- treesitter instead?
 	currentRun.filename = fn.expand("%")
 	local lspWithSymbolSupport = false
 	local clients = vim.lsp.get_active_clients { bufnr = 0 }