Merge pull request #7664 from dotty-staging/tastydoc

Tastydoc

Author: abgruszecki

.gitignore

@@ -83,3 +83,37 @@ community-build/sbt-dotty-sbt
 
 # Vulpix output files
 *.check.out
+
+tastydoc/report/report\.aux
+
+tastydoc/report/report\.fdb_latexmk
+
+tastydoc/report/report\.fls
+
+tastydoc/report/report\.synctex\.gz
+
+tastydoc/report/report\.toc
+
+tastydoc/report/report\.out
+
+tastydoc/report/presentation/presentation\.aux
+
+tastydoc/report/presentation/presentation\.fdb_latexmk
+
+tastydoc/report/presentation/presentation\.fls
+
+tastydoc/report/presentation/presentation\.nav
+
+tastydoc/report/presentation/presentation\.out
+
+tastydoc/report/presentation/presentation\.snm
+
+tastydoc/report/presentation/presentation\.synctex\.gz
+
+tastydoc/report/presentation/presentation\.toc
+
+tastydoc/dotty-0\.15\.0-RC1/
+
+tastydoc/report/presentation/presentation\.vrb
+
+tastydoc/dotty-0\.16\.0-RC3/

build.sbt

@@ -17,6 +17,8 @@ val `dotty-bench-bootstrapped` = Build.`dotty-bench-bootstrapped`
 val `tasty-core` = Build.`tasty-core`
 val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
+val `dotty-tastydoc` = Build.`dotty-tastydoc`
+val `dotty-tastydoc-input` = Build.`dotty-tastydoc-input`
 val `scala-library` = Build.`scala-library`
 val `scala-compiler` = Build.`scala-compiler`
 val `scala-reflect` = Build.`scala-reflect`

doc-tool/src/dotty/tools/dottydoc/model/comment/Comment.scala

@@ -6,7 +6,7 @@ package comment
 import dotty.tools.dottydoc.util.syntax._
 import dotty.tools.dotc.core.Contexts.Context
 import dotty.tools.dotc.util.Spans._
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode }
 import HtmlParsers._
 import util.MemberLookup
 

doc-tool/src/dotty/tools/dottydoc/model/comment/CommentParser.scala

@@ -11,7 +11,7 @@ import dotty.tools.dotc.printing.Formatting.hl
 import scala.collection.mutable
 import dotty.tools.dotc.config.Printers.dottydoc
 import scala.util.matching.Regex
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode }
 import com.vladsch.flexmark.parser.{ Parser => MarkdownParser }
 
 trait CommentParser extends util.MemberLookup {

doc-tool/src/dotty/tools/dottydoc/model/comment/HtmlParsers.scala

@@ -8,7 +8,7 @@ import dotc.util.Spans._
 import dotty.tools.dottydoc.util.syntax._
 import util.MemberLookup
 
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode}
 import com.vladsch.flexmark.html.HtmlRenderer
 import com.vladsch.flexmark.parser.Parser
 import com.vladsch.flexmark.util.sequence.CharSubSequence
@@ -17,7 +17,9 @@ object HtmlParsers {
 
   implicit class StringToMarkdown(val text: String) extends AnyVal {
     def toMarkdown(origin: Entity)(implicit ctx: Context): MarkdownNode = {
-      import com.vladsch.flexmark.ast.{ Link, Visitor, VisitHandler, NodeVisitor }
+      import com.vladsch.flexmark.ast.Link
+      import com.vladsch.flexmark.util.ast.{Visitor, VisitHandler, NodeVisitor }
+
 
       val inlineToHtml = InlineToHtml(origin)
 
@@ -149,4 +151,4 @@ object HtmlParsers {
       }
     }
   }
-}
+}

doc-tool/src/dotty/tools/dottydoc/model/comment/MarkdownShortener.scala

