Merge pull request #1085 from alexarchambault/tweak-docs

Tweak docs

Author: alexarchambault

modules/build/src/main/scala/scala/build/CrossSources.scala

@@ -146,7 +146,7 @@ object CrossSources {
           .flatMap(_.valueFor(path).toSeq)
           .foldLeft(BuildRequirements())(_ orElse _)
 
-      // Scala-cli treats all `.test.scala` files tests as well as
+      // Scala CLI treats all `.test.scala` files tests as well as
       // files from witin `test` subdirectory from provided input directories
       // If file has `using target <scope>` directive this take precendeces.
       if (

modules/cli-options/src/main/scala/scala/cli/commands/SharedCompilationServerOptions.scala

@@ -13,7 +13,7 @@ final case class SharedCompilationServerOptions(
   @Hidden
     bloopBspProtocol: Option[String] = None,
   @Group("Compilation server")
-  @HelpMessage("Socket file to use to open a BSP connection with Bloop (on Windows, a pipe name like \"`\\\\.\\pipe\\…`\")")
+  @HelpMessage("Socket file to use to open a BSP connection with Bloop")
   @ValueDescription("path")
   @Hidden
     bloopBspSocket: Option[String] = None,

modules/cli-options/src/main/scala/scala/cli/commands/UpdateOptions.scala

@@ -6,7 +6,7 @@ import scala.cli.signing.shared.PasswordOption
 import scala.cli.signing.util.ArgParsers._
 
 // format: off
-@HelpMessage("Update scala-cli - it works only for installation script")
+@HelpMessage("Update scala-cli - only works when installed by the installation script")
 final case class UpdateOptions(
   @Recurse
     verbosity: VerbosityOptions = VerbosityOptions(),

modules/cli/src/main/scala/scala/cli/commands/InstallHome.scala

@@ -13,7 +13,7 @@ object InstallHome extends ScalaCommand[InstallHomeOptions] {
 
   private def logEqual(version: String) = {
     System.err.println(
-      s"Scala-cli $version is already installed and up-to-date."
+      s"Scala CLI $version is already installed and up-to-date."
     )
     sys.exit(0)
   }

modules/integration/src/test/scala/scala/cli/integration/NativePackagerTests.scala

@@ -215,7 +215,7 @@ class NativePackagerTests extends munit.FunSuite {
           "--output", s"$appName.msi",
           "--product-name", "scala-cli",
           "--license-path", licencePath,
-          "--maintainer", "Scala-cli",
+          "--maintainer", "Scala-CLI",
           "--launcher-app", appName,
           "--suppress-validation"
         )

website/docs/commands/basics.md

@@ -120,7 +120,7 @@ In our experience, `scala-cli .` is the most used command; it compiles and runs
 :::note
 Scala CLI process all files within the specified directories and all of its subdirectories.
 
-Scala CLI ignores all subdirectories that start with `.` like `.scala` or `.vscode`.
+Scala CLI ignores all subdirectories that start with `.` like `.scala-build` or `.vscode`.
 Such directories needs to be explicitly provided as inputs.
 :::
 
@@ -161,7 +161,7 @@ object Hello extends App {
 }
 ```
 ```bash ignore
-unzip -l hello.zip 
+unzip -l hello.zip
 # Archive:  hello.zip
 #   Length      Date    Time    Name
 # ---------  ---------- -----   ----
@@ -201,7 +201,7 @@ Running another Scala CLI version might be slower because it uses JVM-based Scal
 
 To run another Scala CLI version, specify it with `--cli-version` before any other argument:
 
-```bash 
+```bash
 scala-cli --cli-version 0.1.3-51-g4d314eee-SNAPSHOT about
 # Scala CLI version 0.1.3-51-g4d314eee-SNAPSHOT
 ```
@@ -212,7 +212,7 @@ Scala CLI version 0.1.3-51-g4d314eee-SNAPSHOT
 
 To use the latest Scala CLI nightly build, pass `nightly` to `--cli-version` parameter:
 
-```bash 
+```bash
 scala-cli --cli-version nightly about
 # Scala CLI version 0.1.3-8-g431cc15f-SNAPSHOT
 ```

website/docs/commands/clean.md

@@ -3,4 +3,4 @@ title: Clean
 sidebar_position: 16
 ---
 
-The `clean` command deletes all of the files that are generated by `scala-cli`. This including the `.scala` directory where Scala CLI generated its output and stores its caches.
+The `clean` command deletes all of the files that are generated by `scala-cli`. This includes the `.scala-build` directory where Scala CLI writes outputs and stores its caches.

website/docs/commands/compile.md

@@ -20,15 +20,15 @@ Note that most Scala CLI commands automatically compile your code, if necessary.
 The `compile` command is useful if you'd like to check that your code compiles,
 or know of compilation warnings, without running it or packaging it.
 
-The most common `compile` options are shown below. 
+The most common `compile` options are shown below.
 For a full list of options, run `scala-cli compile --help`, or check the options linked in the
 [reference documentation](../reference/commands.md#compile).
 
 ## Test scope
 
 `--test` makes `scala-cli` compile main and test scopes:
 ```bash ignore
-scala-cli compile --test Hello.scala 
+scala-cli compile --test Hello.scala
 ```
 
 ## Watch mode
@@ -68,13 +68,13 @@ scala-cli compile --scala 3 Hello.scala
 
 The nightly builds of Scala compiler are unstable ones which are published on a nightly basis.
 
-To use the latest Scala 2 and Scala 3 nightly builds, pass `2.nightly` and `3.nightly`, respectively. 
+To use the latest Scala 2 and Scala 3 nightly builds, pass `2.nightly` and `3.nightly`, respectively.
 You can also request the last `2.12.nightly` and `2.13.nightly` versions. `2.13.nightly` is the same as `2.nightly`.
 Moreover, passing the `3.{sub binary number}.nightly` format, such as `3.0.nightly` or `3.1.nightly` is accepted, too.
 
 Scala CLI takes care of fetching the nightly builds of Scala 2 and Scala 3 from different repositories, without you having to pass their addresses as input after the `--repo` flag.
 
-For compiling with the latest Scala 2 nightly build: 
+For compiling with the latest Scala 2 nightly build:
 ```bash
 scala-cli Hello.scala -S 2.nightly
 ```
@@ -84,7 +84,7 @@ scala-cli Hello.scala -S 3.nightly
 ```
 For compiling with an specific nightly build, you have the full version for:
 ```bash
-scala-cli Hello.scala -S 2.13.9-bin-4505094 
+scala-cli Hello.scala -S 2.13.9-bin-4505094
 ```
 
 For adding this inside scala files with [using directives](../guides/using-directives.md), use:
@@ -125,11 +125,11 @@ Most [Scala compiler options](https://docs.scala-lang.org/overviews/compiler-opt
 
 ```bash
 scala-cli compile Hello.scala -Xlint:infer-any
-# Compiling project_b729aa2200-cef76d561e (1 Scala source)
+# Compiling project (1 Scala source)
 # [warn] ./Hello.scala:2:11: a type was inferred to be `Any`; this may indicate a programming error.
 # [warn]   val l = List("a", true, 2, new Object)
 # [warn]           ^
-# Compiled 'project_b729aa2200-cef76d561e'
+# Compiled project
 ```
 
 All `scala-cli` options that start with:
@@ -163,7 +163,7 @@ You can also view the Scala compiler help for a particular Scala version with `-
 ```bash
 scala-cli -S 2.13.8 --scalac-help
 # Usage: scalac <options> <source files>
-# 
+#
 # Standard options:
 #   -Dproperty=value             Pass -Dproperty=value directly to the runtime system.
 #   -J<flag>                     Pass <flag> directly to the runtime system.

website/docs/commands/fmt.md

@@ -3,7 +3,7 @@ title: Format
 sidebar_position: 15
 ---
 
-Scala-cli supports formatting your code using [Scalafmt](https://scalameta.org/scalafmt/):
+Scala CLI supports formatting your code using [Scalafmt](https://scalameta.org/scalafmt/):
 
 ```bash
 scala-cli fmt
@@ -18,9 +18,9 @@ You can check formatting correctness using a `--check` flag:
 scala-cli fmt --check
 ```
 
-### Dialects 
+### Dialects
 
-Scala-cli also supports dialects that are passed to the formatter.
+Scala CLI also supports dialects that are passed to the formatter.
 This value is only used if there is no `.scalafmt.conf` file.
 However, if it exists, then all configuration should be placed there.
 For a list of all possible values, consult the [official Scala Dialects documentation](https://scalameta.org/scalafmt/docs/configuration.html#scala-dialects):
@@ -31,9 +31,9 @@ scala-cli fmt --dialect scala212
 
 ### Scalafmt version
 
-At this time, `scala-cli` read a `scalafmt` version from `.scalafmt.conf` files. If the version is missing, `scala-cli` throws an error, that user should declare explicitly the Scalafmt version. From Scalafmt `3.5.0` it is a mandatory parameter.
+At this time, Scala CLI reads a `scalafmt` version from `.scalafmt.conf` files. If the version is missing, Scala CLI throws an error, stating that users should declare an explicit Scalafmt version. Since Scalafmt `3.5.0`, this parameter is mandatory.
 
-To configure the Scalafmt version add the following config into `.scalafmt.conf`. For example, to set version `3.5.0` you should add the following line:
+To configure the Scalafmt version, add the following to `.scalafmt.conf`. For example, to set the version to `3.5.0`, add the following line:
 
 ```
 version = "3.5.0"

website/docs/commands/package.md

@@ -132,7 +132,7 @@ docker run hello-docker
 Hello from Docker
 -->
 
-You can also create Docker images for the Scala.js and Scala Native environments.
+You can also create Docker images for Scala.js and Scala Native applications.
 This command shows how to create a Docker image (`--docker`) for a Scala.js (`--js`) application:
 
 ```bash
@@ -185,7 +185,7 @@ Hello
 -->
 
 
-Note that the Scala CLI doesn't offer to link the resulting JavaScript with linkers, such as Webpack (yet).
+Note that Scala CLI doesn't offer to link the resulting JavaScript with linkers, such as Webpack (yet).
 
 ## Native image
 
@@ -321,7 +321,7 @@ scala-cli package --rpm --output 'path.rpm' Hello.scala
 
 ### macOS (PKG)
 
-PKG is the software package format for macOS.
+PKG is a software package format for macOS.
 To build a PKG you will need to have [`pkgbuild`](https://www.unix.com/man-page/osx/1/pkgbuild/) installed.
 
 Example:
@@ -341,13 +341,13 @@ Example:
 
 ### Windows
 
-MSI is the software package format for Windows distributions.
-To build a Windows installer, you will need to have [`WIX Toolset`](https://wixtoolset.org/) installed.
+MSI is a software package format for Windows.
+To build an MSI installer, you will need to have [`WIX Toolset`](https://wixtoolset.org/) installed.
 
 Example:
 
 ```cmd
-scala-cli package --msi --output 'path.msi` Hello.scala
+scala-cli package --msi --output path.msi Hello.scala
 ```
 
 #### Mandatory arguments