Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wswebcreation committed Oct 15, 2024
1 parent cf9ddb2 commit 4427257
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions packages/visual-reporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,54 @@ npm install @wdio/visual-reporter --save-dev

## Usage

To build the report you can call the CLI with `npx @wdio/visual-reporter` and answer all questions
To build the report you can call the CLI or use prompts to answer all questions

### The CLI
### CLI

You can call `npx @wdio/visual-reporter` with the following arguments

#### `--jsonOutput`

**Mandatory:** true

The path to the `output.json` file that is generated after each run with the Visual Testing module.

#### `--reportFolder`

**Mandatory:** true

The folder where you want to store the report that is generated by this module

#### `--logLevel`

**Mandatory:** false
**Possible values:** `debug`

This will generate extra logs when errors happen

#### Example usage

```sh
npx @wdio/visual-reporter --jsonOutput=/Users/wdio/visual-testing/.tmp/actual/output.json --reportFolder=/Users/wdio/visual-testing/.tmp/ --logLevel=debug
```

This will generate the following logs

```logs
npx @wdio/visual-reporter
--jsonOutput=/Users/wdio/visual-testing/.tmp/actual/output.json --reportFolder=/Users/wdio/visual-testing/.tmp/ --logLevel=debug
✔ Build output copied successfully to "/Users/wdio/visual-testing/.tmp/report".
⠋ Prepare report assets...
> @wdio/[email protected] script:prepare.report
> node ./dist/prepareReportAssets.js
✔ Successfully generated the report assets.
```

### Prompts

Open a terminal, enter `npx @wdio/visual-reporter` and answer all the questions

https://github.com/user-attachments/assets/fdd8a838-29c0-4235-9bac-fff0269e292e

Expand Down

0 comments on commit 4427257

Please sign in to comment.