@@ -10,6 +10,7 @@ package comment
   * @note calling `shorten` **will** mutate the Markdown AST node.
   */
 class MarkdownShortener {
+  import com.vladsch.flexmark.util.ast._
   import com.vladsch.flexmark.ast._
 
   def shorten(node: Node, maxLen: Int = 150): Node = {
@@ -80,4 +81,4 @@ class MarkdownShortener {
     nodeVisitor.visit(node)
     node
   }
-}
+}

doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownCodeBlockVisitor.scala

@@ -2,6 +2,7 @@ package dotty.tools
 package dottydoc
 package staticsite
 
+import com.vladsch.flexmark.util.ast._
 import com.vladsch.flexmark.ast._
 import com.vladsch.flexmark.util.sequence.CharSubSequence
 
@@ -16,4 +17,4 @@ object MarkdownCodeBlockVisitor {
       })
     )
     .visit(node)
-}
+}

doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala

@@ -3,6 +3,7 @@ package dottydoc
 package staticsite
 
 import com.vladsch.flexmark.ast._
+import com.vladsch.flexmark.util.ast._
 import com.vladsch.flexmark.util.sequence.{BasedSequence, CharSubSequence}
 import model.{Def, Package, TypeAlias, Val}
 import dottydoc.util.MemberLookup
@@ -42,4 +43,4 @@ object MarkdownLinkVisitor {
       })
     )
     .visit(node)
-}
+}

project/Build.scala

@@ -374,6 +374,28 @@ object Build {
     dottyLib + File.pathSeparator + findArtifactPath(externalDeps, "scala-library")
   }
 
+  lazy val tastydocSettings = Seq(
+    baseDirectory in (Compile, run) := baseDirectory.value / "..",
+    baseDirectory in Test := baseDirectory.value / "..",
+    libraryDependencies +=
+      "com.novocode" % "junit-interface" % "0.11",
+    libraryDependencies ++= {
+      val flexmarkVersion = "0.42.12"
+      Seq(
+        "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-anchorlink" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-emoji" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-strikethrough" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-yaml-front-matter" % flexmarkVersion,
+        Dependencies.`jackson-dataformat-yaml`,
+        "nl.big-o" % "liqp" % "0.6.7"
+      )
+    }
+  )
+
   def dottyDocSettings(implicit mode: Mode) = Seq(
     baseDirectory in (Compile, run) := baseDirectory.value / "..",
     baseDirectory in Test := baseDirectory.value / "..",
@@ -414,9 +436,9 @@ object Build {
     }.evaluated,
 
     libraryDependencies ++= {
-      val flexmarkVersion = "0.28.32"
+      val flexmarkVersion = "0.42.12"
       Seq(
-        "com.vladsch.flexmark" % "flexmark" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
@@ -1021,6 +1043,9 @@ object Build {
   lazy val `dotty-bench` = project.in(file("bench")).asDottyBench(NonBootstrapped)
   lazy val `dotty-bench-bootstrapped` = project.in(file("bench")).asDottyBench(Bootstrapped)
 
+  lazy val `dotty-tastydoc` = project.in(file("tastydoc")).asDottyTastydoc(Bootstrapped)
+  lazy val `dotty-tastydoc-input` = project.in(file("tastydoc/input")).asDottyTastydocInput(Bootstrapped)
+
   // Depend on dotty-library so that sbt projects using dotty automatically
   // depend on the dotty-library
   lazy val `scala-library` = project.
@@ -1329,6 +1354,14 @@ object Build {
       settings(commonBenchmarkSettings).
       enablePlugins(JmhPlugin)
 
+    def asDottyTastydoc(implicit mode: Mode): Project = project.withCommonSettings.
+      aggregate(`dotty-tastydoc-input`).
+      dependsOn(dottyCompiler).
+      settings(tastydocSettings)
+
+    def asDottyTastydocInput(implicit mode: Mode): Project = project.withCommonSettings.
+      dependsOn(dottyCompiler)
+
     def asDist(implicit mode: Mode): Project = project.
       enablePlugins(PackPlugin).
       withCommonSettings.

semanticdb/project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.2.6