Merge pull request #7 from pikinier20/static-site-snippets

Run snippet compiler on static sites

Author: pikinier20

docs/css/dottydoc.css

@@ -180,18 +180,6 @@ h5:hover a.anchor:hover {
   font-family: var(--font-family-monospace);
 }
 
-/* code */
-pre, code {
-  font-variant-ligatures: none;
-}
-pre {
-  padding: 0;
-  font-size: 13px;
-  background: var(--pre-bg);
-  border-radius: 2px;
-  border: 1px solid rgba(0, 0, 0, 0.1);
-}
-
 /* admonitions */
 blockquote {
   padding: 0 1em;

project/Build.scala

@@ -1651,8 +1651,8 @@ object Build {
                 s"docs=github://lampepfl/dotty/master#docs",
               "-doc-root-content", docRootFile.toString,
               "-snippet-compiler:" +
-                s"$dottyLibRoot/scala/quoted=nocompile," +
-                s"$dottyLibRoot=compile",
+                s"$dottyLibRoot=compile," +
+                "docs=compile",
               "-Ydocument-synthetic-types"
             )
           ))
@@ -1665,6 +1665,7 @@ object Build {
             "scaladoc/output/testcases",
             "master",
             Seq(
+              "-siteroot", "scaladoc-testcases/docs",
               "-snippet-compiler-debug"
             )
           )

scaladoc-testcases/docs/docs/index.md

@@ -0,0 +1,13 @@
+---
+
+
+---
+
+```scala sc:compile
+2 + List(0)
+```
+
+```scala sc:compile
+new snippetCompiler.Snippet0 { }
+```
+

scaladoc-testcases/src/tests/snippetCompilerTest.scala

@@ -27,13 +27,13 @@ package snippetCompiler
   * val d: Long = "asd"
   * ```
   *
-  * ```scala sc:failing
+  * ```scala sc:fail
   * def a = 2
   * val x = 1 + List()
   * a
   * ```
   *
-  * ```scala sc:failing
+  * ```scala sc:fail
   * def a = 2
   * ```
   *
@@ -42,12 +42,83 @@ package snippetCompiler
   * a()
   * ```
   */
-class A { }
+class A {
+  trait B
+  val a = new B {
+    /**
+      * ```scala sc:compile
+      * 2 + List()
+      * ```
+      *
+      */
+    def a = 3
+  }
+}
 
 /**
- *
  * ```scala sc:compile
  * val c: Int = 4.5
  * ```
  */
-class B { }
+class B { }
+
+trait Quotes {
+  val reflect: reflectModule = ???
+  trait reflectModule { self: reflect.type =>
+    /**
+      * ```scala sc:compile
+      * 2 + List()
+      * ```
+      *
+      */
+    def a = 3
+  }
+}
+
+trait Quotes2[A] {
+  val r1: r1Module[_] = ???
+  trait r1Module[A] {
+     type X
+     object Y {
+      /**
+        * ```scala sc:compile
+        * 2 + List()
+        * ```
+        *
+        */
+       type YY
+     }
+     val z: zModule = ???
+     trait zModule {
+      /**
+        * ```scala sc:compile
+        * 2 + List()
+        * ```
+        *
+        */
+       type ZZ
+     }
+  }
+  object r2 {
+    type X
+    object Y {
+      /**
+        * ```scala sc:compile
+        * 2 + List()
+        * ```
+        *
+        */
+      type YY
+    }
+    val z: zModule = ???
+    trait zModule {
+      /**
+        * ```scala sc:compile
+        * 2 + List()
+        * ```
+        *
+        */
+      type ZZ
+    }
+  }
+}

scaladoc/resources/dotty_res/styles/scalastyle.css

@@ -93,6 +93,7 @@ code {
   padding: 0 .3em;
 }
 pre {
+  overflow: visible;
   scrollbar-width: thin;
   margin: 0px;
 }

scaladoc/src/dotty/tools/scaladoc/DocContext.scala

@@ -73,10 +73,15 @@ case class DocContext(args: Scaladoc.Args, compilerContext: CompilerContext):
 
   lazy val snippetCompilerArgs = snippets.SnippetCompilerArgs.load(args.snippetCompiler, args.snippetCompilerDebug)(using compilerContext)
 
+  lazy val snippetChecker = snippets.SnippetChecker(args.classpath, args.tastyDirs)
+
   lazy val staticSiteContext = args.docsRoot.map(path => StaticSiteContext(
       File(path).getAbsoluteFile(),
       args,
-      sourceLinks
+      sourceLinks,
+      snippetCompilerArgs,
+      snippetChecker
     )(using compilerContext))
 
