@lucasacoutinho/archer 0.0.0-stage → 0.2.1

package/dist/chunk-67YEOTXP.js

@@ -0,0 +1,25 @@
+import {
+  formatResult
+} from "./chunk-IDVLHNL2.js";
+
+// src/testing/matchers.ts
+function isArchitectureCheck(value) {
+  return typeof value === "object" && value !== null && "check" in value && typeof value.check === "function";
+}
+async function toRespectArchitecture(received) {
+  if (!isArchitectureCheck(received)) {
+    throw new TypeError(
+      "toRespectArchitecture() expects an Archer suite created by createArcher() or arch()."
+    );
+  }
+  const result = await received.check();
+  return {
+    pass: result.ok,
+    message: () => result.ok ? "Expected the architecture check to report at least one finding." : formatResult(result)
+  };
+}
+var archerMatchers = { toRespectArchitecture };
+
+export {
+  archerMatchers
+};

package/dist/chunk-IDVLHNL2.js

@@ -0,0 +1,46 @@
+// src/reporting/format.ts
+function formatLocation(violation) {
+  if (violation.file === void 0) {
+    return "";
+  }
+  if (violation.line === void 0) {
+    return violation.file;
+  }
+  return `${violation.file}:${violation.line}:${violation.column ?? 1}`;
+}
+function formatResult(result) {
+  if (result.violations.length === 0) {
+    return `Archer checked ${result.filesAnalyzed} files and ${result.dependenciesAnalyzed} dependencies.`;
+  }
+  const violations = result.violations.map((violation) => {
+    const location = formatLocation(violation);
+    const prefix = location.length > 0 ? `  ${location}
+` : "  ";
+    const source = violation.sourceLine === void 0 ? "" : `
+    ${violation.sourceLine.trim()}
+    ${" ".repeat(Math.max(0, (violation.column ?? 1) - 1))}^`;
+    const chain = violation.importChain === void 0 || violation.importChain.length < 3 ? "" : `
+  Import chain: ${violation.importChain.join(" -> ")}`;
+    const reason = violation.reason === void 0 ? "" : `
+  Because: ${violation.reason}`;
+    const id = violation.ruleId === void 0 ? "" : ` [${violation.ruleId}]`;
+    return `${prefix}  ${violation.severity.toUpperCase()}${id}: ${violation.message}${source}
+  Rule: ${violation.rule}${reason}${chain}`;
+  });
+  return `${result.violations.length} architecture finding${result.violations.length === 1 ? "" : "s"}:
+
+${violations.join("\n\n")}`;
+}
+var ArchitectureError = class extends Error {
+  result;
+  constructor(result) {
+    super(formatResult(result));
+    this.name = "ArchitectureError";
+    this.result = result;
+  }
+};
+
+export {
+  formatResult,
+  ArchitectureError
+};

package/dist/chunk-ZZ6TR4PO.js

