This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
feature(rome_js_analyze): implement import sorting for named specifiers #3916
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
✅ Deploy Preview for docs-rometools canceled.
|
Parser conformance results on ubuntu-latestjs/262
jsx/babel
symbols/microsoft
ts/babel
ts/microsoft
|
MichaReiser
approved these changes
Dec 2, 2022
crates/rome_js_analyze/src/assists/correctness/organize_imports.rs
Outdated
Show resolved
Hide resolved
| let leading_piece = leading_trivia.first()?; | ||
|
|
||
| if !leading_piece.is_newline() { | ||
| return None; |
There was a problem hiding this comment.
Isn't it a programming error if we reach None? How about adding a debug_assert here?
There was a problem hiding this comment.
In theory yes, the newline_source token comes immediately after a single-line trivia piece so I would expect it to start with a newline trivia piece. I wasn't sure if that's always guaranteed to be the case though, so just in case I added a fallback where the newline trivia piece is created manually using the \n character
…s.rs Co-authored-by: Micha Reiser <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
This PR extends the
organizeImportscode action to not only sort whole import nodes, but also reorder the named import specifiers within a given node.The implementation is made quite complex by the necessity of moving nodes along with the relevant comments while remaining syntactically correct, which means inserting or removing comma tokens and newline trivias as nodes get moved to different places.
The current solution correctly handles nodes that were formatted using the Rome Formatter, but the output may be formatted incorrectly when the formatting of the input get more complex (this is only formatting though, it should not result in any syntax errors).
I've also fixed a bug in the
SyntaxTrivia::firstmethod that was causing it to return a trivia piece with an incorrect source offset.Test Plan
I've added an additional snapshot file for the rule testing both case that are expected to work correctly, as well as more complex patterns that are not currently well supported.