Welcome to Cypress Runner Docs!
¯\_(ツ)_/¯
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. Features
2. Extension Settings
3. Contributing
4. Acknowledgments

Features

Simple way to run a single (or multiple) Cypress tests from Code Lens, automatically adding or removing .only to the single test or block you would like to run

Also available the possibility to remove all .only added from a single button on status bar

(🔝 Back to top 🔝)

Extension Settings

Cypress Runner will work out of the box, with a valid Cypress config.
If you have a custom setup use the following options to configure Cypress Runner:

Command	Description
cypressrunner.templates	Array to control extension behaviour over codeLens
cypressrunner.removeAllOnlyButton
cypressrunner.configPath	Cypress config path (relative to ${workFolder} e.g. cypress-config.json)
cypressrunner.cypressPath	Absolute path to cypress bin file (e.g. /usr/lib/node_modules/cypress/bin/cypress.js)
cypressrunner.projectPath
cypressrunner.runOptions
cypressrunner.cypressCommand	Define an alternative Cypress command (e.g. for Create React App and similar abstractions)
cypressrunner.codeLensSelector	CodeLens will be shown on files matching this pattern (default */.{cy,test,spec}.{js,jsx,ts,tsx})
cypressrunner.changeDirectoryToWorkspaceRoot

(🔝 Back to top 🔝)

Contributing

• Fix Remove All Only button

• Add debug Code Lens

• Add arguments generation on command build

(🔝 Back to top 🔝)

Acknowledgments

Based on VsCode extensions:

• vscode-jest-runner
• add-only

And special thanks to @WanManolo as instigator of this project

@WanManolo

Made with love & passion 🚀

(🔝 Back to top 🔝)