Update HTML examples to conform to scaffolded tests

[cacieprins]

The HTML that gets deployed to example.cypress.io for, e.g., commands, should align with the tests that get scaffolded from cypress/*

[MikeMcC399]

@cacieprins

The HTML that gets deployed to example.cypress.io for, e.g., commands, should align with the tests that get scaffolded from cypress/*

Is this an issue for this repo or for the build and deploy process defined in https://github.com/cypress-io/cypress/tree/develop/packages/example ?

[jennifer-shehane]

@MikeMcC399 It's an issue with this repo. This PR updated the test files: https://github.com/cypress-io/cypress-example-kitchensink/pull/802/files but there is HTML that reflects the code in the test files that should be updated. https://example.cypress.io/commands/actions

[MikeMcC399]

@jennifer-shehane

Thanks for explaining. I see that now that you've provided the details. 👍🏻

• fix: lint errors #802 put the repo into an inconsistent state it seems.

[MikeMcC399]

Perhaps @rubysolo would like to follow up with a related PR to change the HTML to match the tests?

For instance, the following would need to be aligned:

cypress-example-kitchensink/app/commands/actions.html

Lines 80 to 88 in 9755df4

	// .type() with special character sequences
	.type('{leftarrow}{rightarrow}{uparrow}{downarrow}')
	.type('{del}{selectall}{backspace}')
	// .type() with key modifiers
	.type('{alt}{option}') //these are equivalent
	.type('{ctrl}{control}') //these are equivalent
	.type('{meta}{command}{cmd}') //these are equivalent
	.type('{shift}')

cypress-example-kitchensink/cypress/e2e/2-advanced-examples/actions.cy.js

Lines 15 to 23 in 9755df4

	// .type() with special character sequences
	cy.get('.action-email').type('{leftarrow}{rightarrow}{uparrow}{downarrow}')
	cy.get('.action-email').type('{del}{selectall}{backspace}')
	// .type() with key modifiers
	cy.get('.action-email').type('{alt}{option}') //these are equivalent
	cy.get('.action-email').type('{ctrl}{control}') //these are equivalent
	cy.get('.action-email').type('{meta}{command}{cmd}') //these are equivalent
	cy.get('.action-email').type('{shift}')

[rubysolo]

Oh, I assumed those were generated. Would there be any interest in templatizing the example HTML files so that they could be autogenerated from the examples with a script?

[jennifer-shehane]

@rubysolo We don't update these examples very often honestly, so I don't think there'd be a lot of utility with that.

[rubysolo]

One question I had -- the tests no longer call end, since click isn't chainable. Is there a better example of using end that we could use in the tests / docs?

[MikeMcC399]

@rubysolo

One question I had -- the tests no longer call end, since click isn't chainable. Is there a better example of using end that we could use in the tests / docs?

Apparently nobody noticed that the .end test had been deactivated. Although that achieved the goal of passing linting, it was at the expense of no longer demonstrating cy.end.

I've raised the following interrelated issues accordingly:

• API cy.end example fails to run cypress-documentation#5752
• API cy.end example fails linting cypress/unsafe-to-chain-command cypress-documentation#5753
• cy.end() test is inactive #808

[jennifer-shehane]

I'd be in favor of removing the .end example I think.

[cypress-app-bot]

🎉 This issue has been resolved in version 2.0.4 🎉

The release is available on:

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

Your semantic-release bot 📦🚀