element-hq / element-web

A glossy Matrix collaboration client for the web.
https://element.io
GNU Affero General Public License v3.0
11.23k stars 2k forks source link

Edit `docs/cypress.md` to explain `percySnapshotElement` #24749

Closed luixxiul closed 7 months ago

luixxiul commented 1 year ago

Your use case

What would you like to do?

This part of docs/cypress.md should explain what percySnapshotElement is and how it should be used.

Why would you like to do it?

Because it is a custom command which is defined on /cypress/support/percy.ts, used widely, and takes care of the issue related to mx_Spinner.

How would you like to achieve it?

Edit https://github.com/matrix-org/matrix-react-sdk/blob/develop/docs/cypress.md#percy-visual-testing

Have you considered any alternatives?

No response

Additional context

No response

richvdh commented 1 year ago

+1. I googled for documentation of percySnapshotElement... and ended up here :(.

For the record, it is an extension of cy.percySnapshot, which sets an option called domTransformation ... which I also can't find any documentation on?

t3chguy commented 7 months ago

Percy tests are gone