Skip to content

refactor: read a block's overrides in one place #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcanouil merged 3 commits into from
Sep 21, 2026
Merged

refactor: read a block's overrides in one place #67

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e05c472
refactor: read a block's overrides in one place
mcanouil Sep 21, 2026
71a9643
refactor: let the marker closure use the block it captures
mcanouil Sep 21, 2026
722de5d
docs: state the collapse reason and the read rule once each
mcanouil Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 51 additions & 47 deletions _extensions/code-window/code-window.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,35 @@ local function read_block_lines_label(block, resolved)
return cln
end

--- @class WindowOverrides
--- @field enabled boolean Whether this block asks for chrome at all
--- @field style string|nil Style this block asks for, in place of the document's
--- @field lines_label string|nil Highlighted-lines spec for the title bar
--- @field no_auto_filename boolean Whether this block refuses a derived name

--- Read what a block asks of the chrome, in the order and the way both format
--- paths ask for it. Collapse is left out, because it is the one override that
--- is HTML only and the Typst path never reads.
--- code-window-enabled declares default: true, and code-window-no-auto-filename
--- declares default: false, each matching this file's own fallback. Neither
--- layers over a document option, so the resolved value answers directly, and
--- the stringified value decides the flag, which is what makes an explicit
--- "false" behave like absence rather than like "true".
--- All four are lookups on the resolved table and on the block, and take
--- nothing off the block, which take_block_attributes already did. So a caller
--- may read them all before it tests the opt-out, and their order is free.
--- @param block pandoc.CodeBlock Code block element
--- @param resolved table<string, any> This block's attributes, resolved against the schema
--- @return WindowOverrides
local function read_window_overrides(block, resolved)
return {
enabled = stringify_bool(resolved['code-window-enabled']) ~= 'false',
style = read_block_style(resolved),
lines_label = read_block_lines_label(block, resolved),
no_auto_filename = stringify_bool(resolved['code-window-no-auto-filename']) == 'true',
}
end

-- ============================================================================
-- TYPST FUNCTION DEFINITION
-- ============================================================================
Expand Down Expand Up @@ -612,63 +641,48 @@ end
--- @param auto_label string|nil Label written by the language module, if any
--- @return pandoc.Div|pandoc.CodeBlock Wrapped block or original
local function process_html(block, resolved, auto_label)
-- code-window-enabled declares default: true, matching this file's own
-- fallback (chrome applies unless turned off), and it never layers over a
-- document option, so the resolved value is read directly.
local block_enabled = resolved['code-window-enabled']
local overrides = read_window_overrides(block, resolved)

-- Per-block opt-out: code-window-enabled="false" skips window chrome.
if stringify_bool(block_enabled) == 'false' then
if not overrides.enabled then
return block
end

local block_style = read_block_style(resolved)
local effective_collapse = read_block_collapse(resolved) or CONFIG.collapse
local lines_label = read_block_lines_label(block, resolved)
-- code-window-no-auto-filename declares default: false, matching this
-- file's own fallback, and never layers over a document option either. The
-- stringified resolved value decides the flag, so an explicit "false"
-- behaves like absence rather than like "true".
local no_auto = stringify_bool(resolved['code-window-no-auto-filename']) == 'true'
local explicit_filename = block.attributes['filename']

if explicit_filename and explicit_filename ~= '' then
-- Let Quarto create the .code-with-filename wrapper.
-- Add a marker class for block-level style override; the injected JS
-- reads it and promotes it to the wrapper div.
if block_style then
table.insert(block.classes, 'cw-style-' .. block_style)
-- Add the marker classes and the chip the injected script reads. Both
-- branches below end this way, on the same block this closure captures.
local function mark()
if overrides.style then
table.insert(block.classes, 'cw-style-' .. overrides.style)
end
if effective_collapse then
table.insert(block.classes, 'cw-collapse-' .. effective_collapse)
end
if lines_label then
block.attributes['code-window-lines-label'] = lines_label
if overrides.lines_label then
block.attributes['code-window-lines-label'] = overrides.lines_label
end
end

if explicit_filename and explicit_filename ~= '' then
-- Let Quarto create the .code-with-filename wrapper, and mark the block so
-- the injected script can promote a block-level override onto that wrapper.
mark()
return block
end

if not CONFIG.auto_filename or no_auto then
if not CONFIG.auto_filename or overrides.no_auto_filename then
return block
end

-- Blocks with a language of their own are labelled with its class.
local filename = auto_label or block.classes[1]

-- Set the filename attribute so Quarto creates its own .code-with-filename
-- wrapper. This preserves the CodeBlock+OrderedList sibling structure
-- needed by Quarto's code-annotations processor.
block.attributes['filename'] = filename
block.attributes['filename'] = auto_label or block.classes[1]
table.insert(block.classes, 'cw-auto')
if block_style then
table.insert(block.classes, 'cw-style-' .. block_style)
end
if effective_collapse then
table.insert(block.classes, 'cw-collapse-' .. effective_collapse)
end
if lines_label then
block.attributes['code-window-lines-label'] = lines_label
end
mark()

return block
end
Expand Down Expand Up @@ -963,27 +977,17 @@ end
--- @return string|nil block_style
--- @return string|nil lines_label Highlighted-lines spec for the title bar
local function resolve_window_params(block, resolved, auto_label)
-- code-window-enabled declares default: true, matching this file's own
-- fallback, and never layers over a document option, so the resolved value
-- is read directly.
local block_enabled = resolved['code-window-enabled']
local overrides = read_window_overrides(block, resolved)

-- Per-block opt-out: code-window-enabled="false" skips window chrome.
if stringify_bool(block_enabled) == 'false' then
if not overrides.enabled then
return nil, false, nil, nil
end

local block_style = read_block_style(resolved)
local lines_label = read_block_lines_label(block, resolved)
-- code-window-no-auto-filename declares default: false, matching this
-- file's own fallback, and never layers over a document option either. The
-- stringified resolved value decides the flag, so an explicit "false"
-- behaves like absence rather than like "true".
local no_auto = stringify_bool(resolved['code-window-no-auto-filename']) == 'true'
local filename = block.attributes['filename']
local is_auto = false

if (not filename or filename == '') and not no_auto then
if (not filename or filename == '') and not overrides.no_auto_filename then
if CONFIG.auto_filename and block.classes and #block.classes > 0 then
-- Default/unknown/no-language blocks carry their label on
-- code-window-auto-label; everything else uses its language class.
Expand All @@ -992,7 +996,7 @@ local function resolve_window_params(block, resolved, auto_label)
end
end

return filename, is_auto, block_style, lines_label
return filename, is_auto, overrides.style, overrides.lines_label
end

--- Process a single CodeBlock for Typst, returning replacement blocks.
Expand Down
Loading