Skip to content

Syntax-highlight run_r code #192

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
simonpcouch merged 2 commits into from
Aug 27, 2026
+87 −4
Merged

Syntax-highlight run_r code #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55aecbd
Highlight run_r code
simonpcouch Aug 27, 2026
9de71a7
Keep run_r output on one line
simonpcouch Aug 27, 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
1 change: 1 addition & 0 deletions pkg-r/DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Imports:
ellmer (>= 0.4.1),
evaluate,
glue,
highr,
htmltools,
httr2 (>= 1.1.0),
jsonlite,
Expand Down
13 changes: 12 additions & 1 deletion pkg-r/R/run-r.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ run_r_html <- function(code, segments) {
}
code_html <- sprintf(
"<pre class=\"commons-run-r-code\"><code class=\"language-r\">%s</code></pre>",
html_escape(paste(c(code, output), collapse = "\n"))
highlight_r_html(paste(c(code, output), collapse = "\n"))
)
if (length(plot_html)) {
code_html <- paste0(
Expand All @@ -251,6 +251,17 @@ run_r_html <- function(code, segments) {
)
}

highlight_r_html <- function(code) {
fallback <- tryCatch(
{
parse(text = code)
FALSE
},
error = function(...) TRUE
)
paste(highr::hi_html(code, fallback = fallback), collapse = "\n")
}

# --- worker lifecycle --------------------------------------------------------

new_r_worker <- function(network = "none", protection = "sandbox") {
Expand Down
45 changes: 44 additions & 1 deletion pkg-r/inst/www/commons-chat/commons-chat.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,12 +373,55 @@ shiny-chat-container
text-transform: uppercase;
}

.commons-run-r-code {
.commons-run-r-display .commons-run-r-code {
margin: 0;
overflow-x: auto;
white-space: pre;
}

.commons-run-r-code .hl.com {
color: #a0a1a7;
font-style: italic;
}

.commons-run-r-code .hl.kwa {
color: #a626a4;
}

.commons-run-r-code .hl.kwc,
.commons-run-r-code .hl.num {
color: #986801;
}

.commons-run-r-code .hl.kwd {
color: #4078f2;
}

.commons-run-r-code .hl.sng {
color: #50a14f;
}

[data-bs-theme="dark"] .commons-run-r-code .hl.com {
color: #5c6370;
}

[data-bs-theme="dark"] .commons-run-r-code .hl.kwa {
color: #c678dd;
}

[data-bs-theme="dark"] .commons-run-r-code .hl.kwc,
[data-bs-theme="dark"] .commons-run-r-code .hl.num {
color: #d19a66;
}

[data-bs-theme="dark"] .commons-run-r-code .hl.kwd {
color: #61aeee;
}

[data-bs-theme="dark"] .commons-run-r-code .hl.sng {
color: #98c379;
}

.commons-run-r-details > .commons-run-r-code {
margin-top: 0.4rem;
}
Expand Down
32 changes: 30 additions & 2 deletions pkg-r/tests/testthat/test-run-r.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ test_that("run_r executes code against stored handles", {
'<pre class="commons-run-r-code"><code class="language-r">',
fixed = TRUE
)
expect_match(
res@extra$display$html,
'<span class="hl kwd">sum</span>',
fixed = TRUE
)
expect_match(
res@extra$display$html,
'<span class="hl com">#&gt; [1] 5650</span>',
fixed = TRUE
)
expect_match(res@extra$display$html, "#&gt; [1] 5650", fixed = TRUE)
expect_no_match(res@extra$display$html, "<details", fixed = TRUE)
expect_no_match(
Expand Down Expand Up @@ -181,19 +191,37 @@ test_that("run_r displays code directly when it produces no output", {

expect_match(res@value, "produced no output", fixed = TRUE)
expect_false(res@extra$display$open)
expect_match(res@extra$display$html, "x &lt;- 1", fixed = TRUE)
expect_match(
res@extra$display$html,
'<span class="hl def">x</span>',
fixed = TRUE
)
expect_match(
res@extra$display$html,
'<span class="hl num">1</span>',
fixed = TRUE
)
expect_match(res@extra$display$html, "commons-run-r-code", fixed = TRUE)
expect_no_match(res@extra$display$html, "#&gt;", fixed = TRUE)
expect_no_match(res@extra$display$html, "<details", fixed = TRUE)
})

test_that("run_r highlights malformed code without exposing HTML", {
expect_no_warning(
html <- run_r_html("x <- '<unsafe>' +", list())
)

expect_match(html, "'&lt;unsafe&gt;'", fixed = TRUE)
expect_no_match(html, "<unsafe>", fixed = TRUE)
})

test_that("run_r displays worker failures directly and escapes their HTML", {
res <- run_r_result("x <- '<unsafe>'", list(failure = "worker <broke>"))

expect_match(res@value, "Error: worker <broke>", fixed = TRUE)
expect_equal(res@extra$display$title, "Analyzed data")
expect_false(res@extra$display$open)
expect_match(res@extra$display$html, "&#39;&lt;unsafe&gt;&#39;", fixed = TRUE)
expect_match(res@extra$display$html, "'&lt;unsafe&gt;'", fixed = TRUE)
expect_match(res@extra$display$html, "#&gt; worker &lt;broke&gt;", fixed = TRUE)
expect_match(res@extra$display$html, "commons-run-r-code", fixed = TRUE)
expect_no_match(res@extra$display$html, "<details", fixed = TRUE)
Expand Down
Loading