@domandigital/craft 0.10.0 → 0.11.0

package/dist/chunk-MSQ57PJU.js

@@ -0,0 +1,206 @@
+import {
+  snapshotUrl,
+  snapshotUrls
+} from "./chunk-JP75P2DU.js";
+import {
+  describeTypicality,
+  loadNull,
+  typicality
+} from "./chunk-3OZQ4C5R.js";
+import {
+  SOURCE_FILE,
+  finish,
+  loadConfig,
+  loadExceptions,
+  parseFlags,
+  prepareReport,
+  readPaths,
+  toJson
+} from "./chunk-2AJB27BJ.js";
+import {
+  fingerprint
+} from "./chunk-QMYERCBB.js";
+import {
+  SNAPSHOT_VERSION,
+  auditSnapshot,
+  scanSource
+} from "./chunk-3NGWXZZE.js";
+
+// src/audit/cli.ts
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { resolve } from "path";
+
+// src/audit/pages.ts
+var decode = (s) => s.replace(/&amp;/g, "&").replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, '"').replace(/&apos;/g, "'");
+function parseSitemap(xml) {
+  const locs = [...xml.matchAll(/<loc>\s*([^<]+?)\s*<\/loc>/gi)].map((m) => decode(m[1]));
+  return /<sitemapindex[\s>]/i.test(xml) ? { urls: [], sitemaps: locs } : { urls: locs, sitemaps: [] };
+}
+function parseUrlList(text) {
+  return text.split(/\r?\n/).map((l) => l.trim()).filter((l) => l && !l.startsWith("#"));
+}
+function parseViewports(value) {
+  const widths = value.split(",").map((w) => w.trim());
+  return widths.map((w) => {
+    const width = Number(w);
+    if (!Number.isInteger(width) || width < 240 || width > 3840) throw new Error(`--viewport: "${w}" is not a width in px between 240 and 3840`);
+    return { width, height: width < 600 ? 844 : width < 1024 ? 1024 : 900 };
+  });
+}
+
+// src/audit/cli.ts
+var fmt = (o) => o ? `oklch(${o.l.toFixed(3)} ${o.c.toFixed(3)} ${o.h.toFixed(1)})` : "none";
+function describeFingerprint(fp) {
+  return [
+    "Fingerprint",
+    `  accent     ${fmt(fp.accent)}`,
+    `  ground     ${fmt(fp.ground)}`,
+    `  display    ${fp.display.family} (${fp.display.class})`,
+    `  body       ${fp.body.family} (${fp.body.class})`,
+    `  roundness  ${fp.roundness === null ? "no buttons" : fp.roundness.toFixed(2)}`,
+    `  motion     ${Math.round(fp.motion * 100)}% of sections below the fold reveal on scroll`,
+    `  effects    ${fp.effects.join(", ") || "none"}`,
+    `  layout     ${fp.layout.join(" > ") || "none"}`
+  ].join("\n");
+}
+function merge(a, b) {
+  const byTell = { ...a.summary.byTell };
+  for (const [k, v] of Object.entries(b.summary.byTell)) byTell[k] = (byTell[k] ?? 0) + v;
+  return {
+    catalogueVersion: a.catalogueVersion,
+    findings: [...a.findings, ...b.findings],
+    rejectedExceptions: a.rejectedExceptions,
+    excepted: [...a.excepted, ...b.excepted],
+    suppressed: [...a.suppressed, ...b.suppressed],
+    summary: {
+      files: a.summary.files + b.summary.files,
+      findings: a.summary.findings + b.summary.findings,
+      byGeneration: { 1: a.summary.byGeneration[1] + b.summary.byGeneration[1], 2: a.summary.byGeneration[2] + b.summary.byGeneration[2], 3: a.summary.byGeneration[3] + b.summary.byGeneration[3] },
+      byTell,
+      blocking: a.summary.blocking + b.summary.blocking
+    }
+  };
+}
+function readSnapshot(path) {
+  const data = JSON.parse(readFileSync(path, "utf8"));
+  if (data.version !== SNAPSHOT_VERSION) throw new Error(`${path} is snapshot version ${String(data.version)}; this craft reads ${SNAPSHOT_VERSION}`);
+  return data;
+}
+async function readText(source, cwd) {
+  if (/^https?:\/\//i.test(source)) {
+    const res = await fetch(source);
+    if (!res.ok) throw new Error(`${source}: HTTP ${res.status}`);
+    return res.text();
+  }
+  const path = resolve(cwd, source);
+  if (!existsSync(path)) throw new Error(`no such file: ${source}`);
+  return readFileSync(path, "utf8");
+}
+async function resolvePages(source, cwd) {
+  const text = await readText(source, cwd);
+  if (!/^\s*<(?:\?xml|urlset|sitemapindex)/i.test(text)) return parseUrlList(text);
+  const { urls, sitemaps } = parseSitemap(text);
+  const nested = await Promise.all(sitemaps.map(async (s) => parseSitemap(await readText(s, cwd)).urls));
+  const all = [...urls, ...nested.flat()];
+  if (all.length === 0) throw new Error(`${source}: no <loc> entries`);
+  return [...new Set(all)];
+}
+function viewportsOf(flags) {
+  if (flags.viewport) return parseViewports(flags.viewport);
+  if (flags.width || flags.height) return [{ width: Number(flags.width ?? 1440), height: Number(flags.height ?? 900) }];
+  return [void 0];
+}
+async function runAudit(command, args, io) {
+  try {
+    const flags = parseFlags(args);
+    if (typeof flags === "string") throw new Error(flags);
+    const target = flags.positional[0];
+    if (command === "snapshot" && (flags.pages || flags.viewport)) throw new Error("craft snapshot takes one page; use --width and --height");
+    if (flags.pages && target) throw new Error("give a page or --pages, not both");
+    if (!target && !flags.pages) throw new Error(`usage: craft ${command} <url${command === "audit" ? " | snapshot.json> | --pages <sitemap.xml | urls.txt>" : ">"}`);
+    const viewports = viewportsOf(flags);
+    const audited = [];
+    const failed = [];
+    const local = target ? resolve(io.cwd, target) : "";
+    if (target && command === "audit" && /\.json$/i.test(target) && existsSync(local)) {
+      audited.push({ url: target, viewport: null, snapshot: readSnapshot(local) });
+    } else if (target && viewports.length === 1) {
+      const snapshot = await snapshotUrl(target, { viewport: viewports[0] });
+      audited.push({ url: target, viewport: viewports[0] ?? null, snapshot });
+    } else {
+      const urls = flags.pages ? await resolvePages(flags.pages, io.cwd) : [target];
+      for (const viewport of viewports) {
+        for (const r of await snapshotUrls(urls, { viewport })) {
+          if (r.snapshot) audited.push({ url: r.url, viewport: viewport ?? null, snapshot: r.snapshot });
+          else failed.push({ url: r.url, viewport: viewport ?? null, error: r.error ?? "no snapshot" });
+        }
+      }
+    }
+    if (audited.length === 0) throw new Error(`no page could be measured:
+${failed.map((f) => `  ${f.url}: ${f.error}`).join("\n")}`);
+    const single = audited.length === 1 && failed.length === 0;
+    if (flags.out) {
+      if (!single) throw new Error("--out saves one snapshot; drop --pages and --viewport, or snapshot each page");
+      writeFileSync(resolve(io.cwd, flags.out), `${JSON.stringify(audited[0].snapshot, null, 2)}
+`);
+    }
+    if (command === "snapshot") {
+      const { snapshot } = audited[0];
+      if (!flags.out) io.out(JSON.stringify(snapshot, null, 2));
+      else io.out(`craft snapshot: ${snapshot.url} saved to ${flags.out}`);
+      return 0;
+    }
+    const root = flags.repo ? resolve(io.cwd, flags.repo) : io.cwd;
+    const exceptions = loadExceptions(flags, root);
+    const config = loadConfig(flags, root);
+    const label = (a) => viewports.length > 1 && a.viewport ? `${a.snapshot.url} @ ${a.viewport.width}px` : a.snapshot.url;
+    let report = audited.map((a) => {
+      const r = auditSnapshot(a.snapshot, { exceptions });
+      return { ...r, findings: r.findings.map((f) => ({ ...f, path: label(a) })) };
+    }).reduce((acc, r) => merge(acc, r));
+    if (flags.repo) {
+      report = merge(scanSource(readPaths(["."], root, SOURCE_FILE, void 0, config.ignore), { exceptions }), report);
+    }
+    const prepared = prepareReport(report, flags, io, config);
+    if (!prepared) return 0;
+    const nulls = flags.null ? flags.null.split(",").map((p) => loadNull(p.trim(), io.cwd)) : [];
+    const pooled = nulls.flatMap((m, i) => m.runs.map((r) => nulls.length > 1 ? { ...r, id: `${i + 1}/${r.id}` } : r));
+    const pages = audited.map((a) => {
+      const fp = fingerprint(a.snapshot);
+      return { url: a.snapshot.url, viewport: a.viewport, fingerprint: fp, typicality: nulls.length ? typicality(fp, pooled) : null };
+    });
+    const unmeasured = failed.length > 0 && flags.strict ? 1 : 0;
+    if (flags.json) {
+      const extra = single ? { fingerprint: pages[0].fingerprint, typicality: pages[0].typicality, snapshot: flags.out ?? null } : {};
+      io.out(toJson({ report: prepared, ...extra, pages, failed }));
+      return Math.max(prepared.summary.blocking > 0 || flags.strict && prepared.summary.findings > 0 ? 1 : 0, unmeasured);
+    }
+    const title = single ? `craft audit ${audited[0].snapshot.url}` : `craft audit: ${audited.length} page${audited.length === 1 ? "" : "s"}`;
+    const code = finish(prepared, { ...flags, json: false }, title, io);
+    for (const page of pages) {
+      io.out("");
+      if (!single) io.out(`${page.url}${page.viewport ? ` @ ${page.viewport.width}px` : ""}`);
+      io.out(describeFingerprint(page.fingerprint));
+      if (page.typicality) {
+        io.out("");
+        io.out(describeTypicality(page.typicality, pooled.length, nulls.length));
+      }
+    }
+    if (failed.length) {
+      io.out("");
+      io.out("Not measured (never counts as a pass):");
+      for (const f of failed) io.out(`  ${f.url}${f.viewport ? ` @ ${f.viewport.width}px` : ""}: ${f.error}`);
+    }
+    return Math.max(code, unmeasured);
+  } catch (error) {
+    io.err(`craft: ${error.message}`);
+    return 2;
+  }
+}
+
+export {
+  describeFingerprint,
+  merge,
+  resolvePages,
+  runAudit
+};

