README.md

@cypress/chrome-recorder

This repo provides tools to export Cypress Tests from Google Chrome DevTools' Recordings programmatically.

Install Cypress Chrome Recorder extension if you want to export the recordings directly from the Chrome DevTools' Recorder UI.

Prerequisites

In order to export JSON files from Chrome DevTools Recorder you will need to be on Chrome 101 or newer.

dblClick and rightclick require Chrome 103 or newer.

Installation

$ npm install -g @cypress/chrome-recorder

Usage

Via CLI

To use the interactive CLI, run:

$ npx @cypress/chrome-recorder

The CLI will prompt you to enter the path of the directory or file that you would like to modify as well as a path to write the generated Cypress test to.

If you prefer to enter paths via the CLI, you can run the following command to export individual recordings:

$ npx @cypress/chrome-recorder <relative path to target test file>

or for folders containing multiple recordings:

$ npx @cypress/chrome-recorder <relative path to target test folder>/*.json

By default the output will be written to cypress/integration with a fallback to cypress/e2e. If you do not have those folders, create them manually or install Cypress by running yarn add -D cypress or npm install --save-dev cypress in your project.

If you prefer a different output directory, specify that via CLI:

$ npx @cypress/chrome-recorder <relative path to target test folder>/*.json --output=folder-name

or via the interactive CLI prompts.

CLI Options

Option	Description
-f, --force	Bypass Git safety checks and force exporter to run
-d, --dry	Dry run (no changes are made to files)
-o, --output	Output location of the files generated by the exporter
-p, --print	Print transformed files to stdout, useful for development

Via Import

import { cypressStringifyChromeRecording } from '@cypress/chrome-recorder';

const stringifiedContent = await cypressStringifyChromeRecording(
  recordingContent
);

return stringifiedContent;

Supported Chrome Recorder Step Types

Below are the step types that are currently supported:

Type	Description
change	becomes cy.get("element").type("text")
click	becomes cy.get("element").click();
click (right click)	becomes cy.get("element").rightclick();
doubleClick	becomes cy.get("element").dblclick();
hover	becomes cy.get("element").trigger();
keyDown	becomes cy.type("{key}")
keyUp	not exported at this time
navigate	becomes cy.visit("url")
setViewport	becomes cy.viewport(width, height)
scroll	becomes cy.scrollTo(${step.x}, ${step.y})

If a step type is not listed above, then a warning message should be displayed in the CLI.

License

This project is licensed under the terms of the MIT license.