[SPARK-40797] [BUILD] Force import groups on a single line. #38252
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
When using the scalafmt.conf file as provided by the project repository to
organize and optimize imports there is a case in which un-desired behavior
appears.
If the import group does not fit on a single line, Scalafmt will by default
try to bin-pack and then break out over mulitple lines.
For example:
import org.apache.spark.sql.catalyst.analysis.{UnresolvedAlias, UnresolvedAttribute, UnresolvedFunction, UnresolvedRelation, UnresolvedStar}
will become
import org.apache.spark.sql.catalyst.analysis.{
UnresolvedAlias,
UnresolvedAttributed,
...
}
In previous code reviews this has been marked as departing from the consistency
of the Spark code base. This patch enables an option in Scalafmt to force
the import group on a single line even if it exceeds the max line length.
HyukjinKwon
approved these changes
Oct 14, 2022
Member
HyukjinKwon
left a comment
HyukjinKwon
left a comment
There was a problem hiding this comment.
Would have been better to have a JIRA since this isn't virtually same before/after the fix:
If the change is new, then it usually needs a new JIRA. However, trivial changes, where the what should change is virtually the same as the how it should change do not require a JIRA. Example: Fix typos in Foo scaladoc
https://spark.apache.org/contributing.html
Otherwise LGTM.
grundprinzip
changed the title
Contributor
Author
|
Created a JIRA and updated the title. |
Member
|
Merged to master. Since CI doesn't have anything to do with this change. |
SandishKumarHN
pushed a commit
to SandishKumarHN/spark
that referenced
this pull request
Dec 12, 2022
### What changes were proposed in this pull request?
When using the scalafmt.conf file as provided by the project repository to organize and optimize imports there is a case in which un-desired behavior appears.
If the import group does not fit on a single line, Scalafmt will by default try to bin-pack and then break out over mulitple lines.
For example:
import org.apache.spark.sql.catalyst.analysis.{UnresolvedAlias, UnresolvedAttribute, UnresolvedFunction, UnresolvedRelation, UnresolvedStar}
will become
import org.apache.spark.sql.catalyst.analysis.{
UnresolvedAlias,
UnresolvedAttributed,
...
}
In previous code reviews this has been marked as departing from the consistency of the Spark code base. This patch enables an option in Scalafmt to force the import group on a single line even if it exceeds the max line length.
### Why are the changes needed?
Code consistency.
### Does this PR introduce _any_ user-facing change?
No
Closes apache#38252 from grundprinzip/scalafmt.
Authored-by: Martin Grund <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changes were proposed in this pull request?
When using the scalafmt.conf file as provided by the project repository to organize and optimize imports there is a case in which un-desired behavior appears.
If the import group does not fit on a single line, Scalafmt will by default try to bin-pack and then break out over mulitple lines.
For example:
will become
In previous code reviews this has been marked as departing from the consistency of the Spark code base. This patch enables an option in Scalafmt to force the import group on a single line even if it exceeds the max line length.
Why are the changes needed?
Code consistency.
Does this PR introduce any user-facing change?
No