pr-checkmate 3.3.0 → 4.0.1

package/dist/esm/core/checks/security/agent-instructions.js

@@ -0,0 +1,146 @@
+// cspell:ignore windsurfrules
+import { logger } from '../../../utils/index.js';
+import { listTrackedFiles } from '../../targets.js';
+import { skip } from '../../types.js';
+import { clientFindingOptions, diffAddedLines, emptyBuckets, mergeSeverityBuckets, reportSeverityBuckets, scanDiffPatterns, scanTrackedFiles, } from '../findings.js';
+/**
+ * Files that tell an AI agent what to do, or what it may do.
+ *
+ * They are code in every sense that matters: an agent reads them and acts, with
+ * the developer's shell and the developer's credentials. A pull request that edits
+ * one changes what every contributor's agent will do on its next run, and the diff
+ * is prose — which review tends to skim. That makes this the cheapest place in a
+ * repository to plant an instruction, and the least reviewed.
+ */
+const INSTRUCTION_GLOBS = [
+    'AGENTS.md',
+    '**/AGENTS.md',
+    'CLAUDE.md',
+    '**/CLAUDE.md',
+    'GEMINI.md',
+    '.cursorrules',
+    '.windsurfrules',
+    '.cursor/rules/**',
+    '.github/copilot-instructions.md',
+    '.claude/commands/**',
+    '.claude/agents/**',
+    '.claude/skills/**',
+    '.claude/settings.json',
+    '.mcp.json',
+];
+/** Dot-directories the file walk drops by default and this check lives in. */
+const KEEP_DIRS = ['.claude', '.cursor', '.github'];
+/**
+ * Characters a person cannot see and a model reads anyway: zero-width characters,
+ * bidirectional overrides and the Unicode "tag" block. Each has been used to hide
+ * an instruction inside text that looks harmless on screen. A byte-order mark is
+ * left out on purpose — editors put one at the top of ordinary files.
+ */
+const INVISIBLE = '[\\u200B-\\u200F\\u202A-\\u202E\\u2060-\\u2064\\u2066-\\u2069]|[\\u{E0000}-\\u{E007F}]';
+export const AGENT_PATTERNS = [
+    {
+        pattern: new RegExp(`^\\+(?!\\+).*(?:${INVISIBLE})`, 'u'),
+        label: 'invisible Unicode characters (can hide instructions from a human reviewer)',
+        severity: 'error',
+    },
+    {
+        pattern: 
+        // "Do not add X without telling the user" asks the agent to check in, so a
+        // `without` that follows a negation in the same sentence is not a match.
+        /^\+(?!\+)(?![^\n]*\b(?:do not|don't|never)\b[^.\n]*\bwithout\b).*\b(?:do not|don't|never|without)\b[^.\n]{0,30}\b(?:tell|telling|inform|informing|mention|show|reveal|notify)\b[^.\n]{0,20}\b(?:the )?(?:user|developer|human)\b/i,
+        label: 'tells the agent to hide something from the user',
+        severity: 'error',
+    },
+    {
+        pattern: /^\+(?!\+).*\b(?:send|post|upload|curl|wget|fetch|exfiltrate|email)\b[^\n]{0,80}(?:\.env\b|credentials?|secrets?|api[_ -]?keys?|\btokens?\b|\bssh\b|id_rsa)[^\n]{0,80}https?:\/\//i,
+        label: 'sends credentials or secrets to a URL',
+        severity: 'error',
+    },
+    {
+        pattern: /^\+(?!\+).*\b(?:ignore|disregard|forget|override)\b[^.\n]{0,40}\b(?:previous|prior|above|earlier|all|any)\b[^.\n]{0,30}\b(?:instructions?|rules|prompts?|guidelines)\b/i,
+        label: 'prompt-injection phrasing ("ignore previous instructions")',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+).*\b(?:curl|wget)\b[^|\n]*\|\s*(?:sudo\s+)?(?:sh|bash|zsh)\b/i,
+        label: 'pipes a download straight into a shell (an agent will run what it is told to run)',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+).*(?:--no-verify|--dangerously-skip-permissions|--no-gpg-sign)\b/,
+        label: 'instructs the agent to skip a safety check',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+)\s*"defaultMode"\s*:\s*"bypassPermissions"/,
+        label: 'bypassPermissions as the project default (every contributor’s agent runs without asking)',
+        severity: 'error',
+    },
+    {
+        pattern: /^\+(?!\+)\s*"enableAllProjectMcpServers"\s*:\s*true/,
+        label: 'auto-approves every MCP server this repository declares',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+)\s*"(?:Bash|Write|Edit)(?:\((?:\*|:\*)\))?"\s*,?\s*$/,
+        label: 'permission granted for every shell command or file write',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+).*"url"\s*:\s*"http:\/\/(?!localhost|127\.0\.0\.1|\[::1\])/,
+        label: 'MCP server reached over plain HTTP',
+        severity: 'warn',
+    },
+    {
+        // `"args": ["-y", "pkg"]` with no @version: whatever is published next runs on
+        // the machine of everyone who opens the repository.
+        pattern: /^\+(?!\+).*"args"\s*:\s*\[\s*"-y"\s*,\s*"(?:@[^/"@]+\/)?[^"@]+"/,
+        label: 'MCP server fetched with npx and no pinned version (the next publish runs on every contributor’s machine)',
+        severity: 'warn',
+    },
+];
+export const agentInstructionsCheck = {
+    name: 'Agent Instructions',
+    phase: 'informational',
+    // No `requiresDiff`: a hidden instruction is as live in a file that arrived last
+    // year as in one added today, so a whole-repository run reads them too.
+    applies(ctx) {
+        return ctx.config.agentInstructions?.enabled !== false;
+    },
+    async run(ctx) {
+        try {
+            const cfg = ctx.config.agentInstructions ?? {};
+            const found = emptyBuckets();
+            const scanInto = (stdout) => {
+                // `comments: 'off'`: these are Markdown and JSON, where a leading `#` is a
+                // heading and `//` is part of a URL — stripping them as comments would
+                // blank exactly the lines worth reading.
+                mergeSeverityBuckets(found, scanDiffPatterns(stdout, AGENT_PATTERNS, {
+                    comments: 'off',
+                    ignorePaths: cfg.ignorePaths,
+                }));
+            };
+            if (ctx.baseSha) {
+                scanInto(await diffAddedLines(ctx, INSTRUCTION_GLOBS));
+            }
+            else if (ctx.config.run?.fullScanBehaviour !== 'skip') {
+                const files = await listTrackedFiles(ctx, INSTRUCTION_GLOBS, ['.'], {
+                    keepDirs: KEEP_DIRS,
+                });
+                if (files === null)
+                    return skip('git unavailable');
+                await scanTrackedFiles(ctx, files, scanInto);
+            }
+            return reportSeverityBuckets(found.errors, found.warnings, {
+                prefix: 'Agent Instructions',
+                errorSummary: n => `${n} issue(s)`,
+                warningSummary: n => `${n} warning(s)`,
+                ...clientFindingOptions(ctx, cfg),
+            });
+        }
+        catch (err) {
+            logger.warn(`[Agent Instructions]: ⚠️ Could not analyze agent files\n${err}`);
+            return skip('agent files unavailable');
+        }
+    },
+};

