[proposal] Literal Scala versions

.github/workflows/ci.yml

@@ -90,11 +90,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: mkdir -p target .js/target .jvm/target .native/target lib/.js/target lib/.jvm/target project/target
+        run: mkdir -p target macros/.jvm/target testkit/.js/target .js/target core/.js/target macros/.js/target core/.jvm/target .jvm/target .native/target lib/.js/target testkit/.jvm/target lib/.jvm/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: tar cf targets.tar target .js/target .jvm/target .native/target lib/.js/target lib/.jvm/target project/target
+        run: tar cf targets.tar target macros/.jvm/target testkit/.js/target .js/target core/.js/target macros/.js/target core/.jvm/target .jvm/target .native/target lib/.js/target testkit/.jvm/target lib/.jvm/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')

.scalafmt.conf

@@ -1,6 +1,11 @@
 version = 3.6.0
 
-runner.dialect = scala213
+runner.dialect = Scala213Source3
+fileOverride {
+  "glob:**/src/{main,test}/scala-3/**" {
+    runner.dialect = Scala3
+  }
+}
 
 preset = defaultWithAlign
 
@@ -10,4 +15,4 @@ indent {
   callSite = 2
   defnSite = 2
   extendSite = 2
-}
+}

build.sbt

@@ -2,6 +2,10 @@ name := "scalac-options-root"
 
 ThisBuild / tlBaseVersion := "0.1"
 
+// Mima validations against the prevous releases are intentionally disabled
+// since the current changes are not (yet) supposed to be binary-compatible.
+ThisBuild / tlMimaPreviousVersions := Set.empty
+
 ThisBuild / organization     := "org.typelevel"
 ThisBuild / organizationName := "Typelevel"
 ThisBuild / startYear        := Some(2022)
@@ -24,19 +28,75 @@ ThisBuild / crossScalaVersions := Seq(
   Scala3
 ) // There's no reason not to cross-publish
 
-lazy val root = tlCrossRootProject.aggregate(lib)
+lazy val root = tlCrossRootProject.aggregate(core, macros, lib, testkit)
 
+lazy val literallyVersion  = "1.1.0"
 lazy val munitVersion      = "0.7.29"
 lazy val scalacheckVersion = "1.17.0"
 
+lazy val core = crossProject(JVMPlatform, JSPlatform)
+  .crossType(CrossType.Pure)
+  .in(file("core"))
+  .enablePlugins(NoPublishPlugin)
+  .settings(
+    name := "scalac-options-core"
+  )
+
+lazy val macros = crossProject(JVMPlatform, JSPlatform)
+  .crossType(CrossType.Pure)
+  .in(file("macros"))
+  .dependsOn(core)
+  .enablePlugins(NoPublishPlugin)
+  .settings(
+    name := "scalac-options-macros",
+    scalacOptions := {
+      if (tlIsScala3.value)
+        scalacOptions.value.filterNot(_ == "-source:3.0-migration") :+ "-source:3.1"
+      else
+        scalacOptions.value
+    },
+    libraryDependencies ++= Seq(
+      "org.typelevel" %%% "literally" % literallyVersion
+    ) ++ {
+      if (tlIsScala3.value) Nil
+      else
+        List("org.scala-lang" % "scala-reflect" % scalaVersion.value % Provided)
+    }
+  )
+
 lazy val lib = crossProject(JVMPlatform, JSPlatform)
   .crossType(CrossType.Pure)
   .in(file("lib"))
+  .dependsOn(core, macros)
+  .settings(
+    name := "scalac-options"
+  )
+  .settings {
+    def projectMappings(cproj: sbtcrossproject.CrossProject) = Def.taskDyn {
+      cproj.projects(crossProjectPlatform.value) / Compile / packageBin / mappings
+    }
+
+    Compile / packageBin / mappings ++=
+      projectMappings(core).value ++ projectMappings(macros).value
+  }
+  .settings {
+    def projectMappings(cproj: sbtcrossproject.CrossProject) = Def.taskDyn {
+      cproj.projects(crossProjectPlatform.value) / Compile / packageSrc / mappings
+    }
+
+    Compile / packageSrc / mappings ++=
+      projectMappings(core).value ++ projectMappings(macros).value
+  }
+
+lazy val testkit = crossProject(JVMPlatform, JSPlatform)
+  .crossType(CrossType.Pure)
+  .in(file("testkit"))
+  .dependsOn(lib)
   .settings(
-    name := "scalac-options",
+    name := "scalac-options-testkit",
     libraryDependencies ++= Seq(
-      "org.scalameta"  %%% "munit"            % munitVersion      % Test,
-      "org.scalacheck" %%% "scalacheck"       % scalacheckVersion % Test,
-      "org.scalameta"  %%% "munit-scalacheck" % munitVersion      % Test
+      "org.scalacheck" %%% "scalacheck"       % scalacheckVersion,
+      "org.scalameta"  %%% "munit"            % munitVersion % Test,
+      "org.scalameta"  %%% "munit-scalacheck" % munitVersion % Test
     )
   )

core/src/main/scala/org/typelevel/scalacoptions/ScalaVersion.scala

