fix(formatter): escape double quotes when printing formatter IR #3036

dyc3 · 2024-06-01T13:35:19Z

Summary

Double quotes in source code when printing formatter IR were previously not escaped, causing poor syntax highlighing on the playground. This PR escapes quotes with a simple string replacement.

fixes #1056

Test Plan

CI should pass, ~~but I'm not sure where to add a test for this.~~ I've added a unit test for this.

codspeed-hq · 2024-06-01T14:07:00Z

CodSpeed Performance Report

Merging #3036 will not alter performance

_{Comparing dyc3:06-01-fix_formatter_escape_double_quotes_when_printing_formatter_ir (e352ec5) with main (e3e93cc)}

Summary

✅ 90 untouched benchmarks

ah-yu

CI should pass, but I'm not sure where to add a test for this.

Maybe you can refer to this test

biome/crates/biome_formatter/src/format_element/document.rs

Lines 718 to 752 in 312e46f

    
               fn display_elements() { 
        
                   let formatted = format!( 
        
                       SimpleFormatContext::default(), 
        
                       [format_with(|f| { 
        
                           write!( 
        
                               f, 
        
                               [group(&format_args![ 
        
                                   text("("), 
        
                                   soft_block_indent(&format_args![ 
        
                                       text("Some longer content"), 
        
                                       space(), 
        
                                       text("That should ultimately break"), 
        
                                   ]) 
        
                               ])] 
        
                           ) 
        
                       })] 
        
                   ) 
        
                   .unwrap(); 
        
                   let document = formatted.into_document(); 
        
                   assert_eq!( 
        
                       &std::format!("{document}"), 
        
                       r#"[ 
        
             group([ 
        
               "(", 
        
               indent([ 
        
                 soft_line_break, 
        
                 "Some longer content That should ultimately break" 
        
               ]), 
        
               soft_line_break 
        
             ]) 
        
           ]"# 
        
                   ); 
        
               }

dyc3 · 2024-06-11T13:21:54Z

Done. I've added a unit test for this. Thanks for the code pointer @ah-yu

ematipico

Awesome work @dyc3 !

ah-yu

Thank you!

…ejs#3036)

github-actions bot added the A-Formatter Area: formatter label Jun 1, 2024

dyc3 force-pushed the 06-01-fix_formatter_escape_double_quotes_when_printing_formatter_ir branch 2 times, most recently from e10f09e to 5c4e3d0 Compare June 1, 2024 14:20

ah-yu reviewed Jun 3, 2024

View reviewed changes

fix(formatter): escape double quotes when printing formatter IR

e352ec5

dyc3 force-pushed the 06-01-fix_formatter_escape_double_quotes_when_printing_formatter_ir branch from 5c4e3d0 to e352ec5 Compare June 11, 2024 12:31

ematipico approved these changes Jun 11, 2024

View reviewed changes

ah-yu approved these changes Jun 12, 2024

View reviewed changes

ah-yu merged commit d2b08d1 into biomejs:main Jun 12, 2024

Sec-ant pushed a commit to minht11/biomee that referenced this pull request Jun 12, 2024

fix(formatter): escape double quotes when printing formatter IR (biom…

e058f4b

…ejs#3036)

This was referenced Aug 28, 2024

[Snyk] Upgrade @biomejs/biome from 1.5.3 to 1.8.3 Ramyromel/mesc#2

Open

[Snyk] Upgrade @biomejs/biome from 1.5.3 to 1.8.3 Ramyromel/mesc#6

Open

Ramyromel mentioned this pull request Sep 9, 2024

[Snyk] Upgrade: , vitest Ramyromel/mesc#8

Open

Conaclos added the A-Changelog Area: changelog label Sep 10, 2024

Ramyromel mentioned this pull request Sep 15, 2024

[Snyk] Upgrade: , , vitest Ramyromel/mesc#9

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(formatter): escape double quotes when printing formatter IR #3036

fix(formatter): escape double quotes when printing formatter IR #3036

Uh oh!

dyc3 commented Jun 1, 2024 •

edited

Loading

Uh oh!

codspeed-hq bot commented Jun 1, 2024 •

edited

Loading

Uh oh!

ah-yu left a comment

Uh oh!

dyc3 commented Jun 11, 2024

Uh oh!

ematipico left a comment

Uh oh!

ah-yu left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	fn display_elements() {
	let formatted = format!(
	SimpleFormatContext::default(),
	[format_with(\|f\| {
	write!(
	f,
	[group(&format_args![
	text("("),
	soft_block_indent(&format_args![
	text("Some longer content"),
	space(),
	text("That should ultimately break"),
	])
	])]
	)
	})]
	)
	.unwrap();

	let document = formatted.into_document();

	assert_eq!(
	&std::format!("{document}"),
	r#"[
	group([
	"(",
	indent([
	soft_line_break,
	"Some longer content That should ultimately break"
	]),
	soft_line_break
	])
	]"#
	);
	}

Uh oh!

fix(formatter): escape double quotes when printing formatter IR #3036

fix(formatter): escape double quotes when printing formatter IR #3036

Uh oh!

Conversation

dyc3 commented Jun 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

codspeed-hq bot commented Jun 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #3036 will not alter performance

Summary

Uh oh!

ah-yu left a comment

Choose a reason for hiding this comment

Uh oh!

dyc3 commented Jun 11, 2024

Uh oh!

ematipico left a comment

Choose a reason for hiding this comment

Uh oh!

ah-yu left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dyc3 commented Jun 1, 2024 •

edited

Loading

codspeed-hq bot commented Jun 1, 2024 •

edited

Loading