fix(cli): do not render hidden commands (#5975)

Before this fix, hidden commands (and subcommands) were visible when
running the help command and in our docs.

This fixes that.

core/src/cli/cli.ts

@@ -109,6 +109,7 @@ export class GardenCli {
   async renderHelp(log: Log, workingDir: string) {
     const commands = Object.values(this.commands)
       .sort()
+      .filter((cmd) => !cmd.hidden)
       .filter((cmd) => cmd.getPath().length === 1)
 
     // `dedent` has a bug where it doesn't indent correctly

core/src/commands/base.ts

@@ -605,6 +605,10 @@ export abstract class Command<
   }
 
   renderHelp() {
+    if (this.hidden) {
+      return ""
+    }
+
     let out = this.description
       ? `\n${cliStyles.heading("DESCRIPTION")}\n\n${styles.secondary(this.description.trim())}\n\n`
       : ""
@@ -674,7 +678,11 @@ export abstract class CommandGroup extends Command {
   }
 
   override renderHelp() {
-    const commands = this.getSubCommands()
+    const commands = this.getSubCommands().filter((cmd) => !cmd.hidden)
+
+    if (commands.length === 0) {
+      return ""
+    }
 
     return `
 ${cliStyles.heading("USAGE")}

core/src/commands/set.ts

@@ -34,6 +34,7 @@ export class SetDefaultEnvCommand extends Command<SetDefaultEnvArgs, {}> {
   name = "default-env"
 
   help = "Locally override the default environment for the project."
+  override hidden = true
 
   override description = dedent`
     Override the default environment for the project for this working copy.

core/test/unit/src/cli/cli.ts

@@ -1177,6 +1177,45 @@ describe("cli", () => {
     })
   })
 
+  describe("renderHelp", () => {
+    it("should skip hidden commands", async () => {
+      class TestCommand extends Command {
+        name = "test-command"
+        help = "halp!"
+        override noProject = true
+
+        override printHeader() {}
+
+        async action({ args }) {
+          return { result: { args } }
+        }
+      }
+      class HiddenTestCommand extends Command {
+        name = "hidden-test-command"
+        help = "halp!"
+        override noProject = true
+        override hidden = true
+
+        override printHeader() {}
+
+        async action({ args }) {
+          return { result: { args } }
+        }
+      }
+
+      const cmd = new TestCommand()
+      const hiddenCmd = new HiddenTestCommand()
+      cli.addCommand(cmd)
+      cli.addCommand(hiddenCmd)
+
+      const { code, consoleOutput } = await cli.run({ args: ["--help"], exitOnError: false })
+
+      expect(code).to.equal(0)
+      expect(consoleOutput).to.include("test-command")
+      expect(consoleOutput).to.not.include("hidden-test-command")
+    })
+  })
+
   describe("makeDummyGarden", () => {
     it("should initialise and resolve config graph in a directory with no project", async () => {
       const path = join(GARDEN_CORE_ROOT, "tmp", "foobarbas")

core/test/unit/src/commands/base.ts

@@ -67,6 +67,40 @@ describe("Command", () => {
                   [array:string]
       `)
     })
+    it("returns an empty string for hidden commands", async () => {
+      class TestCommand extends Command {
+        name = "test-command"
+        override aliases = ["some-alias"]
+        override hidden = true
+        help = "Hi, how are you?"
+
+        override arguments = {
+          foo: new StringsParameter({
+            help: "Some help text.",
+            required: true,
+          }),
+          bar: new StringsParameter({
+            help: "Another help text.",
+          }),
+        }
+
+        override options = {
+          floop: new StringsParameter({
+            help: "Option help text.",
+          }),
+        }
+
+        override printHeader() {}
+
+        async action() {
+          return {}
+        }
+      }
+
+      const cmd = new TestCommand()
+
+      expect(cmd.renderHelp()).to.equal("")
+    })
   })
 
   describe("getPaths", () => {
@@ -386,3 +420,124 @@ describe("CommandGroup", () => {
     })
   })
 })
+
+describe("CommandGroup", () => {
+  describe("renderHelp", () => {
+    it("renders the command help text", async () => {
+      class TestSubCommand extends Command {
+        name = "test-command"
+        override aliases = ["some-alias"]
+        help = "Hi, how are you?"
+
+        override arguments = {
+          foo: new StringsParameter({
+            help: "Some help text.",
+            required: true,
+          }),
+          bar: new StringsParameter({
+            help: "Another help text.",
+          }),
+        }
+
+        override options = {
+          floop: new StringsParameter({
+            help: "Option help text.",
+          }),
+        }
+
+        override printHeader() {}
+
+        async action() {
+          return {}
+        }
+      }
+
+      class TestCommandGroup extends CommandGroup {
+        name = "test-command-group"
+        subCommands = [TestSubCommand]
+        help = "Hi, how are you?"
+      }
+
+      const cmdGroup = new TestCommandGroup()
+      const helpTxt = stripAnsi(cmdGroup.renderHelp()).trim()
+
+      expect(helpTxt).to.equal(dedent`
+        USAGE
+          garden test-command-group <command> [options]
+
+        COMMANDS
+          test-command-group test-command  Hi, how are you?
+      `)
+    })
+    it("skips hidden commands", async () => {
+      class TestSubCommand extends Command {
+        name = "test-command"
+        override aliases = ["some-alias"]
+        help = ""
+
+        async action() {
+          return {}
+        }
+      }
+      class HiddenTestSubCommand extends Command {
+        name = "test-command-hidden"
+        override aliases = ["some-alias"]
+        override hidden = true
+        help = "Hi, how are you?"
+
+        async action() {
+          return {}
+        }
+      }
+
+      class TestCommandGroup extends CommandGroup {
+        name = "test-command-group"
+        subCommands = [HiddenTestSubCommand, TestSubCommand]
+        help = "Hi, how are you?"
+      }
+
+      const cmdGroup = new TestCommandGroup()
+      const helpTxt = stripAnsi(cmdGroup.renderHelp()).trim()
+
+      expect(helpTxt).to.equal(dedent`
+        USAGE
+          garden test-command-group <command> [options]
+
+        COMMANDS
+          test-command-group test-command
+      `)
+    })
+    it("returns an empty string if all sub commands are hidden", async () => {
+      class HiddenTestSubCommandA extends Command {
+        name = "test-command-hidden-a"
+        override aliases = ["some-alias"]
+        override hidden = true
+        help = "Hi, how are you?"
+
+        async action() {
+          return {}
+        }
+      }
+      class HiddenTestSubCommandB extends Command {
+        name = "test-command-hidden-b"
+        override aliases = ["some-alias"]
+        override hidden = true
+        help = "Hi, how are you?"
+
+        async action() {
+          return {}
+        }
+      }
+
+      class TestCommandGroup extends CommandGroup {
+        name = "test-command-group"
+        subCommands = [HiddenTestSubCommandA, HiddenTestSubCommandB]
+        help = "Hi, how are you?"
+      }
+
+      const cmdGroup = new TestCommandGroup()
+
+      expect(cmdGroup.renderHelp()).to.equal("")
+    })
+  })
+})

docs/reference/commands.md

@@ -4986,30 +4986,6 @@ Examples:
 Note! If you use a non-stable version (i.e. pre-release, or draft, or edge), then the latest possible major version will be installed.
 
 
-### garden set default-env
-
-**Locally override the default environment for the project.**
-
-Override the default environment for the project for this working copy.
-
-Examples:
-
-  garden set default-env remote       # Set the default env to remote (with the configured default namespace)
-  garden set default-env dev.my-env   # Set the default env to dev.my-env
-  garden set default-env              # Clear any previously set override
-
-#### Usage
-
-    garden set default-env [env] 
-
-#### Arguments
-
-| Argument | Required | Description |
-| -------- | -------- | ----------- |
-  | `env` | No | The default environment to set for the current project
-
-
-
 ### garden sync start
 
 **Start any configured syncs to the given Deploy action(s).**