Fixed SwayFmt removing comments in configurable blocks

[brandonsurh]

Description

Closes #4966

Added functionality to retain comments in configurable blocks.

Checklist

• I have linked to any relevant issues.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation where relevant (API docs, the reference, and the Sway book).
• I have added tests that prove my fix is effective or that my feature works.
• I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
• I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
• I have requested a review from the relevant team or maintainers.

[brandonsurh]

Gonna need help with adding assignees, adding labels, and requesting reviewers due to permissions.

[sdankel]

Thanks for this!

[sdankel]

Thanks for adding tests! It would be good to test inline comments as well, e.g. /* inline test */

[brandonsurh]

Ah, good catch! That style of comment is coming out a little strange after testing it just now. Weird behaviors with whitespace. Gonna dig into this a little more 👍

[brandonsurh]

After digging into the behaviors a little more, I discovered that this strange whitespace formatting behavior exists across other various items. I have put detailed it in this issue: #5298. Seems like what I found may be outside of the scope of this issue.

I added the /* inline test */ comment and it still exists after the formatting. However, the whitespace around it is a different thing. I had to form the testcase around this for it to pass.

Let me know what you think!

[sdankel]

Thanks for opening the issue. I agree that it's out of scope for this issue, but it would be great to have that test case added as part of #5298

[alipostaci2001]

thanks for full info

[sdankel]

it would be also useful to test adding comments inside of structs and enums in configurable blocks, and at the end of the line.

Suggested change

	value: ZERO_B256,
	// comment here
	// multiline!
	value: ZERO_B256, // end of line too

[CLAassistant]

All committers have signed the CLA.

[brandonsurh]

Going to be shelving this PR for the time being. Currently, there are weird behaviors with how end of line comments are handled inside of structs and inside of configurable blocks. My tests tell me it has something to do with the index that a comment is placed in and how newlines are handled regarding that.

For example, manually shifting the insertion of formatted comments by -1 fixes the extra newline character in some cases. The issue is that it is not clear why or when these cases differ. Will be moving on to other issues as to not spend too much time here. Further explanation on the behavior and findings can be given if desired.