Add version to docs toolbar

Author: felixmulder

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

@@ -123,5 +123,12 @@ class ScalaSettings extends Settings.SettingGroup {
     sys.props("user.dir").split(File.separatorChar).last
   )
 
+  val projectVersion = StringSetting (
+    "-project-version",
+    "project version",
+    "The current version of your project",
+    ""
+  )
+
   val wikiSyntax = BooleanSetting("-Xwiki-syntax", "Retains the Scala2 behavior of using Wiki Syntax in Scaladoc")
 }

doc-tool/resources/_includes/toolbar.html

@@ -4,6 +4,6 @@
     </a>
     <div id="project-details">
         <h1 id="project-name">{{ site.project }} Documentation</h1>
-        <h2 id="project-version">0.1-SNAPSHOT</h2>
+        <h2 id="project-version">{{ site.version }}</h2>
     </div>
 </div>

doc-tool/src/dotty/tools/dottydoc/DocDriver.scala

@@ -45,11 +45,12 @@ class DocDriver extends Driver {
     val reporter = doCompile(newCompiler(ctx), filesToDocument)(ctx)
     val siteRoot = new java.io.File(ctx.settings.siteRoot.value)
     val projectName = ctx.settings.projectName.value
+    val projectVersion = ctx.settings.projectVersion.value
 
     if (!siteRoot.exists || !siteRoot.isDirectory)
       ctx.error(s"Site root does not exist: $siteRoot")
     else {
-      Site(siteRoot, projectName, ctx.docbase.packages)
+      Site(siteRoot, projectName, projectVersion, ctx.docbase.packages)
         .generateApiDocs()
         .copyStaticFiles()
         .generateHtmlFiles()

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

@@ -32,7 +32,8 @@ case class DefaultParams(
       "site" -> Map(
         "baseurl" -> site.baseurl,
         "posts" -> site.posts.map(_.toMap),
-        "project" -> site.projectTitle
+        "project" -> site.projectTitle,
+        "version" -> site.projectVersion
       ).asJava,
 
       "sidebar" -> sidebar.titles.asJava
@@ -47,7 +48,7 @@ case class DefaultParams(
   }
 
   def withPosts(posts: Array[BlogPost]): DefaultParams =
-    copy(site = SiteInfo(site.baseurl, site.projectTitle, posts))
+    copy(site = SiteInfo(site.baseurl, site.projectTitle, site.projectVersion, posts))
 
   def withUrl(url: String): DefaultParams =
     copy(page = PageInfo(url))
@@ -61,7 +62,12 @@ case class PageInfo(url: String, date: String = "") {
   val path: Array[String] = url.split('/').reverse.drop(1)
 }
 
-case class SiteInfo(baseurl: String, projectTitle: String, posts: Array[BlogPost])
+case class SiteInfo(
+  baseurl: String,
+  projectTitle: String,
+  projectVersion: String,
+  posts: Array[BlogPost]
+)
 
 case class Sidebar(titles: List[Title])
 

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

@@ -28,7 +28,7 @@ import io.{ AbstractFile, VirtualFile, File }
 import scala.collection.mutable.ArrayBuffer
 import util.syntax._
 
-case class Site(val root: JFile, val projectTitle: String, val documentation: Map[String, Package]) extends ResourceFinder {
+case class Site(val root: JFile, val projectTitle: String, val projectVersion: String, val documentation: Map[String, Package]) extends ResourceFinder {
   /** Documentation serialized to java maps */
   private val docs: JList[_] = {
     import model.JavaConverters._
@@ -157,7 +157,7 @@ case class Site(val root: JFile, val projectTitle: String, val documentation: Ma
       "../" * (assetLen - rootLen - 1 + additionalDepth) + "."
     }
 
-    DefaultParams(docs, documentation, PageInfo(pathFromRoot), SiteInfo(baseUrl, projectTitle, Array()), sidebar)
+    DefaultParams(docs, documentation, PageInfo(pathFromRoot), SiteInfo(baseUrl, projectTitle, projectVersion, Array()), sidebar)
   }
 
   /* Creates output directories if allowed */

project/Build.scala

@@ -282,6 +282,7 @@ object Build {
       val args: Seq[String] = Seq(
         "-siteroot", "docs",
         "-project", "Dotty",
+        "-project-version", dottyVersion,
         "-classpath", s"$dottyLib:$dottyInterfaces:$otherDeps"
       )
         (runMain in Compile).toTask(