Indicate deprecated option aliases

Author: som-snytt

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -129,7 +129,7 @@ trait CommonScalaSettings:
   val replQuitAfterInit: Setting[Boolean] = BooleanSetting(RootSetting, "repl-quit-after-init", "Quit REPL after evaluating the init script.", aliases = List("--repl-quit-after-init"))
 
   /* YSettings shared with scaladoc */
-  val Yusejavacp: Setting[Boolean] = BooleanSetting(ForkSetting, "Yusejavacp", "Utilize the java.class.path in classpath resolution.", aliases = List("--use-java-class-path", "-usejavacp", "--usejavacp"))
+  val Yusejavacp: Setting[Boolean] = BooleanSetting(ForkSetting, "Yusejavacp", "Utilize the java.class.path in classpath resolution.", aliases = List("--use-java-class-path*", "-usejavacp*", "--usejavacp*"))
 end CommonScalaSettings
 
 /** -P "plugin" settings. Various tools might support plugins. */
@@ -146,8 +146,8 @@ private sealed trait PluginSettings:
 private sealed trait VerboseSettings:
   self: SettingGroup =>
   val Vhelp: Setting[Boolean] = BooleanSetting(VerboseSetting, "V", "Print a synopsis of verbose options.")
-  val Vprint: Setting[List[String]] = PhasesSetting(VerboseSetting, "Vprint", "Print out program after", aliases = List("-Xprint"))
-  val XshowPhases: Setting[Boolean] = BooleanSetting(VerboseSetting, "Vphases", "List compiler phases.", aliases = List("-Xshow-phases"))
+  val Vprint: Setting[List[String]] = PhasesSetting(VerboseSetting, "Vprint", "Print out program after", aliases = List("-Xprint*"))
+  val XshowPhases: Setting[Boolean] = BooleanSetting(VerboseSetting, "Vphases", "List compiler phases.", aliases = List("-Xshow-phases*"))
 
   val Vprofile: Setting[Boolean] = BooleanSetting(VerboseSetting, "Vprofile", "Show metrics about sources and internal representations to estimate compile-time complexity.")
   val VprofileSortedBy = ChoiceSetting(VerboseSetting, "Vprofile-sorted-by", "key", "Show metrics about sources and internal representations sorted by given column name", List("name", "path", "lines", "tokens", "tasty", "complexity"), "")
@@ -161,7 +161,7 @@ private sealed trait WarningSettings:
   self: SettingGroup =>
 
   val Whelp: Setting[Boolean] = BooleanSetting(WarningSetting, "W", "Print a synopsis of warning options.")
-  val Werror: Setting[Boolean] = BooleanSetting(WarningSetting, "Werror", "Fail the compilation if there are any warnings.", aliases = List("-Xfatal-warnings"))
+  val Werror: Setting[Boolean] = BooleanSetting(WarningSetting, "Werror", "Fail the compilation if there are any warnings.", aliases = List("-Xfatal-warnings*"))
   val Wall: Setting[Boolean] = BooleanSetting(WarningSetting, "Wall", "Enable all warning settings.")
   private val WvalueDiscard: Setting[Boolean] = BooleanSetting(WarningSetting, "Wvalue-discard", "Warn when non-Unit expression results are unused.")
   private val WNonUnitStatement = BooleanSetting(WarningSetting, "Wnonunit-statement", "Warn when block statements are non-Unit expressions.")
@@ -361,9 +361,9 @@ private sealed trait XSettings:
   val XdebugMacros: Setting[Boolean] = BooleanSetting(AdvancedSetting, "Xdebug-macros", "Show debug info when quote pattern match fails")
 
   /** Pipeline compilation options */
