* feat(tui): add OSC 8 hyperlinks to make wrapped URLs clickable Long URLs that exceed terminal width get broken across lines by pi-tui's word wrapping, making them unclickable. Post-process rendered markdown output to add OSC 8 terminal hyperlink sequences around URL fragments, so each line fragment links to the full URL. Gracefully degrades on terminals without OSC 8 support. * tui: harden OSC8 URL extraction and prefix resolution * tui: add changelog entry for OSC 8 markdown hyperlinks --------- Co-authored-by: Vincent Koc <vincentkoc@ieee.org>
232 lines
6.5 KiB
TypeScript
232 lines
6.5 KiB
TypeScript
// Regex patterns for ANSI escape sequences (constructed from strings to
|
|
// satisfy the no-control-regex lint rule).
|
|
const SGR_PATTERN = "\\x1b\\[[0-9;]*m";
|
|
const OSC8_PATTERN = "\\x1b\\]8;;.*?(?:\\x07|\\x1b\\\\)";
|
|
const ANSI_RE = new RegExp(`${SGR_PATTERN}|${OSC8_PATTERN}`, "g");
|
|
const SGR_START_RE = new RegExp(`^${SGR_PATTERN}`);
|
|
const OSC8_START_RE = new RegExp(`^${OSC8_PATTERN}`);
|
|
|
|
/** Wrap text with an OSC 8 terminal hyperlink. */
|
|
export function wrapOsc8(url: string, text: string): string {
|
|
return `\x1b]8;;${url}\x07${text}\x1b]8;;\x07`;
|
|
}
|
|
|
|
/**
|
|
* Extract all unique URLs from raw markdown text.
|
|
* Finds both bare URLs and markdown link hrefs [text](url).
|
|
*/
|
|
export function extractUrls(markdown: string): string[] {
|
|
const urls = new Set<string>();
|
|
|
|
// Markdown link hrefs: [text](url), with optional <...> and optional title.
|
|
const mdLinkRe = /\[(?:[^\]]*)\]\(\s*<?(https?:\/\/[^)\s>]+)>?(?:\s+["'][^"']*["'])?\s*\)/g;
|
|
let m: RegExpExecArray | null;
|
|
while ((m = mdLinkRe.exec(markdown)) !== null) {
|
|
urls.add(m[1]);
|
|
}
|
|
|
|
// Bare URLs (remove markdown links first to avoid double-matching)
|
|
const stripped = markdown.replace(
|
|
/\[(?:[^\]]*)\]\(\s*<?https?:\/\/[^)\s>]+>?(?:\s+["'][^"']*["'])?\s*\)/g,
|
|
"",
|
|
);
|
|
const bareRe = /https?:\/\/[^\s)\]>]+/g;
|
|
while ((m = bareRe.exec(stripped)) !== null) {
|
|
urls.add(m[0]);
|
|
}
|
|
|
|
return [...urls];
|
|
}
|
|
|
|
/** Strip ANSI SGR and OSC 8 sequences to get visible text. */
|
|
function stripAnsi(input: string): string {
|
|
return input.replace(ANSI_RE, "");
|
|
}
|
|
|
|
interface UrlRange {
|
|
start: number; // visible text start index
|
|
end: number; // visible text end index (exclusive)
|
|
url: string; // full URL to link to
|
|
}
|
|
|
|
/**
|
|
* Find URL ranges in a line's visible text, handling cross-line URL splits.
|
|
*/
|
|
function findUrlRanges(
|
|
visibleText: string,
|
|
knownUrls: string[],
|
|
pending: { url: string; consumed: number } | null,
|
|
): { ranges: UrlRange[]; pending: { url: string; consumed: number } | null } {
|
|
const ranges: UrlRange[] = [];
|
|
let newPending: { url: string; consumed: number } | null = null;
|
|
let searchFrom = 0;
|
|
|
|
// Handle continuation of a URL broken from the previous line
|
|
if (pending) {
|
|
const remaining = pending.url.slice(pending.consumed);
|
|
const trimmed = visibleText.trimStart();
|
|
const leadingSpaces = visibleText.length - trimmed.length;
|
|
|
|
let matchLen = 0;
|
|
for (let j = 0; j < remaining.length && j < trimmed.length; j++) {
|
|
if (remaining[j] === trimmed[j]) {
|
|
matchLen++;
|
|
} else {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (matchLen > 0) {
|
|
ranges.push({
|
|
start: leadingSpaces,
|
|
end: leadingSpaces + matchLen,
|
|
url: pending.url,
|
|
});
|
|
searchFrom = leadingSpaces + matchLen;
|
|
|
|
if (pending.consumed + matchLen < pending.url.length) {
|
|
newPending = { url: pending.url, consumed: pending.consumed + matchLen };
|
|
}
|
|
}
|
|
}
|
|
|
|
// Find new URL starts in visible text
|
|
const urlRe = /https?:\/\/[^\s)\]>]+/g;
|
|
urlRe.lastIndex = searchFrom;
|
|
let match: RegExpExecArray | null;
|
|
|
|
while ((match = urlRe.exec(visibleText)) !== null) {
|
|
const fragment = match[0];
|
|
const start = match.index;
|
|
|
|
// Resolve fragment to a known URL (exact > prefix > superstring)
|
|
let resolvedUrl = fragment;
|
|
let found = false;
|
|
|
|
for (const known of knownUrls) {
|
|
if (known === fragment) {
|
|
resolvedUrl = known;
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!found) {
|
|
let bestLen = 0;
|
|
for (const known of knownUrls) {
|
|
if (known.startsWith(fragment) && known.length > bestLen) {
|
|
resolvedUrl = known;
|
|
bestLen = known.length;
|
|
found = true;
|
|
}
|
|
}
|
|
}
|
|
if (!found) {
|
|
let bestLen = 0;
|
|
for (const known of knownUrls) {
|
|
if (fragment.startsWith(known) && known.length > bestLen) {
|
|
resolvedUrl = known;
|
|
bestLen = known.length;
|
|
}
|
|
}
|
|
}
|
|
|
|
ranges.push({ start, end: start + fragment.length, url: resolvedUrl });
|
|
|
|
// If fragment is a strict prefix of the resolved URL, it may be split
|
|
if (resolvedUrl.length > fragment.length && resolvedUrl.startsWith(fragment)) {
|
|
newPending = { url: resolvedUrl, consumed: fragment.length };
|
|
}
|
|
}
|
|
|
|
return { ranges, pending: newPending };
|
|
}
|
|
|
|
/**
|
|
* Apply OSC 8 hyperlink sequences to a line based on visible-text URL ranges.
|
|
* Walks through the raw string character by character, inserting OSC 8
|
|
* open/close sequences at URL range boundaries while preserving ANSI codes.
|
|
*/
|
|
function applyOsc8Ranges(line: string, ranges: UrlRange[]): string {
|
|
if (ranges.length === 0) {
|
|
return line;
|
|
}
|
|
|
|
// Build a lookup: visible position → URL
|
|
const urlAt = new Map<number, string>();
|
|
for (const r of ranges) {
|
|
for (let p = r.start; p < r.end; p++) {
|
|
urlAt.set(p, r.url);
|
|
}
|
|
}
|
|
|
|
let result = "";
|
|
let visiblePos = 0;
|
|
let activeUrl: string | null = null;
|
|
let i = 0;
|
|
|
|
while (i < line.length) {
|
|
// Fast path: only check for escape sequences when we see ESC
|
|
if (line.charCodeAt(i) === 0x1b) {
|
|
// ANSI SGR sequence
|
|
const sgr = line.slice(i).match(SGR_START_RE);
|
|
if (sgr) {
|
|
result += sgr[0];
|
|
i += sgr[0].length;
|
|
continue;
|
|
}
|
|
|
|
// Existing OSC 8 sequence (pass through)
|
|
const osc = line.slice(i).match(OSC8_START_RE);
|
|
if (osc) {
|
|
result += osc[0];
|
|
i += osc[0].length;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// Visible character — toggle OSC 8 at range boundaries
|
|
const targetUrl = urlAt.get(visiblePos) ?? null;
|
|
if (targetUrl !== activeUrl) {
|
|
if (activeUrl !== null) {
|
|
result += "\x1b]8;;\x07";
|
|
}
|
|
if (targetUrl !== null) {
|
|
result += `\x1b]8;;${targetUrl}\x07`;
|
|
}
|
|
activeUrl = targetUrl;
|
|
}
|
|
|
|
result += line[i];
|
|
visiblePos++;
|
|
i++;
|
|
}
|
|
|
|
if (activeUrl !== null) {
|
|
result += "\x1b]8;;\x07";
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Add OSC 8 hyperlinks to rendered lines using a pre-extracted URL list.
|
|
*
|
|
* For each line, finds URL-like substrings in the visible text, matches them
|
|
* against known URLs, and wraps each fragment with OSC 8 escape sequences.
|
|
* Handles URLs broken across multiple lines by pi-tui's word wrapping.
|
|
*/
|
|
export function addOsc8Hyperlinks(lines: string[], urls: string[]): string[] {
|
|
if (urls.length === 0) {
|
|
return lines;
|
|
}
|
|
|
|
let pending: { url: string; consumed: number } | null = null;
|
|
|
|
return lines.map((line) => {
|
|
const visible = stripAnsi(line);
|
|
const result = findUrlRanges(visible, urls, pending);
|
|
pending = result.pending;
|
|
return applyOsc8Ranges(line, result.ranges);
|
|
});
|
|
}
|