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(fmt): params_first_multi split if more than one param #8762

Merged
merged 1 commit into from
Aug 28, 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
8 changes: 5 additions & 3 deletions crates/config/src/fmt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,13 @@ pub enum SingleLineBlockStyle {
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MultilineFuncHeaderStyle {
/// Write function parameters multiline first
/// Write function parameters multiline first.
ParamsFirst,
/// Write function attributes multiline first
/// Write function parameters multiline first when there is more than one param.
ParamsFirstMulti,
/// Write function attributes multiline first.
AttributesFirst,
/// If function params or attrs are multiline
/// If function params or attrs are multiline.
/// split the rest
All,
}
Expand Down
13 changes: 10 additions & 3 deletions crates/fmt/src/formatter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1617,7 +1617,9 @@ impl<'a, W: Write> Formatter<'a, W> {
let should_multiline = header_multiline &&
matches!(
fmt.config.multiline_func_header,
MultilineFuncHeaderStyle::ParamsFirst | MultilineFuncHeaderStyle::All
MultilineFuncHeaderStyle::ParamsFirst |
MultilineFuncHeaderStyle::ParamsFirstMulti |
MultilineFuncHeaderStyle::All
);
params_multiline = should_multiline ||
multiline ||
Expand All @@ -1626,8 +1628,13 @@ impl<'a, W: Write> Formatter<'a, W> {
&params,
",",
)?;
// Write new line if we have only one parameter and params on multiline set.
if params.len() == 1 && params_multiline {
// Write new line if we have only one parameter and params first set.
if params.len() == 1 &&
matches!(
fmt.config.multiline_func_header,
MultilineFuncHeaderStyle::ParamsFirst
)
{
writeln!(fmt.buf())?;
}
fmt.write_chunks_separated(&params, ",", params_multiline)?;
Expand Down
4 changes: 1 addition & 3 deletions crates/fmt/testdata/FunctionDefinition/all.fmt.sol
Original file line number Diff line number Diff line change
Expand Up @@ -717,9 +717,7 @@ contract FunctionOverrides is
a = 1;
}

function oneParam(
uint256 x
)
function oneParam(uint256 x)
override(
FunctionInterfaces,
FunctionDefinitions,
Expand Down
8 changes: 6 additions & 2 deletions crates/fmt/testdata/FunctionDefinition/params-first.fmt.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
interface FunctionInterfaces {
function noParamsNoModifiersNoReturns();

function oneParam(uint256 x);
function oneParam(
uint256 x
);

function oneModifier() modifier1;

Expand Down Expand Up @@ -335,7 +337,9 @@ contract FunctionDefinitions {
a = 1;
}

function oneParam(uint256 x) {
function oneParam(
uint256 x
) {
a = 1;
}

Expand Down
Loading
Loading