[#720] Add example with scala and sbt

Author: mengdaming

examples/README.md

@@ -57,6 +57,10 @@ Here are some simple examples for using TCR with various languages & toolchains
 - With [cargo](rust-cargo/README.md)
 - With [nextest](rust-nextest/README.md)
 
+## Scala
+
+- With [sbt](scala-sbt/README.md)
+
 ## TypeScript
 
 - With [yarn](typescript-yarn/README.md)

examples/scala-sbt/.gitignore

@@ -0,0 +1,9 @@
+.metals/
+.bloop/
+.bsp/
+project/
+target/
+.scalafmt.conf
+*.class
+*.tasty
+

examples/scala-sbt/.tcr/config.yml

@@ -0,0 +1,9 @@
+config:
+  git:
+    auto-push: false
+    polling-period: 2s
+  mob-timer:
+    duration: 5m0s
+  tcr:
+    language: scala
+    toolchain: sbt

examples/scala-sbt/.tcr/language/scala.yml

@@ -0,0 +1,9 @@
+toolchains:
+  default: sbt
+  compatible-with: [ sbt ]
+source-files:
+  directories: [ src/main ]
+  patterns: [ '(?i)^.*\.scala$' ]
+test-files:
+  directories: [ src/test ]
+  patterns: [ '(?i)^.*\.scala$' ]

examples/scala-sbt/.tcr/toolchain/sbt.yml

@@ -0,0 +1,11 @@
+build:
+  - os: [ darwin, linux, windows ]
+    arch: [ "386", amd64, arm64 ]
+    command: sbt
+    arguments: [ compile ]
+test:
+  - os: [ darwin, linux, windows ]
+    arch: [ "386", amd64, arm64 ]
+    command: sbt
+    arguments: [ test ]
+test-result-dir: target/test-reports

examples/scala-sbt/README.md

@@ -0,0 +1,53 @@
+# Using TCR with Scala and sbt
+
+## Prerequisites
+
+- macOS, Linux or Windows
+- [git](https://git-scm.com/) client
+- [curl](https://curl.se/download.html) command line utility
+- [java SDK](https://www.oracle.com/java/technologies/downloads/) with `JAVA_HOME` environment variable properly set up
+- [scala](https://www.scala-lang.org/download/)
+- [sbt](https://www.scala-sbt.org/download/)
+
+## Instructions
+
+### 1 - Open a terminal
+
+> ***Note to Windows users***
+>
+> Use a **git bash** terminal for running the commands below.
+> _Windows CMD and PowerShell are not supported_
+
+### 2 - Launch TCR
+
+> ***Reminder***: the command below should be run from
+> [examples/scala-sbt](.)
+> directory
+
+From the built-in terminal:
+
+```shell
+./tcrw
+```
+
+### Cheat Sheet
+
+Here are the main shortcuts available once TCR utility is running:
+
+| Shortcut  | Description                                  |
+|-----------|----------------------------------------------|
+| `o` / `O` | Open in browser (with `web` subcommand only) |
+| `d` / `D` | Enter driver role                            |
+| `n` / `N` | Enter navigator role                         |
+| `t` / `T` | Query timer status                           |
+| `p` / `P` | Toggle on/off git auto-push                  |
+| `l` / `L` | Pull from remote                             |
+| `s` / `S` | Push to remote                               |
+| `a` / `A` | Abort current command (when in driver role)  |
+| `q` / `Q` | Quit current role / Quit TCR                 |
+| `?`       | List available options                       |
+
+### Additional Details
+
+Refer to [tcr.md](../../doc/tcr.md) page for additional details and explanations about TCR
+available subcommands and options

examples/scala-sbt/build.sbt

@@ -0,0 +1,3 @@
+scalaVersion := "3.4.2"
+
+libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.18" % "test"

examples/scala-sbt/src/main/scala/HelloWorld.scala

@@ -0,0 +1,3 @@
+object HelloWorld {
+  def sayHello(name: String): String = s"Hello, $name!"
+}

examples/scala-sbt/src/test/scala/HelloWorldTest.scala

@@ -0,0 +1,11 @@
+import org.scalatest.funsuite.AnyFunSuite
+import org.scalatest.matchers.should.Matchers
+
+
+/** @version 1.1.0 */
+class HelloWorldTest extends AnyFunSuite with Matchers {
+
+  test("Say Hello") {
+    HelloWorld.sayHello("Sue") should be ("Hello, Sue!")
+  }
+}

examples/scala-sbt/tcrw

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+base_dir="$(cd "$(dirname -- "$0")" && pwd)"
+. "${base_dir}/../tcr/tcr.sh"