@hawkeyexl/manni 2.3.8 → 2.3.9

package/dist/cli.js

@@ -7,15 +7,19 @@ import {
   readStdin,
   reportConfig,
   splitList
-} from "./chunk-L73SKPCW.js";
+} from "./chunk-HOLRWVCO.js";
 import {
   CiteError,
   KeyError,
+  RULE_ID_PREFIX,
   SEVERITIES,
   SEVERITY_LIST,
   asCiteError,
   codeEndAt,
   codeRegions,
+  errorSite,
+  findingMessage,
+  isCiteRule,
   isSeverity,
   meetsSeverity,
   renderCheckGithub,
@@ -32,7 +36,7 @@ import {
   shortPin,
   shortSrc,
   spellSource
-} from "./chunk-TIZE6GXU.js";
+} from "./chunk-YSI2VNKE.js";
 import {
   COMMON_FORMAT_LIST,
   OMITTED_WHEN_CLEAN,
@@ -59,7 +63,6 @@ import {
   palette,
   programName,
   readConfigFile,
-  render,
   renderJunit,
   renderSarif,
   resolveBaselineRequest,
@@ -71,7 +74,7 @@ import {
   splitPageArgument,
   terminalConfirm,
   valeConfigPath
-} from "./chunk-EYD2RYKV.js";
+} from "./chunk-LC4H35XX.js";
 
 // src/cli.ts
 import { Command as Command5 } from "commander";
@@ -762,7 +765,7 @@ var A11Y_FORMAT_LIST = A11Y_FORMATS.join(" | ");
 function isA11yFormat(value) {
   return A11Y_FORMATS.includes(value);
 }
-function render2(format, run, opts) {
+function render(format, run, opts) {
   switch (format) {
     case "pretty":
       return renderPretty(run, opts);
@@ -971,7 +974,7 @@ function buildProgram2() {
         { analyzer: createPlaywrightAnalyzer(), onProgress: progress.listener }
       );
       const color = resolveColor(parent, process.stdout);
-      const text2 = render2(format, run, { color, quiet: Boolean(options.quiet) });
+      const text2 = render(format, run, { color, quiet: Boolean(options.quiet) });
       if (text2.length > 0 || format !== "github") {
         process.stdout.write(`${text2}
 `);
@@ -987,7 +990,71 @@ function buildProgram2() {
 
 // src/cite/cli.ts
 import { Command as Command2, Option } from "commander";
+
+// src/cite/reporters/sarif.ts
+var INFORMATION_URI = "https://hawkeyexl.github.io/manni/cite/";
+var RULES_URI = "https://hawkeyexl.github.io/manni/cite/reference/citations/";
+var RULE_DESCRIPTIONS = {
+  "source-moved": "The cited source lines moved to one other place in the file.",
+  "source-moved-ambiguous": "The cited source lines now match at several places in the file.",
+  "source-changed": "The cited source lines changed since the citation pinned them.",
+  "source-never-true": "The pin never matched the source at the recorded commit.",
+  "source-missing": "The cited source file is not tracked under the root, or cannot be decrypted.",
+  "claim-moved": "The cited sentence moved to other lines of the page.",
+  "claim-moved-ambiguous": "The cited sentence now appears at several places on the page.",
+  "claim-changed": "The cited sentence was edited since the citation pinned it.",
+  "marker-orphan": "A marker names an id no citation has.",
+  "marker-invalid": "A marker is malformed, or the page has too many markers.",
+  "marker-repeated": "Two markers name the same citation id.",
+  "anchor-invalid": "A citation's anchor cannot work.",
+  "entry-invalid": "A citation entry is malformed.",
+  "quote-drift": "A quoted block no longer reproduces its source."
+};
+var ENTRY_LABEL = /^(?:\(root\)|\/citations\/\d+) /;
+function withFindingMessages(run) {
+  return run.results.map((result) => {
+    const page = run.pages.find((p) => p.file === result.file);
+    if (page === void 0) return result;
+    const errors = result.errors.map((error) => {
+      const finding = page.findings.find(
+        (f) => f.rule === error.keyword && (f.index === void 0 ? "" : `/citations/${String(f.index)}`) === error.instancePath && f.message === error.message && (errorSite(f).line ?? null) === (error.line ?? null)
+      );
+      return finding === void 0 ? error : { ...error, message: findingMessage(finding) };
+    });
+    return { ...result, errors };
+  });
+}
+function describe(rule) {
+  const name = rule.id.slice(RULE_ID_PREFIX.length + 1);
+  if (!isCiteRule(name)) return rule;
+  return { id: rule.id, shortDescription: { text: RULE_DESCRIPTIONS[name] }, helpUri: `${RULES_URI}#${name}` };
+}
+function renderCheckSarif(run, opts = {}) {
+  const log = JSON.parse(
+    renderSarif(withFindingMessages(run), {
+      frame: run.frame,
+      ...opts.onNotice === void 0 ? {} : { onNotice: opts.onNotice }
+    })
+  );
+  for (const sarifRun of log.runs) {
+    sarifRun.tool.driver.informationUri = INFORMATION_URI;
+    sarifRun.tool.driver.rules = sarifRun.tool.driver.rules.map(describe);
+    for (const result of sarifRun.results) result.message.text = result.message.text.replace(ENTRY_LABEL, "");
+  }
+  return JSON.stringify(log, null, 2);
+}
+
+// src/cite/reporters/junit.ts
 var JUNIT_CLASSNAME = "manni.cite";
+var MESSAGE_LABEL = new RegExp(`message="${ENTRY_LABEL.source.replace(/^\^/, "")}`, "g");
+function renderCheckJunit(run) {
+  return renderJunit(withFindingMessages(run), { frame: run.frame, classname: JUNIT_CLASSNAME }).replace(
+    MESSAGE_LABEL,
+    'message="'
+  );
+}
+
+// src/cite/cli.ts
 var UPDATE_FORMATS = ["pretty", "json"];
 function colorFor(command, isTTY, env) {
   const noColor = colorOwner(command).opts().color === false;
@@ -1122,12 +1189,12 @@ function buildProgram3() {
         case "github":
           text2 = renderCheckGithub(run);
           break;
-        default:
-          text2 = render(format, run.results, run.summary, {
-            frame: run.frame,
-            classname: JUNIT_CLASSNAME,
-            onNotice: notice
-          });
+        case "sarif":
+          text2 = renderCheckSarif(run, { onNotice: notice });
+          break;
+        case "junit":
+          text2 = renderCheckJunit(run);
+          break;
       }
       if (text2.length > 0 || !OMITTED_WHEN_CLEAN.has(format)) {
         process.stdout.write(`${text2}
@@ -1694,7 +1761,7 @@ async function resolveTermRun(opts) {
 }
 
 // src/term/core/severity.ts
-var RULE_ID_PREFIX = "manni:term";
+var RULE_ID_PREFIX2 = "manni:term";
 var DEFAULT_SEVERITY = {
   "undefined-term": "error",
   "duplicate-id": "error",
@@ -1708,10 +1775,10 @@ var DEFAULT_SEVERITY = {
   "unused-term": "notice"
 };
 function ruleId(rule) {
-  return `${RULE_ID_PREFIX}/${rule}`;
+  return `${RULE_ID_PREFIX2}/${rule}`;
 }
 function proseRuleId(check) {
-  return `${RULE_ID_PREFIX}/prose/${check}`;
+  return `${RULE_ID_PREFIX2}/prose/${check}`;
 }
 function isTermRule2(value) {
   return TERM_RULES.includes(value);
@@ -1928,11 +1995,11 @@ var FINDING_FORMATS = ["pretty", "json", "github", "sarif", "junit"];
 var JUNIT_CLASSNAME2 = "manni.term";
 var LINE_REFERENCE = /:\d+\b/g;
 function toFieldError(finding) {
-  const keyword = finding.ruleId.startsWith(`${RULE_ID_PREFIX}/`) ? finding.ruleId.slice(RULE_ID_PREFIX.length + 1) : finding.ruleId;
+  const keyword = finding.ruleId.startsWith(`${RULE_ID_PREFIX2}/`) ? finding.ruleId.slice(RULE_ID_PREFIX2.length + 1) : finding.ruleId;
   const { field } = finding;
   const subject = [finding.id ?? "", field ?? "", finding.message.replace(LINE_REFERENCE, "")].join("\0");
   const error = {
-    schema: RULE_ID_PREFIX,
+    schema: RULE_ID_PREFIX2,
     instancePath: field === void 0 ? "" : `/${field}`,
     message: finding.message,
     keyword,
@@ -1957,7 +2024,7 @@ function toResults(set, findings) {
   }
   const results = [...byFile.keys()].sort().map((file) => {
     const errors = byFile.get(file) ?? [];
-    return { file, format: "term", ok: !errors.some(isErrorSeverity), schemas: [RULE_ID_PREFIX], errors };
+    return { file, format: "term", ok: !errors.some(isErrorSeverity), schemas: [RULE_ID_PREFIX2], errors };
   });
   return { results, origin };
 }
@@ -4429,9 +4496,9 @@ var INTERCHANGE_LABELS = {
 };
 function rendered(writers, format, construct) {
   return writers.some((writer) => {
-    const render3 = DOCUMENT_RENDERS[writer.format];
-    if (render3?.input !== format) return false;
-    return writer.shapes.some((shape) => render3.shapes[shape] === construct);
+    const render2 = DOCUMENT_RENDERS[writer.format];
+    if (render2?.input !== format) return false;
+    return writer.shapes.some((shape) => render2.shapes[shape] === construct);
   });
 }
 function listFormats(opts = {}) {
@@ -4868,14 +4935,14 @@ async function runWrite(opts) {
   const shape = format === "vale" || /[\\/]$/.test(opts.out ?? "") || isDirectory(targetPath) ? "directory" : "file";
   const target = { path: targetPath, shape };
   const existing = await existingFor(target);
-  let render3;
+  let render2;
   try {
-    render3 = writer.render(set.terms, target, { existing });
+    render2 = writer.render(set.terms, target, { existing });
   } catch (error) {
     if (error instanceof TermError) throw relativized(error, [...existing.keys(), targetPath], cwd);
     throw error;
   }
-  const changes = await applyChanges(render3.files, render3.removals, existing, cwd, !check && !dryRun);
+  const changes = await applyChanges(render2.files, render2.removals, existing, cwd, !check && !dryRun);
   const shown = format === "vale" ? displayPath(join4(targetPath, STYLE2), cwd) : opts.out ?? displayPath(targetPath, cwd);
   return {
     mode: "render",
@@ -4884,11 +4951,11 @@ async function runWrite(opts) {
     target: shown,
     terms: set.terms.length,
     changes,
-    files: render3.files.map((file) => ({ path: displayPath(file.path, cwd), content: file.content })),
+    files: render2.files.map((file) => ({ path: displayPath(file.path, cwd), content: file.content })),
     // A Vale style holds designations only, by design; its dropped definitions are not news.
-    dropped: format === "vale" ? [] : render3.dropped,
+    dropped: format === "vale" ? [] : render2.dropped,
     droppedFrom: droppedFrom(format, shape, readers),
-    skipped: render3.skipped,
+    skipped: render2.skipped,
     check,
     dryRun,
     ...wiring === void 0 ? {} : { wiring }
@@ -5034,9 +5101,9 @@ function renderFormatsJson(rows) {
 }
 
 // src/term/reporters/sarif.ts
-var INFORMATION_URI = "https://hawkeyexl.github.io/manni/term/";
-var RULES_URI = "https://hawkeyexl.github.io/manni/term/reference/rules/";
-var RULE_DESCRIPTIONS = {
+var INFORMATION_URI2 = "https://hawkeyexl.github.io/manni/term/";
+var RULES_URI2 = "https://hawkeyexl.github.io/manni/term/reference/rules/";
+var RULE_DESCRIPTIONS2 = {
   "undefined-term": "A page's concepts: names a label no entry claims as its preferred label.",
   "duplicate-id": "Two entries share an id.",
   "label-collision": "Two entries claim the same preferred label, ignoring case.",
@@ -5048,16 +5115,16 @@ var RULE_DESCRIPTIONS = {
   "abstract-too-long": "An abstract is longer than term.abstractMaxLength.",
   "unused-term": "No page's concepts: names the entry's preferred label."
 };
-var PROSE_PREFIX = `${RULE_ID_PREFIX}/prose/`;
+var PROSE_PREFIX = `${RULE_ID_PREFIX2}/prose/`;
 var FIELD_LABEL = new RegExp(`^(?:\\(root\\)|/(?:${TERM_FIELDS.join("|")})) `);
-function describe(rule) {
+function describe2(rule) {
   if (rule.id.startsWith(PROSE_PREFIX)) {
     const check = rule.id.slice(PROSE_PREFIX.length);
     return { id: rule.id, shortDescription: { text: `Vale's ${check} rule flagged the prose of an entry's field.` } };
   }
-  const name = rule.id.slice(RULE_ID_PREFIX.length + 1);
+  const name = rule.id.slice(RULE_ID_PREFIX2.length + 1);
   if (!isTermRule2(name)) return rule;
-  return { id: rule.id, shortDescription: { text: RULE_DESCRIPTIONS[name] }, helpUri: `${RULES_URI}#${name}` };
+  return { id: rule.id, shortDescription: { text: RULE_DESCRIPTIONS2[name] }, helpUri: `${RULES_URI2}#${name}` };
 }
 function renderFindingsSarif(report, opts = {}) {
   const log = JSON.parse(
@@ -5067,18 +5134,18 @@ function renderFindingsSarif(report, opts = {}) {
     })
   );
   for (const run of log.runs) {
-    run.tool.driver.informationUri = INFORMATION_URI;
-    run.tool.driver.rules = run.tool.driver.rules.map(describe);
+    run.tool.driver.informationUri = INFORMATION_URI2;
+    run.tool.driver.rules = run.tool.driver.rules.map(describe2);
     for (const result of run.results) result.message.text = result.message.text.replace(FIELD_LABEL, "");
   }
   return JSON.stringify(log, null, 2);
 }
 
 // src/term/reporters/junit.ts
-var MESSAGE_LABEL = new RegExp(`message="${FIELD_LABEL.source.slice(1)}`, "g");
+var MESSAGE_LABEL2 = new RegExp(`message="${FIELD_LABEL.source.slice(1)}`, "g");
 function renderFindingsJunit(report) {
   return renderJunit(report.results, { frame: report.frame, classname: JUNIT_CLASSNAME2 }).replace(
-    MESSAGE_LABEL,
+    MESSAGE_LABEL2,
     'message="'
   );
 }