pr-checkmate 3.3.0 → 4.0.0

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,13 @@
+/**
+ * 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. 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.

package/dist/esm/init.js

@@ -4,7 +4,7 @@ const __dirname = __dirnameFn(__fileURLToPath(import.meta.url));
 import fs from 'fs';
 import inquirer from 'inquirer';
 import path from 'path';
-import { DEAD_CODE_IGNORE_DEFAULTS, DEFAULT_COMMANDS, DIFF_SECURITY_IGNORE_DEFAULTS, DOCS_URL, documentation, DUPLICATE_IGNORE_DEFAULTS, FULL_CONFIG_URL, GENERATED_DOC_FILES, IGNORED_DIRS, } from './config/index.js';
+import { AGENT_SETUP_COMMAND, DEAD_CODE_IGNORE_DEFAULTS, DEFAULT_COMMANDS, DIFF_SECURITY_IGNORE_DEFAULTS, DOCS_URL, documentation, DUPLICATE_IGNORE_DEFAULTS, FULL_CONFIG_URL, GENERATED_DOC_FILES, IGNORED_DIRS, } from './config/index.js';
 import { DEFAULT_DATAFLOW_WINDOW } from './core/checks/findings.js';
 import { detectLanguages, findOwnPackageRoot, logger } from './utils/index.js';
 const CONFIG_FILE = path.resolve(process.cwd(), 'pr-checkmate.json');
@@ -413,6 +413,16 @@ async function createConfig(root) {
  * update notice insisted `init` must not be skipped after an upgrade. Defaults
  * now apply when the config is loaded, so there is nothing to top up.
  */
+/** Adds the agent-setup command to a client's `commands` block when it is missing; nothing else in it is touched. */
+function withAgentCommand(commands) {
+    if (commands === undefined)
+        return undefined;
+    if (typeof commands !== 'object' || commands === null || Array.isArray(commands))
+        return commands;
+    if (AGENT_SETUP_COMMAND in commands)
+        return commands;
+    return { ...commands, [AGENT_SETUP_COMMAND]: DEFAULT_COMMANDS[AGENT_SETUP_COMMAND] };
+}
 async function updateConfig(root) {
     logger.info('[init]: pr-checkmate.json already exists — updating it.');
     try {
@@ -443,6 +453,7 @@ async function updateConfig(root) {
             // when missing; a client's own block is never touched.
             grypeScan: json.grypeScan ?? structuredClone(GRYPE_SCAN_SEED),
             ...templateExtras({ ...json, grypeScan: true }),
+            commands: withAgentCommand(json.commands),
             languages,
         };
         fs.writeFileSync(CONFIG_FILE, `${JSON.stringify(updated, null, 2)}\n`);

package/dist/esm/interfaces/index.d.ts

@@ -317,6 +317,18 @@ export interface PRCheckMateConfig {
         severityOverrides?: Record<string, 'error' | 'warn' | 'off'>;
         ignorePaths?: string[];
     };
+    mcp?: {
+        enabled?: boolean;
+        disabledTools?: string[];
+        readOnly?: boolean;
+    };
+    agentInstructions?: {
+        enabled?: boolean;
+        ignore?: string[];
+        failOn?: 'error' | 'warn' | 'never';
+        severityOverrides?: Record<string, 'error' | 'warn' | 'off'>;
+        ignorePaths?: string[];
+    };
     dockerfileSecurity?: {
         enabled?: boolean;
         ignore?: string[];

package/dist/esm/mcp/config-tools.d.ts

@@ -0,0 +1,30 @@
+import type { ToolResult } from './protocol.js';
+type Json = Record<string, unknown>;
+/** What a key means, from the schema that ships with the package. */
+export declare function explainConfig(key?: string): ToolResult;
+/** Problems in a proposed config, phrased so the agent can correct them. Empty means it is acceptable. */
+export declare function validateConfig(config: Json, cwd: string): string[];
+/** Validate and write `config` into the repository's `pr-checkmate.json`. */
+export declare function writeConfig(cwd: string, config: unknown, overwrite: boolean): ToolResult;
+interface Suggestion {
+    proposed: Json;
+    notes: string[];
+}
+/**
+ * Look at the repository and propose a config.
+ *
+ * The baseline is a whole-repository run of the fast checks. A check that already
+ * fails is proposed as `warn`: the gate is on from the first commit, the existing
+ * debt is visible, and nothing new can slip in unnoticed — then each check is
+ * promoted back to blocking as it reaches zero. Proposing `error` everywhere would
+ * make the first CI run red for reasons nobody on the pull request caused, and the
+ * usual response to that is to switch the whole tool off.
+ */
+export declare function suggestConfig(cwd: string): Promise<Suggestion & {
+    languages: string[];
+}>;
+/** `suggest_config` as the text an agent reads. */
+export declare function formatSuggestion(s: Suggestion & {
+    languages: string[];
+}): ToolResult;
+export {};