github.com/fnando/bolt@v0.0.4-0.20231107225351-5241e4d187b8/test/expected/run-help.txt (about)

     1  
     2  Run tests by wrapping "go tests".
     3  
     4    Usage: bolt [options] [packages...] -- [additional "go test" arguments]
     5  
     6    Options:
     7      --compat                           Don't append -fullpath, available on go 1.21 or new (default to false)
     8      --coverage-count=COUNT             Number of coverate items to show (default to 10)
     9      --coverage-threshold=THRESHOLD     Anything below this threshold will be listed (default to 100)
    10      --env=ENV                          Load env file (default to .env.test)
    11      --hide-coverage                    Don't display the coverage section (default to false)
    12      --hide-slowest                     Don't display the slowest tests section (default to false)
    13      --no-color                         Disable colored output. When unset, respects the NO_COLOR=1 env var (default to false)
    14      --post-run-command=COMMAND         Run a command after runner is done
    15      --raw                              Don't append arguments to `go test` (default to false)
    16      --slowest-count=COUNT              Number of slowest tests to show (default to 10)
    17      --slowest-threshold=THRESHOLD      Anything above this threshold will be listed. Must be a valid duration string (default to 1s)
    18  
    19  
    20    Available reporters:
    21      progress
    22        Print a character for each test, with a test summary and list of
    23        failed/skipped tests.
    24  
    25      json
    26        Print a JSON representation of the bolt state.
    27  
    28  
    29    How it works:
    30      This is what bolt runs if you execute "bolt ./...":
    31  
    32      $ go test ./... -cover -json -fullpath
    33  
    34      You can pass additional arguments to the "go test" command like this:
    35  
    36      $ bolt ./... -- -run TestExample
    37  
    38      These arguments will be appended to the default arguments used by bolt.
    39      The example above would be executed like this:
    40  
    41      $ go test -cover -json -fullpath -run TestExample ./...
    42  
    43      To execute a raw "go test" command, use the switch --raw. This will avoid
    44      default arguments from being added to the final execution. In practice, it
    45      means you'll need to run the whole command:
    46  
    47      $ bolt --raw -- ./some_module -run TestExample
    48  
    49      Note: -fullpath was introduced on go 1.21. If you're using an older
    50      version, you can use --compat or manually set arguments by using --raw.
    51  
    52  
    53    Env files:
    54      bolt will load .env.test by default. You can also set it to a
    55      different file by using --env. If you want to disable env files
    56      completely, use --env=false.
    57  
    58  
    59    Color:
    60      bolt will output colored text based on ANSI colors. By default, the
    61      following env vars will be used and you can override any of them to set
    62      a custom color:
    63  
    64      export BOLT_TEXT_COLOR="30"
    65      export BOLT_FAIL_COLOR="31"
    66      export BOLT_PASS_COLOR="32"
    67      export BOLT_SKIP_COLOR="33"
    68      export BOLT_DETAIL_COLOR="34"
    69  
    70      To disable colored output you can use "--no-color" or
    71      set the env var NO_COLOR=1.
    72  
    73  
    74    Progress reporter:
    75      You can override the default progress symbols by setting env vars. The
    76      following example shows how to use emojis instead:
    77  
    78      export BOLT_FAIL_SYMBOL=❌
    79      export BOLT_PASS_SYMBOL=⚡️
    80      export BOLT_SKIP_SYMBOL=😴
    81  
    82  
    83    Post run command:
    84      You can run any commands after the runner is done by using
    85      --post-run-command. The command will receive the following environment
    86      variables.
    87  
    88      BOLT_SUMMARY
    89        a text summarizing the tests
    90      BOLT_TITLE
    91        a text that can be used as the title (e.g. Passed!)
    92      BOLT_TEST_COUNT
    93        a number representing the total number of tests
    94      BOLT_FAIL_COUNT
    95        a number representing the total number of failed tests
    96      BOLT_PASS_COUNT
    97        a number representing the total number of passing tests
    98      BOLT_SKIP_COUNT
    99        a number representing the total number of skipped tests
   100      BOLT_BENCHMARK_COUNT
   101        a number representing the total number of benchmarks
   102      BOLT_ELAPSED
   103        a string representing the duration (e.g. 1m20s)
   104      BOLT_ELAPSED_NANOSECONDS
   105        an integer string representing the duration in nanoseconds
   106