Skip to content

Commit

Permalink
update cli doc
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Feb 23, 2021
1 parent 2aa497c commit f7c7c58
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/src/content/docs/cli/index.md
Expand Up @@ -19,7 +19,7 @@ information.
Usage:
tap [options] [<files>]
tap v15.0.0-1 - A Test-Anything-Protocol library for JavaScript
tap v15.0.0-2 - A Test-Anything-Protocol library for JavaScript
Executes all the files and interprets their output as TAP formatted test result
data. If no files are specified, then tap will search for testy-looking files,
Expand Down Expand Up @@ -405,6 +405,22 @@ Other Options:
Run 'tap --dump-config' to see available options and
formatting.
--libtap-settings=<module>
A module which exports an object of fields to assign
onto 'libtap/settings'. These are advanced
configuration options for modifying the behavior of
tap's internal runtime.
Module path is resolved relative to the current working
directory.
Allowed fields: rmdirRecursive, rmdirRecursiveSync,
StackUtils, stackUtils, output, snapshotFile.
See libtap documentation for expected values and usage.
https://github.com/tapjs/libtap
-o<file> --output-file=<file>
Send the raw TAP output to the specified file. Reporter
output will still be printed to stdout, but the file
Expand Down Expand Up @@ -439,6 +455,10 @@ Environment Variables:
TAP_RCFILE A yaml formatted file which can set any of the above
options. Defaults to ./.taprc
TAP_LIBTAP_SETTINGS A path (relative to current working directory) of a
file that exports fields to override the default libtap
settings
TAP_TIMEOUT Default value for --timeout option.
TAP_COLORS Set to '1' to force color output, or '0' to prevent
Expand Down

0 comments on commit f7c7c58

Please sign in to comment.