[nongnu] elpa/buttercup 11d7fdc 148/340: Add "--help" option to buttercup command-line script

[ELPA Syncer]

branch: elpa/buttercup
commit 11d7fdce9f46eec62ed86f4f9617e04d2c204b3a
Author: Ryan C. Thompson <rct@thompsonclan.org>
Commit: Jorgen Schäfer <Jorgen.Schaefer@gmail.com>

    Add "--help" option to buttercup command-line script
---
 bin/buttercup | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/bin/buttercup b/bin/buttercup
index 9f63e69..ede0c51 100755
--- a/bin/buttercup
+++ b/bin/buttercup
@@ -7,12 +7,57 @@ else
     EMACS_BIN="${EMACS:-emacs}"
 fi
 
+usage () {
+    cat <<EOF
+$0 [OPTIONS] [DIRS]
+
+Buttercup will search recursively in each of DIRS for test files (any
+elisp file starting with "test-" or ending with "-test.el" or
+"-tests.el"). It will load all of those files and then run the tests
+defined in those files. If no directories are specified, buttercup
+will search in the current directory.
+
+Options can include the options described below, as well as the
+standard Emacs options "--directory", "--funcall", "--load", "--eval",
+and "--execute". These Emacs options should be used to ensure that any
+Elisp files required for the tests can be found in Emacs' load path.
+For package testing, "-L ." is commonly used. See "emacs --help" for
+more information on Emacs options.
+
+Buttercup options:
+
+--pattern, -p PATTERN   Only run tests with names matching PATTERN.
+                          This option can be used multiple times, in
+                          which case tests will be run if they match
+                          any of the given patterns.
+
+--no-color, -c          Do not colorize test output.
+
+--traceback STYLE       When printing backtraces for errors that occur
+                          during tests, print them in the chosen
+                          STYLE. Available styles are "full", which
+                          shows the full function call for each stack
+                          frame on a single line, "crop", which
+                          truncates each stack frame to 80 characters
+                          (the default), and "pretty", which uses
+                          Emacs' pretty-printing facilities to print
+                          each stack frame, and also annotates each
+                          frame with a lambda or M to indicate whether
+                          it is a normal function call or a
+                          macro/special form.
+EOF
+}
+
 EMACS_ARGS=()
 BUTTERCUP_ARGS=()
 
 while [[ "$#" -gt 0 ]]
 do
     case "$1" in
+        "-h"|"--help")
+            usage
+            exit
+            ;;
         "-L"|"--directory"|"-f"|"--funcall"|"-l"|"--load"|"--eval"|"--execute")
             EMACS_ARGS+=("$1")
             EMACS_ARGS+=("$2")
@@ -29,6 +74,12 @@ do
             BUTTERCUP_ARGS+=("$1")
             shift
             ;;
+        "--traceback")
+            BUTTERCUP_ARGS+=("$1")
+            BUTTERCUP_ARGS+=("$2")
+            shift
+            shift
+            ;;
         *)
             BUTTERCUP_ARGS+=("$1")
             shift