feat(tsdoc): Don't replace line breaks when emitting comments - #443
Conversation
Joshua Smithrud (Josmithr)
changed the title
Joshua Smithrud (Josmithr)
changed the title
|
This LGTM but I'm currently traveling, so I'm not able to test it. Ian Clanton-Thuon (@iclanton) maybe you can try it in the playground? |
|
Joshua Smithrud (@Josmithr), can you provide some examples of what this actually changes? Maybe inputs and diffs of the before/after outputs? |
…s_2025-10-07-21-19.json Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>
Ian Clanton-Thuon (@iclanton) Sorry, I completely missed the notifications on this and have been working in other areas. The main goal here is to preserve the doc author's line breaks when parsing the comments. This makes round-tripping of comments non-lossy. For example, consider this multi-line TSDoc comment: /**
* Hello
* world
* !
*/Round-tripping this comment through TSDoc's current parser and emitter will yield: /**
* Hello world!
*/Which is lossy and potentially changes the doc-author's intention. Where with my above changes you would get the original comment with its original line formatting. A particularly relevant case that can be useful to tools consuming the parsed comment is preservation of list-like syntax. Consider the following: /**
* Prerequisites:
* - Foo
* - Bar
*/This is currently parsed the same as: /**
* Prerequisites: - Foo - Bar
*/Which loses important contextual information. Hopefully that makes sense. Happy to provide more context or capture more of this with tests (if desired and if I can get some guidance as to where such tests should go). |
|
Ian Clanton-Thuon (@iclanton) Pete Gonzalez (@octogonz) Hoping to get some assistance getting this across the finish line. |
…-strip-line-breaks # Conflicts: # common/config/rush/command-line.json
There was a problem hiding this comment.
Joshua Smithrud (@Josmithr) 🙏 Sorry this took so long to get to!
3 participants
Preserves line breaks when emitting TSDoc comments. Ensures information is not lost.