Skip to content

Commit

Permalink
release 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenkilbourn committed Oct 26, 2022
1 parent 0463000 commit 6831c51
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
Small text based custom reporter for Playwright.
It can be handy to publish test results for things such as an SNS message or minimal Slack update. This Tool allows you to generate smaller reports with basic info about your test run.

<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
## Table of Contents

* [✨ Installation ✨](#✨-installation-✨)
* [📍 Configuration 📍](#📍-configuration-📍)
* [ Default Output 📜](#default-output-📜)
* [Customizing Outputs 👨‍💻](#customizing-outputs-👨‍💻)
* [Available Stats 🧰](#available-stats-🧰)
* [✨ Installation ✨](#-configuration-)
* [📍 Configuration 📍](#-configuration-)
* [ Default Output 📜](#default-output-)
* [Customizing Outputs 👨‍💻](#customizing-outputs-)
* [Available Stats 🧰](#available-stats-)

## ✨ Installation ✨

Expand All @@ -32,7 +31,7 @@ Modify your `playwright.config.ts` file to include the reporter:

```typescript
reporter: [
['@skilbourn/playwright-report-summary', { outputFile: 'custom-summary.txt' }]]
['@skilbourn/playwright-report-summary', { outputFile: 'custom-summary.txt' }]],
['html'], // other reporters
['dot']
],
Expand Down Expand Up @@ -98,7 +97,7 @@ this will generate a `custom-summary.txt` file such as :
hello, 50 tests passed as expected in 03:51 (mm:ss)
```

## Available Stats 🧰
## Available Stats 🧰

The `stats` object provides information on your test suite:

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@skilbourn/playwright-report-summary",
"version": "0.2.0",
"version": "1.0.0",
"description": "generate a customizable text summary of your playwright test results",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand Down

0 comments on commit 6831c51

Please sign in to comment.