feat(markdown): Added option to make table parsing strict

OXY2DEV · OXY2DEV · commit 68c9603b6f88 · 2025-05-24T20:14:57.000+06:00
Closes #349
diff --git a/doc/markdown_options.txt b/doc/markdown_options.txt
@@ -1215,6 +1215,7 @@ Configuration for tables.
     ---@class markdown.tables
     ---
     ---@field enable boolean
+    ---@field strict boolean When `true`, leading & trailing whitespaces won't be considered part of the cell.
     ---
     ---@field block_decorator boolean
     ---@field use_virt_lines boolean
@@ -1263,6 +1264,7 @@ Configuration for tables.
     ---@class markdown.tables_static
     ---
     ---@field enable boolean
+    ---@field strict boolean When `true`, leading & trailing whitespaces won't be considered part of the cell.
     ---
     ---@field block_decorator boolean Whether to draw top & bottom border.
     ---@field use_virt_lines boolean Whether to use virtual lines for the borders.
@@ -1302,6 +1304,7 @@ Configuration for tables.
     ---@class __markdown.tables
     ---
     ---@field class "markdown_table"
+    ---@field has_alignment_markers boolean Are there any alignment markers(e.g. `:-`, `-:`, `:-:`)?
     ---
     ---@field top_border boolean Can we draw the top border?
     ---@field bottom_border boolean Can we draw the bottom border?