@@ -0,0 +1,201 @@
+import {
+  formatResult
+} from "./chunk-IDVLHNL2.js";
+
+// src/reporting/baseline.ts
+import { createHash } from "crypto";
+import { mkdir, readFile, writeFile } from "fs/promises";
+import path from "path";
+function violationFingerprint(violation) {
+  const stableDetail = violation.dependency ?? violation.sourceLine;
+  const identity = [
+    violation.ruleId ?? violation.rule,
+    violation.file ?? "",
+    stableDetail ?? (violation.ruleId === void 0 ? violation.message : "")
+  ].join("\0");
+  return createHash("sha256").update(identity).digest("hex").slice(0, 20);
+}
+function createBaseline(result) {
+  return {
+    generatedAt: (/* @__PURE__ */ new Date()).toISOString(),
+    version: 1,
+    violations: result.violations.map((violation) => ({
+      ...violation.file === void 0 ? {} : { file: violation.file },
+      fingerprint: violationFingerprint(violation),
+      message: violation.message,
+      rule: violation.ruleId ?? violation.rule
+    }))
+  };
+}
+async function readBaseline(fileName) {
+  const parsed = JSON.parse(await readFile(fileName, "utf8"));
+  if (typeof parsed !== "object" || parsed === null || !("version" in parsed) || parsed.version !== 1 || !("violations" in parsed) || !Array.isArray(parsed.violations) || parsed.violations.some(
+    (entry) => typeof entry !== "object" || entry === null || !("fingerprint" in entry) || typeof entry.fingerprint !== "string"
+  )) {
+    throw new TypeError(`Unsupported Archer baseline '${fileName}'.`);
+  }
+  return parsed;
+}
+async function writeBaseline(fileName, baseline) {
+  await mkdir(path.dirname(fileName), { recursive: true });
+  await writeFile(fileName, `${JSON.stringify(baseline, void 0, 2)}
+`, "utf8");
+}
+function applyBaseline(result, baseline) {
+  const known = new Set(baseline.violations.map((entry) => entry.fingerprint));
+  const violations = result.violations.filter(
+    (violation) => !known.has(violationFingerprint(violation))
+  );
+  const errors = violations.filter((violation) => violation.severity === "error").length;
+  const warnings = violations.filter((violation) => violation.severity === "warning").length;
+  const infos = violations.filter((violation) => violation.severity === "info").length;
+  return {
+    ...result,
+    errors,
+    infos,
+    ok: errors === 0,
+    violations,
+    warnings
+  };
+}
+
+// src/reporting/reporters.ts
+function singleLine(value) {
+  return value.replaceAll(/\s+/gu, " ").trim();
+}
+function agent(result) {
+  const status = result.errors > 0 ? "fail" : result.warnings > 0 ? "warn" : result.infos > 0 ? "info" : "ok";
+  const summary = [
+    `archer: ${status}`,
+    `files=${result.filesAnalyzed}`,
+    `dependencies=${result.dependenciesAnalyzed}`,
+    `errors=${result.errors}`,
+    `warnings=${result.warnings}`,
+    `infos=${result.infos}`
+  ].join(" ");
+  const findings = result.violations.map((violation) => {
+    const location = violation.file === void 0 ? "architecture" : `${violation.file}:${violation.line ?? 1}:${violation.column ?? 1}`;
+    const fields = [
+      `${location}: ${violation.severity} ${singleLine(ruleKey(violation))}: ${singleLine(violation.message)}`,
+      `rule=${JSON.stringify(singleLine(violation.rule))}`,
+      ...violation.reason === void 0 ? [] : [`reason=${JSON.stringify(singleLine(violation.reason))}`],
+      ...violation.dependency === void 0 ? [] : [`dependency=${JSON.stringify(violation.dependency)}`],
+      ...violation.sourceLine === void 0 ? [] : [`source=${JSON.stringify(singleLine(violation.sourceLine))}`],
+      ...violation.importChain === void 0 ? [] : [`import_chain=${JSON.stringify(violation.importChain)}`]
+    ];
+    return fields.join(" | ");
+  });
+  return [summary, ...findings].join("\n");
+}
+function sarifLevel(severity) {
+  return severity === "info" ? "note" : severity;
+}
+function ruleKey(violation) {
+  return violation.ruleId ?? violation.rule;
+}
+function sarif(result) {
+  const rules = [
+    ...new Map(
+      result.violations.map((violation) => [
+        ruleKey(violation),
+        {
+          id: ruleKey(violation),
+          shortDescription: { text: violation.rule }
+        }
+      ])
+    ).values()
+  ];
+  const results = result.violations.map((violation) => ({
+    level: sarifLevel(violation.severity),
+    message: { text: violation.message },
+    ...violation.file === void 0 ? {} : {
+      locations: [
+        {
+          physicalLocation: {
+            artifactLocation: { uri: violation.file },
+            ...violation.line === void 0 ? {} : {
+              region: {
+                startColumn: violation.column ?? 1,
+                startLine: violation.line
+              }
+            }
+          }
+        }
+      ]
+    },
+    ruleId: ruleKey(violation)
+  }));
+  return JSON.stringify(
+    {
+      $schema: "https://json.schemastore.org/sarif-2.1.0.json",
+      runs: [{ results, tool: { driver: { name: "Archer", rules } } }],
+      version: "2.1.0"
+    },
+    void 0,
+    2
+  );
+}
+function annotationValue(value) {
+  return value.replaceAll("%", "%25").replaceAll("\r", "%0D").replaceAll("\n", "%0A").replaceAll(":", "%3A").replaceAll(",", "%2C");
+}
+function github(result) {
+  if (result.violations.length === 0) {
+    return formatResult(result);
+  }
+  return result.violations.map((violation) => {
+    const level = violation.severity === "info" ? "notice" : violation.severity;
+    const attributes = [
+      ...violation.file === void 0 ? [] : [`file=${annotationValue(violation.file)}`],
+      ...violation.line === void 0 ? [] : [`line=${violation.line}`],
+      ...violation.column === void 0 ? [] : [`col=${violation.column}`],
+      `title=${annotationValue(ruleKey(violation))}`
+    ];
+    return `::${level} ${attributes.join(",")}::${annotationValue(violation.message)}`;
+  }).join("\n");
+}
+function dotEscape(value) {
+  return value.replaceAll("\\", "\\\\").replaceAll('"', '\\"');
+}
+function dot(graph) {
+  const lines = ["digraph archer {", "  rankdir=LR;"];
+  for (const sourceModule of graph.modules) {
+    lines.push(`  "${dotEscape(sourceModule.path)}" [shape=box];`);
+  }
+  for (const dependency of graph.dependencies) {
+    const style = dependency.kind === "type" ? ",style=dashed" : "";
+    lines.push(
+      `  "${dotEscape(dependency.from)}" -> "${dotEscape(dependency.target)}" [label="${dependency.kind}"${style}];`
+    );
+  }
+  lines.push("}");
+  return lines.join("\n");
+}
+function report(name, result, graph) {
+  switch (name) {
+    case "agent":
+    case "llm":
+      return agent(result);
+    case "pretty":
+      return formatResult(result);
+    case "json":
+      return JSON.stringify(result, void 0, 2);
+    case "sarif":
+      return sarif(result);
+    case "github":
+      return github(result);
+    case "dot":
+      if (graph === void 0) {
+        throw new TypeError("The DOT reporter needs an architecture graph.");
+      }
+      return dot(graph);
+  }
+}
+
+export {
+  violationFingerprint,
+  createBaseline,
+  readBaseline,
+  writeBaseline,
+  applyBaseline,
+  report
+};