Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

misc: correct CLI help typo for cypress open --global #30532

Merged

Conversation

MikeMcC399
Copy link
Contributor

Additional details

Executing the following Cypress CLI command shows a grammatical error:

$ npx cypress open -h

...

  --global                         force Cypress into global mode as if its globally installed

...

Steps to test

yarn
yarn build
cd cli/build
yarn pack

cd to cypress-example-kitchensink

npm install ~/{your-dirs}/cypress/cli/build/cypress-v13.13.2.tgz --ignore-scripts

How has the user experience changed?

BEFORE

$ npx cypress open -h
Usage: cypress open [options]

Opens Cypress in the interactive GUI.

Options:
  -b, --browser <browser-path>     runs Cypress in the browser with the given name. if a filesystem path is supplied, Cypress will
                                   attempt to use the browser at that path.
  --component                      runs component tests
  -c, --config <config>            sets configuration values. separate multiple values with a comma. overrides any value in
                                   cypress.config.{js,ts,mjs,cjs}.
  -C, --config-file <config-file>  path to script file where configuration values are set. defaults to
                                   "cypress.config.{js,ts,mjs,cjs}".
  -d, --detached [bool]            runs Cypress application in detached mode
  --e2e                            runs end to end tests
  -e, --env <env>                  sets environment variables. separate multiple values with a comma. overrides any value in
                                   cypress.config.{js,ts,mjs,cjs} or cypress.env.json
  --global                         force Cypress into global mode as if its globally installed
  -p, --port <port>                runs Cypress on a specific port. overrides any value in cypress.config.{js,ts,mjs,cjs}.
  -P, --project <project-path>     path to the project
  --dev                            runs cypress in development and bypasses binary check
  -h, --help                       display help for command

AFTER

global after

PR Tasks

@cypress-app-bot
Copy link
Collaborator

@jennifer-shehane jennifer-shehane merged commit 4ff3b2b into cypress-io:develop Nov 4, 2024
69 checks passed
@MikeMcC399 MikeMcC399 deleted the issue-30531-cli-help-grammar branch November 4, 2024 16:53
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Nov 5, 2024

Released in 13.15.2.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v13.15.2, please open a new issue.

@cypress-bot cypress-bot bot locked as resolved and limited conversation to collaborators Nov 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong grammar in help for CLI cypress open --global
4 participants