[R2] Fix code block highlighting for Sippy commands - #33408
Open
SomSamantray wants to merge 1 commit into
Open
SomSamantray wants to merge 1 commit into
SomSamantray wants to merge 1 commit into
Conversation
SomSamantray
requested review from
a team,
harshil1712,
helloimalastair,
jonesphillip and
rdimaio
as code owners
September 13, 2026 12:07
Contributor
Review✅ No issues found in commit Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Shiki's shell grammar reads
<and>as redirections, so the<BUCKET_NAME>placeholder in the Sippy commands rendered with its last character in the default text colour — the artifact reported in #32496. Quoting the placeholder makes it a single shell string token, so the block highlights uniformly again.The fix deliberately keeps the
shfence language and the angle-bracket placeholder form. The style guide requires a language on every fence, requiresshorbashfor terminal commands, and requires angle-bracket placeholders in non-API contexts — switching totxt, dropping the language, or renaming the placeholder would break one of those three. A quoted placeholder is also copy-safe: pastingnpx wrangler r2 bucket sippy enable "<BUCKET_NAME>"and replacing the placeholder works, and if the quotes are left in place the shell strips them.Applied to the reported changelog entry and to the same command's
enableanddisableoccurrences on the Sippy page, which carried the identical block. The JSON IAM policy on that page also contains<BUCKET_NAME>, but it is a JSON string literal inside ajsonfence, so its grammar handles it correctly and it is unchanged.One thing this does not fix: the same mis-highlighting affects 423 other code blocks across 224 files, wherever a
shorbashfence contains an unquoted angle-bracket placeholder. That is a rendering-wide issue and the durable fix is a Shiki transformer or grammar override inastro.config.ts, which changes highlighting on every page and needs a maintainer's call. Raising it here rather than sweeping hundreds of files.Fixes #32496
Documentation checklist