-  val XjavaTasty: Setting[Boolean] = BooleanSetting(AdvancedSetting, "Xjava-tasty", "Pickler phase should compute TASTy for .java defined symbols for use by build tools", aliases = List("-Xpickle-java", "-Yjava-tasty", "-Ypickle-java"), preferPrevious = true)
-  val XearlyTastyOutput: Setting[AbstractFile] = OutputSetting(AdvancedSetting, "Xearly-tasty-output", "directory|jar", "Destination to write generated .tasty files to for use in pipelined compilation.", NoAbstractFile, aliases = List("-Xpickle-write", "-Yearly-tasty-output", "-Ypickle-write"), preferPrevious = true)
-  val XallowOutlineFromTasty: Setting[Boolean] = BooleanSetting(AdvancedSetting, "Xallow-outline-from-tasty", "Allow outline TASTy to be loaded with the -from-tasty option.", aliases = List("-Yallow-outline-from-tasty"))
+  val XjavaTasty: Setting[Boolean] = BooleanSetting(AdvancedSetting, "Xjava-tasty", "Pickler phase should compute TASTy for .java defined symbols for use by build tools", aliases = List("-Xpickle-java", "-Yjava-tasty*", "-Ypickle-java"), preferPrevious = true)
+  val XearlyTastyOutput: Setting[AbstractFile] = OutputSetting(AdvancedSetting, "Xearly-tasty-output", "directory|jar", "Destination to write generated .tasty files to for use in pipelined compilation.", NoAbstractFile, aliases = List("-Xpickle-write", "-Yearly-tasty-output*", "-Ypickle-write"), preferPrevious = true)
+  val XallowOutlineFromTasty: Setting[Boolean] = BooleanSetting(AdvancedSetting, "Xallow-outline-from-tasty", "Allow outline TASTy to be loaded with the -from-tasty option.", aliases = List("-Yallow-outline-from-tasty*"))
 
   val XmixinForceForwarders = ChoiceSetting(
     AdvancedSetting,

compiler/src/dotty/tools/dotc/config/Settings.scala

@@ -111,8 +111,9 @@ object Settings:
     // accept legacy choices (for example, valid in Scala 2 but no longer supported)
     legacyChoices: Option[Seq[?]] = None)(private[Settings] val idx: Int)(using ct: ClassTag[T]):
 
+    val alternatives = aliases.map(_.stripSuffix("*"))
     validateSettingString(prefix.getOrElse(name))
-    aliases.foreach(validateSettingString)
+    alternatives.foreach(validateSettingString)
     assert(name.startsWith(s"-${category.prefixLetter}"), s"Setting $name does not start with category -$category")
     assert(legacyArgs || !choices.exists(_.contains("")), s"Empty string is not supported as a choice for setting $name")
     validateSettingTag(ct)
@@ -121,7 +122,7 @@ object Settings:
     // Example: -opt Main.scala would be interpreted as -opt:Main.scala, and the source file would be ignored.
     assert(!(ct == ListTag && ignoreInvalidArgs), s"Ignoring invalid args is not supported for multivalue settings: $name")
 
-    val allFullNames: List[String] = s"$name" :: s"-$name" :: aliases
+    val allFullNames: List[String] = s"$name" :: s"-$name" :: alternatives
 
     def valueIn(state: SettingsState): T = state.value(idx).asInstanceOf[T]
 
@@ -143,8 +144,9 @@ object Settings:
         case None                   => ""
 
     // Updates the state from the next arg if this setting is applicable.
-    def tryToSet(state: ArgsSummary): ArgsSummary =
-      val ArgsSummary(sstate, arg :: args, _, _) = state: @unchecked
+    def tryToSet(state0: ArgsSummary): ArgsSummary =
+      val ArgsSummary(sstate, arg :: args, _, _) = state0: @unchecked
+      def state(using ArgsSummary) = summon[ArgsSummary]
       def changed = sstate.wasChanged(idx)
 
       /** Updates the value in state.
@@ -154,7 +156,7 @@ object Settings:
        *  @param args remaining arguments to process
        *  @return updated argument state
        */
-      def update(value: => Any, altArg: String, args: List[String]): ArgsSummary =
+      def update(value: => Any, altArg: String, args: List[String])(using ArgsSummary): ArgsSummary =
         deprecation match
         case Some(Deprecation(msg, Some(replacedBy))) =>
           val deprecatedMsg = s"Option $name is deprecated: $msg"
@@ -169,7 +171,7 @@ object Settings:
           state.updated(updateIn(sstate, value), args)
       end update
 
-      def setBoolean(argValue: String, args: List[String]) =
+      def setBoolean(argValue: String, args: List[String])(using ArgsSummary) =
         def checkAndSet(v: Boolean) =
           val dubious = changed && v != valueIn(sstate).asInstanceOf[Boolean]
           if dubious then
