Refactor the docs to reduce ignored (non-coverable by tests) code snippet examples (#1617)

Author: Gedochao

website/docs/commands/basics.md

@@ -173,11 +173,18 @@ Make sure that you trust the code that you are about to run.
 `scala-cli` accepts input via URLs pointing at `.scala` files.
 It downloads their content, and runs them:
 
+<ChainedSnippet>
+
 ```bash
 scala-cli https://gist.github.com/alexarchambault/f972d941bc4a502d70267cfbbc4d6343/raw/2691c01984c9249936a625a42e29a822a357b0f6/Test.scala
-# Hello from Scala GitHub Gist
 ```
 
+```text
+Hello from Scala GitHub Gist
+```
+
+</ChainedSnippet>
+
 ### GitHub Gist
 
 `scala-cli` accepts input via Github Gist’s urls.

website/docs/commands/compile.md

@@ -3,6 +3,8 @@ title: Package
 sidebar_position: 17
 ---
 
+import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
+
 The `package` command can package your Scala code in various formats, such as:
 - [lightweight launcher JARs](#default-package-format)
 - [standard library JARs](#library-jars)
@@ -30,12 +32,19 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package Hello.scala -o hello
 ./hello
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 <!-- Expected
 Hello
 -->
@@ -54,16 +63,23 @@ class MyLibrary {
 ```
 
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package MyLibrary.scala -o my-library.jar --library
 javap -cp my-library.jar mylib.MyLibrary
-# Compiled from "MyLibrary.scala"
-# public class mylib.MyLibrary {
-#   public java.lang.String message();
-#   public mylib.MyLibrary();
-# }
 ```
 
+```text
+Compiled from "MyLibrary.scala"
+public class mylib.MyLibrary {
+  public java.lang.String message();
+  public mylib.MyLibrary();
+}
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 MyLibrary.scala
 public class mylib.MyLibrary
@@ -87,12 +103,19 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package Hello.scala -o hello --assembly
 ./hello
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 Hello
 -->
@@ -123,11 +146,18 @@ Started building docker image with your application
 docker run hello-docker:latest
 -->
 
+<ChainedSnippets>
+
 ```bash
 docker run hello-docker
-# Hello from Docker
 ```
 
+```text
+Hello from Docker
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 Hello from Docker
 -->
@@ -174,12 +204,19 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package --js HelloJs.scala -o hello.js
 node hello.js
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 Hello
 -->
@@ -202,12 +239,19 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package Hello.scala -o hello --native-image
 ./hello
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 Hello
 -->
@@ -235,14 +279,27 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash
 scala-cli package --native HelloNative.scala -S 2.13.6 -o hello
 file hello
-# hello: Mach-O 64-bit executable x86_64
+```
+
+```text
+hello: Mach-O 64-bit executable x86_64
+```
+
+```bash
 ./hello
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 <!-- Expected:
 Hello
 -->
@@ -264,14 +321,27 @@ object Hello {
 }
 ```
 
+<ChainedSnippets>
+
 ```bash ignore
 scala-cli package --deb Hello.scala -o hello.deb
 file hello
-# hello: Mach-O 64-bit executable x86_64
+```
+
+```text
+hello: Mach-O 64-bit executable x86_64
+```
+
+```bash ignore
 ./hello
-# Hello
 ```
 
+```text
+Hello
+```
+
+</ChainedSnippets>
+
 ### Debian
 
 DEB is the package format for the Debian Linux distribution.
@@ -371,7 +441,7 @@ Instead of passing the `package` options directly from bash, it is possible to p
 
 This using directive makes it possible to define the type of the package generated by the `package` command. For example:
 
-```
+```scala compile
 //> using packaging.packageType "assembly"
 ```
 
@@ -381,7 +451,7 @@ Available types: `assembly`, `raw-assembly`, `bootstrap`, `library`, `source`, `
 
 This using directive makes it possible to define the destination path of the package generated by the `package` command. For example:
 
-```
+```scala compile
 //> using packaging.output "foo"
 ```
 

website/docs/commands/package.md

@@ -3,30 +3,46 @@ title: REPL
 sidebar_position: 8
 ---
 
+import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
+
 The `repl` command starts a Scala REPL, which lets you interactively run your code and inspect its results:
 
+<ChainedSnippets>
+
 ```bash ignore
 scala-cli repl
-# scala> println("Hello Scala")
-# Hello Scala
-#
-# scala> :exit
 ```
 
+```text
+scala> println("Hello Scala")
+Hello Scala
+
+scala> :exit
+```
+
+</ChainedSnippets>
+
 Scala CLI by default uses the normal Scala REPL.
 
 If you prefer to use the [Ammonite REPL](https://ammonite.io/#Ammonite-REPL), specify `--amm` to launch it rather than the default REPL:
 
+<ChainedSnippets>
+
 ```bash ignore
 scala-cli repl --amm
-# Loading...
-# Welcome to the Ammonite Repl 2.4.0-23-76673f7f (Scala 3.0.2 Java 11.0.11)
-# @ println("Hello ammonite")
-# Hello ammonite
-# @ exit
-# Bye!
 ```
 
+```text
+Loading...
+Welcome to the Ammonite Repl 2.4.0-23-76673f7f (Scala 3.0.2 Java 11.0.11)
+@ println("Hello ammonite")
+Hello ammonite
+@ exit
+Bye!
+```
+
+</ChainedSnippets>
+
 The `repl` command accepts the same arguments as the [compile](./compile.md) command. It first compiles any provided sources, and then exposes those results and any provided dependencies to the REPL session:
 
 ```scala title=mylibrary/Messages.scala
@@ -37,14 +53,22 @@ object Messages {
   def print(): Unit = println(message)
 }
 ```
+
+<ChainedSnippets>
+
 ```bash ignore
 scala-cli repl mylibrary/Messages.scala
-# Compiling project (Scala 3.0.2, JVM)
-# Compiled project (Scala 3.0.2, JVM)
-# scala> import mylibrary._
-#
-# scala> Messages.print()
-# Hello
-#
-# scala> :quit
 ```
+
+```text
+Compiling project (Scala 3.0.2, JVM)
+Compiled project (Scala 3.0.2, JVM)
+scala> import mylibrary._
+
+scala> Messages.print()
+Hello
+
+scala> :quit
+```
+
+</ChainedSnippets>