Skip to content
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.

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

fix(css_formatter): don't indent CSS selector when leading comments before #4392

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b

### Formatter

### Bug fixes

- Fix [#4121](https://github.com/biomejs/biome/issues/4326), don't ident a CSS selector when has leading comments. Contributed by @fireairforce

### JavaScript APIs

### Linter
Expand Down
42 changes: 31 additions & 11 deletions crates/biome_css_formatter/src/css/lists/relative_selector_list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,37 @@ impl FormatRule<CssRelativeSelectorList> for FormatCssRelativeSelectorList {
let mut joiner = f.join_with(&separator);

for formatted in node.format_separated(",") {
// Each selector gets `indent` added in case it breaks over multiple
// lines. The break is added here rather than in each selector both
// for simplicity and to avoid recursively adding indents when
// selectors are nested within other rules. The group is then added
// around the indent to ensure that it tries using a flat layout
// first and only expands when the single selector can't fit the line.
//
// For example, a selector like `div span a` is structured like
// `[div, [span, [a]]]`, so `a` would end up double-indented if it
// was handled by the selector rather than here.
joiner.entry(&group(&indent(&formatted)));
let has_leading_comments = formatted
.node()?
.as_css_relative_selector()
.and_then(|relative_selector| {
relative_selector
.selector()
.ok()?
.as_css_compound_selector()
.cloned()
})
.and_then(|computed_selector| computed_selector.simple_selector())
.and_then(|simple_selector| simple_selector.as_css_type_selector().cloned())
.and_then(|type_selector| type_selector.ident().ok()?.value_token().ok())
.is_some_and(|value_token| value_token.has_leading_comments());

if has_leading_comments {
// Computed Selector which contains a leading comments should be formatted without indent.
joiner.entry(&group(&formatted));
} else {
// Each selector gets `indent` added in case it breaks over multiple
// lines. The break is added here rather than in each selector both
// for simplicity and to avoid recursively adding indents when
// selectors are nested within other rules. The group is then added
// around the indent to ensure that it tries using a flat layout
// first and only expands when the single selector can't fit the line.
//
// For example, a selector like `div span a` is structured like
// `[div, [span, [a]]]`, so `a` would end up double-indented if it
// was handled by the selector rather than here.
joiner.entry(&group(&indent(&formatted)));
ematipico marked this conversation as resolved.
Show resolved Hide resolved
}
}

joiner.finish()
Expand Down
16 changes: 16 additions & 0 deletions crates/biome_css_formatter/tests/specs/css/declaration_list.css
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,20 @@ a {

a {
color: red;;;;
}

.with-comments {
/* hello */
a,
/* world */
button {
color: blue;
}
}

.without-comments {
a,
button {
color: blue;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,22 @@ a {
a {
color: red;;;;
}

.with-comments {
/* hello */
a,
/* world */
button {
color: blue;
}
}

.without-comments {
a,
button {
color: blue;
}
}
```


Expand Down Expand Up @@ -103,4 +119,20 @@ a {
a {
color: red;
}

.with-comments {
/* hello */
a,
/* world */
button {
color: blue;
}
}

.without-comments {
a,
button {
color: blue;
}
}
```