tolkira 0.3.0 → 0.4.0
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/DESIGN.md +131 -9
- package/GLOSSARY.md +115 -8
- package/README.md +229 -37
- package/dist/attachment.d.ts +33 -0
- package/dist/attempt-diagnostics.d.ts +2 -0
- package/dist/ci.d.ts +12 -0
- package/dist/cli.js +7099 -3785
- package/dist/cli.js.map +4 -4
- package/dist/compat/cucumber-html-reporter.js +174 -8
- package/dist/compat/cucumber-html-reporter.js.map +4 -4
- package/dist/compat/options.d.ts +2 -0
- package/dist/email.d.ts +18 -0
- package/dist/history.d.ts +41 -0
- package/dist/i18n/catalogs.d.ts +7 -0
- package/dist/index.d.ts +12 -1
- package/dist/index.js +5148 -2453
- package/dist/index.js.map +4 -4
- package/dist/input/detect.d.ts +30 -0
- package/dist/input/load.d.ts +1 -0
- package/dist/input/playwright.d.ts +14 -0
- package/dist/options.d.ts +6 -0
- package/dist/output.d.ts +7 -1
- package/dist/pdf.d.ts +9 -0
- package/dist/render/attachments.d.ts +3 -0
- package/dist/render/ci.d.ts +4 -0
- package/dist/render/client-i18n.d.ts +7 -0
- package/dist/render/details.d.ts +5 -0
- package/dist/render/dom-contract.d.ts +42 -0
- package/dist/render/format.d.ts +34 -0
- package/dist/render/html.d.ts +2 -9
- package/dist/render/i18n.d.ts +30 -0
- package/dist/render/markdown.d.ts +2 -1
- package/dist/render/matrix.d.ts +3 -0
- package/dist/render/print-script.d.ts +1 -0
- package/dist/render/report-client.d.ts +1 -0
- package/dist/render/report.d.ts +4 -0
- package/dist/render/search.d.ts +3 -0
- package/dist/render/trends.d.ts +7 -0
- package/dist/render/triage.d.ts +5 -0
- package/dist/render/types.d.ts +26 -0
- package/dist/report/index-run.d.ts +69 -0
- package/dist/report/model.d.ts +11 -2
- package/dist/summary.d.ts +3 -0
- package/dist/warnings.d.ts +6 -0
- package/docs/AGENT-INTERFACE.md +367 -33
- package/docs/CI.md +185 -0
- package/docs/COMPATIBILITY.md +72 -11
- package/docs/CUCUMBER-COMPATIBILITY.md +50 -26
- package/docs/EMAIL.md +273 -0
- package/docs/I18N.md +241 -0
- package/docs/JUNIT-XML.md +19 -2
- package/docs/LIMITATIONS.md +10 -6
- package/docs/PDF.md +255 -0
- package/llms.txt +36 -4
- package/package.json +21 -5
- package/dist/report/attachment.d.ts +0 -10
package/DESIGN.md
CHANGED
|
@@ -32,6 +32,9 @@ optional Details view, never in the way of the failure.
|
|
|
32
32
|
- **Accessible by default.** WCAG 2.2 AA, keyboard focus, reduced motion,
|
|
33
33
|
200 % page zoom and 200 % text zoom, no colour-only status, no horizontal
|
|
34
34
|
page scroll.
|
|
35
|
+
- **Test data is not UI copy.** Report chrome comes from the active locale
|
|
36
|
+
catalog; names, steps, tags, errors and attachment content always render
|
|
37
|
+
verbatim.
|
|
35
38
|
|
|
36
39
|
## Tokens
|
|
37
40
|
|
|
@@ -100,16 +103,80 @@ describe the viewport, not the font.
|
|
|
100
103
|
|
|
101
104
|
| Component | File / selector | Rule |
|
|
102
105
|
| --- | --- | --- |
|
|
103
|
-
| Top bar / tabs | `.topbar`, `.view` | Report and Details; active tab is a text state, not a card |
|
|
106
|
+
| Top bar / tabs | `.topbar`, `.views`, `.view` | Report and Details, plus Trends when the report carries two or more history runs; active tab is a text state, not a card; one scrollable tab row on narrow screens |
|
|
104
107
|
| Run header | `.runHead`, `.health` | Title, metadata, pass rate, segmented status bar |
|
|
105
|
-
|
|
|
108
|
+
| Attachment notice | `.noticeShell`, `.attachmentWarning` | One shared warning above all views when path attachments were skipped; uses the pending tokens; hidden when the count is zero |
|
|
109
|
+
| Toolbar | `.toolbar`, `.search`, `.filter`, `.presetFilter` | Search and status filters; search opens matching features and scenarios; status chips only for present statuses; the `Failed only` preset appears when failed plus another present status, or when an unexecuted row can be hidden |
|
|
106
110
|
| Triage index | `.triage` | Needs-attention rows with status text, counts and up to three scenario links; five rows visible, up to fifteen more behind a disclosure |
|
|
107
|
-
| Source strip | `.sources` | Per-input cards for multi-file runs with real provenance; status, counts and a proportion bar; hidden
|
|
108
|
-
| Feature | `details.feature` | Native disclosure; status, name, counts, proportion bar, source badge, URI |
|
|
111
|
+
| Source strip | `.sources` | Per-input cards for multi-file runs with real provenance; status, counts and a proportion bar; hidden at 560 px or narrower. The Report row's source badge hides at 900 px or narrower, so the Details matrix keeps the source label |
|
|
112
|
+
| Feature | `details.feature` | Native disclosure; status, name, counts, proportion bar, source badge (file path or `N spec files`), URI |
|
|
109
113
|
| Scenario | `details.scenario` | Fixed thumbnail gutter, status, name, tags, steps, duration |
|
|
110
114
|
| Step | `.step` | Status glyph plus screen-reader label, keyword, text, error, doc string, focusable table, attachments |
|
|
111
115
|
| Attachment | `.shot`, `.fileText`, `.fileLink` | Images inline; text in `<pre>`; binary as download; alt names the scenario and step |
|
|
112
|
-
| Details | `.analysis` | Feature-by-status matrix, status distribution, Run /
|
|
116
|
+
| Details | `.analysis` | Feature-by-status matrix, status distribution, Run / Run environment / Custom metadata blocks, agent summary |
|
|
117
|
+
| Trends | `.trendsTable`, `.tableWrap`, `.spark` | Opt-in third view with two or more history runs: newest-first table of recorded time, title, status, passed/failed/skipped counts, scenario total, attempted pass rate and duration, plus a decorative pass-rate sparkline oldest to newest. The newest row is marked `Current`; the table sits in a labelled, focusable region, spans the panel and scrolls at 320 px; the sparkline is `aria-hidden` and skips runs without attempts |
|
|
118
|
+
|
|
119
|
+
### Renderer modules
|
|
120
|
+
|
|
121
|
+
- `html.ts` - shell, CSP and `renderHtml` assembly.
|
|
122
|
+
- `print-script.ts` - static `beforeprint`/`afterprint` lifecycle, imported only
|
|
123
|
+
by `html.ts` and emitted as a second CSP-hashed inline script outside the
|
|
124
|
+
interactive client bundle.
|
|
125
|
+
- `report.ts` - report header, toolbar, features, scenarios, steps, hooks and
|
|
126
|
+
feature-row chrome.
|
|
127
|
+
- `details.ts` - Details header, run/environment panels and analysis layout.
|
|
128
|
+
- `trends.ts` - Trends header, recorded-runs table and pass-rate sparkline.
|
|
129
|
+
- `triage.ts` - needs-attention index and source strip.
|
|
130
|
+
- `matrix.ts` - feature-by-status matrix.
|
|
131
|
+
- `attachments.ts` - image, text, video, log and file rendering.
|
|
132
|
+
- `ci.ts` - CI header and detail rows.
|
|
133
|
+
- `format.ts` - status, duration, date, bar, count, health and tag helpers.
|
|
134
|
+
- `types.ts` - `RenderOptions`, `DisplayStatus` and `OrderedFeature`.
|
|
135
|
+
- `i18n.ts` - locale resolution, catalogs, translator and locale-aware number,
|
|
136
|
+
percent, duration and date helpers; caches `Intl` formatters per translator.
|
|
137
|
+
- `client-i18n.ts` - browser formatter for the embedded `client.*` block, with
|
|
138
|
+
every `Intl.PluralRules` category and numeric `#` parameters.
|
|
139
|
+
|
|
140
|
+
`report.ts`, `details.ts` and `trends.ts` are peers, as are `triage.ts`,
|
|
141
|
+
`matrix.ts`, `attachments.ts` and `ci.ts`; a module imports only from a lower
|
|
142
|
+
layer.
|
|
143
|
+
|
|
144
|
+
### Localisation
|
|
145
|
+
|
|
146
|
+
The visible shell is rendered from `src/i18n/locales/<locale>.json`. `renderHtml`
|
|
147
|
+
resolves `locale` once, sets `<html lang>` and `dir`, and passes one translator
|
|
148
|
+
to every view. One report carries one locale; there is no in-report switcher.
|
|
149
|
+
All visible counts are locale-formatted (English report digits stay raw; the
|
|
150
|
+
email groups them), on the server and in the client. The report always embeds
|
|
151
|
+
the active `client.*` messages as an inert JSON block; the browser bundle contains
|
|
152
|
+
no non-English catalog, and a missing block or key shows the key. Test data,
|
|
153
|
+
Gherkin keywords, tags, errors, attachment content and names, metadata and URIs
|
|
154
|
+
render verbatim in every locale; the JSON summary and CI text stay English. See
|
|
155
|
+
[`docs/I18N.md`](docs/I18N.md) for keys, fallback, the German glossary and the
|
|
156
|
+
translation checklist.
|
|
157
|
+
|
|
158
|
+
### Email summary
|
|
159
|
+
|
|
160
|
+
`src/email.ts` renders a second, opt-in surface from the stable summary, not from
|
|
161
|
+
the report shell. It is a 600 px table (`width: 100%`, `max-width: 600px`) with
|
|
162
|
+
inline styles and a small `<style>` block that applies below 480 px, so 600 px
|
|
163
|
+
keeps the 2 by 2 metric grid: an inline system font stack, the status colour as a
|
|
164
|
+
pill whose count and label stay separated, the validated accent as the top
|
|
165
|
+
border, and no image, icon, script, link, preheader or remote asset. The heading,
|
|
166
|
+
note and failed names wrap anywhere, and displayed feature, scenario and
|
|
167
|
+
report-name strings are capped at 200 characters with an ellipsis. The layout is
|
|
168
|
+
intentionally plainer than the report so a mail client that strips `<style>`
|
|
169
|
+
still shows a readable summary. The content is the title and status, generation
|
|
170
|
+
time, attempted pass rate as a percentage with a full-sentence note that skipped
|
|
171
|
+
scenarios are not attempts, every non-zero status plus unexecuted,
|
|
172
|
+
feature/step/duration totals, the inline-attachment count
|
|
173
|
+
labelled `Attachments in the run`, and the first five failed scenarios in summary
|
|
174
|
+
order; the full report is referenced by basename, or the note says that no full
|
|
175
|
+
report is attached. The empty and all-unexecuted states are distinct. English
|
|
176
|
+
email digits are grouped (`8,509 bytes`) and durations use a human form
|
|
177
|
+
(`12 ms`, `12.3 s`, `1 min 5 s`, `1 h 2 min`) through email-local helpers; German
|
|
178
|
+
counts and dates reuse the report translator, and the report helpers
|
|
179
|
+
stay unchanged. A standard summary stays under 100 KB.
|
|
113
180
|
|
|
114
181
|
## Interaction rules
|
|
115
182
|
|
|
@@ -119,11 +186,51 @@ describe the viewport, not the font.
|
|
|
119
186
|
- Search and filters: hide non-matches and open matching features; search also
|
|
120
187
|
opens matching scenarios, update a polite live region, show an empty state
|
|
121
188
|
when nothing matches.
|
|
189
|
+
- `Failed only` turns off every other present status chip and adds the
|
|
190
|
+
`unexecuted` sentinel to `hide`, so statusless rows hide too; pressing it again
|
|
191
|
+
restores every chip and drops the sentinel. Any manual chip change drops the
|
|
192
|
+
sentinel, and the toggle is pressed only for the exact preset state. Pressed,
|
|
193
|
+
it uses the ink mode style (paper text on ink, pill radius), not the failed
|
|
194
|
+
status colour.
|
|
122
195
|
- Switching tabs scrolls to the top; the previous panel's scroll position is
|
|
123
|
-
not restored.
|
|
196
|
+
not restored. Each tab toggles the panel named by its `aria-controls`, so
|
|
197
|
+
Report, Details and the conditional Trends tab share one path; a missing panel
|
|
198
|
+
is ignored.
|
|
199
|
+
- Trends shows attempted (non-skipped) pass rates and `—` when a run had no
|
|
200
|
+
attempt. The sparkline is decorative and skips those runs; two points form a
|
|
201
|
+
line only when they are adjacent in time.
|
|
124
202
|
- The lightbox locks background scrolling, restores focus to its trigger on
|
|
125
203
|
Escape, Close, backdrop click and padding click, and reserves header space so
|
|
126
204
|
Close never covers the screenshot.
|
|
205
|
+
- Print is a CSS mode plus a small static inline script, emitted beside the
|
|
206
|
+
client as a second CSP-hashed inline script; the interactive client bundle
|
|
207
|
+
stays at 15,268 bytes with 732 bytes of headroom under its 16 KB budget.
|
|
208
|
+
`beforeprint` adds `body.printing`; its reveal rule lives inside
|
|
209
|
+
`@media print`, so it cannot change the screen, and `afterprint` removes it.
|
|
210
|
+
The handler stores the originally closed details, the open lightbox and the
|
|
211
|
+
`html` overflow, opens every `<details>`, requests lazy thumbnails eagerly
|
|
212
|
+
(`loading=eager`) and restores the lazy state, closes an open lightbox with a
|
|
213
|
+
guarded `close()` and releases the scroll lock. The active panel's `hidden`
|
|
214
|
+
state is never touched: removing `printing` restores it. `afterprint` returns
|
|
215
|
+
the previous state in browsers that fire it; a missed event cannot stack
|
|
216
|
+
panels on screen because the reveal is print-scoped. The print stylesheet
|
|
217
|
+
hides interactive chrome through explicit selectors (screenshots are buttons
|
|
218
|
+
and must print), repeats the light palette including all 16 ANSI foreground
|
|
219
|
+
slots for dark-mode screens, fits every `.tableWrap` table including the
|
|
220
|
+
German Trends case, and starts each present view on a new page. Without
|
|
221
|
+
JavaScript the active Report prints with its closed state; a print button,
|
|
222
|
+
repeated print title and custom page numbers are deliberately absent.
|
|
223
|
+
- The opt-in PDF export prints that exact print state through Playwright
|
|
224
|
+
Chromium: `page.setContent` with the report HTML, lazy images set eager, HTTP(S)
|
|
225
|
+
subresources aborted, fonts and images awaited, A4 portrait via
|
|
226
|
+
`format: 'A4'` with the print CSS 12 mm margins, `printBackground` and
|
|
227
|
+
`preferCSSPageSize`, no header/footer. The font/image wait and print use an
|
|
228
|
+
explicit five-minute deadline (`--pdf-timeout`/`PdfOptions.timeoutMs`), because
|
|
229
|
+
`page.pdf` has no timeout option. It is a fresh page, so the CLI filter does not
|
|
230
|
+
apply; the browser print stays the filtered, landscape and Letter route. The
|
|
231
|
+
engine is an optional dynamic import (`src/pdf.ts`, resolved beside Tolkira or
|
|
232
|
+
from the project) and never enters the report bundle; the default Chromium
|
|
233
|
+
launch is not OS-sandboxed (B-029). See [`docs/PDF.md`](docs/PDF.md).
|
|
127
234
|
- Status is never colour-only: scenario badges carry text, step markers carry a
|
|
128
235
|
shape glyph plus a screen-reader label, and forced-colours mode keeps the
|
|
129
236
|
glyph, marker border and disclosure chevron visible.
|
|
@@ -145,7 +252,8 @@ template strings. A local utility layer is fine when it removes repetition.
|
|
|
145
252
|
## Agent workflow
|
|
146
253
|
|
|
147
254
|
1. Read `docs/PRODUCT.md`, this file, `src/report/model.ts`,
|
|
148
|
-
`src/render/
|
|
255
|
+
`src/render/report.ts`, `src/render/details.ts` and
|
|
256
|
+
`src/render/styles.ts`.
|
|
149
257
|
2. Change the view model first if the data is missing; keep `src/summary.ts`
|
|
150
258
|
independent.
|
|
151
259
|
3. Use tokens and existing component classes; do not add a UI framework.
|
|
@@ -167,13 +275,27 @@ Direction A is implemented in production:
|
|
|
167
275
|
- feature counts/proportion bars and a feature-by-status matrix in Details;
|
|
168
276
|
- `undefined` is a distinct status, not a neutral one;
|
|
169
277
|
- Details tab with producer, runtime, OS, CPU, protocol and user metadata;
|
|
278
|
+
- Trends tab with an aggregate run table and pass-rate sparkline when the report
|
|
279
|
+
carries two or more history runs;
|
|
280
|
+
- English and German report chrome from one catalog, with test data verbatim;
|
|
170
281
|
- empty state for search/filter results;
|
|
171
|
-
- screenshot lightbox with a close button and Escape support
|
|
282
|
+
- screenshot lightbox with a close button and Escape support;
|
|
283
|
+
- browser print/Save as PDF for the complete text and screenshot archive: all
|
|
284
|
+
views and details by default (an active filter still narrows the Report
|
|
285
|
+
view), light palette, fitted tables and page breaks, with the screen state
|
|
286
|
+
restored where `afterprint` fires and a no-JavaScript fallback for the active
|
|
287
|
+
Report;
|
|
288
|
+
- opt-in `--pdf`/`--pdf-timeout` export of that complete print state through
|
|
289
|
+
optional Playwright Chromium, A4 portrait/12 mm with no header/footer or page
|
|
290
|
+
numbers, composed with the report, email, history, JSON and CI outputs;
|
|
291
|
+
- an opt-in 600 px HTML email summary from the same status and counts, with the
|
|
292
|
+
first five failed scenarios in summary order and the report basename (or a
|
|
293
|
+
no-report note), but no image or script.
|
|
172
294
|
|
|
173
295
|
CSS lives in `src/render/report.css`; `scripts/build-styles.mjs` generates
|
|
174
296
|
`src/render/styles.ts` for the inline report.
|
|
175
297
|
|
|
176
|
-
Still open:
|
|
298
|
+
Still open: chart lenses in Details and optional map/compact lenses.
|
|
177
299
|
|
|
178
300
|
## Non-goals
|
|
179
301
|
|
package/GLOSSARY.md
CHANGED
|
@@ -6,6 +6,52 @@
|
|
|
6
6
|
**Report** — one self-contained HTML file generated from one or more test
|
|
7
7
|
result inputs.
|
|
8
8
|
|
|
9
|
+
**Locale catalog** — the flat, sorted ICU message file for one report language
|
|
10
|
+
under `src/i18n/locales/`; English carries descriptions and is the fallback.
|
|
11
|
+
The generated `src/i18n/catalogs.ts` is what the renderer imports. See
|
|
12
|
+
[`docs/I18N.md`](docs/I18N.md).
|
|
13
|
+
|
|
14
|
+
**Report locale** — the requested language tag (`en` or `de`, optionally
|
|
15
|
+
regional such as `de-AT`) resolved once per report. It sets `<html lang>` and
|
|
16
|
+
`dir`; `de-AT` uses the `de` catalog. It never affects test data, the JSON
|
|
17
|
+
summary or CI text.
|
|
18
|
+
|
|
19
|
+
**Client messages** — the `client.*` subset of the active catalog, embedded as
|
|
20
|
+
an inert JSON block in every report so search, filters and copy labels are
|
|
21
|
+
localized without shipping a non-English catalog in the browser bundle. The
|
|
22
|
+
block is the client's only message source: a missing block or key shows the key,
|
|
23
|
+
and the old English fallback map is gone.
|
|
24
|
+
|
|
25
|
+
**German report terms** — the approved sheet for the `de` catalog:
|
|
26
|
+
|
|
27
|
+
| English | German |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| Report | Bericht |
|
|
30
|
+
| Details | Details |
|
|
31
|
+
| Trends | Trends |
|
|
32
|
+
| Scenario | Szenario |
|
|
33
|
+
| Step | Schritt |
|
|
34
|
+
| Attachment | Anhang |
|
|
35
|
+
| Run | Lauf |
|
|
36
|
+
| Passed | Bestanden |
|
|
37
|
+
| Failed | Fehlgeschlagen |
|
|
38
|
+
| Skipped | Übersprungen |
|
|
39
|
+
| Pending | Ausstehend |
|
|
40
|
+
| Pass rate | Erfolgsquote |
|
|
41
|
+
| Test time | Testzeit |
|
|
42
|
+
| Feature | Feature |
|
|
43
|
+
| Hook | Hook |
|
|
44
|
+
| Flaky | flaky |
|
|
45
|
+
| Rule | Rule |
|
|
46
|
+
| URI | URI |
|
|
47
|
+
|
|
48
|
+
The address form is impersonal; avoid `du` and `Sie`. The full
|
|
49
|
+
`Fehlgeschlagen` chip is used and wraps; there is no short form. `de` is the
|
|
50
|
+
generic catalog and `de-AT` uses it. Final copy also uses `Laufzeit` for
|
|
51
|
+
runtime, `Lauf-Hooks` for run-level hooks in the test-time notes,
|
|
52
|
+
`Aufgezeichnet am` for the recorded-at column, `Basisverzeichnisse` for the
|
|
53
|
+
allowed roots and `Fehlerdetails kopieren` for the copy-failure action.
|
|
54
|
+
|
|
9
55
|
**Legacy JSON** — the older Cucumber JSON output format. Implementation-specific
|
|
10
56
|
and lossy, but still widely used.
|
|
11
57
|
|
|
@@ -20,6 +66,24 @@ when an attachment has no Cucumber `fileName`. Known parameterised media types
|
|
|
20
66
|
keep their extension; unknown types normalise to `application/octet-stream` and
|
|
21
67
|
`attachment.bin`.
|
|
22
68
|
|
|
69
|
+
**Allowed root** — one of the places Tolkira may read a Playwright path
|
|
70
|
+
attachment from: the input file's folder and the process working directory.
|
|
71
|
+
Both are resolved to real paths; a target outside every allowed root is not
|
|
72
|
+
read.
|
|
73
|
+
|
|
74
|
+
**Skipped attachment** — a Playwright path attachment that exists as a regular,
|
|
75
|
+
non-symlink file but resolves outside every allowed root. It is not embedded,
|
|
76
|
+
counts once in `generateReport().skippedAttachments`, and drives the report
|
|
77
|
+
run-level and per-scenario attachment notice and the CLI stderr warning. Missing
|
|
78
|
+
files, non-regular files, symlinks, URL schemes, UNC paths, trace zips and
|
|
79
|
+
earlier attempts are skipped without being counted; an inline body always wins.
|
|
80
|
+
|
|
81
|
+
**Flaky / @flaky** — a scenario tagged `@flaky`, either by the Playwright
|
|
82
|
+
adapter when a retry passes or by a user on a scenario, feature, rule or outline.
|
|
83
|
+
The report shows a decorative badge and a run-metadata `N tagged @flaky` count;
|
|
84
|
+
it is display-only, never a computed flake rate or status, and the scenario keeps
|
|
85
|
+
its existing status in the JSON summary, CI and email.
|
|
86
|
+
|
|
23
87
|
**CI metadata** — the optional Messages `meta.ci` block: CI name and URL plus
|
|
24
88
|
git remote, revision, branch and tag. It renders in the HTML header and Details
|
|
25
89
|
and never in the JSON summary.
|
|
@@ -59,7 +123,7 @@ with real provenance. Each card shows the input's worst status, counts and a
|
|
|
59
123
|
proportion bar.
|
|
60
124
|
|
|
61
125
|
**Feature matrix** — the Details table with one row per feature and one count
|
|
62
|
-
column per status present in the run, plus total and
|
|
126
|
+
column per status present in the run, plus total and Scenario time.
|
|
63
127
|
|
|
64
128
|
**Scenario outline** — a Gherkin scenario template with an Examples table.
|
|
65
129
|
Tolkira renders one outline section per executed outline with examples in
|
|
@@ -73,14 +137,57 @@ name, tags and description. An outline can have several.
|
|
|
73
137
|
attachments and anchor.
|
|
74
138
|
|
|
75
139
|
**Executed scenario** — a scenario whose selected test case reported at least
|
|
76
|
-
one raw step result, including a hook result.
|
|
77
|
-
|
|
140
|
+
one raw step result, including a hook result. Adapters represent a reported skip
|
|
141
|
+
without steps as a synthetic skipped step, so the summary reports it as
|
|
142
|
+
executed. Executed scenarios appear in scenario counts, bars, triage and the
|
|
143
|
+
Details matrix.
|
|
144
|
+
|
|
145
|
+
**Skipped scenario** — an executed scenario whose final reported status is
|
|
146
|
+
`skipped`, for example a statically skipped test with no step results. It stays
|
|
147
|
+
in counts, status pills, filters and bars, but it is not a pass attempt.
|
|
148
|
+
|
|
149
|
+
**Attempted pass rate** — the pass percentage over attempted scenarios:
|
|
150
|
+
executed results whose status is not `skipped`. Counts and bars include skipped;
|
|
151
|
+
the Report and Details health, the feature pass text and the Trends table do not.
|
|
152
|
+
A run with results but no attempt states `No scenarios attempted`; Trends shows
|
|
153
|
+
`—` for that run.
|
|
154
|
+
|
|
155
|
+
**History file / sidecar** — the optional UTF-8 JSON file passed with
|
|
156
|
+
`--history <file>`. It keeps the last 30 aggregate history runs in schema
|
|
157
|
+
version 1 and is read, appended and written atomically by the CLI. Without the
|
|
158
|
+
flag no history is read or written.
|
|
159
|
+
|
|
160
|
+
**History run** — one aggregate entry in the history file: id, recorded time,
|
|
161
|
+
resolved title, overall status, feature/scenario/step counts, duration and
|
|
162
|
+
attachment totals. It never carries scenario names, step text, paths, tags or
|
|
163
|
+
attachment content.
|
|
164
|
+
|
|
165
|
+
**Aggregate id** — the SHA-256 in a history run. It hashes the aggregates and
|
|
166
|
+
the title but not the recorded time, so an identical rerun is not appended and
|
|
167
|
+
keeps the old timestamp.
|
|
168
|
+
|
|
169
|
+
**Trends view** — the optional third tab, rendered when a report is generated
|
|
170
|
+
with two or more history runs. It lists the runs newest first and adds a
|
|
171
|
+
decorative pass-rate sparkline oldest to newest; the table is the accessible
|
|
172
|
+
source.
|
|
78
173
|
|
|
79
174
|
**Unexecuted scenario** — a scenario whose selected test case started but
|
|
80
175
|
reported no raw step result, including a started-but-unfinished case. It stays
|
|
81
|
-
visible without an outcome
|
|
82
|
-
the summary, and leaves every count
|
|
83
|
-
dropped. A never-started pickle
|
|
176
|
+
visible without an outcome unless the failed-only preset is active, keeps
|
|
177
|
+
`status: "unknown"` and `executed: false` in the summary, and leaves every count
|
|
178
|
+
surface. Any attachment emitted for it is dropped. A never-started pickle
|
|
179
|
+
produces no row at all.
|
|
180
|
+
|
|
181
|
+
**Failed-only preset** — the toolbar toggle that turns off every other present
|
|
182
|
+
status chip and adds the `unexecuted` sentinel, so only failed scenarios remain.
|
|
183
|
+
It is pressed only for the exact preset chip state, disappears when it could hide
|
|
184
|
+
nothing, and any manual chip change clears the sentinel. Header counts and the
|
|
185
|
+
`N unexecuted` label stay unchanged.
|
|
186
|
+
|
|
187
|
+
**`hide=unexecuted`** — the URL value for the failed-only preset's sentinel. It
|
|
188
|
+
is not a status and has no chip: it hides rows without an outcome and is restored
|
|
189
|
+
only together with the preset chip state. It is dropped unless it is the exact
|
|
190
|
+
preset state (failed with unexecuted rows and no other status).
|
|
84
191
|
|
|
85
192
|
**Rule** — a Gherkin grouping of scenarios and outlines under a named business
|
|
86
193
|
rule. The report renders a rule section with its keyword, name, description and
|
|
@@ -99,8 +206,8 @@ block container; images become alt text and raw HTML stays escaped.
|
|
|
99
206
|
whole query is tag-shaped; mixed text and tags fall back to substring search.
|
|
100
207
|
|
|
101
208
|
**URL state** — the shareable `?query=`, repeated lowercase `?hide=` and `?tag=`
|
|
102
|
-
parameters. The report restores
|
|
103
|
-
without adding history entries.
|
|
209
|
+
parameters, including the `hide=unexecuted` pseudo-status. The report restores
|
|
210
|
+
them and updates them with `replaceState` without adding history entries.
|
|
104
211
|
|
|
105
212
|
**Own tag** — a tag written on the scenario itself; for an outline row, the
|
|
106
213
|
examples-block tags. A standalone scenario row shows its own tags. Outline
|