Fix formatter to correctly convert invalid doc comments

smithy-lang / smithy

Smithy is a protocol-agnostic interface definition language and set of tools for generating clients, servers, and documentation for any programming language.

https://smithy.io

Apache License 2.0

1.77k stars 209 forks source link

Fix formatter to correctly convert invalid doc comments #2277

Closed haydenbaker closed 4 months ago

haydenbaker commented 4 months ago

Background

Fixes an issue where a doc-comment above a trait-statement and member may get converted to a line-comment
Updates the expected formatting of test case file (.formatted.smithy)
Updates tests to use assertEquals, since it provides diff functionality in IDEs

Testing

Ran the tests, no failures

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

milesziemer commented 4 months ago

I pushed a commit that fixes the regression, which is captured by what I added to the test case here. The TODO here is a separate issue that occurs when the comment is after a default value assignment. We will need to follow up to address that.

milesziemer commented 4 months ago

Followup work: https://github.com/smithy-lang/smithy/issues/2279