formalize if whitespace lines should be allowed to change - Githubissues

sloganking / scfmt

A code formatter for structured comments

MIT License

0 stars 0 forks source link

formalize if whitespace lines should be allowed to change #32

Closed sloganking closed 2 years ago

sloganking commented 2 years ago

Currently, running add_brackets will not only add brackets, but also may add or remove whitespace lines, in a currently half baked attempt to make things look better. This is a bit unintuitive.

sloganking commented 2 years ago

One possible option. The only things strfmt is allowed to do is

Create and delete //< closing comments
Convert bracketless SC to //> or //<> bracketed comments
Ensure empty lines are depth 0
Edit the tab depth of lines for SC formatting.

Pros:

This would mean add_brackets and remove_brackets, would be lossless, in that converting from bracketless to brackets and back to bracketless, would result in no change.
Managing empty lines is generally a full code formatter's job, and I generally don't want strfmt to fight them.

sloganking commented 2 years ago

The above proposal https://github.com/sloganking/Structured-commenting-formatter/issues/32#issuecomment-1093698308 is satisfactory for now. Stylistic changes might be added later as an option. I believe my recent commits should half already implemented this as well.