feat: Print help menu on --help for all commands

lib/commands/command-current.bash

@@ -4,6 +4,12 @@
 
 # shellcheck disable=SC2059
 plugin_current_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf current'
+ printf '%s\n' 'usage: asdf current <name>'
+ exit 0
+ fi
+
  local plugin_name=$1
  local terminal_format=$2
 

lib/commands/command-env.bash

@@ -5,8 +5,13 @@ shim_env_command() {
  local env_cmd="${2}"
  local env_args=("${@:3}")
 
+ local help_text="usage: asdf env <command>"
+ if has_help_flag "$@"; then
+ printf '%s\n' "$help_text"
+ exit 0
+ fi
  if [ -z "$shim_name" ]; then
- printf "usage: asdf env <command>\n"
+ display_error "$help_text"
  exit 1
  fi
 

lib/commands/command-exec.bash

@@ -1,12 +1,18 @@
 # -*- sh -*-
 
 shim_exec_command() {
+ local help_text="usage: asdf exec <command>"
+ if has_help_flag "$@"; then
+ printf '%s\n' "$help_text"
+ exit 0
+ fi
+
  local shim_name
  shim_name=$(basename "$1")
  local shim_args=("${@:2}")
 
  if [ -z "$shim_name" ]; then
- printf "usage: asdf exec <command>\n"
+ display_error "$help_text"
  exit 1
  fi
 

lib/commands/command-export-shell-version.bash

@@ -4,11 +4,17 @@
 
 # Output from this command must be executable shell code
 shell_command() {
+ local help_text="usage: asdf shell <name> {<version>|--unset}"
+ if has_help_flag "$@"; then
+ printf '%s\n' "printf '%s\n' \"$help_text\""
+ exit 0
+ fi
+
  local asdf_shell="$1"
  shift
 
  if [ "$#" -lt "2" ]; then
- printf "Usage: asdf shell <name> {<version>|--unset}\n" >&2
+ display_error "$help_text"
  printf "false\n"
  exit 1
  fi

lib/commands/command-help.bash

@@ -37,6 +37,11 @@ help_command() {
  local tool_version="$2"
  local plugin_path
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf help <name> [<version>]'
+ exit 0
+ fi
+
  # If plugin name is present as first argument output plugin help info
  if [ -n "$plugin_name" ]; then
  plugin_path=$(get_plugin_path "$plugin_name")

lib/commands/command-info.bash

@@ -3,6 +3,11 @@
 . "$(dirname "$(dirname "$0")")/lib/functions/plugins.bash"
 
 info_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf info'
+ exit 0
+ fi
+
  printf "%s:\n%s\n\n" "OS" "$(uname -a)"
  printf "%s:\n%s\n\n" "SHELL" "$("$SHELL" --version)"
  printf "%s:\n%s\n\n" "BASH VERSION" "$BASH_VERSION"

lib/commands/command-list.bash

@@ -4,6 +4,11 @@ list_command() {
  local plugin_name=$1
  local query=$2
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf list <name> [version]'
+ exit 0
+ fi
+
  if [ -z "$plugin_name" ]; then
  local plugins_path
  plugins_path=$(get_plugin_path)

lib/commands/command-plugin-list-all.bash

@@ -1,6 +1,11 @@
 # -*- sh -*-
 
 plugin_list_all_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf plugin list all'
+ exit 0
+ fi
+
  initialize_or_update_plugin_repository
 
  local plugins_index_path

lib/commands/command-plugin-remove.bash

@@ -1,6 +1,11 @@
 # -*- sh -*-
 
 plugin_remove_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' "usage: asdf plugin remove <name>"
+ exit 0
+ fi
+
  local plugin_name=$1
  check_if_plugin_exists "$plugin_name"
 

lib/commands/command-shim-versions.bash

@@ -1,6 +1,11 @@
 # -*- sh -*-
 
 shim_versions_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf shim-versions <command>'
+ exit 0
+ fi
+
  local shim_name=$1
  shim_plugin_versions "$shim_name"
 }

lib/commands/command-uninstall.bash

@@ -7,6 +7,12 @@ uninstall_command() {
  local plugin_name=$1
  local full_version=$2
  local plugin_path
+
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf uninstall <name> <version>'
+ exit 0
+ fi
+
  plugin_path=$(get_plugin_path "$plugin_name")
 
  check_if_plugin_exists "$plugin_name"

lib/commands/command-update.bash

@@ -3,6 +3,12 @@
 update_command() {
  local update_to_head=$1
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf update'
+ printf '%s\n' 'usage: asdf update --head'
+ exit 0
+ fi
+
  (
  cd "$(asdf_dir)" || exit 1
 

lib/commands/command-where.bash

@@ -3,6 +3,12 @@
 where_command() {
  local plugin_name=$1
  local full_version=$2
+
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf where <name> [<version>]'
+ exit 0
+ fi
+
  check_if_plugin_exists "$plugin_name"
 
  local version

lib/commands/command-which.bash

@@ -1,11 +1,17 @@
 # -*- sh -*-
 
 which_command() {
+ local help_text="usage: asdf which <command>"
+ if has_help_flag "$@"; then
+ printf '%s\n' "$help_text"
+ exit 0
+ fi
+
  local shim_name
  shim_name=$(basename "$1")
 
  if [ -z "$shim_name" ]; then
- printf "usage: asdf which <command>\n"
+ display_error "$help_text"
  exit 1
  fi
 

lib/commands/reshim.bash

@@ -28,6 +28,11 @@ reshim_command() {
  local plugin_name=$1
  local full_version=$2
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf reshim <name> <version>'
+ exit 0
+ fi
+
  if [ -z "$plugin_name" ]; then
  local plugins_path
  plugins_path=$(get_plugin_path)

lib/functions/installs.bash

@@ -15,6 +15,14 @@ install_command() {
  local full_version=$2
  local extra_args="${*:3}"
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf install'
+ printf '%s\n' 'usage: asdf install <name>'
+ printf '%s\n' 'usage: asdf install <name> <version>'
+ printf '%s\n' 'usage: asdf install <name> latest[:<version>]'
+ exit 0
+ fi
+
  if [ "$plugin_name" = "" ] && [ "$full_version" = "" ]; then
  install_local_tool_versions "$extra_args"
  elif [[ $# -eq 1 ]]; then

lib/functions/plugins.bash

@@ -1,4 +1,10 @@
 plugin_list_command() {
+ if has_help_flag "$@"; then
+ printf '%s\n' "usage: asdf plugin list [--urls] [--refs]"
+ printf '%s\n' "usage: asdf plugin list all"
+ exit 0
+ fi
+
  local plugins_path
  plugins_path=$(get_plugin_path)
 
@@ -47,8 +53,13 @@ plugin_list_command() {
 }
 
 plugin_add_command() {
+ local help_text="usage: asdf plugin add <name> [<git-url>]"
+ if has_help_flag "$@"; then
+ printf '%s\n' "$help_text"
+ exit 0
+ fi
  if [[ $# -lt 1 || $# -gt 2 ]]; then
- display_error "usage: asdf plugin add <name> [<git-url>]"
+ display_error "$help_text"
  exit 1
  fi
 
@@ -104,8 +115,16 @@ plugin_add_command() {
 }
 
 plugin_update_command() {
+ local help_text1="usage: asdf plugin-update <name> [git-ref]"
+ local help_text2="usage: asdf plugin-update --all"
+ if has_help_flag "$@"; then
+ printf '%s\n' "$help_text1"
+ printf '%s\n' "$help_text2"
+ exit 0
+ fi
  if [ "$#" -lt 1 ]; then
- display_error "usage: asdf plugin-update {<name> [git-ref] | --all}"
+ display_error "$help_text1"
+ display_error "$help_text2"
  exit 1
  fi
 

lib/functions/versions.bash

@@ -2,13 +2,20 @@ version_command() {
  local cmd=$1
  local plugin_name=$2
 
- if [ "$#" -lt "3" ]; then
- if [ "$cmd" = "global" ]; then
- printf "Usage: asdf global <name> <version>\n"
+ if has_help_flag "$@" || [ "$#" -lt "3" ]; then
+ if [ "$cmd" = 'global' ]; then
+ printf '%s\n' "usage: asdf global <name> <version>"
+ printf '%s\n' "usage: asdf global <name> latest[:<version>]"
  else
- printf "Usage: asdf local <name> <version>\n"
+ printf '%s\n' "usage: asdf local <name> <version>"
+ printf '%s\n' "usage: asdf local <name> latest[:<version>]"
+ fi
+
+ if has_help_flag "$@"; then
+ exit 0
+ else
+ exit 1
  fi
- exit 1
  fi
 
  shift 2
@@ -86,6 +93,12 @@ list_all_command() {
  local std_out_file
  local std_err_file
  local output
+
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf list all <name> [<version>]'
+ exit 0
+ fi
+
  plugin_path=$(get_plugin_path "$plugin_name")
  check_if_plugin_exists "$plugin_name"
 
@@ -136,6 +149,12 @@ latest_command() {
  local query=$2
  local plugin_path
 
+ if has_help_flag "$@"; then
+ printf '%s\n' 'usage: asdf latest <name> [<version>]'
+ printf '%s\n' 'usage: asdf latest --all'
+ exit 0
+ fi
+
  if [ "$plugin_name" = "--all" ]; then
  latest_all
  fi

lib/utils.bash

@@ -896,3 +896,15 @@ get_plugin_remote_gitref() {
  plugin_path="$(get_plugin_path "$plugin_name")"
  git --git-dir "$plugin_path/.git" rev-parse --short HEAD 2>/dev/null
 }
+
+# @description Returns true if any arguments is '-h' or '--help'
+has_help_flag() {
+ local arg=
+ for arg in "$@"; do
+ case $arg in
+ -h | --help) return 0 ;;
+ esac
+ done
+
+ return 1
+}

test/banned_commands.bats

@@ -87,6 +87,7 @@ teardown() {
  | grep -v '#.*$cmd'\
  | grep -v '\".*$cmd.*\"' \
  | grep -v '${cmd}_'\
+ | grep -v 'usage: asdf'\
  | grep -v '# asdf_allow: $cmd'"
 
  # Only print output if we've found a banned command

test/current_command.bats

@@ -142,3 +142,9 @@ foobar 1.0.0 $PROJECT_DIR/.tool-versions"
  [ "$status" -eq 0 ]
  [ "$output" = "$expected" ]
 }
+
+@test "current prints help if --help is passed" {
+ run asdf current --help
+ [ "$status" -eq 0 ]
+ [[ "${lines[0]}" == 'usage: '* ]]
+}

test/help_command.bats

@@ -79,3 +79,9 @@ EOF
  [[ $output == *$'UTILS\n'* ]]
  [[ $output == *$'"Late but latest"\n-- Rajinikanth' ]]
 }
+
+@test "help prints help if --help is passed" {
+ run asdf help --help
+ [ "$status" -eq 0 ]
+ [[ "${lines[0]}" == 'usage: '* ]]
+}

test/info_command.bats

@@ -31,3 +31,9 @@ teardown() {
  [[ $output == *$'ASDF INSTALLED PLUGINS:\n'* ]]
 
 }
+
+@test "info prints help if --help is passed" {
+ run asdf info --help
+ [ "$status" -eq 0 ]
+ [[ "${lines[0]}" == 'usage: '* ]]
+}

test/install_command.bats

@@ -310,3 +310,9 @@ EOM
 
  [[ "$output" == *'asdf: Warn:'*'not be preserved'* ]]
 }
+
+@test "install_command prints help if --help is passed" {
+ run asdf install --help
+ [ "$status" -eq 0 ]
+ [[ "${lines[0]}" == 'usage: '* ]]
+}

test/latest_command.bats

@@ -12,6 +12,12 @@ teardown() {
  clean_asdf_dir
 }
 
+@test "[laetst_command] prints help if --help is passed" {
+ run asdf latest --help
+ [ "$status" -eq 0 ]
+ [[ "${lines[0]}" == 'usage: '* ]]
+}
+
 ####################################################
 #### plugin with bin/latest-stable ####
 ####################################################