feat(highlights): split modified states into staged and unstaged groups

Author: malewicz1337

README.md

@@ -111,7 +111,8 @@ require("oil-git").setup({
   -- Colors (only applied if highlight groups don't exist)
   highlights = {
     OilGitAdded = { fg = "#a6e3a1" },
-    OilGitModified = { fg = "#f9e2af" },
+    OilGitModifiedStaged = { fg = "#f9e2af" },
+    OilGitModifiedUnstaged = { fg = "#e5c890" },
     OilGitRenamed = { fg = "#cba6f7" },
     OilGitDeleted = { fg = "#f38ba8" },
     OilGitCopied = { fg = "#cba6f7" },
@@ -138,7 +139,8 @@ When `symbol_position = "signcolumn"`, you can optionally provide
 | Status | File Symbol | Color | Description |
 |--------|-------------|-------|-------------|
 | Added | `+` | Green | Staged new file |
-| Modified | `~` | Yellow | Changed (staged/unstaged) |
+| Modified (staged) | `~` | Yellow | Changes staged in the index |
+| Modified (unstaged) | `~` | Gold | Changes only in the worktree |
 | Renamed | `->` | Purple | Renamed file |
 | Deleted | `D` | Red | Deleted file |
 | Copied | `C` | Purple | Copied file |
@@ -152,8 +154,9 @@ Directories show the highest-priority status among their contents:
 
 | Priority | Status | Description |
 |----------|--------|-------------|
-| 7 | Conflict | Merge conflicts need immediate attention |
-| 6 | Modified | Staged or unstaged changes |
+| 8 | Conflict | Merge conflicts need immediate attention |
+| 7 | Modified (staged) | Staged changes take precedence in directories |
+| 6 | Modified (unstaged) | Worktree-only changes |
 | 5 | Deleted | Deleted files |
 | 4 | Added | New staged files |
 | 3 | Renamed/Copied | Renamed or copied files |

lua/oil-git/config.lua

@@ -39,6 +39,8 @@ local default_config = {
 	highlights = {
 		OilGitAdded = { fg = "#a6e3a1" },
 		OilGitModified = { fg = "#f9e2af" },
+		OilGitModifiedStaged = { fg = "#f9e2af" },
+		OilGitModifiedUnstaged = { fg = "#e5c890" },
 		OilGitRenamed = { fg = "#cba6f7" },
 		OilGitUntracked = { fg = "#89b4fa" },
 		OilGitIgnored = { fg = "#6c7086" },
@@ -50,6 +52,27 @@ local default_config = {
 
 local config = {}
 
+local function apply_legacy_modified_highlights(opts, merged_config)
+	local user_highlights = opts.highlights or {}
+	local legacy_modified = user_highlights.OilGitModified
+
+	if not legacy_modified then
+		return
+	end
+
+	if not user_highlights.OilGitModifiedStaged then
+		merged_config.highlights.OilGitModifiedStaged =
+			vim.deepcopy(legacy_modified)
+	end
+
+	if not user_highlights.OilGitModifiedUnstaged then
+		merged_config.highlights.OilGitModifiedUnstaged =
+			vim.deepcopy(legacy_modified)
+	end
+
+	merged_config.highlights.OilGitModified = vim.deepcopy(legacy_modified)
+end
+
 local function make_readonly(t)
 	if type(t) ~= "table" then
 		return t
@@ -83,6 +106,7 @@ end
 function M.setup(opts)
 	opts = opts or {}
 	config = vim.tbl_deep_extend("force", default_config, opts)
+	apply_legacy_modified_highlights(opts, config)
 end
 
 function M.get()

lua/oil-git/constants.lua

@@ -11,6 +11,8 @@ M.DEFAULTS = {
 M.HIGHLIGHT_GROUPS = {
 	ADDED = "OilGitAdded",
 	MODIFIED = "OilGitModified",
+	MODIFIED_STAGED = "OilGitModifiedStaged",
+	MODIFIED_UNSTAGED = "OilGitModifiedUnstaged",
 	RENAMED = "OilGitRenamed",
 	DELETED = "OilGitDeleted",
 	COPIED = "OilGitCopied",
@@ -43,8 +45,10 @@ M.PRIORITY = {
 	COPIED = 3,
 	ADDED = 4,
 	DELETED = 5,
-	MODIFIED = 6,
-	CONFLICT = 7,
+	MODIFIED_UNSTAGED = 6,
+	MODIFIED_STAGED = 7,
+	MODIFIED = 7,
+	CONFLICT = 8,
 }
 
 return M

lua/oil-git/status_mapper.lua

@@ -5,9 +5,9 @@ local constants = require("oil-git.constants")
 local STATUS_MAP = {
 	A = { constants.HIGHLIGHT_GROUPS.ADDED, "added", constants.PRIORITY.ADDED },
 	M = {
-		constants.HIGHLIGHT_GROUPS.MODIFIED,
+		constants.HIGHLIGHT_GROUPS.MODIFIED_STAGED,
 		"modified",
-		constants.PRIORITY.MODIFIED,
+		constants.PRIORITY.MODIFIED_STAGED,
 	},
 	R = {
 		constants.HIGHLIGHT_GROUPS.RENAMED,
@@ -33,9 +33,9 @@ local STATUS_MAP = {
 
 local WORKTREE_STATUS_MAP = {
 	M = {
-		constants.HIGHLIGHT_GROUPS.MODIFIED,
+		constants.HIGHLIGHT_GROUPS.MODIFIED_UNSTAGED,
 		"modified",
-		constants.PRIORITY.MODIFIED,
+		constants.PRIORITY.MODIFIED_UNSTAGED,
 	},
 	D = {
 		constants.HIGHLIGHT_GROUPS.DELETED,

tests/plenary/config_spec.lua

@@ -60,8 +60,29 @@ describe("config", function()
 			assert.equals("*", cfg.symbols.directory.added)
 			assert.equals("#ffffff", cfg.highlights.OilGitAdded.fg)
 			assert.is_not_nil(cfg.highlights.OilGitModified)
+			assert.is_not_nil(cfg.highlights.OilGitModifiedStaged)
+			assert.is_not_nil(cfg.highlights.OilGitModifiedUnstaged)
 		end)
 
+		it(
+			"should apply legacy modified highlight to both new groups",
+			function()
+				config.setup({
+					highlights = {
+						OilGitModified = { fg = "#111111" },
+					},
+				})
+				local cfg = config.get()
+
+				assert.equals("#111111", cfg.highlights.OilGitModified.fg)
+				assert.equals("#111111", cfg.highlights.OilGitModifiedStaged.fg)
+				assert.equals(
+					"#111111",
+					cfg.highlights.OilGitModifiedUnstaged.fg
+				)
+			end
+		)
+
 		it("should handle debug option", function()
 			config.setup({ debug = "verbose" })
 			local cfg = config.get()
@@ -172,6 +193,8 @@ describe("config", function()
 			local expected_groups = {
 				"OilGitAdded",
 				"OilGitModified",
+				"OilGitModifiedStaged",
+				"OilGitModifiedUnstaged",
 				"OilGitRenamed",
 				"OilGitDeleted",
 				"OilGitCopied",

tests/plenary/highlights_spec.lua

@@ -34,13 +34,17 @@ describe("highlights", function()
 		it("should create highlight groups that don't exist", function()
 			vim.cmd("highlight clear OilGitAdded")
 			vim.cmd("highlight clear OilGitModified")
+			vim.cmd("highlight clear OilGitModifiedStaged")
+			vim.cmd("highlight clear OilGitModifiedUnstaged")
 			vim.cmd("highlight clear OilGitDeleted")
 
 			highlights.setup()
 
 			local groups = {
 				"OilGitAdded",
 				"OilGitModified",
+				"OilGitModifiedStaged",
+				"OilGitModifiedUnstaged",
 				"OilGitDeleted",
 				"OilGitRenamed",
 				"OilGitUntracked",

tests/plenary/init_spec.lua

@@ -155,6 +155,8 @@ describe("init", function()
 			local groups = {
 				"OilGitAdded",
 				"OilGitModified",
+				"OilGitModifiedStaged",
+				"OilGitModifiedUnstaged",
 				"OilGitDeleted",
 				"OilGitRenamed",
 				"OilGitUntracked",

tests/plenary/status_mapper_spec.lua

@@ -142,9 +142,9 @@ describe("status_mapper", function()
 				assert.equals("+", sym)
 			end)
 
-			it("should map 'M ' to modified", function()
+			it("should map 'M ' to staged modified", function()
 				local hl, sym = status_mapper.map("M ", test_symbols)
-				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED, hl)
+				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED_STAGED, hl)
 				assert.equals("~", sym)
 			end)
 
@@ -168,9 +168,9 @@ describe("status_mapper", function()
 		end)
 
 		describe("worktree status - second character", function()
-			it("should map ' M' to modified", function()
+			it("should map ' M' to unstaged modified", function()
 				local hl, sym = status_mapper.map(" M", test_symbols)
-				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED, hl)
+				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED_UNSTAGED, hl)
 				assert.equals("~", sym)
 			end)
 
@@ -190,7 +190,13 @@ describe("status_mapper", function()
 
 			it("should prioritize index status for 'MD'", function()
 				local hl, sym = status_mapper.map("MD", test_symbols)
-				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED, hl)
+				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED_STAGED, hl)
+				assert.equals("~", sym)
+			end)
+
+			it("should prioritize staged modified for 'MM'", function()
+				local hl, sym = status_mapper.map("MM", test_symbols)
+				assert.equals(constants.HIGHLIGHT_GROUPS.MODIFIED_STAGED, hl)
 				assert.equals("~", sym)
 			end)
 
@@ -271,9 +277,9 @@ describe("status_mapper", function()
 				assert.equals(constants.PRIORITY.ADDED, priority)
 			end)
 
-			it("should return MODIFIED priority for 'M '", function()
+			it("should return staged modified priority for 'M '", function()
 				local priority = status_mapper.get_priority("M ")
-				assert.equals(constants.PRIORITY.MODIFIED, priority)
+				assert.equals(constants.PRIORITY.MODIFIED_STAGED, priority)
 			end)
 
 			it("should return DELETED priority for 'D '", function()
@@ -293,9 +299,9 @@ describe("status_mapper", function()
 		end)
 
 		describe("worktree statuses", function()
-			it("should return MODIFIED priority for ' M'", function()
+			it("should return unstaged modified priority for ' M'", function()
 				local priority = status_mapper.get_priority(" M")
-				assert.equals(constants.PRIORITY.MODIFIED, priority)
+				assert.equals(constants.PRIORITY.MODIFIED_UNSTAGED, priority)
 			end)
 
 			it("should return DELETED priority for ' D'", function()

tests/plenary/trie_spec.lua

@@ -58,7 +58,7 @@ describe("trie", function()
 					root.children["src"].children["file.lua"].status
 				)
 				assert.equals(
-					6,
+					7,
 					root.children["src"].children["file.lua"].priority
 				)
 			end
@@ -69,7 +69,7 @@ describe("trie", function()
 			local git_root = "/repo"
 
 			trie.insert(root, "/repo/src/a.lua", "A ", git_root) -- ADDED = 4
-			trie.insert(root, "/repo/src/b.lua", "M ", git_root) -- MODIFIED = 6
+			trie.insert(root, "/repo/src/b.lua", "M ", git_root) -- MODIFIED_STAGED = 7
 			trie.insert(root, "/repo/src/c.lua", "??", git_root) -- UNTRACKED = 2
 
 			assert.is_nil(root.children["src"].status)
@@ -204,7 +204,35 @@ describe("trie", function()
 				local root = trie.create_node()
 				local git_root = "/repo"
 				trie.insert(root, "/repo/src/a.lua", "??", git_root) -- UNTRACKED = 2
-				trie.insert(root, "/repo/src/b.lua", "M ", git_root) -- MODIFIED = 6
+				trie.insert(root, "/repo/src/b.lua", "M ", git_root) -- MODIFIED_STAGED = 7
+
+				local result = trie.lookup(root, "/repo/src", git_root)
+				assert.equals("M ", result)
+			end
+		)
+
+		it(
+			"should compute unstaged modified directory status from children",
+			function()
+				local root = trie.create_node()
+				local git_root = "/repo"
+
+				trie.insert(root, "/repo/src/a.lua", " M", git_root)
+				trie.insert(root, "/repo/src/b.lua", "??", git_root)
+
+				local result = trie.lookup(root, "/repo/src", git_root)
+				assert.equals(" M", result)
+			end
+		)
+
+		it(
+			"should prefer staged modified over unstaged for directories",
+			function()
+				local root = trie.create_node()
+				local git_root = "/repo"
+
+				trie.insert(root, "/repo/src/a.lua", " M", git_root)
+				trie.insert(root, "/repo/src/b.lua", "M ", git_root)
 
 				local result = trie.lookup(root, "/repo/src", git_root)
 				assert.equals("M ", result)