forge-fmt 0.2.0

solidity formatting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// config: line_length = 60
// config: wrap_comments = true
contract SimpleComments {
    mapping(address /* asset */ => address /* router */)
        public router;

    constructor() {
        // TODO: do this and that

        uint256 a = 1;

        // TODO: do that and this
        // or maybe
        // smth else
    }

    function test() public view {
        // do smth here

        // then here

        // cleanup
    }

    function test2() public pure {
        uint256 a = 1;
        // comment 1
        // comment 2
        uint256 b = 2;
    }

    function test3() public view {
        uint256 a = 1; // comment

        // line comment
    }

    function test4() public view returns (uint256) {
        uint256 abc; // long postfix comment that exceeds
            // line width. the comment should be split and
            // carried over to the next line
        uint256 abc2; // reallylongsinglewordcommentthatexceedslinewidththecommentshouldbesplitandcarriedovertothenextline

        // long prefix comment that exceeds line width. the
        // comment should be split and carried over to the
        // next line
        // reallylongsinglewordcommentthatexceedslinewidththecommentshouldbesplitandcarriedovertothenextline
        uint256 c;

        /* a really really long prefix block comment that
        exceeds line width */
        uint256 d; /* a really really long postfix block
            comment that exceeds line width */

        uint256 value;
        return /* a long block comment that exceeds line
            width */
            value;
        return /* a block comment that exceeds line width */
            value;
        return // a line comment that exceeds line width
            value;
    }
}

/*

██████╗ ██████╗ ██████╗ ████████╗███████╗███████╗████████╗
██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝
██████╔╝██████╔╝██████╔╝   ██║   █████╗  ███████╗   ██║
██╔═══╝ ██╔══██╗██╔══██╗   ██║   ██╔══╝  ╚════██║   ██║
██║     ██║  ██║██████╔╝   ██║   ███████╗███████║   ██║
╚═╝     ╚═╝  ╚═╝╚═════╝    ╚═╝   ╚══════╝╚══════╝   ╚═╝
*/
function asciiArt() {}

/*
 * @notice Here is my comment
 *       - item 1
 *       - item 2
 * Some equations:
 *     y = mx + b
 */
function test() {}
// comment after function

// comment with extra newlines

// some comment
// another comment

// eof comment