feat(skip,test): support hiding output by result category

Author: olets

completions/_ztr

@@ -45,7 +45,8 @@ case $state in
 				# [(--quiet | -q)] <arg> [<name> [<notes>]]
 				_arguments \
 					"(--quiet)--quiet[Silence output]" \
-					"(-q)-q[Silence output]"
+					"(-q)-q[Silence output]" \
+					"(--quiet-skip)-quiet-skip[Silence output]"
 				ret=0
 				;;
 			queue|\
@@ -55,6 +56,8 @@ case $state in
 					"(--emulate)--emulate[Emulate <shell>]" \
 					"(--quiet)--quiet[Silence output]" \
 					"(-q)-q[Silence output]" \
+					"(--quiet-fail)--quiet-fail[Silence output if test fails]" \
+					"(--quiet-pass)--quiet-pass[Silence output if test passes]" \
 					"(--quiet-emulate)--quiet-emulate[Do not warn when a non-zsh shell is emulated.]"
 				ret=0
 				;;

man/man1/ztr.1

@@ -8,15 +8,15 @@ ztr \- zsh test runner
 
 \fBztr clear-summary\fR
 
-\fBztr queue\fR [([((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] | \fI\-\-skip\fR [(\fI\-\-quiet | \-q\fR)]) <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]]\fR
+\fBztr queue\fR [([((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] | \fI\-\-skip\fR [((\fI\-\-quiet | \-q\fR) | \fI\-\-\quiet\-skip\fR)]) <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]]\fR
 
 \fBztr run-queue\fR [(\fI\-\-quiet | \-q\fR)] [<\fIname\fR>]
 
-\fBztr skip\fR [(\fI\-\-quiet | \-q\fR)] <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]\fR
+\fBztr skip\fR [((\fI\-\-quiet | \-q\fR) | \fI\-\-quiet\-skip\fR)] <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]\fR
 
 \fBztr summary\fR
 
