slik-report 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ # slik-report
2
+
3
+ A powerful Playwright reporter for aggregating test results, flakiness analysis, and historical trend tracking.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install slik-report --save-dev
9
+ ```
10
+
11
+ ## How to Use
12
+
13
+ To use `slik-report` with Playwright, you need to configure it in your `playwright.config.ts` file.
14
+
15
+ ### Configuration Example
16
+
17
+ Add `slik-report` to the `reporter` array in your `playwright.config.ts`:
18
+
19
+ ```typescript
20
+ // playwright.config.ts
21
+ import { defineConfig } from '@playwright/test';
22
+
23
+ export default defineConfig({
24
+ reporter: [
25
+ ['json', { outputFile: 'playwright-report/report.json' }],
26
+ // Use the Slik Report reporter and pass options
27
+ ['slik-report', {
28
+ input: 'playwright-report/report.json', // Path to the JSON report generated by Playwright
29
+ output: 'slik-report.html', // Output file name for the Slik report
30
+ history: './slik_history', // Directory to store history data
31
+ }]
32
+ ],
33
+ });
34
+ ```
35
+
36
+ ### Options
37
+
38
+ | Option | Type | Description | Default |
39
+ | :-------- | :----- | :----------------------------------------------- | :-------------------------- |
40
+ | `input` | string | Path to the JSON report file generated by Playwright. | `playwright-report/report.json` |
41
+ | `output` | string | Path where the HTML report will be generated. | `slik-report.html` |
42
+ | `history` | string | Directory path to store historical run data. | `./slik_history` |
43
+
44
+ ## License
45
+
46
+ ISC