Skip to main content

Pr Tour

@mgreten/pr-tourv2026.11.10.2· MIT· 11d agoBEHAVIORSWORKFLOWSREPORTSACCEPTED WARNINGS
01README

Turn a GitHub pull request into a guided code tour: an agent orders the real diff hunks into narrated stops that follow the change's logic, a validator checks every line is placed exactly once, and a report writes a self-contained, themeable side-by-side HTML page you serve and open in a browser. For reviewers who want to read someone else's PR in a sensible order.

02Behaviors1
@mgreten/pr-tourv2026.11.10.1pr_tour.ts
fn build(prNumber: number, force?: boolean)
Build a guided code tour of a PR at its current head SHA and store it as tour-<pr>-<sha12>.
ArgumentTypeDescription
prNumbernumber
force?boolean

Resources

tour(30d)— A guided tour of one PR at one head SHA: ordered stops of real diff hunks with narrative.
03Workflows1
@mgreten/pr-tourda69739b-e9fe-49eb-afea-606d0e57cccf

Build a guided code tour of a PR on demand and write its HTML page. Run it with `swamp workflow run @mgreten/pr-tour --input prNumber=N`, or POST `{"prNumber": N}` to a `swamp serve --webhook` route that names this workflow. The step runs `build` on the `pr-tour` model instance, which reuses the stored tour when one exists for the PR's current head SHA, and @mgreten/pr-tour-report writes <pagesDir>/<prNumber>.html. Read-only toward GitHub. To rebuild a tour for the same SHA, run `swamp model met

mainBuild the tour and render its page.
1.buildpr-tour.build
04Reports1
@mgreten/pr-tour-reportmethod
pr_tour_report.ts

Render a @mgreten/pr-tour tour as a self-contained side-by-side HTML page (Synthwave dark, GitHub-style light, both restylable) in the model's pagesDir

pr-tour
05Stats
A
100 / 100
Downloads
3
Archive size
36.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned

07Platforms
08Labels