NIT doc and regression test

VirtusLab · May 15, 2023 · bee2401 · bee2401
1 parent f02bebd
commit bee2401
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git a/modules/integration/src/test/scala/scala/cli/integration/CompleteTests.scala b/modules/integration/src/test/scala/scala/cli/integration/CompleteTests.scala
@@ -14,6 +14,15 @@ class CompleteTests extends ScalaCliSuite {
     }
   }
 
+  test("zsh bug") {
+    // guard against https://github.com/alexarchambault/case-app/issues/475
+    TestInputs.empty.fromRoot { root =>
+      val res = os.proc(TestUtil.cli, "complete", "zsh-v1", "2", "scala-cli").call(cwd = root)
+      expect(res.exitCode == 0)
+      expect(!res.out.text().contains(raw"\'"))
+    }
+  }
+
   def shellFormat: String =
     if (Properties.isMac) "zsh-v1"
     else "bash-v1"

diff --git a/website/docs/reference/commands.md b/website/docs/reference/commands.md
@@ -110,7 +110,7 @@ All supported types of inputs can be mixed with each other.
 
 Detailed documentation can be found on our website: https://scala-cli.virtuslab.org
 
-The 'export' sub-command is experimental.
+The `export` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
 
@@ -210,7 +210,7 @@ All supported types of inputs can be mixed with each other.
 
 For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish
 
-The 'publish' sub-command is experimental.
+The `publish` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
 
@@ -222,7 +222,7 @@ Publishes build artifacts to the local Ivy2 repository.
 
 For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish-local
 
-The 'publish-local' sub-command is experimental.
+The `publish-local` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
 
@@ -234,7 +234,7 @@ Configures the project for publishing.
 
 For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish-setup
 
-The 'publish-setup' sub-command is experimental.
+The `publish-setup` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
 
@@ -275,7 +275,7 @@ Creates or updates a GitHub repository secret.
   scala-cli --power github secret create --repo repo-org/repo-name SECRET_VALUE=value:secret
 ```
 
-The 'secret-create' sub-command is experimental.
+The `secret-create` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli
 
@@ -287,7 +287,7 @@ Aliases: `gh secret list`
 
 Lists secrets for a given GitHub repository.
 
-The 'secret-list' sub-command is experimental.
+The `secret-list` sub-command is experimental.
 Please bear in mind that non-ideal user experience should be expected.
 If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team at https://github.com/VirtusLab/scala-cli