Migrate some printlns to reporting

romanowski · romanowski · commit 1447c917c7bc · 2020-12-01T00:55:18.000+01:00
diff --git a/scala3doc/src/dotty/dokka/DocContext.scala b/scala3doc/src/dotty/dokka/DocContext.scala
@@ -7,14 +7,47 @@ import java.io.File
 import collection.JavaConverters._
 import dotty.dokka.site.StaticSiteContext
 import dotty.tools.dotc.core.Contexts._
+import java.io.ByteArrayOutputStream
+import java.io.PrintStream
 
-given compilerContext(using docContext: DocContext) as Context =
+type CompilerContext = dotty.tools.dotc.core.Contexts.Context
+
+given compilerContext(using docContext: DocContext) as CompilerContext =
   docContext.compilerContext
 
 given docContextFromDokka(using dokkaContext: DokkaContext) as DocContext =
   dokkaContext.getConfiguration.asInstanceOf[DocContext]
 
-case class DocContext(args: Scala3doc.Args, compilerContext: Context)
+val report = dotty.tools.dotc.report
+
+def throwableToString(t: Throwable)(using CompilerContext): String =
+  if ctx.settings.verbose.value then
+    val os = new ByteArrayOutputStream
+    t.printStackTrace(new PrintStream(os))
+    os.toString()
+  else s"${t.getClass.getName}: ${t.getMessage}"
+
+// TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
+private def createMessage(
+  msg: String, file: File, e: Throwable | Null)(using CompilerContext): String =
+    val localizedMessage = s"$file: $msg"
+    e match
+      case null => localizedMessage
+      case throwable: Throwable =>
+         s"$localizedMessage \ncaused by: ${throwableToString(throwable)}"
+
+extension (r: report.type):
+  def error(m: String, f: File, e: Throwable | Null = null)(using CompilerContext): Unit =
+    r.error(createMessage(m, f, e))
+
+  def warn(m: String, f: File, e: Throwable)(using CompilerContext): Unit =
+    r.warning(createMessage(m, f, e))
+
+  def warn(m: String, f: File)(using CompilerContext): Unit =
+    r.warning(createMessage(m, f, null))
+
+
+case class DocContext(args: Scala3doc.Args, compilerContext: CompilerContext)
   extends DokkaConfiguration:
     override def getOutputDir: File = args.output
     override def getCacheRoot: File = null
@@ -26,7 +59,7 @@ case class DocContext(args: Scala3doc.Args, compilerContext: Context)
     override def getModuleName(): String = "ModuleName"
     override def getModuleVersion(): String = ""
 
-    lazy val sourceLinks: SourceLinks = SourceLinks.load(args)
+    lazy val sourceLinks: SourceLinks = SourceLinks.load(using this)
 
     lazy val displaySourceSets = getSourceSets.toDisplaySourceSet
 
@@ -37,7 +70,7 @@ case class DocContext(args: Scala3doc.Args, compilerContext: Context)
         Set(mkSourceSet.asInstanceOf[SourceSetWrapper]),
         args,
         sourceLinks
-      ))
+      )(using compilerContext))
 
     override def getPluginsConfiguration: JList[DokkaConfiguration.PluginConfiguration] =
       JList()
diff --git a/scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala b/scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala
@@ -49,7 +49,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
   // Just turn off another translator since multiple overrides does not work
   val disableDescriptorTranslator = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getSourceToDocumentableTranslator)
-    .fromRecipe { case ctx as given DokkaContext => new ScalaModuleProvider }
+    .fromRecipe { case ctx @ given DokkaContext => new ScalaModuleProvider }
     .overrideExtension(dokkaBase.getDescriptorToDocumentableTranslator)
     .name("disableDescriptorTranslator")
   )
