feat!: Replace help command with --help flag

integration/commands.bats

@@ -12,7 +12,6 @@ load test_helper
 b
 c.other
 commands
-help
 nested"
 }
 

integration/help.bats

@@ -2,10 +2,10 @@
 
 load test_helper
 
-@test "help: without arguments, displays help for top level command" {
+@test "help: displays help for top level command" {
   fixture "commands"
 
-  run main help
+  run main --help
 
   assert_success
   assert_output "Usage: main [<subcommands>] [<args>]
@@ -21,14 +21,13 @@ Available subcommands:
     b           
     c.other     
     commands    List available commands
-    help        Display help for a sub command
     nested      "
 }
 
 @test "help: displays usage for a non documented command" {
   fixture "project"
 
-  run main help no-doc
+  run main --help no-doc
 
   assert_success
   assert_output "Usage: main no-doc"
@@ -37,7 +36,7 @@ Available subcommands:
 @test "help: displays help for a subcommand" {
   fixture "project"
 
-  run main help with-help
+  run main --help with-help
 
   assert_success
   assert_output "Usage: main with-help
@@ -52,7 +51,7 @@ The help section can span multiple lines."
 @test "help: displays summary for subcommand if help is not available" {
   fixture "project"
 
-  run main help only-summary
+  run main --help only-summary
 
   assert_success
   assert_output "Usage: main only-summary
@@ -63,7 +62,7 @@ Return with error 4"
 @test "help: fails gracefully when requested command doesn't exist" {
   fixture "project"
 
-  run main help not-found
+  run main --help not-found
 
   assert_failure
   assert_output "main: no such sub command 'not-found'"
@@ -72,7 +71,7 @@ Return with error 4"
 @test "help: displays help for a directory command" {
   fixture "project"
 
-  run main help directory
+  run main --help directory
 
   assert_success
   assert_output "Usage: main directory [<subcommands>] [<args>]
@@ -91,7 +90,7 @@ Available subcommands:
 @test "help: displays help for a nested subcommand" {
   fixture "project"
 
-  run main help directory with-help
+  run main --help directory with-help
 
   assert_success
   assert_output "Usage: main directory with-help
@@ -106,7 +105,7 @@ The help section can span multiple lines."
 @test "help: displays help for a double nested directory command" {
   fixture "project"
 
-  run main help directory double
+  run main --help directory double
 
   assert_success
   assert_output "Usage: main directory double [<subcommands>] [<args>]
@@ -124,7 +123,7 @@ Available subcommands:
 @test "help: displays help for a double nested sub command" {
   fixture "project"
 
-  run main help directory double with-help
+  run main --help directory double with-help
 
   assert_success
   assert_output "Usage: main directory double with-help

integration/nested.bats

@@ -8,7 +8,7 @@ load test_helper
   run main nested
 
   assert_success
-  assert_output "$(main help nested)"
+  assert_output "$(main --help nested)"
 }
 
 @test "nested: with a non existent subcommand, displays error message" {
@@ -35,5 +35,5 @@ load test_helper
   run main nested double
 
   assert_success
-  assert_output "$(main help nested double)"
+  assert_output "$(main --help nested double)"
 }

integration/subcommands.bats

@@ -8,7 +8,7 @@ load test_helper
   run main
 
   assert_success
-  assert_output "$(main help)"
+  assert_output "$(main --help)"
 }
 
 @test "subcommands: ignores hidden files" {

integration/usage.bats

@@ -2,6 +2,17 @@
 
 load test_helper
 
+@test "usage: conflicts with help" {
+  fixture "project"
+
+  run main --usage --help
+
+  assert_failure
+  assert_output "error: the argument '--usage' cannot be used with '--help'
+
+Usage: main --usage [commands_with_args]..."
+}
+
 @test "usage: when command has no Usage docstring prints default usage" {
   fixture "project"
 

src/commands/directory.rs

@@ -6,7 +6,6 @@ use crate::parser;
 use crate::error::{Error, Result};
 use crate::commands::Command;
 use crate::commands::internal::commands::internal_commands;
-use crate::commands::internal::help::internal_help;
 use crate::commands::external_subcommand;
 
 pub struct DirectoryCommand<'a> {
@@ -86,7 +85,8 @@ impl<'a> Command for DirectoryCommand<'a> {
             return Err(Error::UnknownSubCommand(self.names.last().unwrap().to_owned()));
         }
 
-        let help_command = internal_help(self.config, self.names.clone());
-        help_command.invoke()
+        println!("{}", self.help());
+
+        Ok(0)
     }
 }

src/commands/internal/mod.rs

@@ -2,7 +2,6 @@ use crate::error::Result;
 use crate::config::Config;
 use crate::commands::Command;
 
-pub mod help;
 pub mod commands;
 pub mod completions;
 

src/commands/mod.rs

@@ -9,7 +9,6 @@ use crate::config::Config;
 use crate::commands::file::FileCommand;
 use crate::commands::directory::DirectoryCommand;
 use crate::commands::toplevel::TopLevelCommand;
-use crate::commands::internal::help::internal_help;
 use crate::commands::internal::commands::internal_commands;
 use crate::commands::internal::completions::internal_completions;
 use crate::error::Result;
@@ -78,7 +77,6 @@ pub fn subcommand(config: &Config, mut cliargs: Vec<String>) -> Result<Box<dyn C
     let name = &cliargs[0];
 
     match name.as_ref() {
-        "help" => Ok(Box::new(internal_help(config, cliargs.split_off(1)))),
         "commands" => Ok(Box::new(internal_commands(config, cliargs.split_off(1)))),
         "completions" => Ok(Box::new(internal_completions(config, cliargs.split_off(1)))),
         _ => {

src/commands/toplevel.rs

@@ -5,7 +5,6 @@ use crate::config::Config;
 use crate::error::Result;
 use crate::parser;
 use crate::commands::Command;
-use crate::commands::internal::help::internal_help;
 use crate::commands::internal::commands::internal_commands;
 use crate::commands::external_subcommand;
 
@@ -61,7 +60,6 @@ impl<'a> Command for TopLevelCommand<'a> {
             }
         }
 
-        subcommands.push(Box::new(internal_help(self.config, Vec::new())));
         subcommands.push(Box::new(internal_commands(self.config, Vec::new())));
 
         subcommands.sort_by(|c1, c2| c1.name().cmp(c2.name()));
@@ -75,7 +73,8 @@ impl<'a> Command for TopLevelCommand<'a> {
     }
 
     fn invoke(&self) -> Result<i32> {
-        let help_command = internal_help(self.config, Vec::new());
-        help_command.invoke()
+        println!("{}", self.help());
+
+        Ok(0)
     }
 }

src/main.rs

@@ -39,6 +39,8 @@ fn main() {
 
     let user_cli_command = Command::new(&config.name).no_binary_name(true).disable_help_flag(true)
         .arg(Arg::new("usage").long("usage").num_args(0).help("Print usage"))
+        .arg(Arg::new("help").long("help").num_args(0).help("Print help"))
+        .group(ArgGroup::new("help_group").args(["usage", "help"]).multiple(false).required(false))
         .arg(Arg::new("commands_with_args").trailing_var_arg(true).allow_hyphen_values(true).num_args(..));
 
     let args = match user_cli_command.try_get_matches_from(sub_cli_args.cliargs) {
@@ -61,6 +63,11 @@ fn main() {
         exit(0);
     }
 
+    if args.get_one::<bool>("help").cloned().unwrap_or(false) {
+        println!("{}", subcommand.help());
+        exit(0);
+    }
+
     match subcommand.invoke() {
         Ok(code) => exit(code),
         Err(error) => handle_error(&config, error),