@trailmark/core 0.1.0

package/test/report.build.test.ts

@@ -0,0 +1,191 @@
+import { describe, expect, it } from "vitest"
+import { buildBaselineFromRun } from "../src/baseline"
+import { diffRuns } from "../src/diff"
+import { buildReport } from "../src/report/buildReport"
+import { TrailmarkFinding, TrailmarkRun } from "../src/types"
+
+function makeFinding(overrides: Partial<TrailmarkFinding>): TrailmarkFinding {
+  return {
+    issueId: "issue-a",
+    relaxedIssueId: "relaxed-a",
+    ruleId: "image-alt",
+    impact: "serious",
+    tags: ["wcag2a"],
+    pageUrl: "https://example.com/checkout",
+    pageKey: "example.com/checkout",
+    target: ["img.hero"],
+    targetHash: "target-a",
+    selectorHint: "img.hero",
+    failureSummary: "Element does not have an alt attribute",
+    ...overrides,
+  }
+}
+
+function makeRun(findings: TrailmarkFinding[]): TrailmarkRun {
+  return {
+    version: 1,
+    startedAt: "2026-01-01T00:00:00.000Z",
+    finishedAt: "2026-01-01T00:00:20.000Z",
+    tool: { name: "trailmark", version: "0.1.0", scanner: "@axe-core/playwright" },
+    findings,
+    scanErrors: [],
+  }
+}
+
+describe("buildReport", () => {
+  it("builds deterministic summary and issue/occurrence grouping", () => {
+    const baselineRun = makeRun([
+      makeFinding({
+        issueId: "issue-a",
+        relaxedIssueId: "relaxed-a",
+        impact: "serious",
+      }),
+    ])
+    const baseline = buildBaselineFromRun(baselineRun, { configHash: "cfg" })
+
+    const currentRun = makeRun([
+      makeFinding({
+        issueId: "issue-c",
+        relaxedIssueId: "relaxed-c",
+        ruleId: "color-contrast",
+        impact: "critical",
+        pageUrl: "https://example.com/cart",
+        pageKey: "example.com/cart",
+        target: ["button.checkout"],
+        targetHash: "target-c",
+        selectorHint: "button.checkout",
+        occurredAt: "2026-01-01T00:00:10.000Z",
+        meta: {
+          testId: "t-2",
+          projectName: "chromium",
+        },
+      }),
+      makeFinding({
+        issueId: "issue-b",
+        relaxedIssueId: "relaxed-b",
+        ruleId: "label",
+        impact: "moderate",
+        pageUrl: "https://example.com/checkout",
+        pageKey: "example.com/checkout",
+        target: ["input#email"],
+        targetHash: "target-b",
+        selectorHint: "input#email",
+        occurredAt: "2026-01-01T00:00:11.000Z",
+        meta: {
+          testId: "t-3",
+          projectName: "chromium",
+        },
+        attachments: [
+          {
+            kind: "viewport",
+            path: ".trailmark/artifacts/run-1/moderate__label__example_com_checkout__issue-b__viewport.png",
+          },
+        ],
+      }),
+      makeFinding({
+        issueId: "issue-b",
+        relaxedIssueId: "relaxed-b",
+        ruleId: "label",
+        impact: "moderate",
+        pageUrl: "https://example.com/checkout",
+        pageKey: "example.com/checkout",
+        target: ["input#email"],
+        targetHash: "target-b",
+        selectorHint: "input#email",
+        occurredAt: "2026-01-01T00:00:12.000Z",
+        meta: {
+          testId: "t-3",
+          projectName: "chromium",
+        },
+      }),
+      makeFinding({
+        issueId: "issue-b",
+        relaxedIssueId: "relaxed-b",
+        ruleId: "label",
+        impact: "moderate",
+        pageUrl: "https://example.com/checkout",
+        pageKey: "example.com/checkout",
+        target: ["input#email"],
+        targetHash: "target-b",
+        selectorHint: "input#email",
+        occurredAt: "2026-01-01T00:00:13.000Z",
+        meta: {
+          testId: "t-4",
+          projectName: "webkit",
+        },
+      }),
+      makeFinding({
+        issueId: "issue-a",
+        relaxedIssueId: "relaxed-a",
+        impact: "serious",
+        occurredAt: "2026-01-01T00:00:14.000Z",
+      }),
+    ])
+
+    const diff = diffRuns(baseline, currentRun, { failOnImpact: ["serious", "critical"] })
+    const report = buildReport({
+      run: currentRun,
+      mode: "check",
+      configHash: "cfg",
+      diff,
+      createdAt: "2026-01-01T00:01:00.000Z",
+    })
+
+    expect(report.run.reportVersion).toBe(2)
+    expect(report.run.createdAt).toBe("2026-01-01T00:01:00.000Z")
+
+    expect(report.summary).toEqual({
+      scannedPages: 2,
+      totalIssues: 3,
+      totalOccurrences: 5,
+      scanErrors: 0,
+      newIssues: 2,
+      existingIssues: 1,
+      resolvedIssues: 0,
+      byImpact: {
+        critical: 1,
+        moderate: 1,
+        serious: 1,
+      },
+      byRuleId: {
+        "color-contrast": 1,
+        "image-alt": 1,
+        label: 1,
+      },
+      byPageKey: {
+        "example.com/cart": 1,
+        "example.com/checkout": 2,
+      },
+    })
+
+    expect(report.issues.map((issue) => issue.issueId)).toEqual(["issue-c", "issue-a", "issue-b"])
+
+    const issueB = report.issues.find((issue) => issue.issueId === "issue-b")
+    expect(issueB?.occurrences).toHaveLength(2)
+    expect(issueB?.occurrences[0].attachments[0].path).toContain("moderate__label")
+
+    expect(report.diff).toEqual({
+      newIssueIds: ["issue-b", "issue-c"],
+      existingIssueIds: ["issue-a"],
+      resolvedIssueIds: [],
+      newIssues: [
+        {
+          issueId: "issue-c",
+          ruleId: "color-contrast",
+          impact: "critical",
+          pageKey: "example.com/cart",
+          selectorHint: "button.checkout",
+          occurrenceCount: 1,
+        },
+        {
+          issueId: "issue-b",
+          ruleId: "label",
+          impact: "moderate",
+          pageKey: "example.com/checkout",
+          selectorHint: "input#email",
+          occurrenceCount: 2,
+        },
+      ],
+    })
+  })
+})

