@goflag/cli 0.2.12 → 0.2.13

package/README.md

@@ -5,6 +5,12 @@ A CLI that audits a site for broken links, missing translation pages, a robots.t
 [![node](https://img.shields.io/badge/node-%3E%3D22-339933?logo=nodedotjs&logoColor=white)](https://github.com/tancredesimonin/goflag/blob/main/package.json)
 [![license: MIT](https://img.shields.io/badge/license-MIT-green)](#license)
 
+[![A goflag run against a site with findings: a red verdict over the crawl counts, a COVERAGE line saying how many pages of the sitemap were audited, the tally of broken links, missing translations and SEO issues, then the broken links listed under the page that references them.](https://goflag.tech/assets/hero.png)](https://goflag.tech/docs/report)
+
+<sub>The first eleven lines of a real run. Rendered from the same transcript the
+documentation site paints, which is compared to the renderers byte for byte —
+so this picture cannot drift from what the command prints.</sub>
+
 Goflag crawls a site once and judges what it found. It is deliberately small: no dashboard, no config system, no social-preview gallery. Just the findings, as a machine-readable report you can pipe, diff, or gate CI on.
 
 It is built for the mistakes that are invisible while browsing and expensive in
@@ -61,7 +67,7 @@ fine one.
 
 ## Where it runs
 
-Two packages ship to npm from a tag, published by GitLab CI over OIDC with no stored credential: `@goflag/cli` (`v*`) and `@goflag/next` (`next-v*`). The documentation site `apps/website` runs at [goflag.tech](https://goflag.tech), with `develop.goflag.tech` alongside it, both deployed with Kamal onto the shared OVH host described in the `infrastructure` repository.
+Three packages ship to npm from a tag, published by GitLab CI over OIDC with no stored credential: `@goflag/cli` (`v*`), `@goflag/next` (`next-v*`) and `@goflag/og` (`og-v*`). The documentation site `apps/website` runs at [goflag.tech](https://goflag.tech), with `develop.goflag.tech` alongside it, both deployed with Kamal onto the shared OVH host described in the `infrastructure` repository.
 
 ## Your first audit
 
@@ -469,6 +475,11 @@ same confidence would be six unearned claims, so the file says which is which.
 It never gates — it exits 0 unless the run itself failed — and it prints the
 path it wrote, so `open "$(goflag preview http://localhost:3000)"` opens it.
 
+An example of what it writes — a real audit, frozen, so its footer names the date it was
+taken — is served at <https://goflag.tech/assets/example-preview.html>. The URL is absolute
+because `prepack` copies this file into the package and npm renders it, where a relative link
+is dead.
+
 ### Multilingual sites
 
 Discovery is seeded from the sitemap, not just from links. That matters because
@@ -547,7 +558,7 @@ Three rules, whichever you use:
 stages: [build, deploy, audit]
 
 variables:
-  GOFLAG_VERSION: "0.2.12"
+  GOFLAG_VERSION: "0.2.13"
 
 # Before the merge: build the branch, let goflag boot it, audit that.
 seo:mr:
@@ -599,7 +610,7 @@ jobs:
       - run: corepack enable && pnpm install --frozen-lockfile
       - run: pnpm build
       - run: |
-          npx --yes @goflag/cli@0.2.12 http://localhost:3000 \
+          npx --yes @goflag/cli@0.2.13 http://localhost:3000 \
             --start "pnpm start" --static --no-external \
             --baseline .goflag/baseline.json --regressions-only --max-debt 41 \
             --report goflag-report.json
@@ -621,6 +632,25 @@ Audit external links on a schedule instead, where nobody is waiting.
 
 ### Reading a red build
 
+A red build says what moved, not what is wrong. The diff lists rule ids and
+absolute page URLs; the messages and the fixes are in the report:
+
+<!-- goflag:transcript gate -->
+
+```plaintext
+goflag --regressions-only
+REGRESSION  1 new · 13 known findings NOT gating this build · 1 resolved
+baseline https://example.com/ — taken 2026-07-21T09:14:02.881Z (14 days ago)
+
+New findings
+  + error seo  canonical.absolute on https://example.com/pricing
+
+Resolved
+  - warn  seo  og.image.missing on https://example.com/about
+```
+
+<!-- /goflag:transcript -->
+
 The report artefact is the thing to open. It is the same JSON as `--json`, and
 it is kept whether the job passed or failed, because it is most wanted when it
 is red.
@@ -683,7 +713,7 @@ finding unrepresentable. Full documentation at
 Two of this catalogue's rules had no remedy to point at. `og.image.missing`
 fired 24 times on one site and `og.image.alt` 46 times on another, and the fix
 for both is "either an asset or a route you have to write" — which is how a rule
-becomes permanent debt. [`@goflag/og`](packages/og) is that route, written once.
+becomes permanent debt. [`@goflag/og`](https://github.com/tancredesimonin/goflag/tree/main/packages/og) is that route, written once.
 
 ```tsx
 // app/[locale]/opengraph-image.tsx
@@ -701,7 +731,7 @@ embeds satori — turns into a PNG at build time, so nothing installs a second
 renderer and a card can be unit-tested with no framework build. It also packs
 the `favicon.ico` **no Next convention emits**, guarded so that a generated file
 living in git is not dirtied by every commit. API reference in
-[`packages/og/README.md`](packages/og/README.md).
+[`packages/og/README.md`](https://github.com/tancredesimonin/goflag/blob/main/packages/og/README.md).
 
 ## Develop locally
 

package/dist/{chunk-QKXUKHXB.js → chunk-57NVXEJS.js}

@@ -6768,6 +6768,57 @@ function translationsPanel(current, siblings) {
 </table></div>
 <p class="foot">Lengths are graphemes, which is what a card's size ladder counts. The ladder is the site's own \u2014 <code>@goflag/og</code> ships none \u2014 so this reports the length and not the step.</p></section>`;
 }
+function pathSegments(path) {
+  const cut = path.indexOf("?");
+  const pathname = cut === -1 ? path : path.slice(0, cut);
+  const search = cut === -1 ? "" : path.slice(cut);
+  const segments2 = pathname.split("/").filter(Boolean);
+  if (search === "") return segments2;
+  return segments2.length === 0 ? [search] : [...segments2.slice(0, -1), `${segments2.at(-1)}${search}`];
+}
+function buildRouteTree(paths) {
+  const root = { segments: [], children: /* @__PURE__ */ new Map(), count: 0 };
+  paths.forEach((path, index) => {
+    let node = root;
+    node.count++;
+    for (const segment of pathSegments(path)) {
+      const child = node.children.get(segment) ?? {
+        segments: [segment],
+        children: /* @__PURE__ */ new Map(),
+        count: 0
+      };
+      node.children.set(segment, child);
+      child.count++;
+      node = child;
+    }
+    node.index ??= index;
+  });
+  return { ...root, children: foldChildren(root.children) };
+}
+function foldChildren(children) {
+  return new Map([...children].map(([key, node]) => [key, foldChain(node)]));
+}
+function foldChain(node) {
+  let current = node;
+  while (current.index === void 0 && current.children.size === 1) {
+    const only = [...current.children.values()][0];
+    current = { ...only, segments: [...current.segments, ...only.segments] };
+  }
+  return { ...current, children: foldChildren(current.children) };
+}
+function routeList(node, open, className = "") {
+  const items = [...node.children.values()].map((child) => {
+    const label = esc(child.segments.map((segment) => `/${segment}`).join(""));
+    if (child.children.size === 0) {
+      return child.index === void 0 ? `<li class="leaf"><span>${label}</span></li>` : `<li class="leaf"><a href="#page-${child.index}">${label}</a></li>`;
+    }
+    const self = child.index === void 0 ? `<span class="go"></span>` : `<a class="go" href="#page-${child.index}" title="the page at this path">\u2197</a>`;
+    return `<li><details${open ? " open" : ""}><summary><span class="seg">${label}</span><span class="n">${child.count}</span>${self}</summary>
+${routeList(child, open)}</details></li>`;
+  });
+  return `<ul${className ? ` class="${className}"` : ""}>${items.join("\n")}</ul>`;
+}
+var TREE_OPEN_MAX = 20;
 function tagLabel(tag) {
   const key = tag.property ?? tag.name ?? (tag.httpEquiv ? `http-equiv=${tag.httpEquiv}` : void 0);
   if (key) return `${key}${tag.content ? ` = ${clip(tag.content, 120)}` : ""}`;
@@ -6837,9 +6888,21 @@ h1,h2,h3,.badge,.chip,.rid,.src,.from,.mono,code,pre,dt,.pin,.nav{font-family:va
 h1{font-size:22px;letter-spacing:-.02em;margin:0 0 6px}
 .lede{color:var(--ink2);margin:0;max-width:70ch}
 header.doc{padding:44px 0 24px;border-bottom:1px solid var(--line)}
-.nav{display:flex;flex-wrap:wrap;gap:8px;margin:20px 0 0;padding:0;list-style:none;font-size:12px}
-.nav a{display:inline-block;padding:4px 9px;border:1px solid var(--line2);border-radius:3px;color:var(--ink2);text-decoration:none}
-.nav a:hover,.nav a:focus-visible{border-color:var(--brand);color:var(--brand)}
+.nav{margin:22px 0 0;max-width:620px}
+.navnote{margin:0 0 8px;font-family:var(--ui);font-size:12px;color:var(--ink3)}
+.tree,.tree ul{list-style:none;margin:0;padding:0;font-size:12px}
+.tree ul{margin-left:6px;padding-left:12px;border-left:1px solid var(--line)}
+.tree summary{display:flex;align-items:center;gap:10px;padding:3px 7px;border-radius:3px;color:var(--ink2);cursor:pointer;list-style:none}
+.tree summary::-webkit-details-marker{display:none}
+.tree summary::before{content:"\u25B8";flex:none;width:1ch;font-size:9px;color:var(--ink3)}
+.tree details[open]>summary::before{content:"\u25BE"}
+.tree summary:hover,.tree summary:focus-visible{background:var(--wash);color:var(--ink)}
+.tree .seg{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}
+.tree .n{margin-left:auto;flex:none;font-size:10px;color:var(--ink3);font-variant-numeric:tabular-nums}
+.tree .go{flex:none;width:1.2em;text-align:right;font-size:11px;text-decoration:none;opacity:.55}
+.tree .go:hover,.tree .go:focus-visible{opacity:1}
+.tree .leaf a,.tree .leaf span{display:block;padding:3px 7px 3px 24px;color:var(--ink2);text-decoration:none;border-radius:3px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}
+.tree .leaf a:hover,.tree .leaf a:focus-visible{background:var(--wash);color:var(--brand)}
 .page{padding-top:52px}
 .pagehead h2{font-size:16px;margin:0 0 4px}
 .pagehead .url{margin:0;font-size:13px;color:var(--ink2);word-break:break-all}
@@ -6978,9 +7041,14 @@ function renderPreview(report, options = {}) {
       byRoute.get(splitRoute(pathOf(extraction.http.finalUrl)).route) ?? []
     )
   ).join("\n");
-  const nav = extractions.length > 1 ? `<ul class="nav">${extractions.map(
-    (extraction, index) => `<li><a href="#page-${index}">${esc(pathOf(extraction.http.finalUrl))}</a></li>`
-  ).join("")}</ul>` : "";
+  const nav = extractions.length > 1 ? `<nav class="nav">
+  <p class="navnote">${extractions.length} pages, by path. A folder folds; the \u2197 beside one opens the page at that path itself.</p>
+  ${routeList(
+    buildRouteTree(extractions.map((extraction) => pathOf(extraction.http.finalUrl))),
+    extractions.length <= TREE_OPEN_MAX,
+    "tree"
+  )}
+</nav>` : "";
   return `<!doctype html>
 <html lang="en">
 <head>
@@ -7294,4 +7362,4 @@ export {
   summarize,
   Logger
 };
-//# sourceMappingURL=chunk-QKXUKHXB.js.map
+//# sourceMappingURL=chunk-57NVXEJS.js.map