+
   val externalDocumentationLinks = args.externalMappings

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -236,11 +236,11 @@ case class TastyMemberSource(path: java.nio.file.Path, lineNumber: Int)
 
 object SnippetCompilerData:
   case class Position(line: Int, column: Int)
+  case class ClassInfo(tpe: Option[String], names: Seq[String], generics: Option[String])
 
 case class SnippetCompilerData(
   packageName: String,
-  classType: Option[String],
-  classGenerics: Option[String],
+  classInfos: Seq[SnippetCompilerData.ClassInfo],
   imports: List[String],
   position: SnippetCompilerData.Position
 )

scaladoc/src/dotty/tools/scaladoc/site/LoadedTemplate.scala

@@ -51,4 +51,4 @@ case class LoadedTemplate(
       ("site" -> (getMap("site") + ("posts" -> posts))) + ("urls" -> sourceLinks.toMap) +
       ("page" -> (getMap("page") + ("title" -> templateFile.title)))
 
-    templateFile.resolveInner(RenderingContext(updatedSettings, ctx.layouts))
+    templateFile.resolveInner(RenderingContext(updatedSettings, ctx.layouts))(using ctx)

scaladoc/src/dotty/tools/scaladoc/site/StaticSiteContext.scala

@@ -13,7 +13,9 @@ import collection.JavaConverters._
 class StaticSiteContext(
   val root: File,
   val args: Scaladoc.Args,
-  val sourceLinks: SourceLinks)(using val outerCtx: CompilerContext):
+  val sourceLinks: SourceLinks,
+  val snippetCompilerArgs: snippets.SnippetCompilerArgs,
+  val snippetChecker: snippets.SnippetChecker)(using val outerCtx: CompilerContext):
 
   var memberLinkResolver: String => Option[DRI] = _ => None
 

scaladoc/src/dotty/tools/scaladoc/site/common.scala

@@ -36,7 +36,8 @@ val defaultMarkdownOptions: DataHolder =
       EmojiExtension.create(),
       YamlFrontMatterExtension.create(),
       StrikethroughExtension.create(),
-      WikiLinkExtension.create()
+      WikiLinkExtension.create(),
+      tasty.comments.markdown.SnippetRenderingExtension
     ))
 
 def emptyTemplate(file: File, title: String): TemplateFile = TemplateFile(
@@ -48,7 +49,8 @@ def emptyTemplate(file: File, title: String): TemplateFile = TemplateFile(
   title = title,
   hasFrame = true,
   resources = List.empty,
-  layout = None
+  layout = None,
+  configOffset = 0
 )
 
 final val ConfigSeparator = "---"
@@ -106,6 +108,7 @@ def loadTemplateFile(file: File): TemplateFile = {
     title = stringSetting(allSettings, "title").getOrElse(name),
     hasFrame = !stringSetting(allSettings, "hasFrame").contains("false"),
     resources = (listSetting(allSettings, "extraCSS") ++ listSetting(allSettings, "extraJS")).flatten.toList,
-    layout = stringSetting(allSettings, "layout")
+    layout = stringSetting(allSettings, "layout"),
+    configOffset = config.size
   )
 }

scaladoc/src/dotty/tools/scaladoc/site/templates.scala

@@ -2,7 +2,7 @@ package dotty.tools.scaladoc
 package site
 
 import java.io.File
-import java.nio.file.Files
+import java.nio.file.{Files, Paths}
 
 import com.vladsch.flexmark.ext.anchorlink.AnchorLinkExtension
 import com.vladsch.flexmark.ext.autolink.AutolinkExtension
@@ -18,6 +18,7 @@ import liqp.Template
 import scala.collection.JavaConverters._
 
 import scala.io.Source
