Replace cypress open, cypress run references with appropriate command

[flotwig]

Current behavior:

Cypress recommends users to run cypress open or cypress run in different ways. For example:

cypress/packages/desktop-gui/src/update/update-banner.jsx

Lines 82 to 95 in ad70513

	<ol>
	<li>
	<span>Quit this app.</span>
	</li>
	<li>
	<span>If using npm, run <code>npm install --save-dev cypress@{appStore.newVersion}</code></span>
	<br/>
	<span>If using yarn, run <code>yarn add cypress@{appStore.newVersion}</code></span>
	</li>
	<li>
	<span>Run <a href='#' onClick={this._openCyOpenDoc}><code>node_modules/.bin/cypress open</code></a> to open the new version.</span>
	</li>
	</ol>

cypress/packages/server/lib/errors.coffee

Lines 127 to 132 in ad70513

	when "NOT_LOGGED_IN"
	"""
	You're not logged in.
	Run `cypress open` to open the Desktop App and log in.
	"""

cypress/packages/desktop-gui/src/runs/runs-list.jsx

Lines 353 to 355 in ad70513

	<pre>
	<code>cypress run --record --key {this.state.recordKey || '<record-key>'}</code>
	</pre>

cypress/packages/desktop-gui/src/settings/record-key.jsx

Lines 126 to 131 in ad70513

	<p className='text-muted'>
	To record, run this command:
	</p>
	<p>
	<pre><code>cypress run --record --key {this.key.id}</code></pre>
	</p>

cypress/packages/server/lib/errors.coffee

Lines 336 to 347 in ad70513

	when "RECORD_KEY_MISSING"
	"""
	You passed the --record flag but did not provide us your Record Key.
	You can pass us your Record Key like this:
	#{chalk.blue("cypress run --record --key <record_key>")}
	You can also set the key as an environment variable with the name CYPRESS_RECORD_KEY.
	https://on.cypress.io/how-do-i-record-runs
	"""

cypress/packages/server/lib/errors.coffee

Lines 362 to 381 in ad70513

	when "PROJECT_ID_AND_KEY_BUT_MISSING_RECORD_OPTION"
	"""
	This project has been configured to record runs on our Dashboard.
	It currently has the projectId: #{chalk.green(arg1)}
	You also provided your Record Key, but you did not pass the --record flag.
	This run will not be recorded.
	If you meant to have this run recorded please additionally pass this flag.
	#{chalk.blue("cypress run --record")}
	If you don't want to record these runs, you can silence this warning:
	#{chalk.yellow("cypress run --record false")}
	https://on.cypress.io/recording-project-runs
	"""

cypress/packages/server/lib/errors.coffee

Lines 382 to 401 in ad70513

	when "CYPRESS_CI_DEPRECATED"
	"""
	You are using the deprecated command: #{chalk.yellow("cypress ci <key>")}
	Please switch and use: #{chalk.blue("cypress run --record --key <record_key>")}
	https://on.cypress.io/cypress-ci-deprecated
	"""
	when "CYPRESS_CI_DEPRECATED_ENV_VAR"
	"""
	1. You are using the deprecated command: #{chalk.yellow("cypress ci")}
	Please switch and use: #{chalk.blue("cypress run --record")}
	2. You are also using the environment variable: #{chalk.yellow("CYPRESS_CI_KEY")}
	Please rename this environment variable to: #{chalk.blue("CYPRESS_RECORD_KEY")}
	https://on.cypress.io/cypress-ci-deprecated
	"""

Desired behavior:

• If the user has node_modules/.bin in their $PATH, recommend cypress [command]
• If the user is using yarn, recommend yarn cypress [command] (this works?)
• If the user has npx, recommend npx cypress [command]
• Else, recommend ./node_modules/.bin/cypress [command]

[sarthakkundra]

Hi. I would like to work on this issue. Can you please confirm if the commands mentioned in the desired behavior are correct? This will be my first open source contribution so I'd appreciate it if you can tell me if I'm doing anything wrong. Thanks.

[flotwig]

@sarthakkundra the only unknown is if yarn cypress ... is the correct invocation for yarn users or not

[sainthkh]

yarn cypress doesn't work when package.json doesn't have the "script" whose name is "cypress".

In yarn 2, there is a yarn dlx command. You can use it for this purpose. And the issue was debated over 2 years at here. And it is not backported and it seems that it will be.

[merceyz]

yarn cypress doesn't work when package.json doesn't have the "script" whose name is "cypress".

That's not true, it will execute the package with that binary name in the project, it wont however go download and install cypress globally to then invoke it

[Celinarabe]

Is this issue still open? If yes, I can work on it! :)

[sainthkh]

@Celinarabe PRs are always welcome!

[devtayls]

Update:

• Some of the files listed in the original issue have been replaced or are no longer extant
• The commands listed in the source have been changed since the issue was posted

File Changes:

/update/update-banner.jsx is now ../update/update-instructions.

cypress/packages/desktop-gui/src/update/update-instructions.jsx

Lines 89 to 90 in 04e854e

	<UpgradeCommand packageManager='npm' command={`npm install --save-dev cypress@${updateStore.newVersion}`} />
	<UpgradeCommand packageManager='yarn' command={`yarn upgrade cypress@${updateStore.newVersion}`} />

The text is now passed to the <UpgradeCommand command={} /> prop.
For npm: npm install --save-dev cypress@{some_version}
For yarn: yarn upgrade cypress@{some_version}

/lib/errors.coffee is now ../lib/errors.js

cypress/packages/server/lib/errors.js

Lines 371 to 381 in 04e854e

	case 'RECORD_KEY_MISSING':
	return stripIndent`\
	You passed the --record flag but did not provide us your Record Key.
	You can pass us your Record Key like this:
	${chalk.blue('cypress run --record --key <record_key>')}
	You can also set the key as an environment variable with the name CYPRESS_RECORD_KEY.
	https://on.cypress.io/how-do-i-record-runs`

cypress/packages/server/lib/errors.js

Lines 395 to 413 in 04e854e

	case 'PROJECT_ID_AND_KEY_BUT_MISSING_RECORD_OPTION':
	return stripIndent`\
	This project has been configured to record runs on our Dashboard.
	It currently has the projectId: ${chalk.green(arg1)}
	You also provided your Record Key, but you did not pass the --record flag.
	This run will not be recorded.
	If you meant to have this run recorded please additionally pass this flag.
	${chalk.blue('cypress run --record')}
	If you don't want to record these runs, you can silence this warning:
	${chalk.yellow('cypress run --record false')}
	https://on.cypress.io/recording-project-runs`

The command text remains the same here as in the OP issue.

Files without changes:

####cypress/packages/desktop-gui/src/settings/record-key.jsx

cypress/packages/desktop-gui/src/runs/runs-list.jsx

Line 324 in 04e854e

const recordCommand = `cypress run --record --key ${this.state.recordKey || '<record-key>'}`

For Further Discussion:

These commands might change in the future, therefore I think it might be wise to store the data in an abstracted format so we can avoid this issue arising again.

Secondly, would it make sense to incorporate some logic to check for the underlying conditions and then show the relevant command to the user? There is already a component in the @cypress/desktop-gui package, that is performing UI logic on the commands. That might be a good basis for the feature extension.

[cypress-app-bot]

This issue has not had any activity in 180 days. Cypress evolves quickly and the reported behavior should be tested on the latest version of Cypress to verify the behavior is still occurring. It will be closed in 14 days if no updates are provided.

[cypress-app-bot]

This issue has been closed due to inactivity.