pashage

commit d636dc7d8fdd54ce6a2ef7844a76bbbcff7d36f4
parent 6cba32c265a0089e11ff6aff7f0ae2363a2dd545
Author: Natasha Kerensikova <natgh@instinctive.eu>
Date:   Sun, 30 Nov 2025 22:47:40 +0000

Verbosity of usage command is a parameter
Diffstat:
M
spec/pashage_extra_spec.sh
 | 
12
++++++++++--
M
spec/usage_spec.sh
 | 
4
++--
M
src/pashage.sh
 | 
43
+++++++++++++++++++++++--------------------

3 files changed, 35 insertions(+), 24 deletions(-)
diff --git a/spec/pashage_extra_spec.sh b/spec/pashage_extra_spec.sh
@@ -1652,15 +1652,23 @@ Describe 'Integrated Command Functions'
   Describe 'cmd_usage'
     It 'defaults to four-space indentation'
       PROGRAM=prg
+      When call cmd_usage no
+      The status should be success
+      The error should be blank
+      The output should equal "$(cmd_usage no '    ')"
+    End
+
+    It 'defaults to verbose four-space indentation'
+      PROGRAM=prg
       When call cmd_usage
       The status should be success
       The error should be blank
-      The output should equal "$(cmd_usage '    ')"
+      The output should equal "$(cmd_usage yes '    ')"
     End
 
     It 'fails with an unknown command'
       PROGRAM=prg
-      When run cmd_usage 'Usage: ' bad version
+      When run cmd_usage no 'Usage: ' bad version
       The status should equal 1
       The output should be blank
       The error should equal 'cmd_usage: unknown command "bad"'
diff --git a/spec/usage_spec.sh b/spec/usage_spec.sh
@@ -1218,7 +1218,7 @@ Describe 'Command-Line Parsing'
       result() {
         %text | @sed 's/\$$//'
         #|$ cmd_version
-        #|$ cmd_usage     $
+        #|$ cmd_usage yes     $
       }
       When call cmd_help
       The status should be success
@@ -2408,7 +2408,7 @@ Describe 'Command-Line Parsing'
     End
 
     It 'rejects unknown commands'
-      When run cmd_usage '> ' foo
+      When run cmd_usage no '> ' foo
       The output should be blank
       The error should equal 'cmd_usage: unknown command "foo"'
       The status should equal 1
diff --git a/src/pashage.sh b/src/pashage.sh
@@ -1207,13 +1207,13 @@ cmd_copy_move() {
 
 	if [ "${PARSE_ERROR}" = yes ] || [ $# -lt 2 ]; then
 		if [ "${COMMAND}" = "c${COMMAND#c}" ]; then
-			cmd_usage 'Usage: ' copy >&2
+			cmd_usage no 'Usage: ' copy >&2
 			exit 1
 		elif [ "${COMMAND}" = "m${COMMAND#m}" ]; then
-			cmd_usage 'Usage: ' move >&2
+			cmd_usage no 'Usage: ' move >&2
 			exit 1
 		else
-			cmd_usage 'Usage: ' copy move >&2
+			cmd_usage no 'Usage: ' copy move >&2
 			exit 1
 		fi
 	fi
@@ -1271,7 +1271,7 @@ cmd_delete() {
 	done
 
 	if [ "${PARSE_ERROR}" = yes ] || [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' delete >&2
+		cmd_usage no 'Usage: ' delete >&2
 		exit 1
 	fi
 	unset PARSE_ERROR
@@ -1285,7 +1285,7 @@ cmd_delete() {
 
 cmd_edit() {
 	if [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' edit >&2
+		cmd_usage no 'Usage: ' edit >&2
 		exit 1
 	fi
 
@@ -1308,7 +1308,7 @@ cmd_find() {
 	esac
 
 	if [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' find >&2
+		cmd_usage no 'Usage: ' find >&2
 		exit 1
 	fi
 
@@ -1394,7 +1394,7 @@ cmd_generate() {
 	done
 
 	if [ "${PARSE_ERROR}" = yes ] || [ $# -eq 0 ] || [ $# -gt 3 ]; then
-		cmd_usage 'Usage: ' generate >&2
+		cmd_usage no 'Usage: ' generate >&2
 		exit 1
 	fi
 
@@ -1434,7 +1434,7 @@ cmd_git() {
 
 cmd_grep() {
 	if [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' grep >&2
+		cmd_usage no 'Usage: ' grep >&2
 		exit 1
 	fi
 
@@ -1461,7 +1461,7 @@ cmd_gitconfig() {
 cmd_help() {
 	cmd_version
 	printf '\n'
-	cmd_usage '    '
+	cmd_usage yes '    '
 }
 
 cmd_init() {
@@ -1522,7 +1522,7 @@ cmd_init() {
 	done
 
 	if [ "${PARSE_ERROR}" = yes ] || [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' init >&2
+		cmd_usage no 'Usage: ' init >&2
 		exit 1
 	fi
 
@@ -1578,7 +1578,7 @@ cmd_insert() {
             || [ $# -lt 1 ] \
             || [ "${ECHO}${MULTILINE}" = yesyes ]
 	then
-		cmd_usage 'Usage: ' insert >&2
+		cmd_usage no 'Usage: ' insert >&2
 		exit 1
 	fi
 	unset PARSE_ERROR
@@ -1653,13 +1653,13 @@ cmd_list_or_show() {
 
 	if [ "${PARSE_ERROR}" = yes ]; then
 		if [ "${COMMAND}" = "l${COMMAND#l}" ]; then
-			cmd_usage 'Usage: ' list >&2
+			cmd_usage no 'Usage: ' list >&2
 			exit 1
 		elif [ "${COMMAND}" = "s${COMMAND#s}" ]; then
-			cmd_usage 'Usage: ' show >&2
+			cmd_usage no 'Usage: ' show >&2
 			exit 1
 		else
-			cmd_usage 'Usage: ' list show >&2
+			cmd_usage no 'Usage: ' list show >&2
 			exit 1
 		fi
 	fi
@@ -1687,7 +1687,7 @@ cmd_move() {
 
 cmd_random() {
 	if [ $# -gt 2 ]; then
-		cmd_usage 'Usage: ' random >&2
+		cmd_usage no 'Usage: ' random >&2
 		exit 1
 	fi
 
@@ -1728,7 +1728,7 @@ cmd_reencrypt() {
 	done
 
 	if [ "${PARSE_ERROR}" = yes ] || [ $# -eq 0 ]; then
-		cmd_usage 'Usage: ' reencrypt >&2
+		cmd_usage no 'Usage: ' reencrypt >&2
 		exit 1
 	fi
 
@@ -1743,9 +1743,13 @@ cmd_reencrypt() {
 }
 
 # Outputs the whole usage text
-#   $1: indentation
+#   $1: output help text after command syntax when "yes"
+#   $2: indentation
 #   ... commands to document
 cmd_usage(){
+	VERBOSE="${1-yes}"
+	shift
+
 	if [ $# -eq 0 ]; then
 		F='    '
 		I='    '
@@ -1764,9 +1768,6 @@ cmd_usage(){
 		echo 'Usage:'
 		set -- list show copy delete edit find generate git gitconfig \
 		    grep help init insert move random reencrypt version
-		VERBOSE=yes
-	else
-		VERBOSE=no
 	fi
 
 	NON_BLANK="${PROGRAM}"
@@ -1948,6 +1949,8 @@ EOF
 
 		F="${I}"
 	done
+
+	unset VERBOSE
 }
 
 cmd_version() {