Merge pull request #546 from romanowski/better-comments

New using directive syntax

build.sc

@@ -15,6 +15,7 @@ import $file.project.settings, settings.{
   localRepoResourcePath,
   platformExecutableJarExtension
 }
+import $file.project.deps, deps.customRepositories
 
 import java.io.File
 import java.nio.charset.Charset
@@ -113,9 +114,7 @@ object `generate-reference-doc` extends SbtModule with ScalaCliScalafixModule {
   def moduleDeps = Seq(
     cli
   )
-  def repositories = super.repositories ++ Seq(
-    coursier.Repositories.sonatype("snapshots")
-  )
+  def repositories = super.repositories ++ customRepositories
   def ivyDeps = Agg(
     Deps.caseApp,
     Deps.munit
@@ -176,9 +175,8 @@ class Build(val crossScalaVersion: String)
   def scalacOptions = T {
     super.scalacOptions() ++ Seq("-Xasync", "-Ywarn-unused", "-deprecation")
   }
-  def repositories = super.repositories ++ Seq(
-    coursier.Repositories.sonatype("snapshots")
-  )
+  def repositories = super.repositories ++ customRepositories
+
   def compileIvyDeps = super.compileIvyDeps() ++ Agg(
     Deps.svm
   )
@@ -324,9 +322,9 @@ trait Cli extends SbtModule with CliLaunchers with ScalaCliPublishModule with Fo
     build(Scala.defaultInternal),
     `test-runner`(Scala.defaultInternal)
   )
-  def repositories = super.repositories ++ Seq(
-    coursier.Repositories.sonatype("snapshots")
-  )
+
+  def repositories = super.repositories ++ customRepositories
+
   def ivyDeps = super.ivyDeps() ++ Agg(
     Deps.caseApp,
     Deps.coursierLauncher,

examples/cross-build/Hello.js.scala

@@ -1,5 +1,5 @@
-// using scala 2.13
-// using target scala-js
+//> using scala 2.13
+//> using target scala-js
 
 import scala.scalajs.js
 

examples/cross-build/Hello.native.scala

@@ -1,5 +1,5 @@
-// using scala 2.13
-// using target scala-native
+//> using scala 2.13
+//> using target scala-native
 
 import scala.scalanative.libc._
 import scala.scalanative.unsafe._

examples/scala-versions/README.md

@@ -95,7 +95,7 @@ Using directives syntax is still experimental and may change in future versions
 So when we will have:
 
 ```scala title=version.scala
-// using scala 2.12.5
+//> using scala 2.12.5
 
 object OldCode
 //rest of the config

examples/scala-versions/version.scala

@@ -1,6 +1,6 @@
 // File was generated from based on docs/cookbooks/scala-versions.md, do not edit manually!
 
-// using scala 2.12.5
+//> using scala 2.12.5
 
 object OldCode
 //rest of the config

examples/scripting/README.md

@@ -12,7 +12,7 @@ print all files located in path passed as the first argument
 Create a file name `ls.sc`
 ```scala
 #!/usr/bin/env scala-cli
-// using lib "com.lihaoyi::os-lib:0.7.8"
+//> using lib "com.lihaoyi::os-lib:0.7.8"
 val cwd = if(args.nonEmpty) os.Path(args(0), os.pwd) else os.pwd
 println(os.list(cwd).map(_.last).mkString("\n"))
 ```

examples/utest/MyTests.scala

@@ -1,4 +1,4 @@
-// using lib "com.lihaoyi::utest::0.7.10"
+//> using lib "com.lihaoyi::utest::0.7.10"
 
 import utest._
 

gcbenchmark/gcbenchmark.scala

@@ -1,6 +1,6 @@
-// using lib "com.lihaoyi::os-lib:0.8.0"
-// using lib "com.lihaoyi::pprint:0.7.1"
-// using scala "2.13"
+//> using lib "com.lihaoyi::os-lib:0.8.0"
+//> using lib "com.lihaoyi::pprint:0.7.1"
+//> using scala "2.13"
 
 // Usage: scala-cli gcbenchmark.scala -- <path_to_scala_cli_executable>
 

mill

@@ -20,6 +20,6 @@ EOF
   exit 1
 fi
 
-eval "$(cs java --env --jvm temurin:17)"
+eval "$(cs java --env --jvm temurin:17 || cs java --env --jvm openjdk:1.17.0)"
 
 exec /usr/bin/env bash "$DIR/millw" "$@"

modules/build/src/main/scala/scala/build/ConsoleBloopBuildClient.scala

@@ -151,8 +151,8 @@ object ConsoleBloopBuildClient {
   private val red    = Console.RED
   private val yellow = Console.YELLOW
 
-  private def getPrefix(severity: Severity) =
-    if (severity == Severity.Error) s"[${red}error$reset] "
+  def diagnosticPrefix(isError: Boolean): String =
+    if (isError) s"[${red}error$reset] "
     else s"[${yellow}warn$reset] "
 
   def printFileDiagnostic(
@@ -163,9 +163,7 @@ object ConsoleBloopBuildClient {
     val isWarningOrError = diag.getSeverity == bsp4j.DiagnosticSeverity.ERROR ||
       diag.getSeverity == bsp4j.DiagnosticSeverity.WARNING
     if (isWarningOrError) {
-      val prefix =
-        if (diag.getSeverity == bsp4j.DiagnosticSeverity.ERROR) s"[${red}error$reset] "
-        else s"[${yellow}warn$reset] "
+      val prefix = diagnosticPrefix(diag.getSeverity == bsp4j.DiagnosticSeverity.ERROR)
 
       val line  = (diag.getRange.getStart.getLine + 1).toString + ":"
       val col   = (diag.getRange.getStart.getCharacter + 1).toString + ":"
@@ -217,7 +215,7 @@ object ConsoleBloopBuildClient {
     val isWarningOrError = true
     if (isWarningOrError) {
       val msgIt  = message.linesIterator
-      val prefix = getPrefix(severity)
+      val prefix = diagnosticPrefix(severity == Severity.Error)
       out.println(prefix + (if (msgIt.hasNext) " " + msgIt.next() else ""))
       msgIt.foreach(line => out.println(prefix + line))
 

modules/build/src/main/scala/scala/build/Logger.scala

@@ -3,7 +3,7 @@ package scala.build
 import java.io.{OutputStream, PrintStream}
 
 import scala.build.blooprifle.BloopRifleLogger
-import scala.build.errors.{BuildException, Diagnostic}
+import scala.build.errors.{BuildException, Diagnostic, Severity}
 import scala.scalanative.{build => sn}
 
 trait Logger {
@@ -14,6 +14,13 @@ trait Logger {
   def debug(s: => String): Unit
 
   def log(diagnostics: Seq[Diagnostic]): Unit
+
+  def diagnostic(
+    message: String,
+    severity: Severity = Severity.Warning,
+    positions: Seq[Position] = Nil
+  ): Unit = log(Seq(Diagnostic(message, severity, positions)))
+
   def log(ex: BuildException): Unit
   def exit(ex: BuildException): Nothing
 

modules/build/src/main/scala/scala/build/PersistentDiagnosticLogger.scala

@@ -0,0 +1,34 @@
+package scala.build
+
+import java.io.PrintStream
+
+import scala.build.blooprifle.BloopRifleLogger
+import scala.build.errors.{BuildException, Diagnostic}
+import scala.scalanative.{build => sn}
+
+class PersistentDiagnosticLogger(parent: Logger) extends Logger {
+  private val diagBuilder = List.newBuilder[Diagnostic]
+
+  def diagnostics = diagBuilder.result()
+
+  // TODO Use macros for log and debug calls to have zero cost when verbosity <= 0
+  def message(message: => String): Unit         = parent.message(message)
+  def log(s: => String): Unit                   = parent.log(s)
+  def log(s: => String, debug: => String): Unit = parent.log(s, debug)
+  def debug(s: => String): Unit                 = parent.debug(s)
+
+  def log(diagnostics: Seq[Diagnostic]): Unit = {
+    parent.log(diagnostics)
+    diagBuilder ++= diagnostics
+  }
+
+  def log(ex: BuildException): Unit     = parent.log(ex)
+  def exit(ex: BuildException): Nothing = parent.exit(ex)
+
+  def coursierLogger: coursier.cache.CacheLogger        = parent.coursierLogger
+  def bloopRifleLogger: BloopRifleLogger                = parent.bloopRifleLogger
+  def scalaNativeTestLogger: sn.Logger                  = parent.scalaNativeTestLogger
+  def scalaNativeCliInternalLoggerOptions: List[String] = parent.scalaNativeCliInternalLoggerOptions
+
+  def compilerOutputStream: PrintStream = parent.compilerOutputStream
+}

modules/build/src/main/scala/scala/build/bsp/BspClient.scala

@@ -7,9 +7,10 @@ import java.net.URI
 import java.nio.file.Paths
 import java.util.concurrent.{ConcurrentHashMap, ExecutorService}
 
-import scala.build.errors.{BuildException, CompositeBuildException}
+import scala.build.Position.File
+import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic, Severity}
 import scala.build.postprocessing.LineConversion
-import scala.build.{BloopBuildClient, GeneratedSource, Logger, Position}
+import scala.build.{BloopBuildClient, GeneratedSource, Logger}
 import scala.jdk.CollectionConverters._
 
 class BspClient(
@@ -145,7 +146,7 @@ class BspClient(
   def reportBuildException(
     targetIdOpt: Option[b.BuildTargetIdentifier],
     ex: BuildException,
-    isFirst: Boolean = true
+    reset: Boolean = true
   ): Unit =
     targetIdOpt match {
       case None =>
@@ -155,30 +156,8 @@ class BspClient(
           case c: CompositeBuildException => c.exceptions
           case _                          => Seq(ex)
         }
-        var touchedFiles = Set.empty[os.Path]
-        for {
-          ex   <- allExceptions
-          pos  <- ex.positions.distinct.collect { case f: Position.File => f }
-          path <- pos.path.toOption
-        } {
-          val id = new b.TextDocumentIdentifier(path.toNIO.toUri.toASCIIString)
-          val diag = {
-            val startPos = new b.Position(pos.startPos._1, pos.startPos._2)
-            val endPos   = new b.Position(pos.endPos._1, pos.endPos._2)
-            val range    = new b.Range(startPos, endPos)
-            new b.Diagnostic(range, ex.message)
-          }
-          diag.setSeverity(b.DiagnosticSeverity.ERROR)
-          val params = new b.PublishDiagnosticsParams(
-            id,
-            targetId,
-            List(diag).asJava,
-            isFirst
-          )
-          touchedFiles = touchedFiles + path
-          buildExceptionDiagnosticsDocs.put((path, targetId), JBoolean.TRUE)
-          actualBuildPublishDiagnostics(params)
-        }
+        val touchedFiles =
+          allExceptions.flatMap(reportDiagnosticForFiles(targetId, reset = reset)).toSet
 
         // Small chance of us wiping some Bloop diagnostics, if these happen
         // between the call to remove and the call to actualBuildPublishDiagnostics.
@@ -200,4 +179,33 @@ class BspClient(
         }
     }
 
+  def reportDiagnosticForFiles(
+    targetId: b.BuildTargetIdentifier,
+    reset: Boolean = false
+  )(diag: Diagnostic): Seq[os.Path] =
+    diag.positions.flatMap {
+      case File(Right(path), (startLine, startC), (endL, endC)) =>
+        val id = new b.TextDocumentIdentifier(path.toNIO.toUri.toASCIIString)
+        val bDiag = {
+          val startPos = new b.Position(startLine, startC)
+          val endPos   = new b.Position(endL, endC)
+          val range    = new b.Range(startPos, endPos)
+          new b.Diagnostic(range, diag.message)
+        }
+        val severity = diag.severity match {
+          case Severity.Error   => b.DiagnosticSeverity.ERROR
+          case Severity.Warning => b.DiagnosticSeverity.WARNING
+        }
+        bDiag.setSeverity(severity)
+        val params = new b.PublishDiagnosticsParams(
+          id,
+          targetId,
+          List(bDiag).asJava,
+          reset
+        )
+        buildExceptionDiagnosticsDocs.put((path, targetId), JBoolean.TRUE)
+        actualBuildPublishDiagnostics(params)
+        Seq(path)
+      case _ => Nil
+    }
 }