let scalafixScalaBV follow scalaBV to leverage 2.13 & deprecate it #419
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
bjaglin
changed the title
bjaglin
force-pushed
the
scala213
branch
2 times, most recently
from
3574592
to
6236106
Compare
bjaglin
changed the title
bjaglin
added a commit
to bjaglin/scalafix
that referenced
this pull request
May 1, 2024
Leverage scalacenter/sbt-scalafix#419 to remove sbt-projectmatrix workaround so that we run Scalafix on 2.12 sources.
bjaglin
commented
May 1, 2024
| @@ -0,0 +1 @@ | |||
| rules = [OrganizeImports] | |||
There was a problem hiding this comment.
this is not detected as a rename, because I removed the unexercised DisableSyntax
bjaglin
commented
May 1, 2024
| @@ -0,0 +1,5 @@ | |||
| import scala.Int | |||
There was a problem hiding this comment.
this is not detected as a rename because I enabled removal of unused imports to make sure a rule was run (unrelated to the fix)
bjaglin
changed the title
bjaglin
changed the title
bjaglin
changed the title
bjaglin
force-pushed
the
scala213
branch
2 times, most recently
from
9854976
to
00fa848
Compare
bjaglin
commented
May 1, 2024
Comment on lines
-19
to
-21
| scalafixScalaBinaryVersion := { | ||
| if (scalaBinaryVersion.value == "3") scalafixScalaBinaryVersion.value | ||
| else scalaBinaryVersion.value |
There was a problem hiding this comment.
this was a no-op, keeping the default of "2.12"
bjaglin
changed the title
bjaglin
force-pushed
the
scala213
branch
3 times, most recently
from
953b147
to
d02d503
Compare
bjaglin
commented
May 1, 2024
| val scalafixScalaBinaryVersion: SettingKey[String] = | ||
| settingKey[String]( | ||
| "The Scala binary version used for scalafix execution. Can be set in ThisBuild or at project-level. " + | ||
| "Custom rules must be compiled against that binary version. Defaults to 2.12." | ||
| "The Scala binary version used for scalafix execution. Must be set at project-level. " + |
There was a problem hiding this comment.
Until recently, ThisBuild was the only place where scalafixScalaBinaryVersion could be set, so most of the clients must be setting it at that level currently. However, that should not be a problem because the only reason for them to set it was to follow scalaScalafixBinaryVersion, which is now the default (at project-level, thus the inability to override it at ThisBuild level).
That's why the key is being deprecated, and the change in where it effectively not a breaking change.
bjaglin
added a commit
to bjaglin/scalafix
that referenced
this pull request
May 1, 2024
Leverage scalacenter/sbt-scalafix#419 to remove sbt-projectmatrix workaround so that we run Scalafix on 2.12 sources.
bjaglin
added a commit
to bjaglin/scalafix
that referenced
this pull request
May 1, 2024
Leverage scalacenter/sbt-scalafix#419 to remove sbt-projectmatrix workaround so that we also run Scalafix on 2.12 sources.
bjaglin
added a commit
to bjaglin/scalafix
that referenced
this pull request
May 1, 2024
Leverage scalacenter/sbt-scalafix#419 to remove sbt-projectmatrix workaround so that we also run Scalafix on 2.12 sources.
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.
Rationale
ExplicitResultTypescan't easily be used with projects using sbt-projectmatrix scalafix#1592 as demonstrated in Post 0.12.1 release scalafix#1991.ExplicitResultTypesare running Scalafix with Scala 2.12 (since they don't need to set a customscalafixScalaBinaryVersion). However, Scala 2.13 collections are known to perform better (and if they don't, we need to fix rules since that's the baseline for the future as Scala 3 uses them anyway). Concerns raised in the past are no longer relevant in recent versions of OpenJDK or GraalVM. As a result, we want to push for using Scala 2.13 whenever possibleImplementation
Instead of moving to 2.13 on all builds that do not have
scalafixScalaBinaryVersionexplicitly set (which would be a breaking change for users ofExplicitResultTypeson 2.12 sources), the default now honors the Scala binary version at the project level (leveraging #380), falling back to Scala 2.13 for Scala 3 projects until scalacenter/scalafix#1680 is sorted out.Impact
Published community rules
We have been advocating for cross-publishing rules for 4 years (for new and existing projects), so all popular rules are now cross-published. As a result, running community rules with Scalafix in Scala 2.13 on projects with Scala 2.13 or Scala 3 should not cause artifact resolution issues.
Unpublished/source community rules
Running unpublished rules relies on on-the-fly compilation via scalafix-reflect, using the Scala compiler of the runtime Scala version. Even though some users were customizing the Scala version to use
ExplicitResultTypesand therefore potentially exercising compilation of some unpublished rules with Scala 2.13, that was the minority.This changes officializes the need for unpublished rules to support both Scala 2.12 and Scala 2.13 for a maximum reach. The biggest challenge is collection compatibility, but scalafix-core pulls scala-collection-compat since 0.9.7 (released 4,5 years ago), so rule authors have been able to rely on the Scala 2.13 collection framework syntax for as long as Scalafix is mature.
It's hard to tell what's the proportion of unpublished rules which can compile with Scala 2.12 but not with Scala 2.13. Users of those will be impacted in the following scenarios:
scalafixScalaBinaryVersion