package/dist/{cli-PRWTNFVP.js → cli-4ESXOLKV.js}

@@ -6,8 +6,8 @@ import {
   nullPath,
   runHarvest,
   runNull
-} from "./chunk-APO4BT2F.js";
-import "./chunk-JKIDWHG3.js";
+} from "./chunk-3OZQ4C5R.js";
+import "./chunk-2AJB27BJ.js";
 import "./chunk-QMYERCBB.js";
 import "./chunk-3NGWXZZE.js";
 export {

package/dist/{cli-ADQQURNR.js → cli-DBZMVYYV.js}

@@ -3,25 +3,28 @@ import {
 } from "./chunk-JWHC67ZS.js";
 import {
   merge
-} from "./chunk-U2JTFQKO.js";
-import "./chunk-TSKRBIOC.js";
+} from "./chunk-MSQ57PJU.js";
+import "./chunk-JP75P2DU.js";
 import {
   SIBLING_AT,
   compareToEstate,
   loadEstate
-} from "./chunk-2NQFIDLE.js";
+} from "./chunk-HOHHQB4N.js";
 import {
   loadNull,
   typicality
-} from "./chunk-APO4BT2F.js";
+} from "./chunk-3OZQ4C5R.js";
 import {
   COPY_FILE,
   NOT_COPY_DIR,
   SOURCE_FILE,
+  applySeverity,
+  loadConfig,
   loadExceptions,
   parseFlags,
-  readPaths
-} from "./chunk-JKIDWHG3.js";
+  readPaths,
+  toJson
+} from "./chunk-2AJB27BJ.js";
 import {
   fingerprint
 } from "./chunk-QMYERCBB.js";
