feat(typst): Added org indent for sections with headings

Closes #501

Author: OXY2DEV

doc/markview.nvim-typst.txt

@@ -135,8 +135,13 @@ headings                                          *markview.nvim-typst.headings*
 	---
 	---@field enable boolean Enable rendering of Headings.
 	---
-	---@field shift_width integer Amount of spaces to shift per heading level.
 	---@field [string] headings.typst Heading level configuration(name format: "heading_%d", %d = heading level).
+	---
+	---@field shift_width integer Amount of spaces to add before the text for teach heading level.
+	---
+	---@field org_indent? boolean Enables `Org mode` like section indentation. Disabled by default.
+	---@field org_shift_width? integer Amount of `org_shift_char` to add per heading level.
+	---@field org_shift_char? string Character used for indenting/shifting the sections.
 <
 
 Changes how headings are shown.

lua/markview/config/typst.lua

@@ -1,3 +1,4 @@
+---@type markview.config.typst
 return {
 	enable = true,
 
@@ -65,7 +66,11 @@ return {
 			style = "icon",
 
 			icon = "󰎴  ", hl = "MarkviewHeading6",
-		}
+		},
+
+		org_indent = false,
+		org_shift_char = " ",
+		org_shift_width = 1,
 	},
 
 	labels = {

lua/markview/parsers/markdown.lua

@@ -60,7 +60,7 @@ markdown.atx_heading = function (buffer, TSNode, text, range)
 
 		Each `atx_heading` creates a `section` in the document.
 		By checking the depth of a `section` & it's sibling `section`s
-		we cab determine the level of a heading.
+		we can determine the level of a heading.
 
 		Level format: 1.1.1.1
 		They are calculated like so,

lua/markview/parsers/typst.lua

@@ -483,6 +483,42 @@ typst.idet = function (_, TSNode, text, range)
 	});
 end
 
+---@param buffer integer
+---@param TSNode table
+---@param text string[]
+---@param range markview.parsed.typst.sections.range
+typst.section = function (buffer, TSNode, text, range)
+	local heading = TSNode:child(0);
+	local heading_text = vim.treesitter.get_node_text(heading, buffer);
+
+	---@type TSNode?
+	local content = heading:next_sibling();
+	local org_end = range.row_end;
+
+	if content then
+		local child = content:named_child(0);
+
+		while child do
+			if child:type() == "section" then
+				org_end = -1 + child:range();
+				break;
+			end
+
+			child = child:next_named_sibling();
+		end
+	end
+
+	range.org_end = org_end;
+
+	table.insert(typst.content, {
+		class = "typst_section",
+		level = heading_text:match("^%s*(=+)"):len(),
+
+		text = text,
+		range = range
+	});
+end
+
 --- Parser for typst.
 ---@param buffer integer
 ---@param TSTree table
