Skip to content

fix(theme): Fix code block magic comments with CRLF line breaks bug #11046

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
slorber merged 2 commits into from
Apr 1, 2025
Merged

fix(theme): Fix code block magic comments with CRLF line breaks bug #11046

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dfb12f
fix: with CRLF line breaks, an extra empty line was rendered with // …
coder-xiaomo Mar 29, 2025
17d38d5
Add unit tests
slorber Apr 1, 2025
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
4 changes: 2 additions & 2 deletions packages/docusaurus-theme-common/src/utils/codeBlockUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ export function parseLines(
*/
code: string;
} {
let code = content.replace(/\n$/, '');
let code = content.replace(/\r?\n$/, '');
const {language, magicComments, metastring} = options;
// Highlighted lines specified in props: don't parse the content
if (metastring && metastringLinesRangeRegex.test(metastring)) {
Expand All @@ -266,7 +266,7 @@ export function parseLines(
magicComments,
);
// Go through line by line
const lines = code.split('\n');
const lines = code.split(/\r?\n/);
const blocks = Object.fromEntries(
magicComments.map((d) => [d.className, {start: 0, range: ''}]),
);
Expand Down