-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtutorial-04-command-line-options.html
executable file
·243 lines (171 loc) · 13 KB
/
tutorial-04-command-line-options.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Tutorial: Command line options</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Tutorial: Command line options</h1>
<section>
<header>
<h2>Command line options</h2>
</header>
<article>
<p>usage: suman [file/dir] [OPTIONS]</p>
<p>options:
-a, --all Used in conjunction with the --transpile
option, to transpile the whole test
directory to test-target.</p>
<pre class="prettyprint source"><code>--version Print tool version and exit.
-h, --help Print this help and exit.
-v, --verbose Verbose output. Use multiple times for
more verbose.
--vv, --vverbose Very verbose output. There is either
verbose or very verbose (vverbose).
--sparse Sparse output. Less verbose than
standard.
--vsparse Very sparse output. Even less verbose
than sparse option.
--init Initialize Suman in your project;
install it globally first.
--uninstall Uninstall Suman in your project.
--no-runner-lock Don't user runner lock.
--runner-lock Use a global runner lock.
--no-tables No ascii tables will be outputted to
terminal. Accomplished also by
"--vsparse" boolean option.
--use-babel Suman will download and install the
"babel" related dependencies necessary
to transpile to your local project.
--rm-babel, --remove-babel Suman will * uninstall * the "babel"
related dependencies necessary to
transpile to your local project.
--use-server Suman will download and install the
"suman-server" dependencies necessary
for file-watching to your local project.
--use-istanbul Suman will download and install the
Istanbul dependencies necessary to run
test coverage on your local project.
--errors-only Show only errors when logging test
results.
--match=ARG Use this to filter input to match the
given JS regex.
--not-match=ARG Use this to filter input to ignore
matches of the given JS regex.
--register Use babel-core register to transpile
sources on the fly, even in child
processes.
--no-register Prevent usage of babel-register.
--sort-by-millis Prints a duplicate Runner results table
sorted by millis fastest to slowest.
--create=ARG Create suman test skeleton at path.
--coverage Run Suman tests and see coverage report.
--cwd-is-root, --force-cwd-to-be-project-root
Run Suman tests and force cwd to be the
project root.
--cwd-is-tfd, --force-cwd-to-test-file-dir
Will force the cwd for the runner
child_processes to be the directory that
contains the test file.
--tfm=ARG, --test-file-mask=ARG Use this option to specify which of
files.
-r, --recursive Use this option to recurse through
sub-directories of tests.
--safe Reads files in with fs.createReadStream
and makes sure it's a suman test before
running.
-f, --force Force the command at hand.
--ff, --fforce Force the command at hand, with super
double force.
-p, --pipe Pipe data to Suman using stdout to
stdin.
--cnvt, --convert Convert Mocha test file or directory to
Suman test(s).
-b, --bail Bail upon the first test error.
--ignore-break Use this option to aid in the debugging
of child_processes.
--rnr, --runner Sole purpose of this flag is to force
the usage of the runner when executing
only one test file.
-w, --watch Flag to be used so that test files will
be transpiled/run as soon as they are
saved. Starts up the Suman server if it
is not already live,and begins watching
the files desired.
--wp, --watch-project Watch all project files and upon changes
run the script/command given by the
properties of "watchProject" in your
suman.conf.js file.
--swa, --stop-watching-all Flag so that Suman server stops watching
all files for any changes.
--rand, --random Flag to randomize tests.
--testing Internal flag for development purposes.
--sw, --stop-watching Option to tell Suman server to stop
watching the files/directories passed as
arguments.
--mpp=INT, --concurrency=INT Specifiy the maximum number of parallel
child processes.
--src=ARG Specify single path to directory of
Mocha test source files for conversion
to Suman from Mocha.
--dest=ARG Specify single path as dest directory
for conversion to Suman from Mocha.
--reporters=ARG Specify name of reporters to be used
deemed by your config file.
--reporter-paths=ARG Specify reporters by specifying path(s)
to reporter module(s).
--diagnostics Run diagnostics to see if something may
be wrong with your suman.conf.js file
and/or project structure.
-t, --transpile Transpile tests to test-target.
--nt, --no-transpile Useful when the default is set to
transpile:true in your config. Prevents
transpilation and runs test files
directly.
--no-run When --watch and --transpile are set to
true, "--no-run" prevents Suman from
executing the resulting tests, when a
watched file changes onthe filesystem.
In other words, the file will only be
transpiled but not executed as part of
the watch process.
--fst, --full-stack-traces Full stack traces will be shown for all
exceptions, including test failures.
--procs=INT, --processes=INT Override config value for maximum number
of parallel Node.js processes.
-s, --server Start the suman server manually.
--cfg=ARG, --config=ARG Path to the suman.conf.js file you wish
to use.
--gfbn=ARG, --grep-file-base-name=ARG
Regex string used to match file names;
only the basename of the file path.
--no-silent When running a single test file, stdout
will be shown.
--gf=ARG, --grep-file=ARG Regex string used to match file names.
--gs=ARG, --grep-suite=ARG Path to the suman.conf.js file you wish
to use.
--sn=ARG, --server-name=ARG Path to the suman.conf.js file you wish
to use.
--tail Option to tail the suman log files.</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Tutorials</h3><ul><li><a href="tutorial-00-about.html">About Suman</a></li><li><a href="tutorial-01-getting-started.html">Getting Started with Suman</a></li><li><a href="tutorial-02-simple-examples.html">Simple Examples</a></li><li><a href="tutorial-03-high-level-overview.html">Higher Level Overview</a></li><li><a href="tutorial-04-command-line-options.html">Command line options</a></li><li><a href="tutorial-05-advanced-use.html">Advanced Use</a></li><li><a href="tutorial-06-suman-config-file.html">06-suman-config-file</a></li><li><a href="tutorial-07-suman-patterns-and-recipes.html">Suman Patterns and Recipes</a></li><li><a href="tutorial-08-suman-anti-patterns.html">Suman Anti-Patterns</a></li><li><a href="tutorial-09-suman-reporters.html">Suman reporters and creating custom reporters</a></li><li><a href="tutorial-10-dependency-injection.html">10-dependency-injection</a></li><li><a href="tutorial-11-advanced-installation.html">Advanced installation of Suman</a></li><li><a href="tutorial-12-using-suman-with-babel.html">Using Suman with Babel</a></li><li><a href="tutorial-13-test-dir-organization.html">How to organize your test directory</a></li><li><a href="tutorial-14-debugging-suman.html">How to debug Suman tests</a></li><li><a href="tutorial-15-testing-child-processes-with-suman.html">Testing and debugging processes that spawn child processes</a></li><li><a href="tutorial-16-using-spies-with-suman.html">Using test spies with Suman</a></li><li><a href="tutorial-17-suman-server-and-web-reporter.html">About Suman server and built-in web reporter</a></li><li><a href="tutorial-18-tips-and-tricks.html">Tips and tricks</a></li><li><a href="tutorial-19-converting-from-mocha.html">Converting from Mocha to Suman</a></li><li><a href="tutorial-21-running-suman-against-shell-scripts.html">21-running-suman-against-shell-scripts</a></li><li><a href="tutorial-22-case-studies.html">22-case-studies</a></li><li><a href="tutorial-22-programmatic-usage-and-macros.html">22-programmatic-usage-and-macros</a></li><li><a href="tutorial-27-suman-best-practices.html">Best practices with Suman</a></li><li><a href="tutorial-30-anatomy-of-suman-suite.html">Anatomy of Suman Test Suites</a></li><li><a href="tutorial-31-workflows-with-suman.html">Workflows with Suman => Watchers and transpilation</a></li><li><a href="tutorial-40-integrating-with-ci-cd.html">Integrating with CI/CD</a></li><li><a href="tutorial-41-suman-exit-codes.html">List of Suman exit codes</a></li><li><a href="tutorial-42-hidden-secret-features.html">Some secret / hidden features of Suman</a></li><li><a href="tutorial-50-suman-parallelism.html">Complete explanation of Suman parallelism</a></li><li><a href="tutorial-70-usage-with-code-coverage-tools.html">Usage with code coverage tools (namely Istanbul)</a></li><li><a href="tutorial-90-roadmap.html">Suman roadmap and upcoming efforts</a></li><li><a href="tutorial-99-faq.html">FAQ</a></li><li><a href="tutorial-advanced-parallelization-2.html">advanced-parallelization-2</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Feb 08 2017 22:39:23 GMT-0800 (PST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>