@@ -500,6 +536,9 @@ typst.parse = function (buffer, TSTree, from, to)
 	typst.content = {};
 
 	local scanned_queries = vim.treesitter.query.parse("typst", [[
+		((section
+			(heading)) @typst.section)
+
 		((attach
 			sub: (_) @typst.subscript))
 

lua/markview/renderers/typst.lua

@@ -425,15 +425,21 @@ typst.heading = function (buffer, item)
 			line_hl_group = utils.set_hl(config.hl)
 		});
 	elseif config.style == "icon" then
+		local shift_width = main_config.shift_width or 0;
+		local shift_char = " ";
+
 		vim.api.nvim_buf_set_extmark(buffer, typst.ns, range.row_start, range.col_start, {
 			undo_restore = false, invalidate = true,
 			end_col = range.col_start + item.level + 1,
+
 			conceal = "",
+
 			sign_text = config.sign,
 			sign_hl_group = utils.set_hl(config.sign_hl),
+
 			virt_text_pos = "inline",
 			virt_text = {
-				{ string.rep(" ", item.level * spec.get({ "typst", "headings", "shift_width" }, { fallback = 1 })) },
+				{ string.rep(shift_char, (item.level - 1) * shift_width) },
 				{ config.icon or "", utils.set_hl(config.icon_hl or config.hl) },
 			},
 			line_hl_group = utils.set_hl(config.hl),
@@ -1569,6 +1575,68 @@ typst.text = function (buffer, item)
 	});
 end
 
+--- Render org mode like section indentations.
+---@param buffer integer
+---@param item markview.parsed.typst.sections
+typst.section = function (buffer, item)
+	---@type markview.config.typst.headings?
+	local main_config = spec.get({ "typst", "headings" }, { fallback = nil, eval_args = { buffer, item } });
+
+	if main_config == nil then
+		return;
+	elseif main_config.org_indent ~= true then
+		--- Org indent mode disabled.
+		return;
+	end
+
+	local shift_width = main_config.org_shift_width or main_config.shift_width or 0;
+	local shift_char = main_config.org_shift_char or " ";
+
+	local range = item.range;
+
+	for l = range.row_start + 1, range.org_end do
+		vim.api.nvim_buf_set_extmark(buffer, typst.ns, l, 0, {
+			undo_restore = false, invalidate = true,
+
+			virt_text_pos = "inline",
+			virt_text = {
+				{
+					string.rep(
+						shift_char,
+						math.max(
+							0,
+							shift_width * (item.level - 1)
+						)
+					)
+				}
+			},
+
+			right_gravity = false,
+			hl_mode = "combine"
+		});
+	end
+
+	---@type integer, integer Start & end fold level.
+	local foldlevel_s, foldlevel_e;
+
+	vim.api.nvim_buf_call(buffer, function ()
+		foldlevel_s = vim.fn.foldlevel(range.row_start + 1);
+		foldlevel_e = vim.fn.foldlevel(range.row_end + 1);
+	end)
+
+	if foldlevel_s ~= 0 or foldlevel_e ~= 0 then
+		--- Text was folded.
+		return;
+	end
+
+	local win = utils.buf_getwin(buffer);
+
+	if win and main_config.org_indent_wrap == true and vim.wo[win].wrap == true then
+		--- When `wrap` is enabled, run post-processing effects.
+		table.insert(typst.cache, item);
+	end
+end
+
 --- Renders typst previews.
 ---@param buffer integer
 ---@param content markview.parsed.typst[]

lua/markview/types/parsers/typst.lua

@@ -210,6 +210,27 @@
 
 ------------------------------------------------------------------------------
 
+--- Used for Org-indent.
+---@class markview.parsed.typst.sections
+---
+---@field class "typst_section"
+---@field level integer
+---
+---@field text string[]
+---@field range markview.parsed.typst.sections.range
+
+
+---@class markview.parsed.typst.sections.range
+---
+---@field row_start integer
+---@field row_end integer
+---@field col_start integer
+---@field col_end integer
+---
+---@field org_end integer Line where `Org indent` should end.
+
+------------------------------------------------------------------------------
+
 ---@alias markview.parsed.typst
 ---| markview.parsed.typst.code_block
 ---| markview.parsed.typst.code_spans
@@ -222,6 +243,7 @@
 ---| markview.parsed.typst.raw_blocks
 ---| markview.parsed.typst.raw_spans
 ---| markview.parsed.typst.reference_links
+---| markview.parsed.typst.sections
 ---| markview.parsed.typst.strong
 ---| markview.parsed.typst.subscripts
 ---| markview.parsed.typst.superscripts
@@ -251,3 +273,5 @@
 ---@field typst_emphasis markview.parsed.typst.emphasis[]
 ---@field typst_strong markview.parsed.typst.strong[]
 ---@field typst_text markview.parsed.typst.text[]
+---@field typst_section markview.parsed.typst.sections[]
+

lua/markview/types/renderers/typst.lua

@@ -76,8 +76,13 @@
 ---
 ---@field enable boolean Enable rendering of Headings.
 ---
----@field shift_width integer Amount of spaces to shift per heading level.
 ---@field [string] headings.typst Heading level configuration(name format: "heading_%d", %d = heading level).
+---
+---@field shift_width integer Amount of spaces to add before the text for teach heading level.
+---
+---@field org_indent? boolean Enables `Org mode` like section indentation. Disabled by default.
+---@field org_shift_width? integer Amount of `org_shift_char` to add per heading level.
+---@field org_shift_char? string Character used for indenting/shifting the sections.
 
 
 --- Configuration options for each typst heading level.