@aarock1234/slopscan 0.1.0

package/dist/config.d.ts

@@ -0,0 +1,91 @@
+import { z } from 'zod';
+export declare const configSchema: z.ZodPipe<z.ZodObject<{
+    ignore: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    rules: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+    failThreshold: z.ZodDefault<z.ZodNumber>;
+    scoring: z.ZodPrefault<z.ZodObject<{
+        points: z.ZodPrefault<z.ZodObject<{
+            info: z.ZodDefault<z.ZodNumber>;
+            minor: z.ZodDefault<z.ZodNumber>;
+            major: z.ZodDefault<z.ZodNumber>;
+            critical: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+        damping: z.ZodDefault<z.ZodNumber>;
+        densityScale: z.ZodDefault<z.ZodNumber>;
+        axisWeights: z.ZodPrefault<z.ZodObject<{
+            idiom: z.ZodDefault<z.ZodNumber>;
+            hacky: z.ZodDefault<z.ZodNumber>;
+            futureproof: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+        minScoredLines: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    judge: z.ZodPrefault<z.ZodObject<{
+        model: z.ZodDefault<z.ZodString>;
+        maxInputTokens: z.ZodDefault<z.ZodNumber>;
+        minChangedLines: z.ZodDefault<z.ZodNumber>;
+        chunkTokens: z.ZodDefault<z.ZodNumber>;
+        minConfidence: z.ZodDefault<z.ZodNumber>;
+        maxOutputTokens: z.ZodDefault<z.ZodNumber>;
+        timeoutMs: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodTransform<{
+    ignore: string[];
+    rules: Record<string, boolean>;
+    failThreshold: number;
+    scoring: {
+        points: {
+            info: number;
+            minor: number;
+            major: number;
+            critical: number;
+        };
+        damping: number;
+        densityScale: number;
+        axisWeights: {
+            idiom: number;
+            hacky: number;
+            futureproof: number;
+        };
+        minScoredLines: number;
+    };
+    judge: {
+        model: string;
+        maxInputTokens: number;
+        minChangedLines: number;
+        chunkTokens: number;
+        minConfidence: number;
+        maxOutputTokens: number;
+        timeoutMs: number;
+    };
+}, {
+    ignore: string[];
+    rules: Record<string, boolean>;
+    failThreshold: number;
+    scoring: {
+        points: {
+            info: number;
+            minor: number;
+            major: number;
+            critical: number;
+        };
+        damping: number;
+        densityScale: number;
+        axisWeights: {
+            idiom: number;
+            hacky: number;
+            futureproof: number;
+        };
+        minScoredLines: number;
+    };
+    judge: {
+        model: string;
+        maxInputTokens: number;
+        minChangedLines: number;
+        chunkTokens: number;
+        minConfidence: number;
+        maxOutputTokens: number;
+        timeoutMs: number;
+    };
+}>>;
+export type Config = z.infer<typeof configSchema>;
+export declare function loadConfig(cwd: string, explicitPath?: string): Promise<Config>;

package/dist/config.js

@@ -0,0 +1,61 @@
+import { readFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { parse as parseYaml } from 'yaml';
+import { z } from 'zod';
+import { judgeConfigSchema } from './analyzers/judge.js';
+import { scoringSchema } from './score.js';
+import { ConfigError } from './shared/errors.js';
+const CONFIG_FILE = '.slopscan.yml';
+// generated and vendored code is never the author's slop
+const DEFAULT_IGNORE = [
+    '**/node_modules/**',
+    '**/dist/**',
+    '**/vendor/**',
+    '**/*.d.ts',
+    '**/*.pb.go',
+    '**/*_gen.go',
+    '**/*.generated.*',
+    '**/pnpm-lock.yaml',
+];
+export const configSchema = z
+    .object({
+    // added to the defaults, not replacing them
+    ignore: z.array(z.string()).default([]),
+    // rule id -> enabled; anything not listed is enabled
+    rules: z.record(z.string(), z.boolean()).default({}),
+    failThreshold: z.number().min(0).max(100).default(45),
+    scoring: scoringSchema.prefault({}),
+    judge: judgeConfigSchema.prefault({}),
+})
+    .strict()
+    .transform(config => ({
+    ...config,
+    ignore: [...DEFAULT_IGNORE, ...config.ignore],
+}));
+// reads .slopscan.yml from cwd, or the given path. a missing default file means defaults; a missing
+// explicit file is a mistake.
+export async function loadConfig(cwd, explicitPath) {
+    const path = resolve(cwd, explicitPath ?? CONFIG_FILE);
+    const raw = await readConfigFile(path, explicitPath !== undefined);
+    const result = configSchema.safeParse(raw);
+    if (!result.success) {
+        const issues = result.error.issues.map(issue => ` - ${issue.path.join('.')}: ${issue.message}`);
+        throw new ConfigError([`invalid config at ${path}:`, ...issues].join('\n'));
+    }
+    return result.data;
+}
+async function readConfigFile(path, required) {
+    try {
+        return parseYaml(await readFile(path, 'utf-8')) ?? {};
+    }
+    catch (error) {
+        if (!required && isMissingFile(error)) {
+            return {};
+        }
+        throw new ConfigError(`reading ${path}`, { cause: error });
+    }
+}
+function isMissingFile(error) {
+    return error instanceof Error && 'code' in error && error.code === 'ENOENT';
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,WAAW,GAAG,eAAe,CAAC;AAEpC,yDAAyD;AACzD,MAAM,cAAc,GAAG;IACtB,oBAAoB;IACpB,YAAY;IACZ,cAAc;IACd,WAAW;IACX,YAAY;IACZ,aAAa;IACb,kBAAkB;IAClB,mBAAmB;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC3B,MAAM,CAAC;IACP,4CAA4C;IAC5C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACvC,qDAAqD;IACrD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACpD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACrD,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IACnC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;CACrC,CAAC;KACD,MAAM,EAAE;KACR,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrB,GAAG,MAAM;IACT,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;CAC7C,CAAC,CAAC,CAAC;AAIL,oGAAoG;AACpG,8BAA8B;AAC9B,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW,EAAE,YAAqB;IAClE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,YAAY,IAAI,WAAW,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAE3C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAEhG,MAAM,IAAI,WAAW,CAAC,CAAC,qBAAqB,IAAI,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,QAAiB;IAC5D,IAAI,CAAC;QACJ,OAAO,SAAS,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,QAAQ,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,OAAO,EAAE,CAAC;QACX,CAAC;QAED,MAAM,IAAI,WAAW,CAAC,WAAW,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5D,CAAC;AACF,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC7E,CAAC"}

package/dist/confirm.d.ts

@@ -0,0 +1,11 @@
+import type { Finding } from './finding.js';
+import type { Rule } from './rule.js';
+export type ConfirmResult = {
+    kept: Finding[];
+    rejected: Finding[];
+};
+export type ConfirmOptions = {
+    repo: string;
+    ignore: readonly string[];
+};
+export declare function confirm(findings: readonly Finding[], rules: readonly Rule[], options: ConfirmOptions): Promise<ConfirmResult>;

package/dist/confirm.js

@@ -0,0 +1,100 @@
+import { execFile } from 'node:child_process';
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { promisify } from 'node:util';
+import { parseSource } from './analyzers/ast.js';
+import { isIgnored } from './change.js';
+import { Lang, detectLang } from './lang.js';
+import { Confirm, Detect } from './rule.js';
+import { mapConcurrent } from './shared/concurrency.js';
+const execFileAsync = promisify(execFile);
+// judge findings for rules with a `confirm` predicate must pass a deterministic repo-wide check, or they are
+// dropped. a finding without a nominated symbol cannot be checked and is dropped too.
+export async function confirm(findings, rules, options) {
+    const predicateByRule = new Map(rules.flatMap(rule => (rule.detect === Detect.JUDGE && rule.confirm ? [[rule.id, rule.confirm]] : [])));
+    const kept = [];
+    const rejected = [];
+    const repo = new RepoIndex(options);
+    for (const finding of findings) {
+        const predicate = predicateByRule.get(finding.ruleId);
+        if (predicate === undefined) {
+            kept.push(finding);
+            continue;
+        }
+        const lang = detectLang(finding.path);
+        const passes = finding.symbol !== undefined &&
+            lang !== undefined &&
+            (await PREDICATES[predicate](repo, lang, finding.symbol));
+        (passes ? kept : rejected).push(finding);
+    }
+    return { kept, rejected };
+}
+// each predicate says whether the symbol is used little enough for the finding to stand
+const PREDICATES = {
+    [Confirm.CALL_COUNT]: async (repo, lang, symbol) => (await repo.count(lang, callMatcher(symbol))) <= 1,
+    [Confirm.IMPL_COUNT]: async (repo, lang, symbol) => (await repo.count(lang, implMatcher(lang, symbol))) <= 1,
+    [Confirm.REF_COUNT]: async (repo, lang, symbol) => (await repo.count(lang, refMatcher(lang, symbol))) <= 1,
+};
+// call sites: `symbol(...)` or `anything.symbol(...)` in either language
+function callMatcher(symbol) {
+    return {
+        rule: {
+            kind: 'call_expression',
+            has: {
+                field: 'function',
+                regex: `(^|\\.)${escape(symbol)}$`,
+            },
+        },
+    };
+}
+// TS: classes that implement the interface. Go: compile-time assertions `var _ Iface = ...`
+function implMatcher(lang, symbol) {
+    const pattern = `\\b${escape(symbol)}\\b`;
+    return lang === Lang.TS
+        ? { rule: { kind: 'implements_clause', regex: pattern } }
+        : { rule: { kind: 'var_spec', regex: `^_\\s+${escape(symbol)}\\b` } };
+}
+// every identifier spelled exactly like the symbol; the definition counts once
+function refMatcher(lang, symbol) {
+    const kinds = lang === Lang.TS
+        ? ['identifier', 'type_identifier', 'property_identifier']
+        : ['identifier', 'field_identifier', 'type_identifier'];
+    return {
+        rule: {
+            any: kinds.map(kind => ({ kind, regex: `^${escape(symbol)}$` })),
+        },
+    };
+}
+// parses each tracked file of a language once and answers count queries against the trees
+class RepoIndex {
+    #options;
+    #trees = new Map();
+    constructor(options) {
+        this.#options = options;
+    }
+    async count(lang, matcher) {
+        const trees = await this.#load(lang);
+        return trees.reduce((sum, tree) => sum + tree.findAll(matcher).length, 0);
+    }
+    #load(lang) {
+        let trees = this.#trees.get(lang);
+        if (trees === undefined) {
+            trees = this.#parseAll(lang);
+            this.#trees.set(lang, trees);
+        }
+        return trees;
+    }
+    async #parseAll(lang) {
+        const paths = (await trackedFiles(this.#options.repo)).filter(path => detectLang(path) === lang && !isIgnored(path, this.#options.ignore));
+        return mapConcurrent(paths, async (path) => parseSource(lang, await readFile(join(this.#options.repo, path), 'utf-8'), path));
+    }
+}
+// git knows which files are source and which are ignored, so we ask it rather than walking the tree
+async function trackedFiles(repo) {
+    const { stdout } = await execFileAsync('git', ['ls-files', '-z'], { cwd: repo, encoding: 'utf-8' });
+    return stdout.split('\0').filter(path => path.length > 0);
+}
+function escape(text) {
+    return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+//# sourceMappingURL=confirm.js.map

package/dist/confirm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm.js","sourceRoot":"","sources":["../src/confirm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAY1C,6GAA6G;AAC7G,sFAAsF;AACtF,MAAM,CAAC,KAAK,UAAU,OAAO,CAC5B,QAA4B,EAC5B,KAAsB,EACtB,OAAuB;IAEvB,MAAM,eAAe,GAAG,IAAI,GAAG,CAC9B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAC/G,CAAC;IAEF,MAAM,IAAI,GAAc,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;IAEpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEtD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEnB,SAAS;QACV,CAAC;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,MAAM,GACX,OAAO,CAAC,MAAM,KAAK,SAAS;YAC5B,IAAI,KAAK,SAAS;YAClB,CAAC,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAE3D,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAID,wFAAwF;AACxF,MAAM,UAAU,GAAyC;IACxD,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IACtG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5G,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;CAC1G,CAAC;AAEF,yEAAyE;AACzE,SAAS,WAAW,CAAC,MAAc;IAClC,OAAO;QACN,IAAI,EAAE;YACL,IAAI,EAAE,iBAAiB;YACvB,GAAG,EAAE;gBACJ,KAAK,EAAE,UAAU;gBACjB,KAAK,EAAE,UAAU,MAAM,CAAC,MAAM,CAAC,GAAG;aAClC;SACD;KACD,CAAC;AACH,CAAC;AAED,4FAA4F;AAC5F,SAAS,WAAW,CAAC,IAAU,EAAE,MAAc;IAC9C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;IAE1C,OAAO,IAAI,KAAK,IAAI,CAAC,EAAE;QACtB,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACzD,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;AACxE,CAAC;AAED,+EAA+E;AAC/E,SAAS,UAAU,CAAC,IAAU,EAAE,MAAc;IAC7C,MAAM,KAAK,GACV,IAAI,KAAK,IAAI,CAAC,EAAE;QACf,CAAC,CAAC,CAAC,YAAY,EAAE,iBAAiB,EAAE,qBAAqB,CAAC;QAC1D,CAAC,CAAC,CAAC,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;IAE1D,OAAO;QACN,IAAI,EAAE;YACL,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;SAChE;KACD,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,MAAM,SAAS;IACL,QAAQ,CAAiB;IACzB,MAAM,GAAG,IAAI,GAAG,EAAoC,CAAC;IAE9D,YAAY,OAAuB;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAU,EAAE,OAAmB;QAC1C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAErC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,IAAU;QACf,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAU;QACzB,MAAM,KAAK,GAAG,CAAC,MAAM,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAC5D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC3E,CAAC;QAEF,OAAO,aAAa,CAAC,KAAK,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE,CACxC,WAAW,CAAC,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,CAChF,CAAC;IACH,CAAC;CACD;AAED,oGAAoG;AACpG,KAAK,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IAEpG,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC"}

package/dist/finding.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const findingSchema: z.ZodObject<{
+    ruleId: z.ZodString;
+    path: z.ZodString;
+    line: z.ZodNumber;
+    endLine: z.ZodNumber;
+    quote: z.ZodString;
+    message: z.ZodString;
+    confidence: z.ZodNumber;
+    symbol: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type Finding = z.infer<typeof findingSchema>;
+export declare function compareFindings(a: Finding, b: Finding): number;

package/dist/finding.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+// one violation of one rule at one place. `quote` is verbatim source so a reader can find it and so judge
+// findings can be checked against the file. `symbol` is a judge nomination for a confirm predicate.
+export const findingSchema = z.object({
+    ruleId: z.string(),
+    path: z.string(),
+    line: z.number().int().positive(),
+    endLine: z.number().int().positive(),
+    quote: z.string(),
+    message: z.string(),
+    confidence: z.number().min(0).max(1),
+    symbol: z.string().optional(),
+});
+// a stable order for reports and snapshots: by file, then line, then rule
+export function compareFindings(a, b) {
+    return a.path.localeCompare(b.path) || a.line - b.line || a.ruleId.localeCompare(b.ruleId);
+}
+//# sourceMappingURL=finding.js.map

package/dist/finding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finding.js","sourceRoot":"","sources":["../src/finding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,0GAA0G;AAC1G,oGAAoG;AACpG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAIH,0EAA0E;AAC1E,MAAM,UAAU,eAAe,CAAC,CAAU,EAAE,CAAU;IACrD,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAC5F,CAAC"}

package/dist/lang.d.ts

@@ -0,0 +1,16 @@
+export declare const Lang: {
+    readonly TS: "ts";
+    readonly GO: "go";
+};
+export type Lang = (typeof Lang)[keyof typeof Lang];
+export declare const langValues: [Lang, ...Lang[]];
+export declare const RuleLang: {
+    readonly ANY: "any";
+    readonly TS: "ts";
+    readonly GO: "go";
+};
+export type RuleLang = (typeof RuleLang)[keyof typeof RuleLang];
+export declare const ruleLangValues: [RuleLang, ...RuleLang[]];
+export declare function detectLang(path: string): Lang | undefined;
+export declare function fenceLang(info: string): Lang | undefined;
+export declare function ruleAppliesTo(ruleLang: RuleLang, lang: Lang): boolean;

package/dist/lang.js

@@ -0,0 +1,37 @@
+import { extname } from 'node:path';
+export const Lang = {
+    TS: 'ts',
+    GO: 'go',
+};
+export const langValues = Object.values(Lang);
+// a rule targets one language or both
+export const RuleLang = {
+    ...Lang,
+    ANY: 'any',
+};
+export const ruleLangValues = Object.values(RuleLang);
+const EXTENSION_LANGS = {
+    '.ts': Lang.TS,
+    '.tsx': Lang.TS,
+    '.mts': Lang.TS,
+    '.cts': Lang.TS,
+    '.go': Lang.GO,
+};
+const FENCE_LANGS = {
+    ts: Lang.TS,
+    tsx: Lang.TS,
+    typescript: Lang.TS,
+    go: Lang.GO,
+    golang: Lang.GO,
+};
+export function detectLang(path) {
+    return EXTENSION_LANGS[extname(path)];
+}
+// maps a markdown fence info string (```ts, ```go) to a language
+export function fenceLang(info) {
+    return FENCE_LANGS[info.trim().toLowerCase()];
+}
+export function ruleAppliesTo(ruleLang, lang) {
+    return ruleLang === RuleLang.ANY || ruleLang === lang;
+}
+//# sourceMappingURL=lang.js.map

package/dist/lang.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lang.js","sourceRoot":"","sources":["../src/lang.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,MAAM,IAAI,GAAG;IACnB,EAAE,EAAE,IAAI;IACR,EAAE,EAAE,IAAI;CACC,CAAC;AAIX,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAsB,CAAC;AAEnE,sCAAsC;AACtC,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB,GAAG,IAAI;IACP,GAAG,EAAE,KAAK;CACD,CAAC;AAIX,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAA8B,CAAC;AAEnF,MAAM,eAAe,GAAmC;IACvD,KAAK,EAAE,IAAI,CAAC,EAAE;IACd,MAAM,EAAE,IAAI,CAAC,EAAE;IACf,MAAM,EAAE,IAAI,CAAC,EAAE;IACf,MAAM,EAAE,IAAI,CAAC,EAAE;IACf,KAAK,EAAE,IAAI,CAAC,EAAE;CACd,CAAC;AAEF,MAAM,WAAW,GAAmC;IACnD,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,GAAG,EAAE,IAAI,CAAC,EAAE;IACZ,UAAU,EAAE,IAAI,CAAC,EAAE;IACnB,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,MAAM,EAAE,IAAI,CAAC,EAAE;CACf,CAAC;AAEF,MAAM,UAAU,UAAU,CAAC,IAAY;IACtC,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,SAAS,CAAC,IAAY;IACrC,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAkB,EAAE,IAAU;IAC3D,OAAO,QAAQ,KAAK,QAAQ,CAAC,GAAG,IAAI,QAAQ,KAAK,IAAI,CAAC;AACvD,CAAC"}

package/dist/model.d.ts

@@ -0,0 +1,2 @@
+import type { LanguageModel } from 'ai';
+export declare function resolveModel(spec: string): LanguageModel;

package/dist/model.js

@@ -0,0 +1,34 @@
+import { createOpenAI } from '@ai-sdk/openai';
+import { createOpenRouter } from '@openrouter/ai-sdk-provider';
+import { env } from './shared/env.js';
+import { ConfigError } from './shared/errors.js';
+const Provider = {
+    OPENAI: 'openai',
+    OPENROUTER: 'openrouter',
+};
+const providerValues = Object.values(Provider);
+// resolves "provider/model-id" from config to an AI SDK model, asking for the one key it needs
+export function resolveModel(spec) {
+    const slash = spec.indexOf('/');
+    const provider = spec.slice(0, slash);
+    const modelId = spec.slice(slash + 1);
+    if (slash === -1 || !isProvider(provider) || modelId.length === 0) {
+        throw new ConfigError(`judge.model must be "<provider>/<model>" with provider one of ${providerValues.join(', ')}`);
+    }
+    switch (provider) {
+        case Provider.OPENAI:
+            return createOpenAI({ apiKey: requireKey('OPENAI_API_KEY', env.OPENAI_API_KEY) })(modelId);
+        case Provider.OPENROUTER:
+            return createOpenRouter({ apiKey: requireKey('OPENROUTER_API_KEY', env.OPENROUTER_API_KEY) })(modelId);
+    }
+}
+function isProvider(value) {
+    return providerValues.includes(value);
+}
+function requireKey(name, value) {
+    if (value === undefined) {
+        throw new ConfigError(`${name} is required for the judge; set it or run with --no-judge`);
+    }
+    return value;
+}
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,QAAQ,GAAG;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;CACf,CAAC;AAIX,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAsB,CAAC;AAEpE,+FAA+F;AAC/F,MAAM,UAAU,YAAY,CAAC,IAAY;IACxC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAEtC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,WAAW,CACpB,iEAAiE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5F,CAAC;IACH,CAAC;IAED,QAAQ,QAAQ,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,MAAM;YACnB,OAAO,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,gBAAgB,EAAE,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAC5F,KAAK,QAAQ,CAAC,UAAU;YACvB,OAAO,gBAAgB,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,oBAAoB,EAAE,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IACzG,CAAC;AACF,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAChC,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,KAAyB;IAC1D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,WAAW,CAAC,GAAG,IAAI,2DAA2D,CAAC,CAAC;IAC3F,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC"}

package/dist/report.d.ts

@@ -0,0 +1,124 @@
+import { z } from 'zod';
+export declare const reportSchema: z.ZodObject<{
+    overall: z.ZodNumber;
+    grade: z.ZodEnum<{
+        A: "A";
+        B: "B";
+        C: "C";
+        D: "D";
+        F: "F";
+    }>;
+    axes: z.ZodObject<{
+        idiom: z.ZodObject<{
+            score: z.ZodNumber;
+            points: z.ZodNumber;
+            density: z.ZodNumber;
+            findings: z.ZodNumber;
+        }, z.core.$strip>;
+        hacky: z.ZodObject<{
+            score: z.ZodNumber;
+            points: z.ZodNumber;
+            density: z.ZodNumber;
+            findings: z.ZodNumber;
+        }, z.core.$strip>;
+        futureproof: z.ZodObject<{
+            score: z.ZodNumber;
+            points: z.ZodNumber;
+            density: z.ZodNumber;
+            findings: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    files: z.ZodNumber;
+    scoredLines: z.ZodNumber;
+    findings: z.ZodArray<z.ZodObject<{
+        ruleId: z.ZodString;
+        path: z.ZodString;
+        line: z.ZodNumber;
+        endLine: z.ZodNumber;
+        quote: z.ZodString;
+        message: z.ZodString;
+        confidence: z.ZodNumber;
+        symbol: z.ZodOptional<z.ZodString>;
+        axis: z.ZodEnum<{
+            idiom: "idiom";
+            hacky: "hacky";
+            futureproof: "futureproof";
+        }>;
+        severity: z.ZodEnum<{
+            info: "info";
+            minor: "minor";
+            major: "major";
+            critical: "critical";
+        }>;
+        points: z.ZodNumber;
+    }, z.core.$strip>>;
+    baseline: z.ZodOptional<z.ZodObject<{
+        overall: z.ZodNumber;
+        grade: z.ZodEnum<{
+            A: "A";
+            B: "B";
+            C: "C";
+            D: "D";
+            F: "F";
+        }>;
+        axes: z.ZodObject<{
+            idiom: z.ZodObject<{
+                score: z.ZodNumber;
+                points: z.ZodNumber;
+                density: z.ZodNumber;
+                findings: z.ZodNumber;
+            }, z.core.$strip>;
+            hacky: z.ZodObject<{
+                score: z.ZodNumber;
+                points: z.ZodNumber;
+                density: z.ZodNumber;
+                findings: z.ZodNumber;
+            }, z.core.$strip>;
+            futureproof: z.ZodObject<{
+                score: z.ZodNumber;
+                points: z.ZodNumber;
+                density: z.ZodNumber;
+                findings: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    judge: z.ZodOptional<z.ZodObject<{
+        model: z.ZodString;
+        promptVersion: z.ZodString;
+        calls: z.ZodNumber;
+        cachedCalls: z.ZodNumber;
+        inputTokens: z.ZodNumber;
+        outputTokens: z.ZodNumber;
+        skipped: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            reason: z.ZodEnum<{
+                budget: "budget";
+                "too-small": "too-small";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    rejected: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        ruleId: z.ZodString;
+        path: z.ZodString;
+        line: z.ZodNumber;
+        endLine: z.ZodNumber;
+        quote: z.ZodString;
+        message: z.ZodString;
+        confidence: z.ZodNumber;
+        symbol: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Report = z.infer<typeof reportSchema>;
+export declare const Format: {
+    readonly TERMINAL: "terminal";
+    readonly JSON: "json";
+    readonly MARKDOWN: "markdown";
+};
+export type Format = (typeof Format)[keyof typeof Format];
+export declare const formatValues: [Format, ...Format[]];
+export declare function isFormat(value: string): value is Format;
+export type RenderOptions = {
+    format: Format;
+    color: boolean;
+};
+export declare function renderReport(report: Report, options: RenderOptions): string;

package/dist/report.js

@@ -0,0 +1,112 @@
+import pc from 'picocolors';
+import { z } from 'zod';
+import { judgeSummarySchema } from './analyzers/judge.js';
+import { findingSchema } from './finding.js';
+import { axisValues } from './rule.js';
+import { Grade, scoreSchema, scoredSchema } from './score.js';
+// what one scan produces: the score, its findings, and how it was made
+export const reportSchema = scoredSchema.extend({
+    baseline: scoreSchema.optional(),
+    judge: judgeSummarySchema.optional(),
+    // judge findings that failed their confirm predicate; kept for tuning, hidden from humans
+    rejected: z.array(findingSchema).optional(),
+});
+export const Format = {
+    TERMINAL: 'terminal',
+    JSON: 'json',
+    MARKDOWN: 'markdown',
+};
+export const formatValues = Object.values(Format);
+export function isFormat(value) {
+    return formatValues.includes(value);
+}
+// a pull request comment is read top to bottom; the ranked head is what matters, the tail lives in the json
+const MARKDOWN_MAX_FINDINGS = 30;
+export function renderReport(report, options) {
+    switch (options.format) {
+        case Format.TERMINAL:
+            return renderTerminal(report, options.color);
+        case Format.JSON:
+            return renderJson(report);
+        case Format.MARKDOWN:
+            return renderMarkdown(report);
+    }
+}
+const GRADE_COLOR = {
+    [Grade.A]: pc.green,
+    [Grade.B]: pc.green,
+    [Grade.C]: pc.yellow,
+    [Grade.D]: pc.red,
+    [Grade.F]: pc.red,
+};
+function renderTerminal(report, color) {
+    const paint = color ? GRADE_COLOR[report.grade] : identity;
+    const dim = color ? pc.dim : identity;
+    const bold = color ? pc.bold : identity;
+    const lines = [
+        `${bold('slop score')} ${paint(`${report.overall} (${report.grade})`)}${deltaSuffix(report)}`,
+        axisValues.map(axis => `${axis} ${Math.round(report.axes[axis].score)}`).join(dim('  ·  ')),
+        dim(`${report.files} files, ${report.scoredLines} scored lines`),
+    ];
+    if (report.judge !== undefined) {
+        lines.push(dim(judgeLine(report.judge)));
+    }
+    lines.push('');
+    if (report.findings.length === 0) {
+        lines.push(dim('no findings'));
+        return `${lines.join('\n')}\n`;
+    }
+    for (const finding of report.findings) {
+        lines.push(`${bold(`${finding.path}:${finding.line}`)}  ${dim(`[${finding.severity}]`)} ${finding.ruleId}`, `    ${finding.message}`, `    ${dim(`> ${finding.quote}`)}`, '');
+    }
+    return lines.join('\n');
+}
+function renderJson(report) {
+    return `${JSON.stringify(report, null, 2)}\n`;
+}
+function renderMarkdown(report) {
+    const lines = [
+        `## Slop score: ${report.overall} (${report.grade})${deltaSuffix(report)}`,
+        '',
+        '| axis | score | findings |',
+        '| --- | ---: | ---: |',
+        ...axisValues.map(axis => `| ${axis} | ${Math.round(report.axes[axis].score)} | ${report.axes[axis].findings} |`),
+        '',
+        `${report.files} files, ${report.scoredLines} scored lines.${report.judge ? ` ${judgeLine(report.judge)}.` : ''}`,
+        '',
+    ];
+    if (report.findings.length === 0) {
+        lines.push('No findings.', '');
+        return lines.join('\n');
+    }
+    lines.push('| location | severity | rule | message |', '| --- | --- | --- | --- |');
+    for (const finding of report.findings.slice(0, MARKDOWN_MAX_FINDINGS)) {
+        lines.push(`| \`${finding.path}:${finding.line}\` | ${finding.severity} | \`${finding.ruleId}\` | ${escapePipes(finding.message)} |`);
+    }
+    const hidden = report.findings.length - MARKDOWN_MAX_FINDINGS;
+    if (hidden > 0) {
+        lines.push('', `${hidden} more findings in the JSON report.`);
+    }
+    lines.push('');
+    return lines.join('\n');
+}
+function judgeLine(judge) {
+    const skipped = judge.skipped.length > 0 ? `, ${judge.skipped.length} files skipped` : '';
+    return `judge ${judge.model} (${judge.promptVersion}): ${judge.calls} calls, ${judge.cachedCalls} cached, ${judge.inputTokens} in / ${judge.outputTokens} out${skipped}`;
+}
+// "39 (C)  was 45 (C), -6" when a baseline is present
+function deltaSuffix(report) {
+    if (report.baseline === undefined) {
+        return '';
+    }
+    const delta = report.overall - report.baseline.overall;
+    const sign = delta > 0 ? '+' : '';
+    return `  was ${report.baseline.overall} (${report.baseline.grade}), ${sign}${delta}`;
+}
+function escapePipes(text) {
+    return text.replaceAll('|', '\\|');
+}
+function identity(text) {
+    return text;
+}
+//# sourceMappingURL=report.js.map