Skip to content

Commit 5e7b8dc

Browse files
committed
markdown: propagate fg/bg colors to code blocks
MarkdownRenderable creates child CodeRenderable instances for fenced code blocks and paragraph fallbacks, but has no way to pass foreground and background colors through. This means code blocks always render with default colors regardless of the parent context, which breaks light mode. Add fg/bg properties to MarkdownRenderable and forward them to every CodeRenderable created or updated during render. Related: anomalyco/opencode#16470
1 parent c0ea23e commit 5e7b8dc

3 files changed

Lines changed: 230 additions & 9 deletions

File tree

‎packages/core/src/renderables/Markdown.ts‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { SyntaxStyle, type StyleDefinition } from "../syntax-style.js"
44
import type { TextChunk } from "../text-buffer.js"
55
import { createTextAttributes } from "../utils.js"
66
import type { BorderStyle } from "../lib/border.js"
7-
import type { ColorInput } from "../lib/RGBA.js"
7+
import { RGBA, parseColor, type ColorInput } from "../lib/RGBA.js"
88
import { type MarkedToken, type Token, type Tokens } from "marked"
99
import { CodeRenderable, type OnChunksCallback } from "./Code.js"
1010
import {
@@ -63,6 +63,8 @@ export interface MarkdownTableOptions {
6363
export interface MarkdownOptions extends RenderableOptions<MarkdownRenderable> {
6464
content?: string
6565
syntaxStyle: SyntaxStyle
66+
fg?: ColorInput
67+
bg?: ColorInput
6668
/** Controls concealment for markdown syntax markers in markdown text blocks. */
6769
conceal?: boolean
6870
/** Controls concealment inside fenced code blocks rendered by CodeRenderable. */
@@ -122,6 +124,11 @@ interface ResolvedTableRenderableOptions {
122124

123125
const TRAILING_MARKDOWN_BLOCK_BREAKS_RE = /(?:\r?\n){2,}$/
124126

127+
function colorsEqual(left?: RGBA, right?: RGBA): boolean {
128+
if (!left || !right) return left === right
129+
return left.equals(right)
130+
}
131+
125132
export interface BlockState {
126133
token: MarkedToken
127134
tokenRaw: string // Cache raw for comparison
@@ -134,6 +141,8 @@ export type { ParseState }
134141
export class MarkdownRenderable extends Renderable {
135142
private _content: string = ""
136143
private _syntaxStyle: SyntaxStyle
144+
private _fg?: RGBA
145+
private _bg?: RGBA
137146
private _conceal: boolean
138147
private _concealCode: boolean
139148
private _treeSitterClient?: TreeSitterClient
@@ -165,6 +174,8 @@ export class MarkdownRenderable extends Renderable {
165174
})
166175

167176
this._syntaxStyle = options.syntaxStyle
177+
this._fg = options.fg ? parseColor(options.fg) : undefined
178+
this._bg = options.bg ? parseColor(options.bg) : undefined
168179
this._conceal = options.conceal ?? this._contentDefaultOptions.conceal
169180
this._concealCode = options.concealCode ?? this._contentDefaultOptions.concealCode
170181
this._content = options.content ?? this._contentDefaultOptions.content
@@ -201,6 +212,30 @@ export class MarkdownRenderable extends Renderable {
201212
}
202213
}
203214

215+
get fg(): RGBA | undefined {
216+
return this._fg
217+
}
218+
219+
set fg(value: ColorInput | undefined) {
220+
const next = value ? parseColor(value) : undefined
221+
if (!colorsEqual(this._fg, next)) {
222+
this._fg = next
223+
this._styleDirty = true
224+
}
225+
}
226+
227+
get bg(): RGBA | undefined {
228+
return this._bg
229+
}
230+
231+
set bg(value: ColorInput | undefined) {
232+
const next = value ? parseColor(value) : undefined
233+
if (!colorsEqual(this._bg, next)) {
234+
this._bg = next
235+
this._styleDirty = true
236+
}
237+
}
238+
204239
get conceal(): boolean {
205240
return this._conceal
206241
}
@@ -430,6 +465,8 @@ export class MarkdownRenderable extends Renderable {
430465
content,
431466
filetype: "markdown",
432467
syntaxStyle: this._syntaxStyle,
468+
fg: this._fg,
469+
bg: this._bg,
433470
conceal: this._conceal,
434471
drawUnstyledText: false,
435472
streaming: true,
@@ -446,6 +483,8 @@ export class MarkdownRenderable extends Renderable {
446483
content: token.text,
447484
filetype: token.lang || undefined,
448485
syntaxStyle: this._syntaxStyle,
486+
fg: this._fg,
487+
bg: this._bg,
449488
conceal: this._concealCode,
450489
drawUnstyledText: !(this._streaming && this._concealCode),
451490
streaming: this._streaming,
@@ -459,6 +498,8 @@ export class MarkdownRenderable extends Renderable {
459498
renderable.content = content
460499
renderable.filetype = "markdown"
461500
renderable.syntaxStyle = this._syntaxStyle
501+
renderable.fg = this._fg
502+
renderable.bg = this._bg
462503
renderable.conceal = this._conceal
463504
renderable.drawUnstyledText = false
464505
renderable.streaming = true
@@ -469,6 +510,8 @@ export class MarkdownRenderable extends Renderable {
469510
renderable.content = token.text
470511
renderable.filetype = token.lang || undefined
471512
renderable.syntaxStyle = this._syntaxStyle
513+
renderable.fg = this._fg
514+
renderable.bg = this._bg
472515
renderable.conceal = this._concealCode
473516
renderable.drawUnstyledText = !(this._streaming && this._concealCode)
474517
renderable.streaming = this._streaming
Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
import { test, expect, beforeEach, afterEach } from "bun:test"
2+
import { MarkdownRenderable, type MarkdownOptions } from "../Markdown.js"
3+
import { CodeRenderable } from "../Code.js"
4+
import { SyntaxStyle } from "../../syntax-style.js"
5+
import { RGBA } from "../../lib/RGBA.js"
6+
import { createTestRenderer, type TestRenderer, MockTreeSitterClient } from "../../testing.js"
7+
import type { CapturedFrame } from "../../types.js"
8+
9+
let renderer: TestRenderer
10+
let captureSpans: () => CapturedFrame
11+
12+
const syntaxStyle = SyntaxStyle.fromStyles({
13+
default: { fg: RGBA.fromValues(1, 1, 1, 1) },
14+
})
15+
16+
beforeEach(async () => {
17+
const testRenderer = await createTestRenderer({ width: 60, height: 20 })
18+
renderer = testRenderer.renderer
19+
captureSpans = testRenderer.captureSpans
20+
})
21+
22+
afterEach(async () => {
23+
if (renderer) {
24+
renderer.destroy()
25+
}
26+
})
27+
28+
function createMarkdownRenderable(options: MarkdownOptions): MarkdownRenderable {
29+
return new MarkdownRenderable(renderer, options)
30+
}
31+
32+
function findSpanContaining(frame: CapturedFrame, text: string) {
33+
for (const line of frame.lines) {
34+
const span = line.spans.find((candidate) => candidate.text.includes(text))
35+
if (span) return span
36+
}
37+
38+
return undefined
39+
}
40+
41+
function expectSpanColors(text: string, fg: RGBA, bg: RGBA): void {
42+
const span = findSpanContaining(captureSpans(), text)
43+
expect(span).toBeDefined()
44+
expect(span!.fg.equals(fg)).toBe(true)
45+
expect(span!.bg.equals(bg)).toBe(true)
46+
}
47+
48+
test("unlabeled fenced code blocks inherit markdown fg/bg defaults", async () => {
49+
const fg = RGBA.fromValues(0.1, 0.1, 0.1, 1)
50+
const bg = RGBA.fromValues(0.95, 0.95, 0.95, 1)
51+
52+
const md = createMarkdownRenderable({
53+
id: "markdown-code-default-colors",
54+
content: "```\nplain code block\n```",
55+
syntaxStyle,
56+
fg,
57+
bg,
58+
})
59+
60+
renderer.root.add(md)
61+
await renderer.idle()
62+
63+
const codeBlock = md._blockStates[0]?.renderable as CodeRenderable
64+
expect(codeBlock).toBeInstanceOf(CodeRenderable)
65+
expect(codeBlock.filetype).toBeUndefined()
66+
expect(codeBlock.fg.equals(fg)).toBe(true)
67+
expect(codeBlock.bg.equals(bg)).toBe(true)
68+
expectSpanColors("plain code block", fg, bg)
69+
})
70+
71+
test("unsupported fenced code blocks keep inherited markdown fg/bg after highlight fallback", async () => {
72+
const fg = RGBA.fromValues(0.15, 0.15, 0.15, 1)
73+
const bg = RGBA.fromValues(0.9, 0.9, 0.9, 1)
74+
const mockTreeSitterClient = new MockTreeSitterClient()
75+
mockTreeSitterClient.setMockResult({
76+
highlights: [],
77+
warning: "No parser available for filetype toml",
78+
})
79+
80+
const md = createMarkdownRenderable({
81+
id: "markdown-code-unsupported-colors",
82+
content: "```toml\nanswer = 42\n```",
83+
syntaxStyle,
84+
fg,
85+
bg,
86+
treeSitterClient: mockTreeSitterClient,
87+
})
88+
89+
renderer.root.add(md)
90+
await renderer.idle()
91+
expect(mockTreeSitterClient.isHighlighting()).toBe(true)
92+
93+
mockTreeSitterClient.resolveAllHighlightOnce()
94+
await Bun.sleep(10)
95+
await renderer.idle()
96+
97+
const codeBlock = md._blockStates[0]?.renderable as CodeRenderable
98+
expect(codeBlock).toBeInstanceOf(CodeRenderable)
99+
expect(codeBlock.filetype).toBe("toml")
100+
expect(codeBlock.fg.equals(fg)).toBe(true)
101+
expect(codeBlock.bg.equals(bg)).toBe(true)
102+
expectSpanColors("answer = 42", fg, bg)
103+
})
104+
105+
test("updating markdown fg/bg rerenders existing fenced code block renderables", async () => {
106+
const initialFg = RGBA.fromValues(0.1, 0.1, 0.1, 1)
107+
const initialBg = RGBA.fromValues(0.95, 0.95, 0.95, 1)
108+
const nextFg = RGBA.fromValues(0.8, 0.8, 0.8, 1)
109+
const nextBg = RGBA.fromValues(0.2, 0.2, 0.2, 1)
110+
111+
const md = createMarkdownRenderable({
112+
id: "markdown-code-color-update",
113+
content: "```\nplain code block\n```",
114+
syntaxStyle,
115+
fg: initialFg,
116+
bg: initialBg,
117+
})
118+
119+
renderer.root.add(md)
120+
await renderer.idle()
121+
122+
const codeBlock = md._blockStates[0]?.renderable as CodeRenderable
123+
expect(codeBlock).toBeInstanceOf(CodeRenderable)
124+
expectSpanColors("plain code block", initialFg, initialBg)
125+
126+
md.fg = nextFg
127+
md.bg = nextBg
128+
renderer.requestRender()
129+
await renderer.idle()
130+
131+
expect(md._blockStates[0]?.renderable).toBe(codeBlock)
132+
expect(codeBlock.fg.equals(nextFg)).toBe(true)
133+
expect(codeBlock.bg.equals(nextBg)).toBe(true)
134+
expectSpanColors("plain code block", nextFg, nextBg)
135+
})
136+
137+
test("updating markdown fg/bg rerenders markdown fallback renderables", async () => {
138+
const initialFg = RGBA.fromValues(0.15, 0.15, 0.15, 1)
139+
const initialBg = RGBA.fromValues(0.94, 0.94, 0.94, 1)
140+
const nextFg = RGBA.fromValues(0.75, 0.75, 0.75, 1)
141+
const nextBg = RGBA.fromValues(0.18, 0.18, 0.18, 1)
142+
const mockTreeSitterClient = new MockTreeSitterClient()
143+
mockTreeSitterClient.highlightOnce = async () => {
144+
throw new Error("Highlighting failed")
145+
}
146+
147+
const md = createMarkdownRenderable({
148+
id: "markdown-paragraph-color-update",
149+
content: "Plain paragraph text",
150+
syntaxStyle,
151+
fg: initialFg,
152+
bg: initialBg,
153+
treeSitterClient: mockTreeSitterClient,
154+
})
155+
156+
renderer.root.add(md)
157+
await renderer.idle()
158+
await Bun.sleep(10)
159+
await renderer.idle()
160+
161+
const paragraphBlock = md._blockStates[0]?.renderable as CodeRenderable
162+
expect(paragraphBlock).toBeInstanceOf(CodeRenderable)
163+
expect(paragraphBlock.filetype).toBe("markdown")
164+
expectSpanColors("Plain paragraph text", initialFg, initialBg)
165+
166+
md.fg = nextFg
167+
md.bg = nextBg
168+
renderer.requestRender()
169+
await renderer.idle()
170+
await Bun.sleep(10)
171+
await renderer.idle()
172+
173+
expect(md._blockStates[0]?.renderable).toBe(paragraphBlock)
174+
expect(paragraphBlock.fg.equals(nextFg)).toBe(true)
175+
expect(paragraphBlock.bg.equals(nextBg)).toBe(true)
176+
expectSpanColors("Plain paragraph text", nextFg, nextBg)
177+
})

‎packages/core/src/renderables/__tests__/Markdown.test.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,15 @@ async function renderMarkdown(markdown: string, conceal: boolean = true): Promis
103103
return "\n" + lines.join("\n").trimEnd()
104104
}
105105

106+
function findSpanContaining(frame: CapturedFrame, text: string) {
107+
for (const line of frame.lines) {
108+
const span = line.spans.find((candidate) => candidate.text.includes(text))
109+
if (span) return span
110+
}
111+
112+
return undefined
113+
}
114+
106115
test("basic table alignment", async () => {
107116
const markdown = `| Name | Age |
108117
|---|---|
@@ -2169,14 +2178,6 @@ The table alignment uses:
21692178
renderer.root.add(md)
21702179
await renderMarkdownRenderable(md)
21712180

2172-
const findSpanContaining = (frame: CapturedFrame, text: string) => {
2173-
for (const line of frame.lines) {
2174-
const span = line.spans.find((candidate) => candidate.text.includes(text))
2175-
if (span) return span
2176-
}
2177-
return undefined
2178-
}
2179-
21802181
const frame1 = captureSpans()
21812182
const headingSpan1 = findSpanContaining(frame1, "OpenTUI Markdown Demo")
21822183
expect(headingSpan1).toBeDefined()

0 commit comments

Comments
 (0)