From aef1b0fdfb2c1aa40200ae12f9c11a25a6981c4e Mon Sep 17 00:00:00 2001 From: Paul Roebuck Date: Sat, 5 May 2018 10:26:34 -0500 Subject: [PATCH] docs(docs/index.md): Update "mocha.opts" documentation Added information on file content, noting support for comment/blank lines. --- docs/index.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index a5acfc9945..b56610e043 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1257,15 +1257,32 @@ The "HTML" reporter is what you see when running Mocha in the browser. It looks ## `mocha.opts` -Back on the server, Mocha will attempt to load `./test/mocha.opts` as a configuration file of sorts. The lines in this file are combined with any command-line arguments. The command-line arguments take precedence. For example, suppose you have the following `mocha.opts` file: +Back on the server, Mocha will attempt to load `"./test/mocha.opts"` as a +Run-Control file of sorts. + +Beginning-of-line comment support is available; any line _starting_ with a +hash (#) symbol will be considered a comment. Blank lines may also be used. +Any other line will be treated as a command-line argument (along with any +associated option value) to be used as a default setting. Settings should be +specified one per line. + +The lines in this file are prepended to any actual command-line arguments. +As such, actual command-line arguments will take precedence over the defaults. + +For example, suppose you have the following `mocha.opts` file: ```sh +# mocha.opts + --require should --reporter dot --ui bdd ``` -This will default the reporter to `dot`, require the `should` library, and use `bdd` as the interface. With this, you may then invoke `mocha` with additional arguments, here enabling [Growl](http://growl.info) support, and changing the reporter to `list`: +The settings above will default the reporter to `dot`, require the `should` +library, and use `bdd` as the interface. With this, you may then invoke `mocha` +with additional arguments, here enabling [Growl](http://growl.info/) support, +and changing the reporter to `list`: ```sh $ mocha --reporter list --growl