Weird formatting with commented out functions and docs

[bitzoic]

When commenting out a function and there is a doc above the function, we see the following weird formatting behavior.

This is our code before formatting:

    /// This is documentation for a commented out function
    // fn commented_out_function() {
    //}

    fn test_function() -> bool {
        true
    }

After formatting we have the following:

    /// This is documentation for a commented out function

        // fn commented_out_function() {
    //}
fn test_function() -> bool {
        true
    }

Tested with v0.35.3

[eightfilms]

Could you provide a minimal repro that is runnable through forc-fmt? i.e. running forc-fmt <file> works.

I tried it with something like:

contract;
/// This is documentation for a commented out function
// fn commented_out_fn() {
// }

fn test_function() -> bool {
    true
}

which turns into:

contract;
/// This is documentation for a commented out function

fn test_function() -> bool {
    true
}

Not exacly the same output that was posted here though it is still an issue

[bitzoic]

Using forc v0.37.0 I used this input:

contract;

abi MyContract {
    fn test_function() -> bool;
}

impl MyContract for Contract {
    /// This is documentation for a commented out function
    // fn commented_out_function() {
    //}

    fn test_function() -> bool {
        true
    }
}

This is the following formatting output:

contract;

abi MyContract {
    fn test_function() -> bool;
}

impl MyContract for Contract {
    /// This is documentation for a commented out function

    // fn commented_out_function() {
    //}
    fn test_function() -> bool {
        true
    }
}

[Lukasz2891]

In v.0.37.1 after having commented out some number of lines it adds lot of empty lines before the commented code :)

library;

use std::{u256::U256, vec::*};
use ::utils::vec::sort;
use ::utils::numbers::*;

// pub fn aggregate_results(results: Vec<Vec<U256>>) -> Vec<U256> {
//     let mut aggregated = Vec::new();

//     let mut i = 0;
//     while (i < results.len) {
//         let values = results.get(i).unwrap();
//         aggregated.push(aggregate_values(values));

//         i += 1;
//     }

//     return aggregated;
// }

is formatted to

library;

use std::{u256::U256, vec::*};
use ::utils::vec::sort;
use ::utils::numbers::*;





// pub fn aggregate_results(results: Vec<Vec<U256>>) -> Vec<U256> {
//     let mut aggregated = Vec::new();

//     let mut i = 0;
//     while (i < results.len) {
//         let values = results.get(i).unwrap();
//         aggregated.push(aggregate_values(values));

//         i += 1;
//     }

//     return aggregated;
// }

[bitzoic]

In v.0.37.1 after having commented out some number of lines it adds lot of empty lines before the commented code :)

library;

use std::{u256::U256, vec::*};
use ::utils::vec::sort;
use ::utils::numbers::*;

// pub fn aggregate_results(results: Vec<Vec<U256>>) -> Vec<U256> {
//     let mut aggregated = Vec::new();

//     let mut i = 0;
//     while (i < results.len) {
//         let values = results.get(i).unwrap();
//         aggregated.push(aggregate_values(values));

//         i += 1;
//     }

//     return aggregated;
// }

is formatted to

library;

use std::{u256::U256, vec::*};
use ::utils::vec::sort;
use ::utils::numbers::*;





// pub fn aggregate_results(results: Vec<Vec<U256>>) -> Vec<U256> {
//     let mut aggregated = Vec::new();

//     let mut i = 0;
//     while (i < results.len) {
//         let values = results.get(i).unwrap();
//         aggregated.push(aggregate_values(values));

//         i += 1;
//     }

//     return aggregated;
// }

I have seen this in a number of files in the sway-libs repository as well

[eightfilms]

Thank you for the examples/repros! Would be super helpful in fixing these bugs @bitzoic @Lukasz2891

[eightfilms]

Created a new issue #4473 for @Lukasz2891 's bug, because they're separate issues.