feature: automate the creation of proposals/README.md

.gitignore

@@ -0,0 +1,3 @@
+.scala/
+.bsp/
+.metals/

README.md

@@ -30,13 +30,36 @@ Proposals should follow the format and sections laid out in the [template
 proposal](https://github.com/scalacenter/advisoryboard/tree/main/templates/proposal.md),
 and should be concise enough to fit on a single side of paper if printed out.
 
-## Recommendations
+### Recommendations
 
 Once a proposal has been adopted by the Advisory Board, it will become a
 recommendation, and should be copied, noting any amendments, into the
 [recommendations](https://github.com/scalacenter/advisoryboard/tree/main/recommendations)
 directory.
 
+### Proposals status
+
+To see the up-to-date status of a proposal see the
+[proposals/README](./proposals/README.md) which holds a summary of updates and
+statuses of all proposals.
+
+_NOTE_: This proposals/README.md file is auto-generated, so if you need to add
+an update or change the status of a proposal make sure to do so in the heading
+of the proposal file. The possible headings are:
+
+```yaml
+date: date proposed
+accepted: true, yes, false, no
+updates:
+  - postponed until next meeting
+  - accepted after discussion
+  - Updates found at https://www.scala-lang.org/blog/
+status: completed, postponed, active, etc
+```
+
+To regenerate the proposals/README.md file run `scala-cli run bin/` from the
+root of this project.
+
 ## Invitations
 
 For reference, invitations sent to each Advisory Board representative are

bin/.scalafmt.conf

@@ -0,0 +1,8 @@
+version = "3.3.1"
+runner.dialect = scala3
+
+rewrite.scala3.convertToNewSyntax = yes
+rewrite.scala3.removeOptionalBraces = yes
+rewrite.scala3.insertEndMarkerMinLines = 15
+
+docstrings.wrap = no

bin/generate-proposal-listing.scala

@@ -0,0 +1,165 @@
+// using scala 3.1.0
+// using lib com.vladsch.flexmark:flexmark-all:0.62.2
+
+import java.io.PrintWriter
+import java.io.File
+import java.nio.file.Paths
+import java.util.Collection
+
+import com.vladsch.flexmark.ext.yaml.front.matter.AbstractYamlFrontMatterVisitor
+import com.vladsch.flexmark.ext.yaml.front.matter.YamlFrontMatterExtension
+import com.vladsch.flexmark.parser.{Parser as FlexParser}
+import com.vladsch.flexmark.util.ast.Document
+import com.vladsch.flexmark.util.data.MutableDataSet
+import com.vladsch.flexmark.util.misc.Extension
+
+import scala.jdk.CollectionConverters.*
+import scala.io.Source
+
+/** This is a https://scala-cli.virtuslab.org/ script to iterate through all
+  *  the proposals, grab their front matter and then generate the
+  *  proposals/README.md file.
+  */
+@main def generate() =
+  val wd = Paths.get(".")
+
+  val proposalDir = Paths.get(".", "proposals").toFile
+
+  assert(
+    proposalDir.isDirectory,
+    """|Looks like you're not in the root of this project.
+       |Run scala-cli from the root.
+       |
+       |scala-cli run bin/""".stripMargin
+  )
+
+  for
+    file <- proposalDir.listFiles.sorted
+    if file.isFile &&
+      file.getName.endsWith(".md") &&
+      file.getName.startsWith("0")
+  do
+    val contents = Source
+      .fromFile(file)
+      .getLines
+      .mkString(Printer.newline)
+    val document = Parser.parser.parse(contents)
+    val (date, accepted, updates, status) =
+      Parser.retrieveMetaData(document, file)
+    Printer.printName(file)
+    Printer.printDate(file, date)
+    Printer.printAccepted(file, accepted)
+    Printer.printUpdates(file, updates)
+    Printer.printStatus(file, status)
+  end for
+
+  Printer.printWarning()
+  Printer.close()
+
+end generate
+
+object Printer:
+  private val pw = new PrintWriter(new File("proposals", "README.md"))
+
+  def close() = pw.close()
+
+  // Just for sanity, let's force unix and not use System.lineSeparator or
+  // anything like that.
+  val newline = "\n"
+  val tab = "\t"
+
+  def printName(file: File) =
+    pw.write(s"# [${file.getName}](./${file.getName})$newline")
+
+  def printDate(file: File, date: Option[String]) =
+    date match
+      case Some(d) => pw.write(s"* Date proposed: $d$newline")
+      case _       => println(s"""Missing "date" for ${file.getName}""")
+
+  def printAccepted(file: File, accepted: Option[String]) =
+    accepted match
+      case Some("true" | "yes") => pw.write(s"* Accepted: yes$newline")
+      case Some("false" | "no") => pw.write(s"* Accepted: no$newline")
+      case Some(_) =>
+        println("Invalid value for accepted. Use either true, yes, false, no")
+      case _ => println(s"""Missing "accepted" value for ${file.getName}""")
+
+  def printUpdates(file: File, updates: Option[List[String]]) =
+    updates match
+      case Some(u) =>
+        pw.write(s"* Updates:$newline")
+        u.foreach(update => pw.write(s"$tab* $update$newline"))
+      case None => println(s"No updates found for ${file.getName}")
+
+  def printStatus(file: File, status: Option[String]) =
+    status match
+      case Some(s) => pw.write(s"* Status: **$s**$newline")
+      case _       => println(s"""Missing "status" for ${file.getName}""")
+
+  def printWarning() =
+    pw.write(
+      s"${newline}_This file is auto-generated. Don't edit here, instead run scala-cli run bin/ to regenerate._"
+    )
+
+end Printer
+
+object Parser:
+  val rawExtensions: List[Extension] = List(
+    YamlFrontMatterExtension.create()
+  )
+
+  val extensions: Collection[Extension] = rawExtensions.asJava
+
+  val options =
+    new MutableDataSet()
+      .set(FlexParser.EXTENSIONS, extensions)
+
+  val parser = FlexParser.builder(options).build()
+
+  enum AcceptedKey(key: String):
+    case date extends AcceptedKey("date")
+    case accepted extends AcceptedKey("accepted")
+    case updates extends AcceptedKey("updates")
+    case status extends AcceptedKey("status")
+  end AcceptedKey
+
+  def retrieveMetaData(node: Document, file: File) =
+    val visitor = new AbstractYamlFrontMatterVisitor()
+    visitor.visit(node)
+    val data = visitor.getData.asScala
+
+    val metadata: Map[AcceptedKey, List[String]] = visitor
+      .getData()
+      .asScala
+      .toMap
+      .foldLeft(Map.empty) { case (mapping, (key, value)) =>
+        if value.asScala.toList.nonEmpty && AcceptedKey.values
+            .map(_.toString.toLowerCase)
+            .contains(key.toLowerCase)
+        then mapping + (AcceptedKey.valueOf(key) -> value.asScala.toList)
+        else if value.asScala.toList.nonEmpty then
+          println(
+            s"""|!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+                |"$key" in file: ${file.getName} is not an accepted front matter.
+                |!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+                |
+                |The accepted values are:
+                |  ${AcceptedKey.values.mkString(", ")}
+                |
+                |""".stripMargin
+          )
+          mapping
+        else mapping
+
+      }
+
+    // Keep in mind the YAML front matter only supports subset of YAML
+    // https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter
+    val date = metadata.get(AcceptedKey.date).flatMap(_.headOption)
+    val accepted = metadata.get(AcceptedKey.accepted).flatMap(_.headOption)
+    val updates = metadata.get(AcceptedKey.updates)
+    val status = metadata.get(AcceptedKey.status).flatMap(_.headOption)
+
+    (date, accepted, updates, status)
+  end retrieveMetaData
+end Parser

proposals/001-native-scala-for-spark.md

@@ -1,3 +1,13 @@
+---
+date: May 2016
+accepted: true
+updates:
+  - deferred for later consideration
+  - considered again and accepted August 2016
+  - dormant no recent activity as of August 2019
+status: dormant
+---
+
 # SCP-001: Native Execution of Scala/Spark via LLVM
 
 ## Proposer

proposals/002-dotty-migration-path.md

@@ -1,3 +1,11 @@
+---
+date: May 2016
+accepted: true
+updates:
+  - Remains active as of August 2019
+status: active
+---
+
 # SCP-002: Migration path to Dotty for Scalac users
 
 ## Proposer

proposals/003-scala-center-publicity-chair.md

@@ -1,3 +1,11 @@
+---
+date: May 2016
+accepted: true
+updates:
+  - Remains active as of August 2019
+status: active
+---
+
 # SCP-003: Scala Center Publicity Chair
 
 ## Proposer

proposals/004-sip-and-slip-coordination.md

@@ -1,3 +1,11 @@
+---
+date: May 2016
+accepted: true
+updates:
+  - SIP coordinator is Darja
+status: active
+---
+
 # SCP-004: Center to coordinate SIP/SLIP process
 
 ## Note

proposals/005-continuity-of-scala-js.md

@@ -1,3 +1,11 @@
+---
+date: May 2016
+accepted: true
+updates:
+  - Remains active as of August 2019
+status: active
+---
+
 # SCP-005: Ensurance of continuity of Scala.js project
 
 ## Note

proposals/006-compile-time-serializibility-check.md

@@ -1,3 +1,11 @@
+---
+date: August 2016
+accepted: true
+updates:
+  - Completed in 2016
+status: completed
+---
+
 # SCP-006: Compile Time Check of Serializability
 
 ## Proposer

proposals/007-collections.md

@@ -1,3 +1,11 @@
+---
+date: November 2016
+accepted: true
+updates:
+  - Completed in 2019 with the release of 2.13
+status: completed
+---
+
 # SCP-007: Collaborative redesign and implementation of Scala 2.13's collections library.
 
 ## Proposer

proposals/008-websites.md

@@ -1,3 +1,9 @@
+---
+date: November 2016
+accepted: true
+status: active
+---
+
 # SCP-008: Maintain scala-lang, docs.scala-lang, scala.epfl.ch websites
 
 ## Proposer

proposals/009-improve-direct-dependency-experience.md

@@ -1,3 +1,11 @@
+---
+date: November 2016
+accepted: true
+updates:
+  - Completed in 2017
+status: completed
+---
+
 # SCP-009: Improve user experience for builds that use only direct dependencies
 
 ## Proposer

proposals/010-compiler-profiling.md

@@ -1,3 +1,11 @@
+---
+date: May 2017
+accepted: true
+updates:
+  - Completed in 2018
+status: completed
+---
+
 # Providing Better Compilation Performance Information
 
 ## Proposer

proposals/011-debugging-symbols.md

@@ -1,3 +1,12 @@
+---
+date: May 2017
+accepted: false
+updates:
+  - Was postponed after discussion
+  - Superseded by a sequel proposal: SCP-022
+status: superseded
+---
+
 # Debugging Position Information
 
 ## Proposer

proposals/012-improve-sbt-learning-materials.md

@@ -1,3 +1,11 @@
+---
+date: May 2017
+accepted: false
+updates:
+  - Withdrawn after discussion
+status: withdrawn
+---
+
 # Improve Resources for Learning SBT
 
 ## Proposer

proposals/013-sbt-migration.md

@@ -1,3 +1,11 @@
+---
+date: September 2017
+accepted: true
+updates:
+  - Migration largely complete as of August 2019
+status: completed
+---
+
 # SCP-013: Aid the ecosystem in upgrading to sbt 1.0.x
 
 ## Proposer

proposals/014-production-ready-scalamacros.md

@@ -1,3 +1,11 @@
+---
+date: September 2017
+accepted: true
+updates:
+  - In the sense that designs were discussed, trials were made, and conclusions were reached: no substantial changes in Scala 2; design and implementation work on Scala 3 macros remains ongoing at LAMP
+status: completed
+---
+
 # SCP-014: Production ready scalamacros/scalamacros
 
 ## Proposer

proposals/015-zinc-performance.md

@@ -1,3 +1,11 @@
+---
+date: September 2017
+accepted: true
+updates:
+  - Completed in 2018
+status: completed
+---
+
 # SCP-015: Improving performance and profiling of Zinc
 
 ## Proposer