shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(tui): use OSC 8 hyperlinks in Markdown when terminal supports them (#3248)

Browse Source 
TerminalCapabilities already tracks hyperlinks: boolean and returns true
for Ghostty, Kitty, WezTerm, and iTerm2, but nothing generated OSC 8
sequences. This completes that stub.

Changes to packages/tui:
- terminal-image.ts: add hyperlink(text, url) and setCapabilities()
- index.ts: export hyperlink and setCapabilities
- utils.ts: extend AnsiCodeTracker to track active OSC 8 URLs
  - process() now handles OSC 8 open/close sequences
  - getActiveCodes() re-emits the OSC 8 open at each line start
  - getLineEndReset() closes the OSC 8 hyperlink before each line break
  This ensures hyperlinks wrap correctly across multiple lines.
- components/markdown.ts: link renderer uses hyperlink() when
  getCapabilities().hyperlinks is true; falls back to (url) text
- Tests: new wrap-ansi tests for OSC 8 line-wrapping; terminal-image
  tests for hyperlink(); markdown tests covering both code paths;
  table-cell width test pinned to hyperlinks:false (checks raw columns)

closes #3239

Co-authored-by: AI (Pi/Claude Sonnet 4.6) <noreply@pi.dev>
Co-authored-by: Mario Zechner <badlogicgames@gmail.com>
This commit is contained in:
Omair Ahmed
2026-04-16 16:13:36 -04:00
committed by GitHub
parent acbf8eca06
commit e8743e870b
7 changed files with 212 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
packages/tui/src/utils.ts
View File

@@ -311,8 +311,16 @@ class AnsiCodeTracker {
private strikethrough = false;
private fgColor: string | null = null; // Stores the full code like "31" or "38;5;240"
private bgColor: string | null = null; // Stores the full code like "41" or "48;5;240"
private activeHyperlink: string | null = null; // Active OSC 8 hyperlink URL, or null
process(ansiCode: string): void {
// OSC 8 hyperlink: \x1b]8;;<url>\x1b\\ (open) or \x1b]8;;\x1b\\ (close)
if (ansiCode.startsWith("\x1b]8;")) {
const m = ansiCode.match(/^\x1b\]8;[^;]*;([^\x1b\x07]*)/);
this.activeHyperlink = m?.[1] ? m[1] : null;
return;
}
if (!ansiCode.endsWith("m")) {
return;
}
@@ -447,11 +455,13 @@ class AnsiCodeTracker {
this.strikethrough = false;
this.fgColor = null;
this.bgColor = null;
// SGR reset does not affect OSC 8 hyperlink state
}
/** Clear all state for reuse. */
clear(): void {
this.reset();
this.activeHyperlink = null;
}
getActiveCodes(): string {
@@ -467,8 +477,11 @@ class AnsiCodeTracker {
if (this.fgColor) codes.push(this.fgColor);
if (this.bgColor) codes.push(this.bgColor);
if (codes.length === 0) return "";
return `\x1b[${codes.join(";")}m`;
let result = codes.length > 0 ? `\x1b[${codes.join(";")}m` : "";
if (this.activeHyperlink) {
result += `\x1b]8;;${this.activeHyperlink}\x1b\\`;
}
return result;
}
hasActiveCodes(): boolean {
@@ -482,22 +495,26 @@ class AnsiCodeTracker {
this.hidden ||
this.strikethrough ||
this.fgColor !== null ||
this.bgColor !== null
this.bgColor !== null ||
this.activeHyperlink !== null
);
}
/**
* Get reset codes for attributes that need to be turned off at line end,
* specifically underline which bleeds into padding.
* Returns empty string if no problematic attributes are active.
* Get reset codes for attributes that need to be turned off at line end.
* Underline must be closed to prevent bleeding into padding.
* Active OSC 8 hyperlinks must be closed and re-opened on the next line.
* Returns empty string if no attributes need closing.
*/
getLineEndReset(): string {
// Only underline causes visual bleeding into padding
// Other attributes like colors don't visually bleed to padding
let result = "";
if (this.underline) {
return "\x1b[24m"; // Underline off only
result += "\x1b[24m"; // Underline off only
}
return "";
if (this.activeHyperlink) {
result += "\x1b]8;;\x1b\\"; // Close hyperlink; re-opened at line start via getActiveCodes()
}
return result;
}
}