Skip to content

test(examples): add deterministic markdown-report output test #371

@gregkonush

Description

@gregkonush

Outcome

Add a focused test or smoke assertion that keeps the Markdown report example output deterministic.

Likely files

  • examples/headless-workpaper/markdown-report.ts
  • examples/headless-workpaper/README.md
  • Optional new test under scripts/__tests__/ if you choose to run the example from Vitest

Suggested approach

The example already prints JSON with verified: true and a markdown table. Add a small automated check that runs the example or imports its report formatter and asserts the table contains the expected rows:

  • Committed MRR
  • Weighted pipeline MRR
  • Target gap

Keep the output format stable. Do not rewrite the example into a framework-specific demo.

Acceptance proof

Run:

pnpm --dir examples/headless-workpaper run markdown-report

Also run the focused test command for the assertion you add.

Scope check

  • The task can be reviewed in one sitting.
  • The task has one clear validation command or artifact.
  • The task does not require broad architecture knowledge.
  • The task should stay open for a new contributor unless it is urgent.

Notes

This is a small code/test starter for contributors who want to work on runnable examples without touching formula internals.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: examplesRunnable examples and external consumer smoke coveragefirst-timers-onlyReserved for someone making their first contribution to this projectgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions