Skip to content

util: fix OSC 8 hyperlink stripping in stripVTControlCharacters #64319

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
nodejs-github-bot merged 6 commits into from
Aug 24, 2026
+27 −7
Merged

util: fix OSC 8 hyperlink stripping in stripVTControlCharacters #64319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0817b0a
util: fix OSC 8 hyperlink stripping in stripVTControlCharacters
dushyant-hada-90 Jul 6, 2026
273fbfe
util: use [;:] as CSI parameter separator, matching ansi-regex v6.2.0
dushyant-hada-90 Jul 8, 2026
29f6205
util: extend stripVTControlCharacters regression tests
dushyant-hada-90 Jul 8, 2026
20fc79d
util: use full ansi-regex commit SHA in comment
dushyant-hada-90 Jul 20, 2026
983f681
util: align CSI regex grouping with ansi-regex
dushyant-hada-90 Jul 24, 2026
8bcabf1
test: clarify unterminated OSC strip comment
dushyant-hada-90 Jul 24, 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
12 changes: 5 additions & 7 deletions lib/internal/util/inspect.js
View file
Open in desktop
Comment thread
dushyant-hada-90 marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -282,16 +282,14 @@ const meta = [
];

// Regex used for ansi escape code splitting
// Ref: https://github.com/chalk/ansi-regex/blob/f338e1814144efb950276aac84135ff86b72dc8e/index.js
// Ref: https://github.com/chalk/ansi-regex/blob/72bc570aaf25fca25541b49c6a8564f3ec63e835/index.js
// License: MIT by Sindre Sorhus <[email protected]>
// Matches all ansi escape code sequences in a string
const ansi = new RegExp(
'[\\u001B\\u009B][[\\]()#;?]*' +
'(?:(?:(?:(?:;[-a-zA-Z\\d\\/\\#&.:=?%@~_]+)*' +
'|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/\\#&.:=?%@~_]*)*)?' +
'(?:\\u0007|\\u001B\\u005C|\\u009C))' +
'|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?' +
'[\\dA-PR-TZcf-nq-uy=><~]))', 'g',
'(?:\\u001B\\][\\s\\S]*?(?:\\u0007|\\u001B\\u005C|\\u009C))' +
'|[\\u001B\\u009B][[\\]()#;?]*' +
'(?:\\d{1,4}(?:[;:]\\d{0,4})*)?' +
'[\\dA-PR-TZcf-nq-uy=><~]', 'g',
);

let getStringWidth;
Expand Down
22 changes: 22 additions & 0 deletions test/parallel/test-util-stripvtcontrolcharacters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,31 @@ for (const ST of ['\u0007', '\u001B\u005C', '\u009C']) {
tests.push(
[`\u001B]8;;mailto:[email protected]${ST}mail\u001B]8;;${ST}`, 'mail'],
[`\u001B]8;k=v;https://example-a.com/?a_b=1&c=2#tit%20le${ST}click\u001B]8;;${ST}`, 'click'],
[`\u001B]8;;https://example.com/(foo${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo)bar${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/!foo${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo+bar${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/[foo]${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo$bar${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo'bar${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo*bar${ST}label\u001B]8;;${ST}`, 'label'],
[`\u001B]8;;https://example.com/foo,bar${ST}label\u001B]8;;${ST}`, 'label'],
);
}

// Colon-delimited CSI sub-parameters (SGR) should be stripped like the
// semicolon-delimited form.
tests.push(
['\u001B[38:2:255:0:0mHello\u001B[0m', 'Hello'],
['\u001B[4:3mUnderline\u001B[4:0m', 'Underline'],
);

// Unterminated OSC does not match the OSC alternative; the CSI alternative may
// still consume a short prefix (here ESC ] 8 ;; h), leaving the remainder.
tests.push(
['\u001B]8;;https://example.com/no-terminator', 'ttps://example.com/no-terminator'],
);

test('util.stripVTControlCharacters', (t) => {
for (const [before, expected] of tests) {
t.assert.strictEqual(util.stripVTControlCharacters(before), expected);
Expand Down
Loading