reporting-labs 0.1.3 → 0.1.4

package/README.md

@@ -81,6 +81,27 @@ reporter: process.env.CI
   : [['list'], ['html', { open: 'never' }], ['reporting-labs', reportingLabs]],
 ```
 
+## Examples you can copy
+
+The [`examples/`](https://github.com/naveenanimation20/reporting-labs/tree/main/examples) folder has one small spec per feature. Each one runs offline in a few seconds, so you can read it, run it, and copy what you need.
+
+| Spec | What it shows |
+|---|---|
+| [01-tag-your-tests.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/01-tag-your-tests.spec.ts) | `meta()` with priority, severity, owner, feature, story; the same via tags and annotations |
+| [02-logs-and-test-data.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/02-logs-and-test-data.spec.ts) | `log()` lines and `testData()` as key/value, table and CSV, with secrets masked |
+| [03-api-calls.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/03-api-calls.spec.ts) | `recordApi()` around `request.post`, `api()` for manual records, a 404 in the API tab |
+| [04-steps-and-attachments.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/04-steps-and-attachments.spec.ts) | `test.step()` bars, screenshot / JSON attachments, visual comparison viewer |
+| [05-outcomes.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/05-outcomes.spec.ts) | skip with a reason, fixme, expected failure, timeout, a plain failure, a flaky test |
+| [06-bdd-style.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/06-bdd-style.spec.ts) | Given / When / Then steps rendered as Gherkin |
+| [reporting-labs.config.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/reporting-labs.config.ts) | A complete reporter config, every option commented |
+| [playwright.config.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/playwright.config.ts) | How the reporter sits next to the built-in reporters |
+
+```bash
+git clone https://github.com/naveenanimation20/reporting-labs
+cd reporting-labs/examples && npm install && npx playwright test
+open reporting-labs/index.html
+```
+
 ## A tour of the report
 
 ### Overview: the state of the run in one screen
@@ -132,7 +153,7 @@ test('completes purchase', async ({ page }) => {
 });
 ```
 
-Tags work too: `{ tag: ['@P1', '@severity:critical', '@owner:priya'] }`. Plain annotations (`test.info().annotations.push({ type: 'priority', description: 'P1' })`) are picked up as well.
+Full example: [examples/01-tag-your-tests.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/01-tag-your-tests.spec.ts). Tags work too: `{ tag: ['@P1', '@severity:critical', '@owner:priya'] }`. Plain annotations (`test.info().annotations.push({ type: 'priority', description: 'P1' })`) are picked up as well.
 
 Turn story, epic or issue keys into links:
 
@@ -157,7 +178,7 @@ test('creates an order', async ({ request }) => {
 });
 ```
 
-Passwords, tokens, API keys, `Authorization` / `Cookie` headers, JWTs and `Bearer …` values are masked as `****` everywhere. Add your own keys with `maskKeys: ['otp', 'pan']`.
+Full examples: [02-logs-and-test-data.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/02-logs-and-test-data.spec.ts) and [03-api-calls.spec.ts](https://github.com/naveenanimation20/reporting-labs/blob/main/examples/03-api-calls.spec.ts). Passwords, tokens, API keys, `Authorization` / `Cookie` headers, JWTs and `Bearer …` values are masked as `****` everywhere. Add your own keys with `maskKeys: ['otp', 'pan']`.
 
 ## Run history: new vs known, flaky, slower
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reporting-labs",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "reportingLabs – beautiful, customizable single-file HTML test reports. One line of config. Playwright adapter included, more runners on the way.",
   "keywords": [
     "test-report",