feat(commitMsg): spellcheck of commit msg (opt-in)

README.md

@@ -197,6 +197,10 @@ local defaultConfig = {
 				"style", "revert", "ci", "docs", "break", "improv",
 			},
 		},
+
+		-- enable vim's builtin spellcheck for the commit message input field
+		-- (configured to ignore capitalization and correctly consider camelCase)
+		spellcheck = false, 
 	},
 	asyncOpConfirmationSound = true, -- currently macOS only
 	issueIcons = {

lua/tinygit/commit-and-amend.lua

@@ -96,6 +96,13 @@ local function setGitCommitAppearance()
 
 			-- activate styling of statusline plugins
 			vim.api.nvim_buf_set_name(0, "COMMIT_EDITMSG")
+
+			-- spellcheck
+			if conf.spellcheck then
+				vim.opt_local.spell = true
+				vim.opt_local.spelloptions = "camel"
+				vim.opt_local.spellcapcheck = ""
+			end
 		end,
 	})
 end

lua/tinygit/config.lua

@@ -17,11 +17,8 @@ local M = {}
 ---@field maxLen number
 ---@field mediumLen number
 ---@field emptyFillIn string
----@field enforceConvCommits enforceConvCommitsConfig
-
----@class enforceConvCommitsConfig
----@field enabled boolean
----@field keywords string[]
+---@field enforceConvCommits {enabled: boolean, keywords: string[]}
+---@field spellcheck boolean
 
 ---@class searchFileHistoryConfig 
 ---@field diffPopupWidth number
@@ -50,6 +47,10 @@ local defaultConfig = {
 				"style", "revert", "ci", "docs", "break", "improv",
 			},
 		},
+
+		-- enable vim's builtin spellcheck for the commit message input field.
+		-- (configured to ignore capitalization and correctly consider camelCase)
+		spellcheck = false, 
 	},
 	asyncOpConfirmationSound = true, -- currently macOS only
 	issueIcons = {