Feat/format conditions multi line

[Syzygy106]

Motivation

Closes #12508

When conditions in if statements are formatted inline (all on one line), coverage analysis tools like lcov cannot properly distinguish which individual conditions within the chain are actually covered by tests. This happens because the tool sees only one line with the condition, making it difficult to determine branch coverage for each condition.

For example:

if (newNumber % 2 == 0 || newNumber % 2 == 1 || newNumber != 0 || newNumber != 1 || newNumber != 2) {
    number = newNumber;
}

With inline formatting, if a test only covers the first condition (e.g., newNumber % 2 == 0), lcov may show the entire line as covered, but it cannot indicate which specific conditions were actually tested. This makes it difficult to identify untested conditions and achieve accurate branch coverage analysis.

Solution

Added a new format_conditions configuration option in foundry.toml that allows placing each condition on a separate line:

[fmt]
format_conditions = "multi"  # or "inline" (default)

When format_conditions = "multi", logical operators (||, &&) in if conditions are formatted with each condition on a separate line:

if (
    newNumber % 2 == 0
        ||
    newNumber % 2 == 1
        ||
    newNumber != 0
        ||
    newNumber != 1
        ||
    newNumber != 2
) {
    number = newNumber;
}

PR Checklist

• Added Tests
• Added Documentation
• Breaking changes

[Syzygy106]

======================================================================

1. With format_conditions = 'inline' (default):

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

contract Counter {
    uint256 public number = 1;

    function setNumber(uint256 newNumber) public {
        if (newNumber % 2 == 0 || newNumber % 2 == 1 || newNumber != 0 || newNumber != 1 || newNumber != 2) {
            number = newNumber;
        }
    }

    function increment() public {
        number++;
    }
}


======================================================================

2. With format_conditions = 'multi':

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;

contract Counter {
    uint256 public number = 1;

    function setNumber(uint256 newNumber) public {
        if (
            newNumber % 2 == 0
                ||
                    newNumber % 2 == 1
                ||
                    newNumber != 0
                ||
                    newNumber != 1
                ||
                    newNumber != 2
        ) {
            number = newNumber;
        }
    }

    function increment() public {
        number++;
    }
}

[grandizzy]

thank you, makes sense IMO (pending @0xrusowsky ). Please update the readme too to reflect the new config https://github.com/foundry-rs/foundry/tree/master/crates/fmt#configuration and add an ui_test as in https://github.com/foundry-rs/foundry/tree/master/crates/fmt#testing

[0xrusowsky]

the impl LGTM, but imo it would be nice to make the output prettier.

if possible, let's aim for:

if (
    newNumber % 2 == 0
        || newNumber % 2 == 1
        || newNumber != 0
        || newNumber != 1
        || newNumber != 2
) {

i think you should be able to achieve if with an extra box when the multiline config is enabled

[0xrusowsky]

why do we need to introduce this logic?

[0xrusowsky]

@Syzygy106 can we bring this over the finish line?

stale

[grandizzy]

think this should be good to merge, @0xrusowsky @DaniPopes mind to have a 2nd look? ty!