Format MASM

[partylikeits1983]

I ran my Miden Assembly code formatter on the stdlib directory and discovered several formatting issues:

• Trailing white space at the end of lines
• Inconsistent indentation of comments
• Inconsistent indentation inside procedures
• Consecutive empty lines

Note: There are large chunks where there are modifications, this is where indentation is changed to 4 spaces as opposed to two.

You can install the masm formatter from crates.io using:

cargo install masm-formatter

To run the formatter on a specific directory (e.g., crates/miden-lib/asm), execute:

cargo masm-fmt stdlib

This PR applies the formatter's changes, addressing the issues noted above.

[partylikeits1983]

There are certain areas where comments that are on the same line as an instruction don't line up, but I think this should be addressed in a separate PR.

[partylikeits1983]

This is one of those edge cases that is hard to fix with the masm formatter.

[partylikeits1983]

I know this is a massive PR and might take a bit of time to verify that only formatting was changed. Lmk if there is a different way I should structure this PR.

Also, we can maybe add the MASM formatter to the rust compiler and then add it as a CI check.

[plafer]

Very cool!

Probably best to wait for big MASM PRs like #1665 to be merged before running the formatter though.

Also, we can maybe add the MASM formatter to the rust compiler and then add it as a CI check.

Is it reliable enough to be added as CI check? For example, in your comment, didn't the formatter do the wrong thing?

[partylikeits1983]

Is it reliable enough to be added as CI check? For example, in your comment, didn't the formatter do the wrong thing?

I think to be added as a CI check it needs to be tested a bit more, and maybe added to the miden compiler toolchain, or as a separate standalone repo.

Regarding formatting comments that are on the same lines as code and span multiple lines, it depends if it is necessary to support this, or just have the comment on the line above the code. What do you think?

[plafer]

Looking more into it (especially partylikeits1983/masm-formatter#3), it seems like we'd probably want to reuse our internal pretty print infrastructure to make sure the formatter is consistent with what we pretty print. But until that happens, running it every once in a while like you did here sounds like a good alternative!

So I think I would wait for the main MASM-related PRs to be merged, and then run a formatter pass.

Blocked on: #1665, and maybe #1670, #1675