-\fBztr test\fR [(\fI\-\-quiet | \-q\fR)] <\fIarg\fR> [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] [<\fIname\fR> [<\fInotes\fR>]]\fR
+\fBztr test\fR [((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] <\fIarg\fR> [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] [<\fIname\fR> [<\fInotes\fR>]]\fR
 
 \fBztr\fR (\fBhelp | \-\-help\fR | \fB\-h\fR)
 
@@ -39,13 +39,13 @@ Clear the queue.
 Clear the summary.
 
 .IP \(bu
-\fBqueue\fR [([((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] | \fI\-\-skip\fR [(\fI\-\-quiet | \-q\fR)]) <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]]\fR
+\fBqueue\fR [([((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] | \fI\-\-skip\fR [((\fI\-\-quiet | \-q\fR) | \fI\-\-\quiet\-skip\fR)]) <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]]\fR
 
 Without arguments: print the queued tests.
 
-With arguments: as `ztr test` but the test is queued rather than run.
+With arguments but not \fI\-\-skip\fR: as \fBtest\fR but queueing rather than running immediately.
 
-\fI\-\-skip\fR queues up a \fBskip\fR command rather than a \fBtest\fR command.
+With arguments and \fI\-\-skip\fR: as \fBskip\fR but queueing rather than running immediately.
 
 .IP \(bu
 \fBrun-queue\fR [(\fI\-\-quiet | \-q\fR)] [<\fIname\fR>]
@@ -61,10 +61,12 @@ If \fIZTR_BOOTSTRAP_FN\fR is defined, it is run before the first queued test.
 If \fIZTR_CLEAN_FN\fR is defined, it is run after the last queued test.
 
 .IP \(bu
-\fBskip\fR [(\fI\-\-quiet | \-q\fR)] <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]\fR
+\fBskip\fR [((\fI\-\-quiet | \-q\fR) | \fI\-\-quiet\-skip\fR)] <\fIarg\fR> [<\fIname\fR> [<\fInotes\fR>]]\fR
 
 Skip <arg>.
 
+Pass \fI\-\-quiet\-skip\fR to output nothing. Set \fIZTR_QUIET_SKIP=1\fR to make this the default.
+
 See \fBtest\fR for details about \fI\-\-quiet\fR, <\fIname\fR>, and <\fInotes\fR>.
 
 .IP \(bu
@@ -73,7 +75,7 @@ See \fBtest\fR for details about \fI\-\-quiet\fR, <\fIname\fR>, and <\fInotes\fR
 Pretty-print summary of results.
 
 .IP \(bu
-\fBtest\fR [(\fI\-\-quiet | \-q\fR)] <\fIarg\fR> [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] [<\fIname\fR> [<\fInotes\fR>]]\fR
+\fBtest\fR [((\fI\-\-quiet | \-q\fR) | [\fI\-\-quiet\-fail\fR] [\fI\-\-quiet\-pass\fR])] <\fIarg\fR> [\fI\-\-emulate\fR <\fIshell\fR>] [\fI\-\-quiet\-emulate\fR] [<\fIname\fR> [<\fInotes\fR>]]\fR
 
 Test <\fIarg\fR>. Pretty-print result and notes unless "quiet".
 
@@ -83,6 +85,12 @@ If your arg will error when passed to `eval`, quote it. If your arg has spaces,
 
 \fI\-\-quiet\-emulate\fR keeps the \fI\-\-emulate\fR <\fIshell\fR>'s <\fIshell\fR> out of the command output.
 
+Pass \fI\-\-quiet\-fail\fR to output nothing if the test fails. Set \fIZTR_QUIET_FAIL=1\fR to make this the default.
+
+Pass \fI\-\-quiet\-pass\fR to output nothing if the test passes. Set \fIZTR_QUIET_PASS=1\fR to make this the default.
+
+Pass \fI\-\-quiet\fR to output nothing regardless of the result.
+
 Optionally pass a <\fIname\fR> as a second parameter.
 
 Optionally pass <\fInotes\fR> as a third parameter (requires that you also pass a <\fIname\fR> as a second parameter). For example, noting dependencies can help with troubleshooting. In the output notes are indented.

ztr.zsh

@@ -127,6 +127,12 @@ __ztr_init() { # Set variables.
 		ZTR_QUIET=${ZTR_QUIET:-0}
 	typeset -gi ZTR_QUIET_EMULATION_MODE >/dev/null && \
 		ZTR_QUIET_EMULATION_MODE=${ZTR_QUIET_EMULATION_MODE:-0}
+	typeset -gi ZTR_QUIET_FAIL >/dev/null && \
+		ZTR_QUIET_FAIL=${ZTR_QUIET_FAIL:-0}
+	typeset -gi ZTR_QUIET_PASS >/dev/null && \
+		ZTR_QUIET_PASS=${ZTR_QUIET_PASS:-0}
+	typeset -gi ZTR_QUIET_SKIP >/dev/null && \
+		ZTR_QUIET_SKIP=${ZTR_QUIET_SKIP:-0}
 
 	# Global read-only string variables
 	typeset -g +r ZTR_PATH && \
@@ -231,7 +237,7 @@ __ztr_skip() { # Skip <arg>.
 	(( ZTR_RESULTS[skipped]++ ))
 	typeset -gAr ZTR_RESULTS
 
-	if (( ! __ztr_quiet )); then
+	if (( ! __ztr_quiet && ! __ztr_quiet_skip )); then
 		'builtin' 'echo' - "${color_skipped}SKIP$color_default ${name:-$arg}${notes:+\\n    $notes}"
 	fi
 }
@@ -315,20 +321,24 @@ __ztr_test() { # Test <arg> [<name> [<notes>]]. Pretty-print result and notes un
 	__ztr_teardown
 
 	if (( exit_code )); then
-		result="${color_failed}FAIL$color_default"
+		if (( ! __ztr_quiet_fail )); then
+			result="${color_failed}FAIL$color_default"
+		fi
 
 		typeset -gA +r ZTR_RESULTS
 		(( ZTR_RESULTS[failed]++ ))
 		typeset -gAr ZTR_RESULTS
 	else
-		result="${color_passed}PASS$color_default"
+		if (( ! __ztr_quiet_pass )); then
+			result="${color_passed}PASS$color_default"
+		fi
 
 		typeset -gA +r ZTR_RESULTS
 		(( ZTR_RESULTS[passed]++ ))
 		typeset -gAr ZTR_RESULTS
 	fi
 
-	if (( ! __ztr_quiet )); then
+	if [[ -n $result ]] && (( ! __ztr_quiet )); then
 		'builtin' 'print' "$result ${name:-$arg}${notes:+\\n    $notes}"
 
 		(( ! __ztr_quiet_emulation_mode )) && [[ $__ztr_emulation_mode_used != zsh ]] \
@@ -352,11 +362,14 @@ ztr() {
 	local -a args exit_code flags
 	local -i clear_queue clear_summary queue run_queue run_test skip_test summary
 	typeset -g __ztr_emulation_mode_requested __ztr_emulation_mode_used
-	typeset -gi __ztr_queue_skip __ztr_quiet __ztr_quiet_emulation_mode
+	typeset -gi __ztr_queue_skip __ztr_quiet __ztr_quiet_emulation_mode __ztr_quiet_fail __ztr_quiet_pass __ztr_quiet_skip
 
 	__ztr_emulation_mode_requested=$ZTR_EMULATION_MODE
-	__ztr_quiet=$ZTR_QUIET
 	__ztr_quiet_emulation_mode=$ZTR_QUIET_EMULATION_MODE
+	__ztr_quiet_fail=$ZTR_QUIET_FAIL
+	__ztr_quiet_pass=$ZTR_QUIET_PASS
+	__ztr_quiet_skip=$ZTR_QUIET_SKIP
+	__ztr_quiet=$ZTR_QUIET
 
 	while (( $# )); do
 		case $1 in
@@ -385,6 +398,21 @@ ztr() {
 				flags+=( "--quiet-emulate" )
 				shift
 				;;
+			"--quiet-fail")
+				__ztr_quiet_fail=1
+				flags+=( "--quiet-fail" )
+				shift
+				;;
+			"--quiet-pass")
+				__ztr_quiet_pass=1
+				flags+=( "--quiet-pass" )
+				shift
+				;;
+			"--quiet-skip")
+				__ztr_quiet_skip=1
+				flags+=( "--quiet-skip" )
+				shift
+				;;
 			"--version"|\
 			"-v"|\
 			"version")