package/test/report.console.test.ts

@@ -0,0 +1,102 @@
+import { describe, expect, it } from "vitest"
+import { buildBaselineFromRun } from "../src/baseline"
+import { diffRuns } from "../src/diff"
+import { buildReport } from "../src/report/buildReport"
+import { formatConsoleReport } from "../src/report/formatConsole"
+import { TrailmarkFinding, TrailmarkRun } from "../src/types"
+
+function makeFinding(overrides: Partial<TrailmarkFinding>): TrailmarkFinding {
+  return {
+    issueId: "issue-a",
+    relaxedIssueId: "relaxed-a",
+    ruleId: "image-alt",
+    impact: "serious",
+    tags: ["wcag2a"],
+    pageUrl: "https://example.com/checkout",
+    pageKey: "example.com/checkout",
+    target: ["img.hero"],
+    targetHash: "target-a",
+    selectorHint: "img.hero",
+    failureSummary: "Element does not have an alt attribute",
+    ...overrides,
+  }
+}
+
+function makeRun(findings: TrailmarkFinding[]): TrailmarkRun {
+  return {
+    version: 1,
+    startedAt: "2026-01-01T00:00:00.000Z",
+    finishedAt: "2026-01-01T00:00:20.000Z",
+    tool: { name: "trailmark", version: "0.1.0", scanner: "@axe-core/playwright" },
+    findings,
+    scanErrors: [],
+  }
+}
+
+describe("formatConsoleReport", () => {
+  it("formats grouped NEW issue output with artifacts and reproduce hint", () => {
+    const baselineRun = makeRun([
+      makeFinding({
+        issueId: "issue-a",
+        relaxedIssueId: "relaxed-a",
+      }),
+    ])
+    const baseline = buildBaselineFromRun(baselineRun, { configHash: "cfg" })
+
+    const currentRun = makeRun([
+      makeFinding({ issueId: "issue-a", relaxedIssueId: "relaxed-a" }),
+      makeFinding({
+        issueId: "issue-b",
+        relaxedIssueId: "relaxed-b",
+        ruleId: "label",
+        impact: "moderate",
+        target: ["input#email"],
+        targetHash: "target-b",
+        selectorHint: "input#email",
+        meta: {
+          testId: "checkout-a11y",
+          projectName: "chromium",
+        },
+        attachments: [
+          {
+            kind: "viewport",
+            path: ".trailmark/artifacts/20260101/moderate__label__example_com_checkout__issue-b__viewport.png",
+          },
+        ],
+      }),
+    ])
+
+    const diff = diffRuns(baseline, currentRun, { failOnImpact: ["serious", "critical"] })
+    const report = buildReport({ run: currentRun, mode: "check", configHash: "cfg", diff })
+
+    expect(
+      formatConsoleReport(report, { failOnImpact: ["serious", "critical"], topPagesPerRule: 2 }),
+    ).toEqual(
+      `trailmark: scanned pages=1 | total issues=2 | NEW=1 | fail on=serious, critical\ntrailmark: [moderate] 1 NEW issue(s)\n  rule label (1) top pages: example.com/checkout\n  - moderate | label | example.com/checkout | input#email\n    artifact: .trailmark/artifacts/20260101/moderate__label__example_com_checkout__issue-b__viewport.png\n    reproduce: testId=checkout-a11y url=https://example.com/checkout`,
+    )
+  })
+
+  it("prints a concise message when no new issues are present", () => {
+    const baselineRun = makeRun([
+      makeFinding({
+        issueId: "issue-a",
+        relaxedIssueId: "relaxed-a",
+      }),
+    ])
+    const baseline = buildBaselineFromRun(baselineRun, { configHash: "cfg" })
+
+    const currentRun = makeRun([
+      makeFinding({
+        issueId: "issue-a",
+        relaxedIssueId: "relaxed-a",
+      }),
+    ])
+
+    const diff = diffRuns(baseline, currentRun, { failOnImpact: ["serious", "critical"] })
+    const report = buildReport({ run: currentRun, mode: "check", configHash: "cfg", diff })
+
+    expect(formatConsoleReport(report)).toContain(
+      "trailmark: no new accessibility violations compared to baseline.",
+    )
+  })
+})

package/test/url.test.ts

@@ -0,0 +1,25 @@
+import { describe, expect, it } from "vitest"
+import { normalizeUrlToPageKey } from "../src/url"
+
+describe("normalizeUrlToPageKey", () => {
+  it("lowercases host and strips hash/query by default", () => {
+    const key = normalizeUrlToPageKey("https://EXAMPLE.com/Checkout?order=123#summary")
+    expect(key).toBe("example.com/Checkout")
+  })
+
+  it("keeps allowed query parameters only", () => {
+    const key = normalizeUrlToPageKey("https://shop.example.com/p?sku=abc&utm=1&lang=en", {
+      stripQuery: { allow: ["sku", "lang"] },
+    })
+
+    expect(key).toBe("shop.example.com/p?lang=en&sku=abc")
+  })
+
+  it("applies route replacements in order", () => {
+    const key = normalizeUrlToPageKey("https://example.com/products/12345", {
+      routePatterns: [{ match: "products/\\d+", replace: "products/:id" }],
+    })
+
+    expect(key).toBe("example.com/products/:id")
+  })
+})

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts"]
+}