Toolkit: MUnit, os-lib, sttp and upickle tutorials

Gemfile.lock

@@ -219,6 +219,8 @@ GEM
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.18.0)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.14.2-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
@@ -263,6 +265,7 @@ GEM
     zeitwerk (2.6.7)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

_config.yml

@@ -192,6 +192,14 @@ defaults:
       overview-name: "Scaladoc"
       layout: multipage-overview
       permalink: "/scala3/guides/scaladoc/:title.html"
+  -
+    scope:
+      path: "_overviews/toolkit"
+    values:
+      partof: toolkit
+      overview-name: "The Scala Toolkit"
+      layout: multipage-overview
+      permalink: "/toolkit/:title.html"
   -
     scope:
       path: "scala3"
@@ -203,6 +211,6 @@ highlighter: rouge
 permalink: /:categories/:title.html:output_ext
 baseurl:
 scala3ref: "https://docs.scala-lang.org/scala3/reference"
-exclude: ["vendor"]
+exclude: ["vendor", ".metals"]
 plugins:
   - jekyll-redirect-from

_data/doc-nav-header.yml

@@ -37,6 +37,8 @@
       url: "/tutorials/scala-on-android.html"
     - title: Scala with Maven
       url: "/tutorials/scala-with-maven.html"
+    - title: Using the Scala Toolkit
+      url: "/toolkit/introduction.html"
 - title: Reference
   url: "#"
   submenu:

_includes/_markdown/install-munit.md

@@ -0,0 +1,51 @@
+{% altDetails install-info-box 'Getting MUnit' %}
+
+{% tabs munit-unit-test-1 class=tabs-build-tool %}
+{% tab 'Scala CLI' %}
+You can require the entire toolkit in a single line:
+```scala
+//> using dep "org.scala-lang::toolkit-test:0.1.7"
+```
+
+Alternatively, you can require just a specific version of MUnit:
+```scala
+//> using dep "org.scalameta::munit:1.0.0-M7"
+```
+{% endtab %}
+{% tab 'sbt' %}
+In your build.sbt file, you can add the dependency on toolkit-test:
+```scala
+lazy val example = project.in(file("example"))
+  .settings(
+    scalaVersion := "3.2.2",
+    libraryDependencies += "org.scala-lang" %% "toolkit-test" % "0.1.7" % Test
+  )
+```
+Here the `Test` configuration means that the dependency is only used by the source files in `example/src/test`.
+
+Alternatively, you can require just a specific version of MUnit:
+```scala
+libraryDependencies += "org.scalameta" %% "munit" % "1.0.0-M7" % Test
+```
+{% endtab %}
+{% tab 'Mill' %}
+In your build.sc file, you can add a `test` object extending `Tests` and `TestModule.Munit`:
+```scala
+object example extends ScalaModule {
+  def scalaVersion = "3.2.2"
+  object test extends Tests with TestModule.Munit {
+    def ivyDeps =
+      Agg(
+        ivy"org.scala-lang::toolkit-test:0.1.7"
+      )
+  }
+}
+```
+
+Alternatively, you can require just a specific version of MUnit:
+```scala
+ivy"org.scalameta::munit:1.0.0-M7"
+```
+{% endtab %}
+{% endtabs %}
+{% endaltDetails %}

_includes/_markdown/install-os-lib.md

@@ -0,0 +1,46 @@
+{% altDetails require-info-box 'Getting OS-Lib' %}
+
+{% tabs oslib-install class=tabs-build-tool %}
+{% tab 'Scala CLI' %}
+You can require the entire toolkit in a single line:
+```scala
+//> using toolkit "latest"
+```
+
+Alternatively, you can require just a specific version of OS-Lib:
+```scala
+//> using dep "com.lihaoyi::os-lib:0.9.1"
+```
+{% endtab %}
+{% tab 'sbt' %}
+In your `build.sbt`, you can add a dependency on the toolkit:
+```scala
+lazy val example = project.in(file("example"))
+  .settings(
+    scalaVersion := "3.2.2",
+    libraryDependencies += "org.scala-lang" %% "toolkit" % "0.1.7"
+  )
+```
+Alternatively, you can require just a specific version of OS-Lib:
+```scala
+libraryDependencies += "com.lihaoyi" %% "os-lib" % "0.9.1"
+```
+{% endtab %}
+{% tab 'Mill' %}
+In your `build.sc` file, you can add a dependency on the Toolkit:
+```scala
+object example extends ScalaModule {
+  def scalaVersion = "3.2.2"
+  def ivyDeps =
+    Agg(
+      ivy"org.scala-lang::toolkit:0.1.7"
+    )
+}
+```
+Alternatively, you can require just a specific version of OS-Lib:
+```scala
+ivy"com.lihaoyi::os-lib:0.9.1"
+```
+{% endtab %}
+{% endtabs %}
+{% endaltDetails %}

_includes/_markdown/install-sttp.md