@@ -183,7 +185,7 @@ object Settings:
         else if argValue.equalsIgnoreCase("false") then checkAndSet(false)
         else state.fail(s"$argValue is not a valid choice for Boolean flag $name", args)
 
-      def setString(argValue: String, args: List[String]) =
+      def setString(argValue: String, args: List[String])(using ArgsSummary) =
         choices match
         case Some(choices) if !choices.contains(argValue) =>
           state.fail(s"$argValue is not a valid choice for $name", args)
@@ -193,7 +195,7 @@ object Settings:
           else
             update(argValue, argValue, args)
 
-      def setInt(argValue: String, args: List[String]) =
+      def setInt(argValue: String, args: List[String])(using ArgsSummary) =
         argValue.toIntOption.map: intValue =>
           choices match
           case Some(r: Range) if intValue < r.head || r.last < intValue =>
@@ -207,7 +209,7 @@ object Settings:
         .getOrElse:
           state.fail(s"$argValue is not an integer argument for $name", args)
 
-      def setOutput(arg: String, args: List[String]) =
+      def setOutput(arg: String, args: List[String])(using ArgsSummary) =
         val path = Directory(arg)
         val isJar = path.ext.isJar
         if (!isJar && !path.isDirectory) then
@@ -221,7 +223,7 @@ object Settings:
 
       // argRest is the remainder of -foo:bar if any. This setting will receive a value from argRest or args.head.
       // useArg means use argRest even if empty.
-      def doSet(argRest: String, useArg: Boolean): ArgsSummary =
+      def doSet(argRest: String, useArg: Boolean)(using ArgsSummary): ArgsSummary =
         def missingArg =
           val msg = s"missing argument for option $name"
           if ignoreInvalidArgs then state.warn(s"$msg, the tag was ignored", args) else state.fail(msg, args)
@@ -248,12 +250,12 @@ object Settings:
           doSet(arg1, args1)
       end doSet
 
-      def setVersion(arg: String, args: List[String]) =
+      def setVersion(arg: String, args: List[String])(using ArgsSummary) =
         ScalaVersion.parse(arg) match
         case Success(v) => update(v, arg, args)
         case Failure(e) => state.fail(e.getMessage, args)
 
-      def setMultivalue(arg: String, args: List[String]) =
+      def setMultivalue(arg: String, args: List[String])(using ArgsSummary) =
         val split = arg.split(",").toList
         def setOrUpdate(actual: List[String]) =
           val updated =
@@ -285,7 +287,22 @@ object Settings:
         val name = arg.takeWhile(_ != ':')
         allFullNames.exists(_ == name) || prefix.exists(arg.startsWith)
 
+      def checkDeprecatedAlias()(using ArgsSummary) =
+        val name = arg.takeWhile(_ != ':')
+        val found =
+          for
+            alt <- alternatives.find(_ == name)
+            altx = alt + "*"
+            _ <- aliases.find(_ == altx)
+          yield
+            alt
+        found.map: alt =>
+          state.warn(s"Option $alt is a deprecated alias: use -${this.name}", args)
+        .getOrElse(state)
+
       if matches then
+        val checked = checkDeprecatedAlias()(using state0)
+        given ArgsSummary = checked
         deprecation match
         case Some(Deprecation(msg, _)) if ignoreInvalidArgs => // a special case for Xlint
           state.warn(s"Option $name is deprecated: $msg", args)
@@ -300,7 +317,7 @@ object Settings:
               doSet("", useArg = false)
             else
               doSet(split(1), useArg = true)
-      else state
+      else state0
 
     end tryToSet
   end Setting

compiler/test/dotty/tools/dotc/config/ScalaSettingsTests.scala

@@ -306,4 +306,11 @@ class ScalaSettingsTests:
       assertEquals(0, result.warnings.length)
       assertEquals(1, result.errors.length)
 
+  @Test def `deprecated aliases warn`: Unit =
+    val settings = ScalaSettings
+    val args = "-Xfatal-warnings" :: "-usejavacp" :: Nil
+    val result = settings.processArguments(args, processAll = true)
+    assertEquals(2, result.warnings.length)
+    assertEquals(0, result.errors.length)
+
 end ScalaSettingsTests