grunt-cypress

grunt-cypress

A Grunt wrapper for Cypress, a test runner for your projects

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-cypress cypress --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-cypress');

Usage

Run this task with the grunt cypress command. You can also specify which CLI method to run by passing the method name as an argument grunt cypress:open. By default, if no method name is given, the open method will be called/

Options

This grunt task is not configurable and therefore does not have any options available for use with Grunt. It's merely a Grunt wrapper for the cypress package to allow you to call the Cypress CLI via Grunt. This means that you can pass in any Cypress CLI options like you normally would using command line flags. Do note, it's recommended that you use the double-dash version of flag names to avoid any confusion with Grunt flags. Refer to Cypress's command line docs for a complete list of available flags for all Cypress method. For additional information about Cypress, refer their documentation and/or Github repo to learn more about how to use it within your project, how to setup a cypress.json file, and/or how to write your first test.

Do note that, by default, this grunt task has been configured to use the --detached Cypress CLI flag when running grunt cypress:open to prevent any subsequent grunt tasks from stalling or not running. For use cases where you may need to prevent this behavior, a custom --attached flag has been added to this grunt task, but this --attached flag is not a standard option for the Cypress CLI.