@@ -0,0 +1,47 @@
+{% altDetails install-info-box 'Getting sttp' %}
+
+{% tabs sttp-install-methods class=tabs-build-tool%}
+{% tab 'Scala CLI' %}
+You can require the entire toolkit in a single line:
+```scala
+//> using toolkit "latest"
+```
+
+Alternatively, you can require just a specific version of sttp:
+```scala
+//> using dep "com.softwaremill.sttp.client4::core:4.0.0-M1"
+```
+{% endtab %}
+{% tab 'sbt' %}
+In your build.sbt file, you can add a dependency on the Toolkit:
+```scala
+lazy val example = project.in(file("example"))
+  .settings(
+    scalaVersion := "3.2.2",
+    libraryDependencies += "org.scala-lang" %% "toolkit" % "0.1.7"
+  )
+```
+
+Alternatively, you can require just a specific version of sttp:
+```scala
+libraryDependencies += "com.softwaremill.sttp.client4" %% "core" % "4.0.0-M1"
+```
+{% endtab %}
+{% tab 'Mill' %}
+In your build.sc file, you can add a dependency on the Toolkit:
+```scala
+object example extends ScalaModule {
+  def scalaVersion = "3.2.2"
+  def ivyDeps =
+    Agg(
+      ivy"org.scala-lang::toolkit:0.1.7"
+    )
+}
+```
+Alternatively, you can require just a specific version of sttp:
+```scala
+ivy"com.softwaremill.sttp.client4::core:4.0.0-M1"
+```
+{% endtab %}
+{% endtabs %}
+{% endaltDetails %}

_includes/_markdown/install-upickle.md

@@ -0,0 +1,46 @@
+{% altDetails install-info-box 'Getting upickle' %}
+
+{% tabs upickle-install-methods class=tabs-build-tool %}
+{% tab 'Scala CLI' %}
+Using Scala CLI, you can require the entire toolkit in a single line:
+```scala
+//> using toolkit "latest"
+```
+
+Alternatively, you can require just a specific version of UPickle:
+```scala
+//> using dep "com.lihaoyi::upickle:3.1.0
+```
+{% endtab %}
+{% tab 'sbt' %}
+In your build.sbt file, you can add the dependency on the Toolkit:
+```scala
+lazy val example = project.in(file("example"))
+  .settings(
+    scalaVersion := "3.2.2",
+    libraryDependencies += "org.scala-lang" %% "toolkit" % "0.1.7"
+  )
+```
+Alternatively, you can require just a specific version of UPickle:
+```scala
+libraryDependencies += "com.lihaoyi" %% "upickle" % "3.1.0"
+```
+{% endtab %}
+{% tab 'Mill' %}
+In your build.sc file, you can add the dependency to the upickle library:
+```scala
+object example extends ScalaModule {
+  def scalaVersion = "3.2.2"
+  def ivyDeps =
+    Agg(
+      ivy"org.scala-lang::toolkit:0.1.7"
+    )
+}
+```
+Alternatively, you can require just a specific version of UPickle:
+```scala
+ivy"com.lihaoyi::upickle:3.1.0"
+```
+{% endtab %}
+{% endtabs %}
+{% endaltDetails %}

_includes/markdown.html

@@ -0,0 +1,3 @@
+{%if include.selector%}<{{include.selector}} {%if include.classes%}class="{{include.classes}}"{%endif%} {%if include.id%}id="{{include.id}}{%endif%}">{%endif%}
+  {% capture markdown %}{% include {{include.path}} %}{% endcapture %}{{ markdown | markdownify }}
+{%if include.selector%}</{{include.selector}}>{%endif%}

_overviews/toolkit/OrderedListOfMdFiles

@@ -0,0 +1,29 @@
+introduction.md
+testing-intro.md
+testing-suite.md
+testing-run.md
+testing-run-only.md
+testing-exceptions.md
+testing-asynchronous.md
+testing-resources.md
+testing-what-else.md
+os-intro.md
+os-read-directory.md
+os-read-file.md
+os-write-file.md
+os-run-process.md
+os-what-else.md
+json-intro.md
+json-parse.md
+json-modify.md
+json-deserialize.md
+json-serialize.md
+json-files.md
+json-what-else.md
+http-client-intro.md
+http-client-request.md
+http-client-uris.md
+http-client-request-body.md
+http-client-json.md
+http-client-upload-file.md
+http-client-what-else.md

_overviews/toolkit/http-client-intro.md

@@ -0,0 +1,20 @@
+---
+title: Sending HTTP requests with sttp
+type: chapter
+description: The introduction of the sttp library
+num: 23
+previous-page: json-what-else
+next-page: http-client-request
+---
+
+sttp is a popular and feature-rich library for making HTTP requests to web servers.
+
+It provides both a synchronous API and an asynchronous `Future`-based API. It also supports WebSockets.
+
+Extensions are available that add capabilities such as streaming, logging, telemetry, and serialization.
+
+sttp offers the same APIs on all platforms (JVM, Scala.js, and Scala Native).
+
+sttp is a good choice for small synchronous scripts as well as large-scale, highly concurrent, asynchronous applications.
+
+{% include markdown.html path="_markdown/install-sttp.md" %}