fix(cli): restore command line help contents

[devoto13]

These were lost after migration to yargs as CLI parser.

The only issue I've noticed is that yargs reports all unknown arguments in the error about unknown command, but I guess we can live with it for now:

$ karma bla bla bla

...

Unknown commands: bla, bla, bla

Fixes #3474

[devoto13]

Below are diffs against output of Karma 4.4.1. Most notable difference is that yargs now wraps output at 80 characters. It is configurable, but I think we should stay wit the default as a good practice.

$ karma --help

 Karma - Spectacular Test Runner for JavaScript.

+Run --help with particular command to see its description and available options.
+
 Usage:
   karma <command>

 Commands:
-  start [<configFile>] [<options>] Start the server / do single run.
-  init [<configFile>] Initialize a config file.
-  run [<options>] [ -- <clientArgs>] Trigger a test run.
-  completion Shell completion for karma.
-
-Run --help with particular command to see its description and available options.
+  karma init        Initialize a config file.
+  karma start       Start the server / do a single run.
+  karma run         Trigger a test run.
+  karma stop        Stop the server.
+  karma completion  Shell completion for karma.

 Options:
-  --help     Print usage and options.
-  --version  Print current version.
-
+  --help     Print usage and options.                                  [boolean]
+  --version  Print current version.                                    [boolean]

$ karma init --help

 Karma - Spectacular Test Runner for JavaScript.

 INIT - Initialize a config file.

 Usage:
-  karma init [<configFile>]
+  karma init [configFile]

 Options:
+  --help       Print usage and options.                                [boolean]
   --log-level  <disable | error | warn | info | debug> Level of logging.
   --colors     Use colors when reporting and printing logs.
   --no-colors  Do not use colors when reporting or printing logs.
-  --help       Print usage and options.
-

$ karma start --help

 Karma - Spectacular Test Runner for JavaScript.

 START - Start the server / do a single run.

 Usage:
-  karma start [<configFile>] [<options>]
+  karma start [configFile]

 Options:
+  --help                           Print usage and options.            [boolean]
   --port                           <integer> Port where the server is running.
   --auto-watch                     Auto watch source files and run on change.
   --detached                       Detach the server.
   --no-auto-watch                  Do not watch source files.
-  --log-level                      <disable | error | warn | info | debug> Level of logging.
+  --log-level                      <disable | error | warn | info | debug> Level
+                                   of logging.
   --colors                         Use colors when reporting and printing logs.
-  --no-colors                      Do not use colors when reporting or printing logs.
-  --reporters                      List of reporters (available: dots, progress, junit, growl, coverage).
-  --browsers                       List of browsers to start (eg. --browsers Chrome,ChromeCanary,Firefox).
-  --capture-timeout                <integer> Kill browser if does not capture in given time [ms].
+  --no-colors                      Do not use colors when reporting or printing
+                                   logs.
+  --reporters                      List of reporters (available: dots, progress,
+                                   junit, growl, coverage).
+  --browsers                       List of browsers to start (eg. --browsers
+                                   Chrome,ChromeCanary,Firefox).
+  --capture-timeout                <integer> Kill browser if does not capture in
+                                   given time [ms].
   --single-run                     Run the test when browsers captured and exit.
   --no-single-run                  Disable single-run.
-  --report-slower-than             <integer> Report tests that are slower than given time [ms].
+  --report-slower-than             <integer> Report tests that are slower than
+                                   given time [ms].
   --fail-on-empty-test-suite       Fail on empty test suite.
   --no-fail-on-empty-test-suite    Do not fail on empty test suite.
   --fail-on-failing-test-suite     Fail on failing test suite.
   --no-fail-on-failing-test-suite  Do not fail on failing test suite.
-  --help                           Print usage and options.
-

$ karma run --help

 Karma - Spectacular Test Runner for JavaScript.

 RUN - Run the tests (requires running server).

 Usage:
-  karma run [<configFile>] [<options>] [ -- <clientArgs>]
+  karma run [configFile] [-- <clientArgs>]

 Options:
+  --help                         Print usage and options.              [boolean]
   --port                         <integer> Port where the server is listening.
   --no-refresh                   Do not re-glob all the patterns.
   --fail-on-empty-test-suite     Fail on empty test suite.
   --no-fail-on-empty-test-suite  Do not fail on empty test suite.
-  --help                         Print usage.
-  --log-level                    <disable | error | warn | info | debug> Level of logging.
+  --log-level                    <disable | error | warn | info | debug> Level
+                                 of logging.
   --colors                       Use colors when reporting and printing logs.
-  --no-colors                    Do not use colors when reporting or printing logs.
-
+  --no-colors                    Do not use colors when reporting or printing
+                                 logs.

$ karma stop --help

 Karma - Spectacular Test Runner for JavaScript.

 STOP - Stop the server (requires running server).

 Usage:
-  karma run [<configFile>] [<options>]
+  karma stop [configFile]

 Options:
+  --help       Print usage and options.                                [boolean]
   --port       <integer> Port where the server is listening.
   --log-level  <disable | error | warn | info | debug> Level of logging.
-  --help       Print usage.
-

$ karma completion --help

 Karma - Spectacular Test Runner for JavaScript.

 COMPLETION - Bash/ZSH completion for karma.

 Installation:
   karma completion >> ~/.bashrc

-
 Options:
-  --help  Print usage.
-
+  --help  Print usage and options.                                     [boolean]

$ karma --version

- Karma version: 4.4.1
+ 5.0.4

[karmarunnerbot]

✅ Build karma 258 completed (commit a60214e794 by @devoto13)

[karmarunnerbot]

✅ Build karma 259 completed (commit a60214e794 by @devoto13)

[johnjbarton]

Thanks for the test! Answered my question: "how did this happen" ;-)

[karmarunnerbot]

🎉 This PR is included in version 5.0.5 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