@@ -259,17 +262,20 @@ async function runReport(command, args, io) {
       snap = JSON.parse(readFileSync(local, "utf8"));
       if (snap.version !== SNAPSHOT_VERSION) throw new Error(`${target2} is not a snapshot`);
     } else {
-      const { snapshotUrl } = await import("./audit-EGDNWSQB.js");
+      const { snapshotUrl } = await import("./audit-QIPXL7E4.js");
       snap = await snapshotUrl(target2);
     }
     const fp = fingerprint(snap);
     const repo = flags.repo ? resolve(io.cwd, flags.repo) : null;
     const exceptions = loadExceptions(flags, repo ?? io.cwd);
+    const config = loadConfig(flags, repo ?? io.cwd);
     let findings = auditSnapshot(snap, { exceptions });
     if (repo) {
-      findings = merge(scanSource(readPaths(["."], repo, SOURCE_FILE), { exceptions }), findings);
-      findings = merge(findings, checkCopy(readPaths(["."], repo, COPY_FILE, (d) => NOT_COPY_DIR(d) || d === "docs"), { exceptions }));
+      findings = merge(scanSource(readPaths(["."], repo, SOURCE_FILE, void 0, config.ignore), { exceptions }), findings);
+      const copyPaths = config.copyPaths ?? ["."];
+      findings = merge(findings, checkCopy(readPaths(copyPaths, repo, COPY_FILE, (d) => NOT_COPY_DIR(d) || d === "docs", config.ignore), { exceptions }));
     }
