questions about intended behaviour regarding comments and empty lines

Thanks so much for sharing this project! <3

I am testing this commit: https://github.com/nushell/nufmt/commit/4d578493d937c0b49bfd7f1c29a903e642732ab3

Test cases:

• nufmt --stdin "# hello\n\n\nlet foo = 'abc'\n\n\n# goodbye"

output:
# hello
let foo = 'abc'

# goodbye

• nufmt --stdin "# hello\n\n\n# goodbye"

output:
# hello


# goodbye

I understand the experimental/early nature of this project, and I'm a huge fan of nu, so I'm curious about what idiomatic code looks like regarding comments and empty lines:

• should nufmt preserve all empty lines, or is it idiomatic to have gaps no larger than a single empty line?
• is it idiomatic to have "floating comments" that have one or more empty lines between them and the nearest code?
• is it idiomatic to have multiple "floating comments" in a sequence, separated by one or more empty lines?
• is it idiomatic for all comments to always be anchored to the next nearest code (e.g. no empty lines in between)?

Cheers! <3

Start by reproducing the two nufmt --stdin examples from the issue at commit 4d578493d937c0b49bfd7f1c29a903e642732ab. Read the formatter behavior around comments and empty lines and review the comment thread for an agreed convention. The issue is done only once the intended behavior is decided and captured in an implementation or tests.