Skip to content

Commit

Permalink
Merge pull request #1990 from scalacenter/scalafixScalaBinaryVersion213
Browse files Browse the repository at this point in the history
sbt-scalafix scalafixScalaBinaryVersion is now deprecated
  • Loading branch information
bjaglin authored May 1, 2024
2 parents 2ca0d85 + 909248c commit d0a8f3b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
9 changes: 0 additions & 9 deletions docs/developers/local-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ change sets as the domain sources they will be run against.
Make sure the sbt plugin, as well as the Scala compiler plugin and options [are
set up correctly](../users/installation.md#sbt).

Although it is possible to define your rules in a Scala binary version that
does not match your build, it is highly recommended that you align them via:

```diff
// build.sbt
+ThisBuild / scalafixScalaBinaryVersion :=
+ CrossVersion.binaryScalaVersion(scalaVersion.value)
```

> Note that any potential external Scalafix rule, loaded with the
> `scalafixDependencies` setting key, must be built and published against the
> same Scala binary version.
Expand Down
9 changes: 9 additions & 0 deletions docs/developers/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,15 @@ several sub-projects for each directory.
can be applied.
- `tests` verifies each `input` sub-project against a `rules` sub-project.

> Failure to cross-build will reduce the reach of your rule, as users running
> Scalafix in a Scala version you are not building for will get either
> resolution errors (for published rules) or potential compilation errors (for
> unpublished rules, compiled on-the-fly). Note that `scalafix-core` brings
> [`scala-collection-compat`](https://github.com/scala/scala-collection-compat),
> which allows to use the Scala 2.13 collection framework on Scala 2.12, and
> therefore removes the need for maintaining different source files depending
> on the Scala version.
The `scalafix/` directory is a self-contained sbt build and can live in the same
directory as your existing library.

Expand Down
1 change: 0 additions & 1 deletion docs/users/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,6 @@ Great! You are all set to use Scalafix with sbt :)
| `scalafixDependencies` | `SettingKey[Seq[ModuleID]]` | Dependencies making [custom rules](#run-custom-rules) available via their simple name. Can be set in `ThisBuild` or at project-level. Defaults to `Nil`.
| `scalafixOnCompile` | `SettingKey[Boolean]` | When `true`, Scalafix rule(s) declared in `scalafixConfig` are run on compilation, applying rewrites and failing on lint errors. Defaults to `false`.
| `scalafixResolvers` | `SettingKey[Seq[Repository]]` | Custom resolvers where `scalafixDependencies` are resolved from, in addition to the user-defined sbt `ThisBuild / resolvers`. Must be set in `ThisBuild`. Defaults to: Ivy2 local, Maven Central, Sonatype releases & Sonatype snapshots.
| `scalafixScalaBinaryVersion` | `SettingKey[String]` | Scala binary version used for Scalafix execution. Can be set in `ThisBuild` or at project-level. Defaults to 2.12. For advanced rules such as ExplicitResultTypes to work, it must match the binary version defined in the build for compiling sources. Note that `scalafixDependencies` artifacts must be published against that Scala version.


### Main and test sources
Expand Down
5 changes: 2 additions & 3 deletions project/ScalafixBuild.scala
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,10 @@ object ScalafixBuild extends AutoPlugin with GhpagesKeys {
}

val prevVersions = previousVersions(sv).map(prev => TargetAxis(prev))
val scala3FromScala2 = TargetAxis(scala3)
val xsource3 = TargetAxis(sv, xsource3 = true)

(prevVersions :+ scala3FromScala2 :+ xsource3).map((sv, _))
}
(prevVersions :+ xsource3).map((sv, _))
} :+ (scala213, TargetAxis(scala3))

lazy val publishLocalTransitive =
taskKey[Unit]("Run publishLocal on this project and its dependencies")
Expand Down

0 comments on commit d0a8f3b

Please sign in to comment.