CyJet - VS Code Extension for Cypress Testing

CyJet is a Visual Studio Code extension designed to streamline your Cypress test execution workflow. It provides an intuitive interface for running Cypress tests directly from VS Code, with support for both GUI and headless modes.

Features

Spec File Search

• Search and filter Cypress spec files directly from the sidebar
• Real-time filtering as you type

Test Explorer

• View all Cypress spec files in your project
• Select individual spec files for targeted testing
• Run selected tests with a single click

Browser Selection

• Choose from multiple browsers for test execution:
  • Chrome
  • Firefox
  • Edge
  • Electron (default)

Run Mode Options

• Run tests in headless mode (default)
• Run tests in headed (GUI) mode

Environment Variables

• Set custom environment variables for your Cypress tests
• Variables are passed to Cypress using the --env flag
• Support for multiple variables (one per line)

Cypress Configurations

• Set custom Cypress configurations for your tests
• Configurations are passed to Cypress using the --config flag
• Support for multiple configurations (one per line)
• Overrides values in your Cypress configuration file

Quick Actions

• Run all tests in the project with a single click
• Open the Cypress Runner GUI for interactive execution
• Access Official Cypress documentation directly from VS Code

Installation

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "CyJet"
4. Click Install

Requirements

• Visual Studio Code 1.85.0 or higher
• Node.js and npm installed
• Cypress project folder is opened in VS Code

Usage

1. Open a Cypress project in VS Code
2. Click on the CyJet icon in the Activity Bar
3. Use the search bar to find specific spec files
4. Select the browser and run mode from the dropdown menus
5. (Optional) Enter environment variables in the textarea (one per line, in the format KEY=VALUE)
6. (Optional) Enter Cypress configurations in the textarea (one per line, in the format KEY=VALUE)
7. Select the spec files you want to run
8. Click the "Run Selected Tests" button to execute the tests

Running All Tests

To run all tests in your project:

1. Make sure no spec files are selected
2. Click the "Run All Tests" button

Using Environment Variables

You can set environment variables for your Cypress tests:

1. Enter each variable on a new line in the environment variables textarea
2. Use the format KEY=VALUE (e.g., NODE_ENV=test)
3. Examples:

   NODE_ENV=test
   DEBUG=cypress:*
   API_URL=https://api.example.com
   

4. These variables will be passed to Cypress using the --env flag

Using Cypress Configurations

You can set Cypress configurations for your tests:

1. Enter each configuration on a new line in the Cypress configurations textarea
2. Use the format KEY=VALUE (e.g., baseUrl=https://example.com)
3. Examples:

   baseUrl=https://example.com
   viewportWidth=1280
   viewportHeight=720
   defaultCommandTimeout=10000
   

4. These configurations will be passed to Cypress using the --config flag and will override the values in your Cypress configuration file

Opening Cypress GUI

To open the Cypress Runner GUI:

1. Navigate to the "MISC" section
2. Click on "Open Cypress Runner GUI"

Extension Settings

This extension contributes the following settings:

• CyJet.openCypressGUI: Open Cypress Runner GUI
• CyJet.openCypressDocs: Open Cypress Documentation
• CyJet.runHeadless: Run Tests in Headless Mode
• CyJet.selectSpec: Select/Deselect Spec
• CyJet.selectRunMode: Select Run Mode
• CyJet.runSelectedTests: Run Selected Tests
• CyJet.runAllTests: Run All Tests

License

This extension is licensed under the MIT License.