Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webdriverio/chrome-recorder
Generate WebdriverIO Tests from Google Chrome DevTools Recordings.
https://github.com/webdriverio/chrome-recorder
chrome chrome-extension recorder wdio webdriverio
Last synced: 3 months ago
JSON representation
Generate WebdriverIO Tests from Google Chrome DevTools Recordings.
- Host: GitHub
- URL: https://github.com/webdriverio/chrome-recorder
- Owner: webdriverio
- License: mit
- Created: 2022-08-18T22:52:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T14:21:45.000Z (10 months ago)
- Last Synced: 2024-04-14T07:11:15.452Z (10 months ago)
- Topics: chrome, chrome-extension, recorder, wdio, webdriverio
- Language: TypeScript
- Homepage: https://webdriver.io
- Size: 2.95 MB
- Stars: 28
- Watchers: 4
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
WebdriverIO Chrome Recorder [](https://github.com/webdriverio/chrome-recorder/actions/workflows/build.yml)
[![npm][npm-badge]][npm]
===========================
This repo provide tools to convert JSON user flows from [Google Chrome DevTools Recorder](https://goo.gle/devtools-recorder) to WebdriverIO test scripts programmatically (WebdriverIO `v7.24.0` or higher required).
✅ Converts multiple recordings to WebdriverIO tests in one go (out-of-the-box glob support)
🗂 User can pass their custom path to export tests.
💃 Users can also use a dry run to see the interim output of the recordings
👨💻 Programmatic API which users can use in their own project to create plugins or custom scripts.
Alternatively, you can export JSON user flows as WebdriverIO test scripts straight away from Chrome DevTools with our [WebdriverIO Recorder Chrome extension](https://chrome.google.com/webstore/detail/webdriverio-chrome-record/pllimkccefnbmghgcikpjkmmcadeddfn).
## 🏗 Installation
```sh
npm install -g @wdio/chrome-recorder
```
## 🚀 Usage
To quickly run the interactive CLI, run:
```sh
npx @wdio/chrome-recorder
```
> The CLI will prompt you to enter the path of directory or file of the chrome devtool recordings that you will modify and path to write the generated WebdriverIO tests
**⚡️ Transform individual recordings**
```sh
npx @wdio/chrome-recorder
```
**⚡️ Transform multiple recordings**
```sh
npx @wdio/chrome-recorder *.json
```
👉 By default output will be written to `webdriverio` folder. If you don't have these folders, tool will create it for you or install WebdriverIO by running `npm init webdriverio` in your project.
You can specify different output directory, specify that via CLI:
```sh
npx @wdio/chrome-recorder --output=
```
## ⚙️ CLI Options
| Option | Description |
| ------------ | ------------------------------------------------------ |
| -d, --dry | Dry run the output of the transformed recordings |
| -o, --output | Output location of the files generated by the exporter |
## 💻 Programmatic API
```javascript
import { stringifyChromeRecording } from '@wdio/chrome-recorder';
const recordingContent = {
title: 'recording',
steps: [
{
type: 'setViewport',
width: 1905,
height: 223,
deviceScaleFactor: 1,
isMobile: false,
hasTouch: false,
isLandscape: false,
},
],
};
const stringifiedContent = await stringifyChromeRecording(
JSON.stringify(recordingContent),
);
console.log(stringifiedContent);
// Console Log output
//
// describe('recording', function () {
// it('tests recording', function (browser) {
// browser.setWindowRect({ width: 1905, height: 223 });
// });
// });
```
## 🐛 Issues
Issues with this schematic can filed [here](https://github.com/webdriverio/chrome-recorder/issues)
If you want to contribute (or have contributed in the past), feel free to add yourself to the list of contributors in the package.json before you open a PR!
## 👨💻 Development
### Getting started
🛠️ [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) are required for the scripts. Make sure it's installed on your machine.
⬇️ **Install** the dependencies for the WebdriverIO chrome recorder tool
```bash
npm install
```
👷♂️ **Build** the tools using typescript compiler
```bash
npm run build
```
🏃 **Run** the tool
```bash
./bin/wdio-chrome-recorder.js
```
### 🧪 Unit Testing
Run the unit tests using mocha as a runner and test framework
```bash
npm run test
```
### ♻️ Clean build files
```bash
npm run clean
```
## Supported Chrome Devtools Recorder Steps
WebdriverIO supports all existing [StepTypes](https://github.com/puppeteer/replay/blob/bcee5b54d94ae3fa1398c41d9166892da617eaad/docs/api/enums/Schema.StepType.md). If any step type seems to be missing, please raise an issue so we can add it. Thanks!
[npm-badge]: https://img.shields.io/npm/v/@wdio/chrome-recorder.svg
[npm]: https://www.npmjs.com/package/@wdio/chrome-recorder
---
For more information on WebdriverIO see the [homepage](https://webdriver.io). The initial implementation was inspired by [Nightwatch Chrome Recorder](https://github.com/nightwatchjs/nightwatch-chrome-recorder)