Show CLI help when user passed unknown option

[bahmutov]

Feature

All versions of Cypress

When a user passes unknown CLI option we just die.

$(npm bin)/cypress open --foo

  error: unknown option `--foo'

First, the quotes are wrong around --foo, second we should display help message right away to show the right options for that command. Simple to do by replacing commander method

commander.Command.prototype.unknownOption = function(flag) {
  if (this._allowUnknownOption) return;
  console.error();
  console.error("  error: unknown option '%s'", flag);
  console.error();
  this.outputHelp()
  process.exit(1);
};

[slawiko]

Is this issue about DO NOT FAIL IF PASSED UNKNOWN OPTION? I think CLI shouldn't fail in such cases. What about you?

[bahmutov]

No, this issue is just that it is not enough to say "wrong option" and exit with error code 1, but the app needs to show valid options and then exit with error code 1. Exiting with error is good - otherwise the user will never know they are doing something wrong.

[bahmutov]

Here is the fixed output

$ npm run cypress:open -- --foo

> cypress@2.1.0 cypress:open /Users/gleb/git/cypress
> node ./cli/bin/cypress open --dev --global "--foo"


  error: unknown option '--foo'


  Usage: open [options]

  Opens Cypress in the interactive GUI.


  Options:

    -p, --port <port>             runs Cypress on a specific port. overrides any value in cypress.json.
    -e, --env <env>               sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json
    -c, --config <config>         sets configuration values. separate multiple values with a comma. overrides any value in cypress.json.
    -d, --detached [bool]         runs Cypress application in detached mode
    -P, --project <project path>  path to the project
    --global                      force Cypress into global mode as if its globally installed
    --dev                         runs cypress in development and bypasses binary check
    -h, --help                    output usage information
npm ERR! code ELIFECYCLE
npm ERR! errno 1

[brian-mann]

Released in 3.0.0.