fix: reworked comment adding algorithm #7
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ycmjason
force-pushed
the
content-aware-annotate-fix
branch
from
0a6fe79 to
1a99abf
Compare
ycmjason
commented
Aug 5, 2025
| }); | ||
|
|
||
| // Currently failing due to: https://github.com/benjamn/recast/issues/1423 | ||
| it.skip('should annotate correctly for weird formatted ternary', () => { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
reworked the algorithm for adding comments.
the main pain point of the original implementation in #4 was that adding comment via AST has its limitations. we cannot for example add comment here (or at least I haven't found a way to do that):
this is because there's no node for the
.that begins on.birthday(). the first node on that line would be the Identifier node forbirthday. so if we used AST to insert comment, we end up with:which is obviously horrible.
so I introduced some naive adding again since it seems to be more reliable. I only use AST for:
// @ts-migratingin string templateThere are some edge cases where recast / babel parser would not preserve the original formatting of the code which result in incorrect line ordering, this causes the annotation to fail. I have added an example where this will fail here and I have raised an issue in benjamn/recast#1423.
related #1, #2