tolkira 0.2.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.
Files changed (64) hide show
  1. package/DESIGN.md +131 -9
  2. package/GLOSSARY.md +201 -1
  3. package/README.md +413 -29
  4. package/SECURITY.md +3 -0
  5. package/dist/attachment.d.ts +33 -0
  6. package/dist/attempt-diagnostics.d.ts +2 -0
  7. package/dist/ci.d.ts +12 -0
  8. package/dist/cli.js +6881 -2691
  9. package/dist/cli.js.map +4 -4
  10. package/dist/compat/cucumber-html-reporter.cjs +12 -0
  11. package/dist/compat/cucumber-html-reporter.d.cts +10 -0
  12. package/dist/compat/cucumber-html-reporter.js +263 -26
  13. package/dist/compat/cucumber-html-reporter.js.map +4 -4
  14. package/dist/compat/options.d.ts +4 -0
  15. package/dist/email.d.ts +18 -0
  16. package/dist/history.d.ts +41 -0
  17. package/dist/i18n/catalogs.d.ts +7 -0
  18. package/dist/index.d.ts +15 -7
  19. package/dist/index.js +5301 -1709
  20. package/dist/index.js.map +4 -4
  21. package/dist/input/background.d.ts +4 -0
  22. package/dist/input/detect.d.ts +30 -0
  23. package/dist/input/load.d.ts +3 -0
  24. package/dist/input/playwright.d.ts +14 -0
  25. package/dist/options.d.ts +18 -0
  26. package/dist/output.d.ts +9 -1
  27. package/dist/pdf.d.ts +9 -0
  28. package/dist/render/ansi.d.ts +2 -0
  29. package/dist/render/attachments.d.ts +3 -0
  30. package/dist/render/ci.d.ts +4 -0
  31. package/dist/render/client-bundle.d.ts +1 -0
  32. package/dist/render/client-i18n.d.ts +7 -0
  33. package/dist/render/details.d.ts +5 -0
  34. package/dist/render/dom-contract.d.ts +42 -0
  35. package/dist/render/format.d.ts +34 -0
  36. package/dist/render/html.d.ts +2 -9
  37. package/dist/render/i18n.d.ts +30 -0
  38. package/dist/render/markdown.d.ts +2 -0
  39. package/dist/render/matrix.d.ts +3 -0
  40. package/dist/render/print-script.d.ts +1 -0
  41. package/dist/render/report-client.d.ts +1 -0
  42. package/dist/render/report.d.ts +4 -0
  43. package/dist/render/search.d.ts +21 -0
  44. package/dist/render/trends.d.ts +7 -0
  45. package/dist/render/triage.d.ts +5 -0
  46. package/dist/render/types.d.ts +26 -0
  47. package/dist/report/index-run.d.ts +69 -0
  48. package/dist/report/model.d.ts +96 -6
  49. package/dist/report/status.d.ts +12 -0
  50. package/dist/stream.d.ts +15 -0
  51. package/dist/summary.d.ts +17 -2
  52. package/dist/text.d.ts +15 -0
  53. package/dist/warnings.d.ts +6 -0
  54. package/docs/AGENT-INTERFACE.md +504 -33
  55. package/docs/CI.md +185 -0
  56. package/docs/COMPATIBILITY.md +121 -16
  57. package/docs/CUCUMBER-COMPATIBILITY.md +232 -15
  58. package/docs/EMAIL.md +273 -0
  59. package/docs/I18N.md +241 -0
  60. package/docs/JUNIT-XML.md +46 -4
  61. package/docs/LIMITATIONS.md +21 -0
  62. package/docs/PDF.md +255 -0
  63. package/llms.txt +63 -0
  64. package/package.json +46 -8
package/dist/summary.d.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  import type { Envelope } from '@cucumber/messages';
2
- export declare const SUMMARY_SCHEMA_VERSION = 1;
3
- export type SummaryStatus = 'passed' | 'failed' | 'skipped' | 'pending' | 'undefined' | 'ambiguous' | 'unknown';
2
+ import { type RunIndex } from './report/index-run.js';
3
+ import { type ReportStatus } from './report/status.js';
4
+ export declare const SUMMARY_SCHEMA_VERSION = 2;
5
+ export type SummaryStatus = ReportStatus;
4
6
  export interface StatusCounts {
5
7
  total: number;
6
8
  passed: number;
@@ -14,15 +16,26 @@ export interface StatusCounts {
14
16
  export interface SummaryStep {
15
17
  keyword: string;
16
18
  text: string;
19
+ name?: string;
17
20
  status: SummaryStatus;
18
21
  durationMs: number;
19
22
  message?: string;
23
+ suggestions?: Array<{
24
+ language?: string;
25
+ code: string;
26
+ }>;
27
+ definitions?: Array<{
28
+ pattern: string;
29
+ source?: string;
30
+ }>;
20
31
  }
21
32
  export interface SummaryScenario {
22
33
  name: string;
23
34
  uri: string;
24
35
  feature: string;
25
36
  status: SummaryStatus;
37
+ /** True when the selected test case reported at least one raw result. */
38
+ executed: boolean;
26
39
  durationMs: number;
27
40
  attempt: number;
28
41
  tags: string[];
@@ -50,4 +63,6 @@ export declare function displayUri(uri: string): string;
50
63
  * This is the machine-readable contract for agents and CI tools.
51
64
  */
52
65
  export declare function summarizeEnvelopes(input: Envelope[]): ReportSummary;
66
+ /** Builds the summary from an index already reduced from sanitized envelopes. */
67
+ export declare function summarizeIndex(index: RunIndex): ReportSummary;
53
68
  export declare function summarizeReport(inputs: string | string[]): Promise<ReportSummary>;
package/dist/text.d.ts ADDED
@@ -0,0 +1,15 @@
1
+ export declare function stripBidiControls(value: string): string;
2
+ export interface EscapeScan {
3
+ /** Index just past the escape sequence. */
4
+ end: number;
5
+ /** SGR parameters when the sequence is a Select Graphic Rendition. */
6
+ sgr?: string;
7
+ }
8
+ export declare function isEscapeIntroducer(code: number): boolean;
9
+ export declare function scanEscape(text: string, start: number): EscapeScan;
10
+ /**
11
+ * Removes ANSI escape sequences, including 8-bit C1 escapes, and other terminal
12
+ * controls. Newlines and tabs are kept so copied and summarised text stays
13
+ * readable.
14
+ */
15
+ export declare function stripAnsi(text: string): string;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copy for the skipped path attachment notice. Shared by the HTML report, the
3
+ * CLI stderr warning and the compat shim so the wording stays one string.
4
+ */
5
+ export declare const ATTACHMENT_HINT = "Run from the folder that contains the referenced files, or regenerate the JSON where the files live.";
6
+ export declare function attachmentWarning(count: number): string;