+    findings = applySeverity(findings, config);
     const nulls = flags.null ? flags.null.split(",").map((p) => loadNull(p.trim(), io.cwd)) : [];
     const typical = nulls.length ? typicality(fp, nulls.flatMap((m, i) => m.runs.map((r) => nulls.length > 1 ? { ...r, id: `${i + 1}/${r.id}` } : r))) : null;
     let estate = null;
@@ -297,8 +303,8 @@ async function runReport(command, args, io) {
       } else io.out(plan);
       return 0;
     }
-    io.out(flags.json ? JSON.stringify(report, null, 2) : formatCharacter(report));
-    if (flags.out) writeFileSync(resolve(io.cwd, flags.out), `${JSON.stringify(report, null, 2)}
+    io.out(flags.json ? toJson(report) : formatCharacter(report));
+    if (flags.out) writeFileSync(resolve(io.cwd, flags.out), `${toJson(report)}
 `);
     return flags.strict && report.verdict !== "decided" ? 1 : 0;
   } catch (error) {

package/dist/{cli-EK3GSAOW.js → cli-T5RD2BTK.js}

@@ -1,15 +1,17 @@
 import {
   describeFingerprint,
   merge,
+  resolvePages,
   runAudit
-} from "./chunk-U2JTFQKO.js";
-import "./chunk-TSKRBIOC.js";
-import "./chunk-APO4BT2F.js";
-import "./chunk-JKIDWHG3.js";
+} from "./chunk-MSQ57PJU.js";
+import "./chunk-JP75P2DU.js";
+import "./chunk-3OZQ4C5R.js";
+import "./chunk-2AJB27BJ.js";
 import "./chunk-QMYERCBB.js";
 import "./chunk-3NGWXZZE.js";
 export {
   describeFingerprint,
   merge,
+  resolvePages,
   runAudit
 };

package/dist/{cli-2WBGTBKD.js → cli-U3SZVHSK.js}

@@ -3,8 +3,9 @@ import {
   validateDirection
 } from "./chunk-JWHC67ZS.js";
 import {
-  parseFlags
-} from "./chunk-JKIDWHG3.js";
+  parseFlags,
+  toJson
+} from "./chunk-2AJB27BJ.js";
 import {
   fingerprint
 } from "./chunk-QMYERCBB.js";
@@ -287,7 +288,7 @@ function runDirection(args, io) {
         fingerprint: current,
         pathExists: (p) => existsSync(resolve(dirname(file), p))
       });
-      if (flags.json) io.out(JSON.stringify(report, null, 2));
+      if (flags.json) io.out(toJson(report));
       else {
         for (const p of report.problems) io.out(`  ${p.severity === "error" ? "error" : "warn "}  ${p.at || "(file)"}  ${p.message}`);
         io.out(`craft direction: ${report.valid ? "valid" : "not valid"}, ${report.decided} of 7 choices decided with a reason.`);

package/dist/{cli-VQUNNIZM.js → cli-VREYWCT4.js}

@@ -3,9 +3,9 @@ import {
   formatPairs,
   loadEstate,
   runEstate
-} from "./chunk-2NQFIDLE.js";
-import "./chunk-APO4BT2F.js";
-import "./chunk-JKIDWHG3.js";
+} from "./chunk-HOHHQB4N.js";
+import "./chunk-3OZQ4C5R.js";
+import "./chunk-2AJB27BJ.js";
 import "./chunk-QMYERCBB.js";
 import "./chunk-3NGWXZZE.js";
 export {

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   run
-} from "./chunk-JKIDWHG3.js";
+} from "./chunk-2AJB27BJ.js";
 import "./chunk-3NGWXZZE.js";
 
 // src/cli.ts