cypress-commands

Cypress commands

A collection of high-quality Cypress commands to complement and extend the defaults.

This repository is not maintained by the Cypress developers. This means we can choose to ignore parts of their vision.

Documentation is a cornerstone of Cypress, the commands in this repository will try to keep these documentation standards.

Cypress version

cypress-commands should work with the latest version of Cypress. If this is not the case, please open an issue.

It's tested against multiple versions of Cypress. See the CI definition for the most up-to-date list.

Installation

Install the module.

npm install cypress-commands

Add the following line to cypress/support/index.js.

require('cypress-commands');

Type definitions

Import typescript definitions by adding them to your tsconfig.json. Add the cypress-commands types before the Cypress types so intellisense will prefer the cypress-commands versions of extended commands.

{
  "compilerOptions": {
    "types": ["cypress-commands", "cypress"]
  }
}

Known issue: cypress.config.ts limitation

Due to the way Cypress defines its types, it's currently not possible for plugin authors to extend the Cypress config types.

Because of this limitation, it's not possible to set the requestBaseUrl option in cypress.config.ts. For the time being, you can work around this limitation by using cypress.config.js instead.

See https://github.com/cypress-io/cypress/issues/22127 for more details.

Extended commands

These commands have been extended to be able to do more than originally intended. For these commands, all tests that exist in the Cypress repository are copied to make sure the default behaviour stays identical unless we want it changed.

• .request()
• .then()

Added commands

These commands do not exist in Cypress by default.

• .attribute()
• .text()
• .to()

Contributing

Contributors are always welcome! I don't care if you are a beginner or an expert, all help is welcome.

Running tests

First clone the repository and install the dependencies.

GUI mode

npm start

CLI mode

npm test

Changelog

3.0.0 - 2022-06-06

Breaking changes

Dropped support for node@10

Cypress 10 supports node@16 or up, to simplify CI we're no longer testing with Node@10. It should still work, but it's no longer guaranteed.

Dropped support for Cypress@<=9

Cypress 10 introduces a new configuration format. To simplify CI we're no longer testing with Cypress@9 or lower. It should still work, but it's no longer guaranteed.

If you're not ready to upgrade to Cypress 10 yet, stick to cypress-commands@2.

Changes

Added support for Cypress@10

Cypress 10 introduces breaking changes to the plugin system. None of these breaking changes have impact on cypress-commands. Changes to ensure support for Cypress@10 are mainly documentation changes.