package/dist/esm/core/checks/security/diff-security.d.ts

@@ -1,2 +1,9 @@
 import { Check } from '../../types.js';
+import { DiffPattern } from '../findings.js';
+/**
+ * npm supply-chain entry points, matched in `package.json`. Both are how a
+ * compromised package reaches a developer machine or CI runner, so they are
+ * worth a human look whenever one is added — neither is wrong by itself.
+ */
+export declare const PACKAGE_JSON_PATTERNS: DiffPattern[];
 export declare const diffSecurityCheck: Check;

package/dist/esm/core/checks/security/diff-security.js

@@ -232,6 +232,25 @@ const KOTLIN_SECURITY_PATTERNS = [
     },
 ];
 const JS_GLOBS = ['*.ts', '*.tsx', '*.js', '*.jsx', '*.mjs', '*.cjs'];
+const PACKAGE_JSON_GLOBS = ['package.json', '*/package.json'];
+/**
+ * npm supply-chain entry points, matched in `package.json`. Both are how a
+ * compromised package reaches a developer machine or CI runner, so they are
+ * worth a human look whenever one is added — neither is wrong by itself.
+ */
+export const PACKAGE_JSON_PATTERNS = [
+    {
+        pattern: /^\+(?!\+)\s*"(?:preinstall|install|postinstall)"\s*:/,
+        label: 'npm install lifecycle script (runs on every consumer install)',
+        severity: 'warn',
+    },
+    {
+        // `repository.url` is the one key that legitimately holds a `git+https:` value.
+        pattern: /^\+(?!\+)\s*"(?!url")[^"]+"\s*:\s*"(?:git\+[a-z]+:|git:\/\/|git@|github:|https?:\/\/[^"]+\.(?:tgz|tar\.gz)")/,
+        label: 'dependency from a git or tarball URL (bypasses registry integrity and audit)',
+        severity: 'warn',
+    },
+];
 /**
  * Compile the client's `extraPatterns` into the same shape as the built-ins, so
  * a project rule gets identical treatment: comment stripping, the code/raw view,
@@ -320,6 +339,7 @@ export const diffSecurityCheck = {
             // Client `extraPatterns` run against every scanned language, since a
             // project rule is not tied to the built-in language split.
             const sets = [[JS_GLOBS, [...SECURITY_PATTERNS, ...extra]]];
+            sets.push([PACKAGE_JSON_GLOBS, PACKAGE_JSON_PATTERNS]);
             if (ctx.languages.includes('python')) {
                 sets.push([['*.py'], [...PYTHON_SECURITY_PATTERNS, ...extra]]);
             }

package/dist/esm/core/checks/security/security.d.ts

@@ -30,19 +30,6 @@ import { Check } from '../../types.js';
  *   the caller keeps its old wording rather than claiming a number it does not have.
  */
 export declare function countFindings(reportPath: string): number | null;