+import dotty.tools.scaladoc.snippets._
 
 case class RenderingContext(
   properties: Map[String, Object],
@@ -52,10 +53,32 @@ case class TemplateFile(
   hasFrame: Boolean,
   resources: List[String],
   layout: Option[String],
+  configOffset: Int
 ):
   def isIndexPage() = file.isFile && (file.getName == "index.md" || file.getName == "index.html")
 
-  private[site] def resolveInner(ctx: RenderingContext): ResolvedPage =
+  private[site] def resolveInner(ctx: RenderingContext)(using ssctx: StaticSiteContext): ResolvedPage =
+
+    lazy val snippetCheckingFunc: SnippetChecker.SnippetCheckingFunc =
+      val path = Some(Paths.get(file.getAbsolutePath))
+      val pathBasedArg = ssctx.snippetCompilerArgs.get(path)
+      (str: String, lineOffset: SnippetChecker.LineOffset, argOverride: Option[SCFlags]) => {
+          val arg = argOverride.fold(pathBasedArg)(pathBasedArg.overrideFlag(_))
+          val compilerData = SnippetCompilerData(
+            "staticsitesnippet",
+            Seq(SnippetCompilerData.ClassInfo(None, Nil, None)),
+            Nil,
+            SnippetCompilerData.Position(configOffset - 1, 0)
+          )
+          ssctx.snippetChecker.checkSnippet(str, Some(compilerData), arg, lineOffset).collect {
+              case r: SnippetCompilationResult if !r.isSuccessful =>
+                val msg = s"In static site (${file.getAbsolutePath}):\n${r.getSummary}"
+                report.error(msg)(using ssctx.outerCtx)
+                r
+              case r => r
+          }
+      }
+
     if (ctx.resolving.contains(file.getAbsolutePath))
       throw new RuntimeException(s"Cycle in templates involving $file: ${ctx.resolving}")
 
@@ -74,10 +97,13 @@ case class TemplateFile(
     val rendered = Template.parse(this.rawCode).render(mutableProperties)
     // We want to render markdown only if next template is html
     val code = if (isHtml || layoutTemplate.exists(!_.isHtml)) rendered else
+      // Snippet compiler currently supports markdown only
       val parser: Parser = Parser.builder(defaultMarkdownOptions).build()
-      HtmlRenderer.builder(defaultMarkdownOptions).build().render(parser.parse(rendered))
+      val parsedMd = parser.parse(rendered)
+      val processed = FlexmarkSnippetProcessor.processSnippets(parsedMd, ssctx.snippetCompilerArgs.debug, snippetCheckingFunc)(using ssctx.outerCtx)
+      HtmlRenderer.builder(defaultMarkdownOptions).build().render(processed)
 
     layoutTemplate match
       case None => ResolvedPage(code, resources ++ ctx.resources)
       case Some(layoutTemplate) =>
-        layoutTemplate.resolveInner(ctx.nest(code, file, resources))
+        layoutTemplate.resolveInner(ctx.nest(code, file, resources))

scaladoc/src/dotty/tools/scaladoc/snippets/FlexmarkSnippetProcessor.scala

@@ -0,0 +1,57 @@
+package dotty.tools.scaladoc
+package snippets
+
+import com.vladsch.flexmark.util.{ast => mdu, sequence}
+import com.vladsch.flexmark.{ast => mda}
+import com.vladsch.flexmark.formatter.Formatter
+import com.vladsch.flexmark.util.options.MutableDataSet
+import collection.JavaConverters._
+
+import dotty.tools.scaladoc.tasty.comments.markdown.ExtendedFencedCodeBlock
+
+object FlexmarkSnippetProcessor:
+  def processSnippets(root: mdu.Node, debug: Boolean, checkingFunc: => SnippetChecker.SnippetCheckingFunc)(using CompilerContext): mdu.Node = {
+    lazy val cf: SnippetChecker.SnippetCheckingFunc = checkingFunc
+
+    val nodes = root.getDescendants().asScala.collect {
+      case fcb: mda.FencedCodeBlock => fcb
+    }.toList
+
+    nodes.foreach { node =>
+      val snippet = node.getContentChars.toString
+      val lineOffset = node.getStartLineNumber
+      val info = node.getInfo.toString.split(" ")
+      if info.contains("scala") then {
+        val argOverride =
+          info
+            .find(_.startsWith("sc:"))
+            .map(_.stripPrefix("sc:"))
+            .map(SCFlagsParser.parse)
+            .flatMap(_ match {
+              case Right(flags) => Some(flags)
+              case Left(error) =>
+                report.warning(
+                  s"""|Error occured during parsing flags in snippet:
+                      |$error""".stripMargin
+                )
+                None
+            })
+        val snippetCompilationResult = cf(snippet, lineOffset, argOverride) match {
+          case result@Some(SnippetCompilationResult(wrapped, _, _, _)) if debug =>
+            val s = sequence.BasedSequence.EmptyBasedSequence()
+              .append(wrapped)
+              .append(sequence.BasedSequence.EOL)
+            val content = mdu.BlockContent()
+            content.add(s, 0)
+            node.setContent(content)
+            result
+          case result => result
+        }
+
+        node.insertBefore(new ExtendedFencedCodeBlock(node, snippetCompilationResult))
+        node.unlink()
+      }
+    }
+
+    root
+  }