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

Preserve trailing semicolons when using fmt: off #8275

Merged
merged 2 commits into from
Oct 30, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,27 @@
def f():
# fmt: off
a = 10

if True:
with_semicolon = 10 \
;

formatted = true;


def f():
# fmt: off

if True:
with_semicolon = 20 \
; # comment


# fmt: off
statement = 0 \
;
# fmt: on
a = 10

# fmt: off
last_statement_with_semi ;
20 changes: 12 additions & 8 deletions crates/ruff_python_formatter/src/verbatim.rs
Expand Up @@ -395,14 +395,18 @@ fn write_suppressed_statements<'a>(
statement = SuiteChildStatement::Other(next_statement);
leading_node_comments = comments.leading(next_statement);
} else {
let mut nodes =
std::iter::successors(Some(AnyNodeRef::from(statement.statement())), |statement| {
statement.last_child_in_body()
});

let end = nodes
.find_map(|statement| comments.trailing(statement).last().map(Ranged::end))
.unwrap_or(statement.end());
let mut current = AnyNodeRef::from(statement.statement());
// Expand the range of the statement to include any trailing comments or semicolons.
let end = loop {
if let Some(comment) = comments.trailing(current).last() {
break comment.end();
} else if let Some(child) = current.last_child_in_body() {
current = child;
} else {
break trailing_semicolon(current, source)
.map_or(statement.end(), TextRange::end);
}
};

FormatVerbatimStatementRange {
verbatim_range: TextRange::new(format_off_comment.end(), end),
Expand Down
@@ -0,0 +1,69 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/fmt_on_off/trailing_semicolon.py
---
## Input
```py
def f():
# fmt: off
a = 10

if True:
with_semicolon = 10 \
;

formatted = true;


def f():
# fmt: off

if True:
with_semicolon = 20 \
; # comment


# fmt: off
statement = 0 \
;
# fmt: on
a = 10

# fmt: off
last_statement_with_semi ;
```

## Output
```py
def f():
# fmt: off
a = 10

if True:
with_semicolon = 10 \
;


formatted = true


def f():
# fmt: off

if True:
with_semicolon = 20 \
; # comment


# fmt: off
statement = 0 \
;
# fmt: on
a = 10

# fmt: off
last_statement_with_semi ;
```