-/**
- * How the outcome names what was found.
- *
- * Its own function so both halves are reachable without running the scanner. The
- * corpus for this check deliberately does not: the wrapper downloads a gitleaks
- * binary on first use, and a unit suite that reaches the network is the thing the
- * `installer` seam in `ensure.ts` exists to avoid. What broke here was the wording
- * — a row that read the same for one secret and for thirty-nine — and the wording
- * is testable on its own.
- *
- * `null` keeps the old sentence rather than inventing a number: a report we could
- * not read is not a reason to claim a count.
- */
 export declare function secretsSummary(found: number | null): string;
 /**
  * Whether the wrapper died instead of reporting, judged from its stderr.

package/dist/esm/core/checks/security/security.js

@@ -4,6 +4,7 @@ import path from 'node:path';
 import { getPackageConfigPath, hasLocalConfig } from '../../../config/index.js';
 import { execa } from '../../../utils/execa.js';
 import { logger, resolveGitRef, resolvePackageBin } from '../../../utils/index.js';
+import { addFinding } from '../../finding-store.js';
 import { fail, pass, skip, warn } from '../../types.js';
 /**
  * A HOME the scanner can actually write to.
@@ -57,6 +58,31 @@ export function countFindings(reportPath) {
  * `null` keeps the old sentence rather than inventing a number: a report we could
  * not read is not a reason to claim a count.
  */
