@hawkeyexl/manni 2.7.0 → 2.8.0

package/dist/cli.js

@@ -7,7 +7,7 @@ import {
   readStdin,
   reportConfig,
   splitList
-} from "./chunk-3V4FMZHD.js";
+} from "./chunk-MHB242JA.js";
 import {
   CiteError,
   KeyError,
@@ -40,9 +40,10 @@ import {
   shortPin,
   shortSrc,
   spellSource
-} from "./chunk-ELRE54LH.js";
+} from "./chunk-O6RXG33V.js";
 import {
   COMMON_FORMAT_LIST,
+  FAMILY_CONFIG_NAMES,
   OMITTED_WHEN_CLEAN,
   REPORT_FORMATS,
   REPORT_FORMAT_LIST,
@@ -62,6 +63,7 @@ import {
   isMachineFormat,
   isReportFormat,
   locateFrontmatter,
+  matchesFileGlob,
   notice,
   package_default,
   palette,
@@ -78,7 +80,7 @@ import {
   splitPageArgument,
   terminalConfirm,
   valeConfigPath
-} from "./chunk-2672QGFM.js";
+} from "./chunk-MB3DIO7S.js";
 
 // src/cli.ts
 import { Command as Command5 } from "commander";
@@ -172,6 +174,7 @@ async function crawl(opts, analyzer) {
   const frontier = [];
   const seen = /* @__PURE__ */ new Set();
   const visited = /* @__PURE__ */ new Set();
+  const excluded = /* @__PURE__ */ new Set();
   const progress = opts.onProgress ?? (() => void 0);
   const enqueue = (raw, source) => {
     let url;
@@ -184,6 +187,10 @@ async function crawl(opts, analyzer) {
     }
     if (source !== "seed" && !isPageLink(url)) return;
     if (!opts.seeds.some((seed) => sameHost(seed, url))) return;
+    if (opts.exclude?.matches(url) === true) {
+      excluded.add(key);
+      return;
+    }
     if (seen.has(key)) return;
     seen.add(key);
     frontier.push({ url, key, source });
@@ -199,6 +206,9 @@ async function crawl(opts, analyzer) {
   };
   for (const seed of opts.seeds) enqueue(seed, "seed");
   if (opts.crawl) for (const url of opts.extra) enqueue(url, "sitemap");
+  if (excluded.size > 0) {
+    progress({ kind: "excluded", urls: excluded.size, patterns: opts.exclude?.patterns.length ?? 0 });
+  }
   const pages = [];
   let duplicates = 0;
   const capped = () => opts.maxPages !== void 0 && pages.length >= opts.maxPages;
@@ -229,7 +239,37 @@ async function crawl(opts, analyzer) {
   }
   const skipped2 = frontier.length - pages.length - duplicates;
   progress({ kind: "done", checked: pages.length, skipped: skipped2 });
-  return { pages, discovered: frontier.length, skipped: skipped2, duplicates };
+  return { pages, discovered: frontier.length, skipped: skipped2, duplicates, excluded: excluded.size };
+}
+
+// src/a11y/core/exclude.ts
+var MUST_START_WITH_SLASH = 'must start with "/": it matches a URL path.';
+function isUrlPathGlob(pattern) {
+  return pattern.startsWith("/");
+}
+function excludePath(url) {
+  let parsed;
+  try {
+    parsed = new URL(url);
+  } catch {
+    return null;
+  }
+  const path = parsed.pathname;
+  return path.length > 1 && path.endsWith("/") ? path.slice(0, -1) : path;
+}
+function createExcludeFilter(patterns) {
+  const list = [...patterns];
+  const match = (url) => {
+    if (list.length === 0) return null;
+    const path = excludePath(url);
+    if (path === null) return null;
+    return list.find((pattern) => matchesFileGlob(path, pattern.glob)) ?? null;
+  };
+  return {
+    patterns: list,
+    match,
+    matches: (url) => match(url) !== null
+  };
 }
 
 // src/a11y/core/seeds.ts
@@ -401,7 +441,8 @@ var CHECK_DEFAULTS = Object.freeze({
   crawl: true,
   tags: [],
   severity: "notice",
-  timeout: 3e4
+  timeout: 3e4,
+  exclude: []
 });
 async function runCheck2(opts, deps) {
   const { analyzer } = deps;
@@ -413,6 +454,12 @@ async function runCheck2(opts, deps) {
       if (!isHttpUrl(url)) throw new A11yError(`Not an http(s) URL: "${url}".`);
     }
     const seeds = opts.urls.map(normalizeUrl);
+    const exclude = createExcludeFilter(opts.exclude);
+    const contradictions = seeds.map((seed) => {
+      const pattern = exclude.match(seed);
+      return pattern === null ? null : `${pattern.source} excludes the seed ${seed}.`;
+    }).filter((line) => line !== null);
+    if (contradictions.length > 0) throw new A11yError(contradictions.join("\n"));
     let sitemap = { source: null, urls: [] };
     const first = seeds[0];
     if (opts.crawl && first !== void 0) {
@@ -425,6 +472,7 @@ async function runCheck2(opts, deps) {
         crawl: opts.crawl,
         maxPages: opts.maxPages,
         extra: sitemap.urls,
+        exclude,
         analyze: { tags: opts.tags, timeout: opts.timeout },
         onProgress: deps.onProgress
       },
@@ -446,7 +494,7 @@ function finishPage(page, floor) {
   const score = applicable === 0 ? null : Math.round(100 * page.passes / applicable);
   return { ...page, violations, score };
 }
-function summarize(results, { discovered, skipped: skipped2, duplicates }, sitemap, crawl2) {
+function summarize(results, { discovered, skipped: skipped2, duplicates, excluded }, sitemap, crawl2) {
   const bySeverity = { notice: 0, warning: 0, error: 0 };
   let failed = 0;
   let violations = 0;
@@ -462,6 +510,7 @@ function summarize(results, { discovered, skipped: skipped2, duplicates }, sitem
     checked: results.length,
     skipped: skipped2,
     duplicates,
+    excluded,
     failed,
     violations,
     bySeverity,
@@ -585,7 +634,7 @@ function reason(err) {
 
 // src/a11y/core/config.ts
 var SECTION = "a11y";
-var CONFIG_KEYS = ["urls", "crawl", "maxPages", "tags", "severity", "timeout"];
+var CONFIG_KEYS = ["urls", "crawl", "maxPages", "tags", "severity", "timeout", "exclude"];
 var CONFIG_FILE = {
   section: SECTION,
   // The a11y tool never had a pre-family file of its own.
@@ -625,8 +674,21 @@ function parseA11yConfig(value, source) {
   if (obj.timeout !== void 0) {
     config.timeout = asPositiveInteger(obj.timeout, "timeout", source);
   }
+  if (obj.exclude !== void 0) config.exclude = asExcludes(obj.exclude, source);
   return config;
 }
+function excludeEntryLabel(source, index) {
+  return `${source}: "${SECTION}.exclude[${String(index)}]"`;
+}
+function asExcludes(value, source) {
+  const globs = asStringList(value, "exclude", source);
+  globs.forEach((glob, i) => {
+    const at = excludeEntryLabel(source, i);
+    if (glob === "") throw new A11yError(`${at} must be a non-empty string.`);
+    if (!isUrlPathGlob(glob)) throw new A11yError(`${at} ${MUST_START_WITH_SLASH}`);
+  });
+  return globs;
+}
 function asStringList(value, field, source) {
   if (!Array.isArray(value) || !value.every((v) => typeof v === "string")) {
     throw new A11yError(`${source}: "${SECTION}.${field}" must be a list of strings.`);
@@ -717,7 +779,7 @@ function renderPretty(run, opts) {
     for (const v of page.violations) lines.push(...violationLines(v, c));
   }
   const failed = summary.failed;
-  const footer = `${summary.violations} violation${summary.violations === 1 ? "" : "s"} on ${failed} of ${summary.checked} pages` + (summary.skipped > 0 ? `; ${summary.skipped} skipped (--max-pages)` : "") + (summary.duplicates > 0 ? `; ${summary.duplicates} duplicate${summary.duplicates === 1 ? "" : "s"} dropped` : "");
+  const footer = `${summary.violations} violation${summary.violations === 1 ? "" : "s"} on ${failed} of ${summary.checked} pages` + (summary.skipped > 0 ? `; ${summary.skipped} skipped (--max-pages)` : "") + (summary.duplicates > 0 ? `; ${summary.duplicates} duplicate${summary.duplicates === 1 ? "" : "s"} dropped` : "") + (summary.excluded > 0 ? `; ${summary.excluded} excluded` : "");
   lines.push("");
   lines.push(failed > 0 ? c.red(footer) : c.green(footer));
   return lines.join("\n");
@@ -826,6 +888,9 @@ function terminalReporter(opts) {
         if (event.source === null) show("No sitemap; following links");
         else showUrl("Sitemap: ", event.source, ` (${plural(event.urls, "page")})`);
         return;
+      case "excluded":
+        show(`Excluded ${plural(event.urls, "page")} (${plural(event.patterns, "pattern")})`);
+        return;
       case "page":
         queued = event.queued;
         showUrl(`${c.dim(counter(event.index, queued))} `, event.url);
@@ -859,6 +924,9 @@ function plainReporter(stream) {
         if (event.source === null) say("no sitemap; following links");
         else say(`sitemap ${event.source} (${plural(event.urls, "page")})`);
         return;
+      case "excluded":
+        say(`excluded ${plural(event.urls, "page")} (${plural(event.patterns, "pattern")})`);
+        return;
       case "page":
         queued = event.queued;
         say(`${counter(event.index, queued)} ${event.url}`);
@@ -933,6 +1001,18 @@ function resolveMaxPages(flag, configured) {
 function resolveCrawl(flag, configured) {
   return flag ?? configured ?? CHECK_DEFAULTS.crawl;
 }
+function assertExcludeGlobs(globs) {
+  return globs.map((glob) => {
+    if (!isUrlPathGlob(glob)) {
+      throw new A11yError(`--exclude "${glob}" ${MUST_START_WITH_SLASH}`);
+    }
+    return { glob, source: `--exclude "${glob}"` };
+  });
+}
+function configExcludeGlobs(globs, source) {
+  const file = source ?? FAMILY_CONFIG_NAMES[0] ?? "manni.config.yaml";
+  return globs.map((glob, i) => ({ glob, source: excludeEntryLabel(file, i) }));
+}
 function assertSeverity(value) {
   if (!isSeverity(value)) {
     throw new A11yError(`Unknown --severity "${value}". Use ${SEVERITY_LIST}.`);
@@ -948,7 +1028,12 @@ function buildProgram2() {
   ).option("-f, --format <format>", `output: ${A11Y_FORMAT_LIST}`, "pretty").option("--crawl", "crawl from the given URLs: sitemap and link following (default)").option("--no-crawl", "check exactly the given URLs: no sitemap, no link following").option(
     "--max-pages <n>",
     "cap on pages checked; the rest are reported as skipped (default: no cap)"
-  ).option("--no-max-pages", "check every page found, ignoring a configured maxPages").option("--tags <list>", "comma-separated axe tags to restrict the rules to").option(
+  ).option("--no-max-pages", "check every page found, ignoring a configured maxPages").option(
+    "--exclude <glob>",
+    "URL path glob to keep out of the crawl; repeatable",
+    collect2,
+    []
+  ).option("--tags <list>", "comma-separated axe tags to restrict the rules to").option(
     "--severity <level>",
     `minimum severity reported: ${SEVERITY_LIST}`,
     CHECK_DEFAULTS.severity
@@ -972,6 +1057,7 @@ function buildProgram2() {
       const severity = assertSeverity(options.severity);
       const maxPages = parseMaxPages(options.maxPages);
       const timeout = positiveInteger(options.timeout, "--timeout");
+      const exclude = assertExcludeGlobs(options.exclude);
       const loaded = options.config === false ? { config: {}, source: null, collections: [] } : await loadA11yConfig(process.cwd(), options.config);
       const cfg = loaded.config;
       const seeds = resolveSeeds({
@@ -992,6 +1078,11 @@ function buildProgram2() {
           // to, and `--no-max-pages` is the typed way to ask for none.
           maxPages: resolveMaxPages(maxPages, cfg.maxPages),
           tags: options.tags !== void 0 ? splitList2(options.tags) : cfg.tags ?? CHECK_DEFAULTS.tags,
+          // A typed flag replaces the config list entirely; the two do not
+          // merge. Merging would only ever let a run exclude *more* than
+          // the repository's default, so checking one excluded section on
+          // purpose would need --no-config, which also drops collections:.
+          exclude: typed("exclude") ? exclude : configExcludeGlobs(cfg.exclude ?? [], loaded.source),
           severity: typed("severity") ? severity : cfg.severity ?? CHECK_DEFAULTS.severity,
           timeout: typed("timeout") ? timeout : cfg.timeout ?? CHECK_DEFAULTS.timeout
         },