@@ -0,0 +1,101 @@
+/*
+ * Copyright 2022 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.scalacoptions
+
+import org.typelevel.scalacoptions.internal.Parser
+
+import scala.Ordering.Implicits._
+import scala.collection.immutable
+
+abstract sealed case class ScalaVersion private (major: Long, minor: Long, patch: Long) {
+
+  def isBetween(addedVersion: ScalaVersion, removedVersion: ScalaVersion): Boolean =
+    this >= addedVersion && this < removedVersion
+}
+
+object ScalaVersion {
+  private def apply(major: Long, minor: Long, patch: Long): ScalaVersion =
+    new ScalaVersion(major, minor, patch) {}
+
+  lazy val knownVersions: immutable.SortedSet[ScalaVersion] = {
+    val bld = immutable.SortedSet.newBuilder[ScalaVersion]
+
+    def bldPatches(major: Long, minor: Long, lastPatch: Long): Unit =
+      for (patch <- 0L to lastPatch)
+        bld += ScalaVersion(major, minor, patch)
+
+    bldPatches(2, 11, 12)
+    bldPatches(2, 12, 17)
+    bldPatches(2, 13, 9)
+    bldPatches(3, 0, 2)
+    bldPatches(3, 1, 3)
+    bldPatches(3, 2, 0)
+
+    bld.result()
+  }
+
+  def from(major: Long, minor: Long, patch: Long): Option[ScalaVersion] = {
+    val candidate = ScalaVersion(major, minor, patch)
+    if (knownVersions.contains(candidate)) Some(candidate) else None
+  }
+
+  def unsafeFrom(major: Long, minor: Long, patch: Long): ScalaVersion =
+    from(major, minor, patch).getOrElse(throw invalidScalaVersionError(s"$major.$minor.$patch"))
+
+  object fromString {
+    def apply(s: String): Option[ScalaVersion] =
+      Parser.parseGenericVersion(s).flatMap(Function.tupled(from _))
+    def unapply(s: String): Option[ScalaVersion] = apply(s)
+
+    def unsafe(s: String): ScalaVersion = apply(s).getOrElse(throw invalidScalaVersionError(s))
+  }
+
+  @deprecated("use literal `sver\"2.11.0\"` instead", "<TBD>")
+  val V2_11_0 = ScalaVersion(2, 11, 0)
+  @deprecated("use literal `sver\"2.11.11\"` instead", "<TBD>")
+  val V2_11_11 = ScalaVersion(2, 11, 11)
+  @deprecated("use literal `sver\"2.12.0\"` instead", "<TBD>")
+  val V2_12_0 = ScalaVersion(2, 12, 0)
+  @deprecated("use literal `sver\"2.12.2\"` instead", "<TBD>")
+  val V2_12_2 = ScalaVersion(2, 12, 2)
+  @deprecated("use literal `sver\"2.12.5\"` instead", "<TBD>")
+  val V2_12_5 = ScalaVersion(2, 12, 5)
+  @deprecated("use literal `sver\"2.12.13\"` instead", "<TBD>")
+  val V2_12_13 = ScalaVersion(2, 12, 13)
+  @deprecated("use literal `sver\"2.13.0\"` instead", "<TBD>")
+  val V2_13_0 = ScalaVersion(2, 13, 0)
+  @deprecated("use literal `sver\"2.13.2\"` instead", "<TBD>")
+  val V2_13_2 = ScalaVersion(2, 13, 2)
+  @deprecated("use literal `sver\"2.13.3\"` instead", "<TBD>")
+  val V2_13_3 = ScalaVersion(2, 13, 3)
+  @deprecated("use literal `sver\"2.13.4\"` instead", "<TBD>")
+  val V2_13_4 = ScalaVersion(2, 13, 4)
+  @deprecated("use literal `sver\"2.13.5\"` instead", "<TBD>")
+  val V2_13_5 = ScalaVersion(2, 13, 5)
+  @deprecated("use literal `sver\"2.13.6\"` instead", "<TBD>")
+  val V2_13_6 = ScalaVersion(2, 13, 6)
+  @deprecated("use literal `sver\"3.0.0\"` instead", "<TBD>")
+  val V3_0_0 = ScalaVersion(3, 0, 0)
+  @deprecated("use literal `sver\"3.1.0\"` instead", "<TBD>")
+  val V3_1_0 = ScalaVersion(3, 1, 0)
+
+  implicit lazy val scalaVersionOrdering: Ordering[ScalaVersion] =
+    Ordering.by(version => (version.major, version.minor, version.patch))
+
+  private def invalidScalaVersionError(s: String) =
+    new IllegalArgumentException(s"invalid Scala version: $s")
+}

core/src/main/scala/org/typelevel/scalacoptions/internal/Parser.scala

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.scalacoptions.internal
+
+private[scalacoptions] object Parser {
+  private[internal] lazy val genericVersionRe = """^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$""".r
+
+  private object asLong {
+    def unapply(s: String): Option[Long] = {
+      try {
+        Some(java.lang.Long.parseUnsignedLong(s))
+      } catch {
+        case _: NumberFormatException => None
+      }
+    }
+  }
+
+  def parseGenericVersion(s: String): Option[(Long, Long, Long)] = s match {
+    case genericVersionRe(asLong(major), asLong(minor), asLong(patch)) =>
+      Some((major, minor, patch))
+    case _ =>
+      None
+  }
+}