Skip to content

union types: fix trailing comment causing multiline when preferSingleLine is true #496

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
23 changes: 13 additions & 10 deletions src/generation/generate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9292,37 +9292,40 @@ fn has_any_node_comment_on_different_line(nodes: &[impl SourceRanged], context:

let node_end = node.end();
let next_node_pos = nodes.get(i + 1).map(|n| n.start());
if check_pos_has_trailing_comments(node_end, next_node_pos, context) {
let comment_kind = if let Some(comma) = context.token_finder.get_next_token_if_comma(&node_end) {
get_pos_trailing_comments(comma.end(), next_node_pos, context)
} else {
get_pos_trailing_comments(node_end, next_node_pos, context)
};

// the final node is allowed to have a trailing line comment as it'll be on the same line
if comment_kind.is_some() && (nodes.len() == 1 || !(i == nodes.len() - 1 && comment_kind == Some(CommentKind::Line))) {
return true;
} else if let Some(comma) = context.token_finder.get_next_token_if_comma(&node_end) {
if check_pos_has_trailing_comments(comma.end(), next_node_pos, context) {
return true;
}
}
}

return false;

fn check_pos_has_trailing_comments(end: SourcePos, next_node_pos: Option<SourcePos>, context: &mut Context) -> bool {
fn get_pos_trailing_comments(end: SourcePos, next_node_pos: Option<SourcePos>, context: &mut Context) -> Option<CommentKind> {
let end_line = end.end_line_fast(context.program);
let stop_line = next_node_pos.map(|p| p.start_line_fast(context.program));

for c in end.trailing_comments_fast(context.program) {
if c.kind == CommentKind::Line {
return true;
return Some(CommentKind::Line);
}
if let Some(stop_line) = stop_line {
if c.start_line_fast(context.program) >= stop_line {
// do not look at comments that the next node owns
return false;
return None;
}
}
if c.end_line_fast(context.program) > end_line {
return true;
return Some(CommentKind::Block);
}
}

false
None
}
}

Expand Down
36 changes: 36 additions & 0 deletions tests/specs/types/UnionType/UnionType_PreferSingleLine_True.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,39 @@ export type T =

[expect]
export type T = string | test | other;

== should be multi line when over the line width ==
export type T = string | test | other1 | other2 | other3;

[expect]
export type T =
| string
| test
| other1
| other2
| other3;

== should be single line if the final type has a trailing comment ==
export type T = string | number // TODO
function f(
arg: "1" | "2", // todo
otherArg: string,
) {}

[expect]
export type T = string | number; // TODO
function f(
arg: "1" | "2", // todo
otherArg: string,
) {}

== should be multi line if any type apart from the final type has a trailing comment ==
export type T = string|number // TODO
| foo | bar

[expect]
export type T =
| string
| number // TODO
| foo
| bar;