doctest

FORK: The fastest feature-rich C++11/14/17/20 single-header testing framework
git clone https://git.neptards.moe/neptards/doctest.git
Log | Files | Refs | README

help.txt (3798B)


      1 [doctest]
      2 [doctest] boolean values: "1/on/yes/true" or "0/off/no/false"
      3 [doctest] filter  values: "str1,str2,str3" (comma separated strings)
      4 [doctest]
      5 [doctest] filters use wildcards for matching strings
      6 [doctest] something passes a filter if any of the strings in a filter matches
      7 [doctest]
      8 [doctest] ALL FLAGS, OPTIONS AND FILTERS ALSO AVAILABLE WITH A "dt-" PREFIX!!!
      9 [doctest]
     10 [doctest] Query flags - the program quits after them. Available:
     11 
     12  -?,   --help, -h                      prints this message
     13  -v,   --version                       prints the version
     14  -c,   --count                         prints the number of matching tests
     15  -ltc, --list-test-cases               lists all matching tests by name
     16  -lts, --list-test-suites              lists all matching test suites
     17  -lr,  --list-reporters                lists all registered reporters
     18 
     19 [doctest] The available <int>/<string> options/filters are:
     20 
     21  -tc,  --test-case=<filters>           filters     tests by their name
     22  -tce, --test-case-exclude=<filters>   filters OUT tests by their name
     23  -sf,  --source-file=<filters>         filters     tests by their file
     24  -sfe, --source-file-exclude=<filters> filters OUT tests by their file
     25  -ts,  --test-suite=<filters>          filters     tests by their test suite
     26  -tse, --test-suite-exclude=<filters>  filters OUT tests by their test suite
     27  -sc,  --subcase=<filters>             filters     subcases by their name
     28  -sce, --subcase-exclude=<filters>     filters OUT subcases by their name
     29  -r,   --reporters=<filters>           reporters to use (console is default)
     30  -o,   --out=<string>                  output filename
     31  -ob,  --order-by=<string>             how the tests should be ordered
     32                                        <string> - [file/suite/name/rand/none]
     33  -rs,  --rand-seed=<int>               seed for random ordering
     34  -f,   --first=<int>                   the first test passing the filters to
     35                                        execute - for range-based execution
     36  -l,   --last=<int>                    the last test passing the filters to
     37                                        execute - for range-based execution
     38  -aa,  --abort-after=<int>             stop after <int> failed assertions
     39  -scfl,--subcase-filter-levels=<int>   apply filters for the first <int> levels
     40 
     41 [doctest] Bool options - can be used like flags and true is assumed. Available:
     42 
     43  -s,   --success=<bool>                include successful assertions in output
     44  -cs,  --case-sensitive=<bool>         filters being treated as case sensitive
     45  -e,   --exit=<bool>                   exits after the tests finish
     46  -d,   --duration=<bool>               prints the time duration of each test
     47  -m,   --minimal=<bool>                minimal console output (only failures)
     48  -q,   --quiet=<bool>                  no console output
     49  -nt,  --no-throw=<bool>               skips exceptions-related assert checks
     50  -ne,  --no-exitcode=<bool>            returns (or exits) always with success
     51  -nr,  --no-run=<bool>                 skips all runtime doctest operations
     52  -ni,  --no-intro=<bool>               omit the framework intro in the output
     53  -nv,  --no-version=<bool>             omit the framework version in the output
     54  -nc,  --no-colors=<bool>              disables colors in output
     55  -fc,  --force-colors=<bool>           use colors even when not in a tty
     56  -nb,  --no-breaks=<bool>              disables breakpoints in debuggers
     57  -ns,  --no-skip=<bool>                don't skip test cases marked as skip
     58  -gfl, --gnu-file-line=<bool>          :n: vs (n): for line numbers in output
     59  -npf, --no-path-filenames=<bool>      only filenames and no paths in output
     60  -nln, --no-line-numbers=<bool>        0 instead of real line numbers in output
     61 
     62 [doctest] for more information visit the project documentation
     63