+/**
+ * Tell the report where each leak is. The secret itself is never copied: the
+ * finding carries a file, a line and the rule that matched, which is all anyone
+ * needs to go and remove it — and all that is safe to hand to an agent's context.
+ */
+function recordLeaks(reportPath, cwd) {
+    try {
+        const report = JSON.parse(fs.readFileSync(reportPath, 'utf-8'));
+        if (!Array.isArray(report))
+            return;
+        for (const leak of report) {
+            if (typeof leak?.File !== 'string')
+                continue;
+            addFinding({
+                file: path.isAbsolute(leak.File) ? path.relative(cwd, leak.File) : leak.File,
+                line: typeof leak.StartLine === 'number' ? leak.StartLine : undefined,
+                rule: typeof leak.RuleID === 'string' ? leak.RuleID : 'secret',
+                severity: 'error',
+            });
+        }
+    }
+    catch {
+        // An unreadable report already shows up as an uncounted summary; no locations to add.
+    }
+}
 export function secretsSummary(found) {
     return found === null ? 'potential secrets detected' : `${found} potential secret(s)`;
 }
@@ -177,6 +203,7 @@ export const securityCheck = {
         if (stderr.trim())
             logger.warn(stderr.trimEnd());
         const found = countFindings(reportPath);
+        recordLeaks(reportPath, ctx.cwd);
         fs.rmSync(reportDir, { recursive: true, force: true });
         if (result.exitCode === 0)
             return pass();

package/dist/esm/core/checks/security/workflow-security.js

@@ -52,6 +52,39 @@ export const WORKFLOW_PATTERNS = [
         label: 'pull_request_target trigger (runs with repo secrets on untrusted PRs)',
         severity: 'warn',
     },
+    {
+        // The second half of the "pwn request": `pull_request_target` alone is harmless,
+        // checking out the PR's own code under it hands the attacker a privileged
+        // runner. One line cannot see the trigger, so this stays a warning.
+        pattern: /^\+(?!\+)\s*(?:ref|repository):\s*['"]?\$\{\{\s*github\.event\.pull_request\.head\.(?:sha|ref|repo\.full_name)\s*\}\}/,
+        label: 'checkout of the PR head (code execution with secrets under pull_request_target)',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+)\s*permissions:\s*write-all\b/,
+        label: 'permissions: write-all (grant the token only the scopes the job needs)',
+        severity: 'error',
+    },
+    {
+        pattern: /^\+(?!\+)\s*secrets:\s*inherit\b/,
+        label: 'secrets: inherit (hands every repository secret to the called workflow)',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+)\s*ACTIONS_ALLOW_UNSECURE_COMMANDS:\s*['"]?true\b/i,
+        label: 'ACTIONS_ALLOW_UNSECURE_COMMANDS (re-enables the deprecated set-env / add-path injection vector)',
+        severity: 'error',
+    },
+    {
+        pattern: /^\+(?!\+).*\b(?:curl|wget)\b[^|]*\|\s*(?:sudo\s+)?(?:sh|bash)\b/i,
+        label: 'piping a download straight to a shell (curl/wget … | sh)',
+        severity: 'warn',
+    },
+    {
+        pattern: /^\+(?!\+)\s*runs-on:\s*\[?\s*['"]?self-hosted\b/,
+        label: 'self-hosted runner (a PR from a fork can run code on your own infrastructure)',
+        severity: 'warn',
+    },
 ];
 export const workflowSecurityCheck = {
     name: 'Workflow Security',

package/dist/esm/core/commands.d.ts

@@ -22,6 +22,12 @@ export declare const COMMAND_TO_CHECK: Record<string, string>;
  * and not a reading of our source.
  */
 export declare const TOOLING_COMMANDS: readonly string[];
+/**
+ * Commands that serve AI agents rather than review a diff. They share the CLI's
+ * entry point and nothing else: no scope flags apply, and `mcp` in particular owns
+ * stdout for the protocol, so none of them may be confused with a check name.
+ */
+export declare const AGENT_COMMANDS: readonly string[];
 export declare const STANDALONE_COMMANDS: readonly string[];
 /** Flags accepted anywhere on the command line, with what each one means. */
 export declare const FLAGS: Record<string, string>;

package/dist/esm/core/commands.js

@@ -41,6 +41,7 @@ export const COMMAND_TO_CHECK = {
     'license-header': 'License Header',
     'config-validation': 'Config Validation',
     'dockerfile-security': 'Dockerfile Security',
+    'agent-instructions': 'Agent Instructions',
     'case-collision': 'Case Collision',
     'vuln-scan': 'Vuln Scan',
     'leftover-debug': 'Leftover Debug',
@@ -76,14 +77,23 @@ export const COMMAND_TO_CHECK = {
  * and not a reading of our source.
  */
 export const TOOLING_COMMANDS = ['install', 'doctor', 'cache-prune'];
+/**
+ * Commands that serve AI agents rather than review a diff. They share the CLI's
+ * entry point and nothing else: no scope flags apply, and `mcp` in particular owns
+ * stdout for the protocol, so none of them may be confused with a check name.
+ */
+export const AGENT_COMMANDS = ['mcp', 'hook', 'agent-setup'];
 export const STANDALONE_COMMANDS = [
     'init',
     'all',
     'precommit',
     ...TOOLING_COMMANDS,
+    ...AGENT_COMMANDS,
 ];
 /** Flags accepted anywhere on the command line, with what each one means. */
 export const FLAGS = {
     '--full': 'review every tracked file instead of the diff (the default outside CI)',
     '--all': 'with "install": fetch every profile, not only the ones this repository needs',
+    '--sarif': 'write findings as SARIF 2.1.0 to pr-checkmate.sarif (check-running commands only)',
+    '--no-hook': 'with "agent-setup": skip the git-commit gate for Claude Code',
 };

package/dist/esm/core/finding-store.d.ts

@@ -0,0 +1,16 @@
+import type { Finding } from '../utils/result-collector.js';
+/** Run `work` collecting every finding filed inside it. */
+export declare function collectFindings<T>(work: () => Promise<T>): Promise<{
+    result: T;
+    findings: Finding[];
+}>;
+/** A scanner saw `sample` under `label` at `file:line`. Claimed later by {@link fileFindings}. */
+export declare function noteLocation(label: string, sample: string, file: string, line: number): void;
+/**
+ * Turn the findings that survived filtering into located ones. Each sample claims
+ * the oldest location noted for it, so the same line appearing twice resolves to
+ * two places rather than one place twice.
+ */
+export declare function fileFindings(bucket: Record<string, string[]>, severity: Finding['severity']): void;
+/** File a finding directly, for scanners that already know exactly where it is. */
+export declare function addFinding(finding: Finding): void;

package/dist/esm/core/finding-store.js

@@ -0,0 +1,67 @@
+/**
+ * Where a finding was, carried from the scanner that saw it to the report that
+ * names it.
+ *
+ * Scanners reduce what they find to strings in a bucket — `"debugger statement" →
+ * ["debugger;"]` — because the report only ever needed a count and a sample. An
+ * agent needs more: which file, which line. Rewriting forty checks to carry that
+ * would have been forty chances to disagree with each other, so the location is
+ * noted once, where the diff is walked, and attached once, where the buckets are
+ * filed.
+ *
+ * It is attached at filing time, not scan time, on purpose. `ignore` and
+ * `severityOverrides` run in between, and a finding the client has silenced must
+ * not reach an agent that would then dutifully "fix" it.
+ *
+ * The store is an `AsyncLocalStorage` scope per check. Checks of one phase run in
+ * parallel, so a module-level list would mix their findings; a scope cannot. Code
+ * running outside `collectFindings` (the library API, unit tests) finds no store
+ * and every call here does nothing.
+ */
+import { AsyncLocalStorage } from 'node:async_hooks';
+/** More than this and the list is noise to a reader and a cost to an agent. */
+const MAX_FINDINGS_PER_CHECK = 200;
+const scope = new AsyncLocalStorage();
+const keyOf = (label, sample) => `${label}\u0000${sample}`;
+/** Run `work` collecting every finding filed inside it. */
+export async function collectFindings(work) {
+    const store = { found: [], pending: new Map() };
+    const result = await scope.run(store, work);
+    return { result, findings: store.found };
+}
+/** A scanner saw `sample` under `label` at `file:line`. Claimed later by {@link fileFindings}. */
+export function noteLocation(label, sample, file, line) {
+    const store = scope.getStore();
+    if (!store)
+        return;
+    const key = keyOf(label, sample);
+    const queue = store.pending.get(key) ?? [];
+    queue.push({ file, line });
+    store.pending.set(key, queue);
+}
+/**
+ * Turn the findings that survived filtering into located ones. Each sample claims
+ * the oldest location noted for it, so the same line appearing twice resolves to
+ * two places rather than one place twice.
+ */
+export function fileFindings(bucket, severity) {
+    const store = scope.getStore();
+    if (!store)
+        return;
+    for (const [label, samples] of Object.entries(bucket)) {
+        for (const sample of samples) {
+            if (store.found.length >= MAX_FINDINGS_PER_CHECK)
+                return;
+            const where = store.pending.get(keyOf(label, sample))?.shift();
+            if (!where)
+                continue;
+            store.found.push({ ...where, rule: label, snippet: sample, severity });
+        }
+    }
+}
+/** File a finding directly, for scanners that already know exactly where it is. */
+export function addFinding(finding) {
+    const store = scope.getStore();
+    if (store && store.found.length < MAX_FINDINGS_PER_CHECK)
+        store.found.push(finding);
+}

package/dist/esm/core/registry.js

@@ -38,6 +38,7 @@ import { packageSizeCheck } from './checks/quality/package-size.js';
 import { spellcheckCheck } from './checks/quality/spellcheck.js';
 import { symlinksCheck } from './checks/quality/symlinks.js';
 import { yamlLintCheck } from './checks/quality/yaml-lint.js';
+import { agentInstructionsCheck } from './checks/security/agent-instructions.js';
 import { diffSecurityCheck } from './checks/security/diff-security.js';
 import { dockerfileSecurityCheck } from './checks/security/dockerfile-security.js';
 import { migrationSafetyCheck } from './checks/security/migration-safety.js';
@@ -63,6 +64,7 @@ export const REGISTRY = [
     diffSecurityCheck,
     workflowSecurityCheck,
     dockerfileSecurityCheck,
+    agentInstructionsCheck,
     caseCollisionCheck,
     vulnScanCheck,
     grypeScanCheck,

package/dist/esm/core/reporters.js

@@ -1,4 +1,7 @@
 import fs from 'node:fs';
+import { isMcpRegistered } from '../agent/registration.js';
+import { AGENT_SETUP_COMMAND } from '../config/constants.js';
+import { readMcpSettings } from '../mcp/settings.js';
 import { paginate, request } from '../utils/http.js';
 import { logger } from '../utils/index.js';
 import { packageVersion } from '../utils/package-version.js';
@@ -100,6 +103,12 @@ function printStdout(report, cfg) {
     if (cfg.include?.docsLink !== false) {
         // The docs cover every check and config key.
         logger.print(' DOCUMENTATION: https://pr-checkmate-docs.pages.dev/');
+        // Said once per project, and never in CI, where nobody is there to act on it.
+        if (!process.env.CI &&
+            readMcpSettings(process.cwd()).enabled &&
+            !isMcpRegistered(process.cwd())) {
+            logger.print(` AI AGENT: ${AGENT_SETUP_COMMAND} — your agent then writes code that passes.`);
+        }
     }
 }
 /** Network settings shared by every platform call. */

package/dist/esm/core/run-checks.js

@@ -4,6 +4,7 @@ import { resolveConcurrency, runPool, Semaphore, withTimeout } from '../utils/po
 import { clearToolPaths } from '../utils/resolve-bin.js';
 import { ResultCollector } from '../utils/result-collector.js';
 import { buildContext } from './context.js';
+import { collectFindings } from './finding-store.js';
 import { noTooling, prepareTooling } from './install/prepare.js';
 import { REGISTRY } from './registry.js';
 import { report } from './reporters.js';
@@ -169,15 +170,24 @@ async function runOne(check, ctx, collector, heavy, tooling) {
         }
         const started = Date.now();
         const timeoutMs = ctx.config.run?.checkTimeoutMs ?? 300000;
-        const execute = () => withTimeout(check.run(ctx), timeoutMs, () => {
-            logger.warn(`[runChecks]: ⏱️ ${check.name} exceeded ${timeoutMs}ms`);
-            return { status: 'warn', details: `timed out after ${timeoutMs}ms` };
-        });
+        // Locations noted while this check runs, collected per check: the phase runs
+        // its checks in parallel, so a shared list would mix their findings.
+        let located = [];
+        const execute = async () => {
+            const { result, findings } = await collectFindings(() => withTimeout(check.run(ctx), timeoutMs, () => {
+                logger.warn(`[runChecks]: ⏱️ ${check.name} exceeded ${timeoutMs}ms`);
+                return { status: 'warn', details: `timed out after ${timeoutMs}ms` };
+            }));
+            located = findings;
+            return result;
+        };
         const outcome = check.weight === 'heavy' ? await heavy.run(execute) : await execute();
         if (ctx.config.run?.timings) {
             logger.info(`[runChecks]: ${check.name} took ${Date.now() - started}ms`);
         }
-        collector.register(check.name, applySeverity(check.name, outcome.status, ctx), outcome.details);
+        collector.register(check.name, applySeverity(check.name, outcome.status, ctx), outcome.details, 
+        // A clean result has nothing to locate, even when `failOn: never` filed some.
+        outcome.status === 'pass' ? undefined : (outcome.findings ?? located));
     }
     catch (err) {
         // An unexpected throw in a blocking check fails the run; in informational/format

package/dist/esm/core/sarif.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A report as SARIF 2.1.0 — the format GitHub code scanning, VS Code and most
+ * security dashboards read, so a finding shows up inline on the line it names
+ * instead of only in a summary table.
+ *
+ * Only what a consumer can use is written. A failed or warned check that located
+ * its problems yields one result per location; one that could not yields a single
+ * result with no location, because a finding with nowhere to point is still a
+ * finding. GitHub code scanning displays only results that have a location, so
+ * those one-line summaries reach editors and other viewers, not its alerts.
+ * Passes and skips are not results.
+ */
+import type { CheckReport } from './types.js';
+/** Convert a report to a SARIF log object, ready for `JSON.stringify`. */
+export declare function toSarif(report: CheckReport, toolVersion: string): Record<string, unknown>;

package/dist/esm/core/sarif.js

@@ -0,0 +1,57 @@
+const SARIF_SCHEMA = 'https://json.schemastore.org/sarif-2.1.0.json';
+const ruleIdFor = (check, rule) => (rule ? `${check}/${rule}` : check);
+function locatedResult(check, f) {
+    return {
+        ruleId: ruleIdFor(check.name, f.rule),
+        level: f.severity === 'error' ? 'error' : 'warning',
+        message: { text: f.snippet ? `${f.rule}: ${f.snippet}` : f.rule },
+        locations: [
+            {
+                physicalLocation: {
+                    artifactLocation: { uri: f.file },
+                    ...(f.line !== undefined && { region: { startLine: f.line } }),
+                },
+            },
+        ],
+    };
+}
+function summaryResult(check) {
+    return {
+        ruleId: ruleIdFor(check.name),
+        level: check.status === 'fail' ? 'error' : 'warning',
+        message: { text: check.details ?? `${check.name} reported a problem` },
+    };
+}
+/** Convert a report to a SARIF log object, ready for `JSON.stringify`. */
+export function toSarif(report, toolVersion) {
+    const results = [];
+    const rules = new Map();
+    for (const check of report.results) {
+        if (check.status !== 'fail' && check.status !== 'warn')
+            continue;
+        const found = check.findings && check.findings.length > 0
+            ? check.findings.map(f => locatedResult(check, f))
+            : [summaryResult(check)];
+        for (const r of found) {
+            results.push(r);
+            rules.set(r.ruleId, { id: r.ruleId, name: r.ruleId });
+        }
+    }
+    return {
+        $schema: SARIF_SCHEMA,
+        version: '2.1.0',
+        runs: [
+            {
+                tool: {
+                    driver: {
+                        name: 'pr-checkmate',
+                        version: toolVersion,
+                        informationUri: 'https://www.npmjs.com/package/pr-checkmate',
+                        rules: [...rules.values()],
+                    },
+                },
+                results,
+            },
+        ],
+    };
+}

package/dist/esm/core/types.d.ts

@@ -1,7 +1,7 @@
 import type { PRCheckMateConfig, ReporterConfig } from '../interfaces/index.js';
 import type { Language, LanguageUsage } from '../utils/detect-language.js';
-import type { CheckResult, CheckStatus } from '../utils/result-collector.js';
-export type { CheckResult, CheckStatus, Language, LanguageUsage };
+import type { CheckResult, CheckStatus, Finding } from '../utils/result-collector.js';
+export type { CheckResult, CheckStatus, Finding, Language, LanguageUsage };
 /**
  * Execution phases, run strictly in order. Within a phase checks run in parallel.
  * `format` runs last because formatters (prettier) may write files.
@@ -67,6 +67,11 @@ export interface CheckContext {
 export interface CheckOutcome {
     status: CheckStatus;
     details?: string;
+    /**
+     * Where the problems are. Left to the orchestrator for pattern-based checks,
+     * which note locations as they scan; a check that knows better may set it.
+     */
+    findings?: Finding[];
 }
 /**
  * A single quality gate. `applies` decides relevance (language/marker gating);

package/dist/esm/index.d.ts

@@ -4,8 +4,9 @@
  * @module pr-checkmate
  */
 export { runChecks, buildContext, REGISTRY } from './core/index.js';
+export { toSarif } from './core/sarif.js';
 export { pass, warn, fail, skip, defineCheck } from './core/index.js';
-export type { Check, CheckContext, CheckOutcome, CheckReport, CheckResult, CheckStatus, Language, Phase, ReporterFn, ReporterKind, RunOptions, } from './core/index.js';
+export type { Check, CheckContext, CheckOutcome, CheckReport, CheckResult, CheckStatus, Finding, Language, Phase, ReporterFn, ReporterKind, RunOptions, } from './core/index.js';
 export { getSourcePath, getSourcePaths, getIgnoredDirs, getPackageConfigPath, hasLocalConfig, } from './config/index.js';
 export type { PRCheckMateConfig } from './interfaces/index.js';
 export { Logger } from './utils/logger.js';

package/dist/esm/index.js

@@ -6,6 +6,8 @@
 // Primary programmatic API: run checks and receive a structured report.
 // Never throws for violations, never calls process.exit — the caller decides.
 export { runChecks, buildContext, REGISTRY } from './core/index.js';
+// SARIF 2.1.0 export of a report, for code-scanning dashboards and editors.
+export { toSarif } from './core/sarif.js';
 // Authoring helpers for consumers writing their own checks (plugins).
 export { pass, warn, fail, skip, defineCheck } from './core/index.js';
 // Config helpers for consumers embedding pr-checkmate.