diff --git a/lua/definitions/markdown.lua b/lua/definitions/markdown.lua
@@ -812,6 +812,7 @@ M.__reference_definitions_range = {
 ---@class markdown.tables
 ---
 ---@field enable boolean
+---@field strict boolean When `true`, leading & trailing whitespaces are not considered part of the cell.
 ---
 ---@field block_decorator boolean
 ---@field use_virt_lines boolean
@@ -832,6 +833,7 @@ M.markdown_tables = {
 ---@class markdown.tables_static
 ---
 ---@field enable boolean
+---@field strict boolean When `true`, leading & trailing whitespaces are not considered part of the cell.
 ---
 ---@field block_decorator boolean Whether to draw top & bottom border.
 ---@field use_virt_lines boolean Whether to use virtual lines for the borders.
@@ -870,6 +872,7 @@ M.tables_parts = {
 ---@class __markdown.tables
 ---
 ---@field class "markdown_table"
+---@field has_alignment_markers boolean Are there any alignment markers(e.g. `:-`, `-:`, `:-:`)?
 ---
 ---@field top_border boolean Can we draw the top border?
 ---@field bottom_border boolean Can we draw the bottom border?
diff --git a/lua/markview/parsers/markdown.lua b/lua/markview/parsers/markdown.lua
@@ -610,6 +610,7 @@ markdown.table = function (_, _, text, range)
 	---+${lua}
 
 	local header, separator, rows = {}, {}, {};
+	local has_alignment_markers = false;
 	local aligns = {};
 
 	if text[1] and text[1]:match("^%s+") then
@@ -647,10 +648,13 @@ markdown.table = function (_, _, text, range)
 				end
 
 				if col:match("^%s*:") and col:match(":%s*$") then
+					has_alignment_markers = true;
 					table.insert(aligns, "center");
 				elseif col:match("^%s*:") then
+					has_alignment_markers = true;
 					table.insert(aligns, "left");
 				elseif col:match(":%s*$") then
+					has_alignment_markers = true;
 					table.insert(aligns, "right");
 				else
 					table.insert(aligns, "default");
@@ -674,6 +678,7 @@ markdown.table = function (_, _, text, range)
 		border_overlap = border_overlap,
 
 		alignments = aligns,
+		has_alignment_markers = has_alignment_markers,
 
 		header = header,
 		separator = separator,
diff --git a/lua/markview/renderers/markdown.lua b/lua/markview/renderers/markdown.lua
@@ -2365,6 +2365,15 @@ markdown.table = function (buffer, item)
 		end
 	end
 
+	---@type boolean
+	local strict = config.strict ~= nil and config.strict or true;
+
+	if item.has_alignment_markers == false then
+		-- Disable strict mode if no alignment
+		-- markers are found.
+		strict = false;
+	end
+
 	---@type integer[] Visible column widths(may be inaccurate).
 	local col_widths = {};
 
@@ -2647,6 +2656,31 @@ markdown.table = function (buffer, item)
 			local visible_width = visible_texts.header[c];
 			local column_width  = col_widths[c];
 
+			if strict then
+				local before = string.match(part.text, "^%s*");
+				local after = string.match(part.text, "%s*$");
+
+				if #before > 1 then
+					vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_start, range.col_start + part.col_start + 1, {
+						undo_restore = false, invalidate = true,
+						end_col = range.col_start + part.col_start + #before,
+						conceal = ""
+					});
+
+					visible_width = visible_width - (#before - 1);
+				end
+
+				if #after > 1 then
+					vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_start, range.col_start + part.col_end - #after, {
+						undo_restore = false, invalidate = true,
+						end_col = range.col_start + part.col_end - 1,
+						conceal = ""
+					});
+
+					visible_width = visible_width - (#after - 1);
+				end
+			end
+
 			local top, top_hl = get_border("top", 2);
 
 			table.insert(tmp, {
@@ -3040,6 +3074,31 @@ markdown.table = function (buffer, item)
 				local visible_width = visible_texts.rows[r][c];
 				local column_width  = col_widths[c];
 
+				if strict then
+					local before = string.match(part.text, "^%s*");
+					local after = string.match(part.text, "%s*$");
+
+					if #before > 1 then
+						vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_start + (r + 1), range.col_start + part.col_start + 1, {
+							undo_restore = false, invalidate = true,
+							end_col = range.col_start + part.col_start + #before,
+							conceal = ""
+						});
+
+						visible_width = visible_width - (#before - 1);
+					end
+
+					if #after > 1 then
+						vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_start + (r + 1), range.col_start + part.col_end - #after, {
+							undo_restore = false, invalidate = true,
+							end_col = range.col_start + part.col_end - 1,
+							conceal = ""
+						});
+
+						visible_width = visible_width - (#after - 1);
+					end
+				end
+
 				if visible_width < column_width then
 					if item.alignments[c] == "default" or item.alignments[c] == "left" then
 						vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_start + (r + 1), range.col_start + part.col_end, {
@@ -3217,6 +3276,31 @@ markdown.table = function (buffer, item)
 			local visible_width = visible_texts.rows[#visible_texts.rows][c];
 			local column_width  = col_widths[c];
 
+			if strict then
+				local before = string.match(part.text, "^%s*");
+				local after = string.match(part.text, "%s*$");
+
+				if #before > 1 then
+					vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_end - 1, range.col_start + part.col_start + 1, {
+						undo_restore = false, invalidate = true,
+						end_col = range.col_start + part.col_start + #before,
+						conceal = ""
+					});
+
+					visible_width = visible_width - (#before - 1);
+				end
+
+				if #after > 1 then
+					vim.api.nvim_buf_set_extmark(buffer, markdown.ns, range.row_end - 1, range.col_start + part.col_end - #after, {
+						undo_restore = false, invalidate = true,
+						end_col = range.col_start + part.col_end - 1,
+						conceal = ""
+					});
+
+					visible_width = visible_width - (#after - 1);
+				end
+			end
+
 			local bottom, bottom_hl = bottom_part(2);
 
 			table.insert(tmp, {
diff --git a/lua/markview/spec.lua b/lua/markview/spec.lua
@@ -1065,6 +1065,7 @@ spec.default = {
 			---+ ${class, Tables}
 
 			enable = true,
+			strict = false,
 
 			col_min_width = 10,
 			block_decorator = true,
diff --git a/markview.nvim.wiki b/markview.nvim.wiki
@@ -1 +1 @@
-Subproject commit 1b903d579847edd8800d12cb659ea19017beea28
+Subproject commit a7500ce610f0c3229830b534ca83e801875f195c
