NIT Refactor sclicheck

Author: Gedochao

modules/docs-tests/src/main/scala/sclicheck/sclicheck.scala

@@ -5,6 +5,7 @@ import fansi.Color.{Blue, Green, Red}
 import java.io.File
 import java.security.SecureRandom
 
+import scala.annotation.tailrec
 import scala.io.StdIn.readLine
 import scala.util.Random
 import scala.util.matching.Regex
@@ -28,8 +29,8 @@ case class Options(
 
 enum Commands:
   def context: Context
-  def name = toString.takeWhile(_ != '(')
-  def log = this match {
+  def name: String = toString.takeWhile(_ != '(')
+  def log: Any = this match {
     case _: Clear => ""
     case Check(patterns, regex, _) =>
       val kind = if regex then "regexes" else "patterns"
@@ -51,13 +52,13 @@ enum Commands:
   case Clear(context: Context)
 
 case class Context(file: os.RelPath, line: Int):
-  def proceed(linesToSkip: Int = 1) = copy(line = line + linesToSkip)
-  override def toString             = s"$file:$line"
+  def proceed(linesToSkip: Int = 1): Context = copy(line = line + linesToSkip)
+  override def toString                      = s"$file:$line"
 
 case class FailedCheck(line: Int, file: os.RelPath, txt: String)
     extends RuntimeException(s"[$file:$line] $txt")
 
-def check(cond: Boolean, msg: => String)(using c: Context) =
+def check(cond: Boolean, msg: => String)(using c: Context): Unit =
   if !cond then throw FailedCheck(c.line, c.file, msg)
 
 @annotation.tailrec
@@ -197,10 +198,10 @@ def checkFile(file: os.Path, options: Options): Unit =
   var lastOutput: String = null
   val allSources         = Set.newBuilder[os.Path]
 
-  def runCommand(cmd: Commands, log: String => Unit) =
+  def runCommand(cmd: Commands, log: String => Unit): Unit =
     given Context = cmd.context
 
-    def writeFile(file: os.Path, code: Seq[String], c: Context) =
+    def writeFile(file: os.Path, code: Seq[String], c: Context): Unit =
       val (prefixLines, codeLines) =
         code match
           case shbang :: tail if shbang.startsWith("#!") =>
@@ -254,7 +255,7 @@ def checkFile(file: os.Path, options: Options): Unit =
         else
           check(exitCode == 0, s"Compilation failed.")
 
-      case Commands.Check(patterns, regex, line) =>
+      case Commands.Check(patterns, regex, _) =>
         check(lastOutput != null, "No output stored from previous commands")
         val lines = lastOutput.linesIterator.toList
 
@@ -282,7 +283,7 @@ def checkFile(file: os.Path, options: Options): Unit =
     commands.foreach { cmd =>
       val logs = List.newBuilder[String]
 
-      def printResult(success: Boolean, startTime: Long) =
+      def printResult(success: Boolean, startTime: Long): Unit =
         val duration    = System.currentTimeMillis - startTime
         val commandName = s"[${cmd.name} in $duration ms]"
         val cmdLog =
@@ -341,8 +342,8 @@ def checkFile(file: os.Path, options: Options): Unit =
 
     os.list(out).filter(_.last.endsWith(".scala")).foreach(p => os.copy.into(p, exampleDir))
 
-@main def check(args: String*) =
-  def processFiles(options: Options) =
+@main def check(args: String*): Unit =
+  def processFiles(options: Options): Unit =
     val paths = options.files.map { str =>
       val path = os.Path(str, os.pwd)
       assert(os.exists(path), s"Provided path $str does not exists in ${os.pwd}")
@@ -382,6 +383,7 @@ def checkFile(file: os.Path, options: Options): Unit =
   val Dest       = PathParameter("--dest")
   val StatusFile = PathParameter("--status-file")
 
+  @tailrec
   def parseArgs(args: Seq[String], options: Options): Options = args match
     case Nil => options
     case "--step" :: rest =>

modules/docs-tests/src/test/scala/sclicheck/SclicheckTests.scala

@@ -2,33 +2,26 @@ package sclicheck
 
 class SclicheckTests extends munit.FunSuite:
   test("Run regex") {
-    assert(None == clue(CompileBlock.unapplySeq("``scala compile")))
+    assert(clue(CompileBlock.unapplySeq("``scala compile")).isEmpty)
     assert(
-      Some(Seq("```", "scala", "compile", null)) == clue(
-        CompileBlock.unapplySeq("```scala compile")
-      )
+      clue(CompileBlock.unapplySeq("```scala compile"))
+        .contains(Seq("```", "scala", "compile", null))
     )
     assert(
-      Some(Seq("```", "scala", "fail", null)) == clue(CompileBlock.unapplySeq("```scala fail"))
+      clue(CompileBlock.unapplySeq("```scala fail"))
+        .contains(Seq("```", "scala", "fail", null))
     )
     assert(
-      Some(Seq("````", "markdown", "compile", null)) == clue(
-        CompileBlock.unapplySeq("````markdown compile")
-      )
+      clue(CompileBlock.unapplySeq("````markdown compile"))
+        .contains(Seq("````", "markdown", "compile", null))
     )
     assert(
-      Some(Seq("````", "markdown", "fail", "a.md")) == clue(
-        CompileBlock.unapplySeq("````markdown fail  title=a.md")
-      )
+      clue(CompileBlock.unapplySeq("````markdown fail  title=a.md"))
+        .contains(Seq("````", "markdown", "fail", "a.md"))
     )
+    assert(clue(CompileBlock.unapplySeq("``scala fail  title=a.sc")).isEmpty)
     assert(
-      None == clue(
-        CompileBlock.unapplySeq("``scala fail  title=a.sc")
-      )
-    )
-    assert(
-      Some(Seq("```", "scala", "fail", "a.sc")) == clue(
-        CompileBlock.unapplySeq("```scala fail  title=a.sc")
-      )
+      clue(CompileBlock.unapplySeq("```scala fail  title=a.sc"))
+        .contains(Seq("```", "scala", "fail", "a.sc"))
     )
   }