Grouping all comments in a chain at the beginning of it #708
Conversation
This file contains 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
mattiaerre
reviewed
Jul 19, 2022
| return false; | ||
| } | ||
|
|
||
| module.exports = handleMemberAccessComments; |
There was a problem hiding this comment.
Can this file be called also handleMemberAccessComments.js perhaps?
Comment on lines
+6
to
+10
| text, | ||
| precedingNode, | ||
| enclosingNode, | ||
| followingNode, | ||
| comment |
There was a problem hiding this comment.
not all these params have been used; maybe pass an object into the function instead of all these params?
Comment on lines
+252
to
+258
| // Comment before chain | ||
| // CONFIG | ||
| // Comment 1 | ||
| // Comment 2 | ||
| // Comment 3 | ||
| // Comment 4 | ||
| // Comment 5 |
There was a problem hiding this comment.
Is this what we would like to achieve? Move all the comments above the chain?
There was a problem hiding this comment.
Yes
Have a look at #644 and also try it on Prettier JS to see what they are doing at the moment.
It's not perfect but there is something nice in it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
addressing some issues with comments in chains. #644
For now we are grouping comments at the beginning of the chain.
This is a good first step however we must address some questions if we want to continue with this approach.
first of all in this scenario:
This is the expected behaviour but the order of the comments is not the same anymore. Therefore the AST comparison will fail.
Shall we remove the comments from the AST comparison understanding that Prettier already has a lot of security making sure that each comment will be printed?
In this case we are making new advances since Prettier JS does mess up with the order of the comments when the chain get a bit complex and also the indentation.
Thoughts @fvictorio @mattiaerre
there are some more ideas I have but for now this is a good first step.