@@ -63,14 +63,14 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val ourSignatureProvider = extend(
     _.extensionPoint(dokkaBase.getSignatureProvider)
-      .fromRecipe{ case ctx as given DokkaContext =>
+      .fromRecipe{ case ctx @ given DokkaContext =>
         new ScalaSignatureProvider(ctx.single(dokkaBase.getCommentsToContentConverter))
       }.overrideExtension(dokkaBase.getKotlinSignatureProvider)
   )
 
   val scalaResourceInstaller = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe{ case ctx as given DokkaContext => new ScalaResourceInstaller }
+      .fromRecipe{ case ctx @ given DokkaContext => new ScalaResourceInstaller }
       .after(dokkaBase.getCustomResourceInstaller)
   )
 
@@ -83,7 +83,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val scalaDocumentableToPageTranslator = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getDocumentableToPageTranslator)
-      .fromRecipe { case ctx as given DokkaContext =>
+      .fromRecipe { case ctx @ given DokkaContext =>
           new DocumentableToPageTranslator {
             override def invoke(module: DModule): ModulePageNode = ScalaPageCreator(
               ctx.single(dokkaBase.getCommentsToContentConverter),
@@ -108,7 +108,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val ourRenderer = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getRenderer)
-      .fromRecipe { case ctx as given DokkaContext => new ScalaHtmlRenderer }
+      .fromRecipe { case ctx @ given DokkaContext => new ScalaHtmlRenderer }
       .overrideExtension(dokkaBase.getHtmlRenderer)
   )
 
@@ -126,7 +126,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val customDocumentationProvider = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe{ case c as given DokkaContext => new SitePagesCreator }
+      .fromRecipe{ case c @ given DokkaContext => new SitePagesCreator }
       .name("customDocumentationProvider")
       .ordered(
         before = Seq(
@@ -141,7 +141,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val customNavigation = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe{ case c as given DokkaContext => new NavigationCreator }
+      .fromRecipe{ case c @ given DokkaContext => new NavigationCreator }
       .name("customNavigation")
       .ordered(
         before = Seq(
@@ -155,7 +155,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val customDocumentationResources = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-    .fromRecipe{ case c as given DokkaContext => new SiteResourceManager }
+    .fromRecipe{ case c @ given DokkaContext => new SiteResourceManager }
       .name("customDocumentationResources")
       .after(
         scalaEmbeddedResourceAppender.getValue,
@@ -165,7 +165,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val locationProvider = extend(
     _.extensionPoint(dokkaBase.getLocationProviderFactory)
-      .fromRecipe { case c as given DokkaContext => new StaticSiteLocationProviderFactory }
+      .fromRecipe { case c @ given DokkaContext => new StaticSiteLocationProviderFactory }
       .overrideExtension(dokkaBase.getLocationProvider)
   )
 
diff --git a/scala3doc/src/dotty/dokka/Main.scala b/scala3doc/src/dotty/dokka/Main.scala
@@ -13,7 +13,6 @@ import java.nio.file.Files
 
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
 import dotty.tools.dotc.core.Contexts._
 
 /** Main class for the doctool.
diff --git a/scala3doc/src/dotty/dokka/Scala3doc.scala b/scala3doc/src/dotty/dokka/Scala3doc.scala
@@ -11,14 +11,12 @@ import collection.immutable.ArraySeq
 
 import java.nio.file.Files
 
-import dotty.tools.dotc.core.Contexts._
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
 import dotty.tools.dotc.reporting.Reporter
 
 
-class Scala3DocDokkaLogger(using Context) extends DokkaLogger:
+class Scala3DocDokkaLogger(using CompilerContext) extends DokkaLogger:
   def debug(msg: String): Unit = report.debuglog(msg)
 
   // We do not want errors from dokka (that are) not critical to fail our runs
@@ -69,7 +67,7 @@ object Scala3doc:
     revision: Option[String] = None
   )
 
-  def run(args: Array[String])(using ctx: Context): Reporter =
+  def run(args: Array[String])(using ctx: CompilerContext): Reporter =
     val parsedArgs = Scala3docArgs.extract(args.toList)
 
     def listTastyFiles(f: File): Seq[File] =
@@ -90,7 +88,7 @@ object Scala3doc:
     ctx.reporter
 
 
-  private [dokka] def run(args: Args)(using ctx: Context) =
+  private [dokka] def run(args: Args)(using ctx: CompilerContext) =
     val docContext = new DocContext(args, ctx)
     new DokkaGenerator(docContext, docContext.logger).generate()
 
diff --git a/scala3doc/src/dotty/dokka/Scala3docArgs.scala b/scala3doc/src/dotty/dokka/Scala3docArgs.scala
@@ -13,8 +13,6 @@ import java.nio.file.Files
 
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
-import dotty.tools.dotc.core.Contexts._
 import dotty.dokka.Scala3doc._
 
 class Scala3docArgs extends SettingGroup with CommonScalaSettings:
@@ -37,7 +35,7 @@ class Scala3docArgs extends SettingGroup with CommonScalaSettings:
     StringSetting("-revision", "revision", "Revision (branch or ref) used to build project project", "")
 
 object Scala3docArgs:
-  def extract(args: List[String])(using Context) =
+  def extract(args: List[String])(using CompilerContext) =
     val inst = new Scala3docArgs
     import inst._
     val initialSummary =
diff --git a/scala3doc/src/dotty/dokka/ScalaModuleCreator.scala b/scala3doc/src/dotty/dokka/ScalaModuleCreator.scala
@@ -13,7 +13,6 @@ import org.jetbrains.dokka.model._
 import org.jetbrains.dokka.base.parsers.MarkdownParser
 import collection.JavaConverters._
 import kotlin.coroutines.Continuation
-import dotty.tools.dotc.core.Contexts._
 
 class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTranslator:
    override def invoke(sourceSet: DokkaSourceSet, cxt: DokkaContext, unused: Continuation[? >: DModule]) =
diff --git a/scala3doc/src/dotty/dokka/SourceLinks.scala b/scala3doc/src/dotty/dokka/SourceLinks.scala
@@ -4,6 +4,7 @@ import java.nio.file.Path
 import java.nio.file.Paths
 import liqp.Template
 import dotty.dokka.model.api._
+import dotty.tools.dotc.core.Contexts.Context
 
 case class SourceLink(val path: Option[Path], val urlTemplate: Template)
 
@@ -113,7 +114,11 @@ object SourceLinks:
       |
       |Template can defined only by subset of sources defined by path prefix represented by `<sub-path>`""".stripMargin
 
-  def load(configs: Seq[String], revision: Option[String], projectRoot: Path): SourceLinks =
+  def load(
+      configs: Seq[String],
+      revision: Option[String],
+      projectRoot: Path)(
+      using Context): SourceLinks =
     // TODO ...
     val mappings = configs.map(str => str -> SourceLink.parse(str, revision))
 
@@ -122,7 +127,7 @@ object SourceLinks:
         s"'$template': $message"
     }.mkString("\n")
 
-    if errors.nonEmpty then println(
+    if errors.nonEmpty then report.warning(
       s"""Following templates has invalid format:
          |$errors
          |
@@ -132,10 +137,10 @@ object SourceLinks:
 
     SourceLinks(mappings.collect {case (_, Right(link)) => link}, projectRoot)
 
-  def load(args: Scala3doc.Args): SourceLinks =
+  def load(using ctx: DocContext): SourceLinks =
     load(
-      args.sourceLinks,
-      args.revision,
+      ctx.args.sourceLinks,
+      ctx.args.revision,
       // TODO (https://github.com/lampepfl/scala3doc/issues/240): configure source root
       Paths.get("").toAbsolutePath
     )
diff --git a/scala3doc/src/dotty/dokka/site/LoadedTemplate.scala b/scala3doc/src/dotty/dokka/site/LoadedTemplate.scala
@@ -17,17 +17,19 @@ case class LazyEntry(getKey: String, value: () => String) extends JMapEntry[Stri
   lazy val getValue: Object = value()
   def setValue(x$0: Object): Object = ???
 
-case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File):
+case class LoadedTemplate(
+  templateFile: TemplateFile,
+  children: List[LoadedTemplate],
+  file: File):
 
   private def brief(ctx: StaticSiteContext): String =
     try
       val code = Jsoup.parse(resolveToHtml(ctx).code)
       Option(code.select("p").first()).fold("...")(_.outerHtml())
     catch
       case e: Throwable =>
-        // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
-        println(s"[ERROR] Unable to process brief for ${templateFile.file}")
-        e.printStackTrace()
+        val msg = s"[ERROR] Unable to process brief for ${templateFile.file}"
+        report.error(msg, templateFile.file, e)(using ctx.outerCtx)
         "..."
 
   def lazyTemplateProperties(ctx: StaticSiteContext): JMap[String, Object] = new java.util.AbstractMap[String, Object]():
diff --git a/scala3doc/src/dotty/dokka/site/SitePagesCreator.scala b/scala3doc/src/dotty/dokka/site/SitePagesCreator.scala
@@ -39,8 +39,10 @@ class SitePagesCreator(using ctx: DocContext) extends BaseStaticSiteProcessor:
     val apiRoot = mkRootPage(input, contentPage)
     val (indexes, children) = ctx.allPages.partition(f =>
       f.template.isIndexPage() && f.template.file.toPath.getParent() == ctx.docsPath )
-    // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
-    if (indexes.size > 1) println(s"ERROR: Multiple index pages found ${indexes.map(_.template.file)}")
+
+    if (indexes.size > 1)
+      val msg = s"ERROR: Multiple index pages for doc found ${indexes.map(_.template.file)}"
+      report.error(msg)
 
     def emptyContent = ctx.asContent(Text(), mkDRI(extra = "root_content")).get(0)
 
diff --git a/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala b/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala
@@ -20,14 +20,20 @@ import util.Try
 
 import scala.collection.JavaConverters._
 
-class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper], val args: Scala3doc.Args, val sourceLinks: SourceLinks):
+class StaticSiteContext(
+  val root: File,
+  sourceSets: Set[SourceSetWrapper],
+  val args: Scala3doc.Args, val sourceLinks: SourceLinks)(using val outerCtx: CompilerContext):
 
   var memberLinkResolver: String => Option[DRI] = _ => None
 
-  def indexPage():Option[StaticPageNode] =
+  def indexPage(): Option[StaticPageNode] =
     val files = List(new File(root, "index.html"), new File(root, "index.md")).filter { _.exists() }
-    // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
-    if (files.size > 1) println(s"ERROR: Multiple root index pages found: ${files.map(_.getAbsolutePath)}")
+
+    if files.size > 1 then
+      val msg = s"ERROR: Multiple root index pages found: ${files.map(_.getAbsolutePath)}"
+      report.error(msg)
+
     files.flatMap(loadTemplate(_, isBlog = false)).headOption.map(templateToPage)
 
   lazy val layouts: Map[String, TemplateFile] =
@@ -102,8 +108,9 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper], val a
 
         val processedTemplate = // Set provided name as arg in page for `docs`
           if from.getParentFile.toPath == docsPath && templateFile.isIndexPage() then
-            // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
-            if templateFile.title != "index" then println(s"[WARN] title in $from will be overriden")
+            if templateFile.title != "index" then
+              report.warn("Property `title` will be overriden by project name", from)
+
             templateFile.copy(title = args.name)
           else templateFile
 
diff --git a/scala3doc/src/dotty/dokka/site/StaticSiteLocationProvider.scala b/scala3doc/src/dotty/dokka/site/StaticSiteLocationProvider.scala
@@ -42,7 +42,8 @@ class StaticSiteLocationProvider(pageNode: RootPageNode)(using ctx: DokkaContext
                 case regex(year, month, day, name) =>
                   rawFilePath.getParent.resolveSibling(Paths.get(year, month, day, name))
                 case _ =>
-                  println(s"Blog file at path: $rawFilePath doesn't match desired format.")
+                  val msg = s"Relative path for blog: $rawFilePath doesn't match `yyy-mm-dd-name.md` format."
+                  report.warn(msg, page.template.file)
                   rawFilePath.resolveSibling(pageName.substring(0, dotIndex))
               }
               blogPostPath.iterator.asScala.map(_.toString).toList.asJava
diff --git a/scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala b/scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala
@@ -35,8 +35,9 @@ trait ScaladocSupport { self: TastyParser =>
       preparsed.syntax.headOption match {
         case Some(commentSetting) =>
           CommentSyntax.parse(commentSetting).getOrElse {
-            println(s"WARN: not a valid comment syntax: $commentSetting")
-            println(s"WARN: Defaulting to Markdown syntax.")
+            val msg = s"not a valid comment syntax: $commentSetting, defaulting to Markdown syntax."
+            // we should update pos with span from documentation
+            report.warning(msg, tree.pos)
             CommentSyntax.default
           }
         case None => ctx.args.defaultSyntax
diff --git a/scala3doc/src/dotty/dokka/tasty/TastyParser.scala b/scala3doc/src/dotty/dokka/tasty/TastyParser.scala
@@ -105,15 +105,21 @@ case class TastyParser(qctx: Quotes, inspector: DokkaTastyInspector)(using val c
     extends ScaladocSupport with BasicSupport with TypesSupport with ClassLikeSupport with SyntheticsSupport with PackageSupport with NameNormalizer:
   import qctx.reflect._
 
-  def processTree[T](tree: Tree)(op: => T): Option[T] = try Option(op) catch case e: Throwable => errorMsg(tree, tree.symbol.show, e)
-  def processTreeOpt[T](tree: Tree)(op: => Option[T]): Option[T] = try op catch case e: Throwable => errorMsg(tree, tree.symbol.show, e)
-  def processSymbol[T](sym: Symbol)(op: => T): Option[T] = try Option(op) catch case e: Throwable => errorMsg(sym, sym.show, e)
-
-  private def errorMsg[T](a: Any, m: => String, e: Throwable): Option[T] =
-    val msg = try m catch case e: Throwable => a.toString
-    println(s"ERROR: tree is faling: $msg")
-    e.printStackTrace()
-    throw e
+  def processTree[T](tree: Tree)(op: => T): Option[T] = try Option(op) catch
+    case e: Exception  =>
+      report.error(throwableToString(e), tree.pos)
+      None
+  def processTreeOpt[T](tree: Tree)(op: => Option[T]): Option[T] = try op catch
+    case e: Exception =>
+      report.error(throwableToString(e), tree.pos)
+      None
+
+  def processSymbol[T](sym: Symbol)(op: => T): Option[T] = try Option(op) catch
+    case t: Throwable =>
+      try report.error(throwableToString(t), sym.tree.pos) catch
+        case _: Throwable =>
+          report.error(s"Failed to process ${sym.show}:\n${throwableToString(t)}")
+      None
 
   def parseRootTree(root: Tree): Seq[Documentable] =
     val docs = Seq.newBuilder[Documentable]
diff --git a/scala3doc/test/dotty/dokka/RaportingTest.scala b/scala3doc/test/dotty/dokka/RaportingTest.scala
diff --git a/scala3doc/test/dotty/dokka/ScaladocTest.scala b/scala3doc/test/dotty/dokka/ScaladocTest.scala
diff --git a/scala3doc/test/dotty/dokka/SourceLinksTests.scala b/scala3doc/test/dotty/dokka/SourceLinksTests.scala
diff --git a/scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala b/scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala
diff --git a/scala3doc/test/dotty/dokka/testUtils.scala b/scala3doc/test/dotty/dokka/testUtils.scala
