feat: Added comments to changed settings

lua/truss/set.lua

@@ -1,10 +1,16 @@
-vim.opt.guicursor = ""
+-- VIM Options
 
-vim.opt.nu = true
+-- Cursor
-vim.opt.relativenumber = true
+vim.opt.guicursor = "" -- Use Default Cursor
+vim.opt.termguicolors = true -- Enable 24 bit true color in supported terminals
 
-vim.opt.list = true
+-- Line Numbering
-vim.opt.listchars = {
+vim.opt.nu = true -- Show absolute number for current line
+vim.opt.relativenumber = true -- Relative number on other lines
+
+-- Whitespace Display
+vim.opt.list = true -- Show whitespace characters
+vim.opt.listchars = { -- Characters to use for whitespace
     space = '·',
     tab = '>-',
     eol = '$',
@@ -13,29 +19,31 @@ vim.opt.listchars = {
     precedes = '<'
 }
 
-vim.opt.tabstop = 4
+-- Indentation / Tabs
-vim.opt.softtabstop = 4
+vim.opt.tabstop = 4 -- Visual width of a tab
-vim.opt.shiftwidth = 4
+vim.opt.softtabstop = 4 -- Insert mode tab size
-vim.opt.expandtab = true
+vim.opt.shiftwidth = 4 -- Shift / autoindent size
-
+vim.opt.expandtab = true -- Tabs to spaces
 vim.opt.smartindent = true
 
-vim.opt.wrap = false
+-- Wrapping
+vim.opt.wrap = false -- Disable line wrapping
 
-vim.opt.swapfile = false
+-- Backup/Undo
-vim.opt.backup = false
+vim.opt.swapfile = false -- No buffer swap files
-vim.opt.undodir = os.getenv("HOME") .. "/.vim/undodir"
+vim.opt.backup = false -- No backups when saving
-vim.opt.undofile = true
+vim.opt.undofile = true -- Persistent undo history
+vim.opt.undodir = os.getenv("HOME") .. "/.vim/undodir" -- Persistent undo save location
 
-vim.opt.hlsearch = false
+-- Search Behavior
-vim.opt.incsearch = true
+vim.opt.hlsearch = true -- Highlight all search matches
+vim.opt.incsearch = true -- Highlight matches as its being typed
 
-vim.opt.termguicolors = true
+-- UI Layout
-
+vim.opt.scrolloff = 8 -- Context to keep visible while scrolling
-vim.opt.scrolloff = 8
 vim.opt.signcolumn = "yes"
 vim.opt.isfname:append("@-@")
 
-vim.opt.updatetime = 50
+-- Misc
-
+vim.opt.updatetime = 50 -- Update time after typing
-vim.opt.colorcolumn = "80"
+vim.opt.colorcolumn = "80" -- Display a column at this position