@aarock1234/slopscan 0.1.0

package/dist/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE9D,uEAAuE;AACvE,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC;IAC/C,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACpC,0FAA0F;IAC1F,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,MAAM,GAAG;IACrB,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;CACX,CAAC;AAIX,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA0B,CAAC;AAE3E,MAAM,UAAU,QAAQ,CAAC,KAAa;IACrC,OAAQ,YAAkC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED,4GAA4G;AAC5G,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAOjC,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,OAAsB;IAClE,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,MAAM,CAAC,QAAQ;YACnB,OAAO,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9C,KAAK,MAAM,CAAC,IAAI;YACf,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;QAC3B,KAAK,MAAM,CAAC,QAAQ;YACnB,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;AACF,CAAC;AAED,MAAM,WAAW,GAAsD;IACtE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK;IACnB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK;IACnB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM;IACpB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG;IACjB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG;CACjB,CAAC;AAEF,SAAS,cAAc,CAAC,MAAc,EAAE,KAAc;IACrD,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC3D,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;IACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;IAExC,MAAM,KAAK,GAAG;QACb,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,KAAK,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE;QAC7F,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3F,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,WAAW,MAAM,CAAC,WAAW,eAAe,CAAC;KAChE,CAAC;IAEF,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;QAE/B,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CACT,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,EAC/F,OAAO,OAAO,CAAC,OAAO,EAAE,EACxB,OAAO,GAAG,CAAC,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,EAClC,EAAE,CACF,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,UAAU,CAAC,MAAc;IACjC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,cAAc,CAAC,MAAc;IACrC,MAAM,KAAK,GAAG;QACb,kBAAkB,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,KAAK,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;QAC1E,EAAE;QACF,6BAA6B;QAC7B,uBAAuB;QACvB,GAAG,UAAU,CAAC,GAAG,CAChB,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,CAC9F;QACD,EAAE;QACF,GAAG,MAAM,CAAC,KAAK,WAAW,MAAM,CAAC,WAAW,iBAAiB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACjH,EAAE;KACF,CAAC;IAEF,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAE/B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,0CAA0C,EAAE,2BAA2B,CAAC,CAAC;IAEpF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,EAAE,CAAC;QACvE,KAAK,CAAC,IAAI,CACT,OAAO,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,QAAQ,OAAO,CAAC,QAAQ,QAAQ,OAAO,CAAC,MAAM,QAAQ,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CACzH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,qBAAqB,CAAC;IAE9D,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,MAAM,oCAAoC,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,SAAS,CAAC,KAAmC;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,MAAM,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAE1F,OAAO,SAAS,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,aAAa,MAAM,KAAK,CAAC,KAAK,WAAW,KAAK,CAAC,WAAW,YAAY,KAAK,CAAC,WAAW,SAAS,KAAK,CAAC,YAAY,OAAO,OAAO,EAAE,CAAC;AAC1K,CAAC;AAED,sDAAsD;AACtD,SAAS,WAAW,CAAC,MAAc;IAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,EAAE,CAAC;IACX,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IACvD,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAElC,OAAO,SAAS,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC;AACvF,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAChC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC;AACb,CAAC"}

package/dist/rule.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+import { RuleLang } from './lang.js';
+import type { Lang } from './lang.js';
+export declare const Axis: {
+    readonly IDIOM: "idiom";
+    readonly HACKY: "hacky";
+    readonly FUTUREPROOF: "futureproof";
+};
+export type Axis = (typeof Axis)[keyof typeof Axis];
+export declare const axisValues: [Axis, ...Axis[]];
+export declare const Severity: {
+    readonly INFO: "info";
+    readonly MINOR: "minor";
+    readonly MAJOR: "major";
+    readonly CRITICAL: "critical";
+};
+export type Severity = (typeof Severity)[keyof typeof Severity];
+export declare const severityValues: [Severity, ...Severity[]];
+export declare const Detect: {
+    readonly AST: "ast";
+    readonly JUDGE: "judge";
+};
+export type Detect = (typeof Detect)[keyof typeof Detect];
+export declare const Confirm: {
+    readonly CALL_COUNT: "callCount";
+    readonly IMPL_COUNT: "implCount";
+    readonly REF_COUNT: "refCount";
+};
+export type Confirm = (typeof Confirm)[keyof typeof Confirm];
+declare const astMatcherSchema: z.ZodObject<{
+    rule: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    constraints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    utils: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strict>;
+export type AstMatcher = z.infer<typeof astMatcherSchema>;
+export type Example = {
+    lang: Lang;
+    source: string;
+    expectLines: readonly number[];
+};
+type RuleBase = {
+    id: string;
+    lang: RuleLang;
+    axis: Axis;
+    category: string;
+    severity: Severity;
+    ignore: readonly string[];
+    why: string;
+    message: string;
+    good: readonly Example[];
+    bad: readonly Example[];
+    path: string;
+};
+export type AstRule = RuleBase & {
+    detect: typeof Detect.AST;
+    ast: Partial<Record<Lang, AstMatcher>>;
+};
+export type JudgeRule = RuleBase & {
+    detect: typeof Detect.JUDGE;
+    confirm?: Confirm;
+    falsePositives: readonly string[];
+};
+export type Rule = AstRule | JudgeRule;
+export declare function loadRules(rulesDir: string): Promise<Rule[]>;
+export declare function parseRule(rulesDir: string, path: string, content: string): Rule;
+export {};

package/dist/rule.js

@@ -0,0 +1,259 @@
+import { readdir, readFile } from 'node:fs/promises';
+import { join, relative, sep } from 'node:path';
+import matter from 'gray-matter';
+import { z } from 'zod';
+import { RuleLang, fenceLang, ruleAppliesTo, ruleLangValues } from './lang.js';
+import { RuleError } from './shared/errors.js';
+export const Axis = {
+    IDIOM: 'idiom',
+    HACKY: 'hacky',
+    FUTUREPROOF: 'futureproof',
+};
+export const axisValues = Object.values(Axis);
+export const Severity = {
+    INFO: 'info',
+    MINOR: 'minor',
+    MAJOR: 'major',
+    CRITICAL: 'critical',
+};
+export const severityValues = Object.values(Severity);
+export const Detect = {
+    AST: 'ast',
+    JUDGE: 'judge',
+};
+// deterministic checks that a judge finding must pass before it counts; implemented in confirm.ts
+export const Confirm = {
+    CALL_COUNT: 'callCount',
+    IMPL_COUNT: 'implCount',
+    REF_COUNT: 'refCount',
+};
+const confirmValues = Object.values(Confirm);
+// an ast-grep rule body exactly as its YAML reference defines it. ast-grep validates the shape when matching,
+// so this schema only guards the envelope.
+const astMatcherSchema = z
+    .object({
+    rule: z.record(z.string(), z.unknown()),
+    constraints: z.record(z.string(), z.record(z.string(), z.unknown())).optional(),
+    utils: z.record(z.string(), z.record(z.string(), z.unknown())).optional(),
+})
+    .strict();
+const astByLangSchema = z
+    .object({
+    ts: astMatcherSchema.optional(),
+    go: astMatcherSchema.optional(),
+})
+    .strict();
+const commonFrontmatter = {
+    severity: z.enum(severityValues),
+    ignore: z.array(z.string()).default([]),
+};
+const frontmatterSchema = z.discriminatedUnion('detect', [
+    z
+        .object({
+        detect: z.literal(Detect.AST),
+        ast: z.union([astMatcherSchema, astByLangSchema]),
+        ...commonFrontmatter,
+    })
+        .strict(),
+    z
+        .object({
+        detect: z.literal(Detect.JUDGE),
+        confirm: z.enum(confirmValues).optional(),
+        falsePositives: z.array(z.string()).default([]),
+        ...commonFrontmatter,
+    })
+        .strict(),
+]);
+const RULE_EXTENSION = '.md';
+const MARKER_PATTERN = /^\s*\/\/\s*(GOOD|BAD):/;
+const FENCE_OPEN_PATTERN = /^```(\w*)\s*$/;
+const FENCE_CLOSE = '```';
+const SECTION_PREFIX = '## ';
+const Section = {
+    WHY: 'why',
+    BAD: 'bad',
+    GOOD: 'good',
+    MESSAGE: 'message',
+};
+export async function loadRules(rulesDir) {
+    const entries = await readdir(rulesDir, { recursive: true, withFileTypes: true });
+    const paths = entries
+        .filter(entry => entry.isFile() && entry.name.endsWith(RULE_EXTENSION))
+        .map(entry => join(entry.parentPath, entry.name))
+        .sort();
+    return Promise.all(paths.map(async (path) => parseRule(rulesDir, path, await readFile(path, 'utf-8'))));
+}
+// parses one rule file. identity comes from the path: rules/<lang>/<axis>/<category>/<slug>.md
+export function parseRule(rulesDir, path, content) {
+    const identity = parseIdentity(rulesDir, path);
+    const { data, content: body } = matter(content);
+    const frontmatter = frontmatterSchema.safeParse(data);
+    if (!frontmatter.success) {
+        const issues = frontmatter.error.issues.map(issue => `${issue.path.join('.')}: ${issue.message}`);
+        throw new RuleError(path, `invalid frontmatter: ${issues.join('; ')}`);
+    }
+    const sections = splitSections(body);
+    const why = requireSection(path, sections, Section.WHY);
+    const good = parseExamples(path, identity.lang, sections.get(Section.GOOD), Section.GOOD);
+    const bad = parseExamples(path, identity.lang, sections.get(Section.BAD), Section.BAD);
+    const message = sections.get(Section.MESSAGE)?.trim() ?? firstSentence(why);
+    const base = {
+        ...identity,
+        severity: frontmatter.data.severity,
+        ignore: frontmatter.data.ignore,
+        why,
+        message,
+        good,
+        bad,
+        path,
+    };
+    if (frontmatter.data.detect === Detect.AST) {
+        return {
+            ...base,
+            detect: Detect.AST,
+            ast: normalizeAst(path, identity.lang, frontmatter.data.ast),
+        };
+    }
+    return {
+        ...base,
+        detect: Detect.JUDGE,
+        ...(frontmatter.data.confirm && { confirm: frontmatter.data.confirm }),
+        falsePositives: frontmatter.data.falsePositives,
+    };
+}
+function parseIdentity(rulesDir, path) {
+    const segments = relative(rulesDir, path).split(sep);
+    const [lang, axis, category, file] = segments;
+    if (segments.length !== 4 || !lang || !axis || !category || !file) {
+        throw new RuleError(path, 'expected path rules/<lang>/<axis>/<category>/<slug>.md');
+    }
+    if (!isRuleLang(lang)) {
+        throw new RuleError(path, `unknown language directory "${lang}"`);
+    }
+    if (!isAxis(axis)) {
+        throw new RuleError(path, `unknown axis directory "${axis}"`);
+    }
+    const slug = file.slice(0, -RULE_EXTENSION.length);
+    return {
+        id: `${lang}.${axis}.${slug}`,
+        lang,
+        axis,
+        category,
+    };
+}
+function isRuleLang(value) {
+    return ruleLangValues.includes(value);
+}
+function isAxis(value) {
+    return axisValues.includes(value);
+}
+// a lang-specific rule writes `ast: { rule: ... }`; a lang-agnostic rule writes `ast: { ts: {...}, go: {...} }`
+function normalizeAst(path, lang, ast) {
+    const isSingle = 'rule' in ast;
+    if (lang === RuleLang.ANY) {
+        if (isSingle) {
+            throw new RuleError(path, 'lang-agnostic rules must give ast.ts and/or ast.go');
+        }
+        if (!ast.ts && !ast.go) {
+            throw new RuleError(path, 'ast must define at least one of ts, go');
+        }
+        return ast;
+    }
+    if (!isSingle) {
+        throw new RuleError(path, `${lang} rules must give ast.rule directly`);
+    }
+    return { [lang]: ast };
+}
+// splits the markdown body into `## Heading` sections keyed by lowercase heading, ignoring headings inside fences
+function splitSections(body) {
+    const sections = new Map();
+    let current;
+    let lines = [];
+    let inFence = false;
+    for (const line of body.split('\n')) {
+        if (line.startsWith(FENCE_CLOSE)) {
+            inFence = !inFence;
+        }
+        if (!inFence && line.startsWith(SECTION_PREFIX)) {
+            if (current !== undefined) {
+                sections.set(current, lines.join('\n'));
+            }
+            current = line.slice(SECTION_PREFIX.length).trim().toLowerCase();
+            lines = [];
+            continue;
+        }
+        lines.push(line);
+    }
+    if (current !== undefined) {
+        sections.set(current, lines.join('\n'));
+    }
+    return sections;
+}
+function requireSection(path, sections, name) {
+    const text = sections.get(name)?.trim();
+    if (!text) {
+        throw new RuleError(path, `missing "## ${capitalize(name)}" section`);
+    }
+    return text;
+}
+function parseExamples(path, ruleLang, section, name) {
+    const examples = [...fencedBlocks(section ?? '')].map(block => toExample(path, ruleLang, block));
+    if (examples.length === 0) {
+        throw new RuleError(path, `"## ${capitalize(name)}" needs at least one fenced code block`);
+    }
+    return examples;
+}
+function* fencedBlocks(section) {
+    let open;
+    let lines = [];
+    for (const line of section.split('\n')) {
+        const fence = FENCE_OPEN_PATTERN.exec(line);
+        if (open === undefined) {
+            if (fence?.[1] !== undefined) {
+                open = { info: fence[1], lines: [] };
+                lines = [];
+            }
+            continue;
+        }
+        if (line.startsWith(FENCE_CLOSE)) {
+            yield { ...open, lines };
+            open = undefined;
+            continue;
+        }
+        lines.push(line);
+    }
+}
+function toExample(path, ruleLang, block) {
+    const lang = fenceLang(block.info);
+    if (lang === undefined) {
+        throw new RuleError(path, `code fence needs a ts or go language tag, got "${block.info}"`);
+    }
+    if (!ruleAppliesTo(ruleLang, lang)) {
+        throw new RuleError(path, `${lang} example in a ${ruleLang} rule`);
+    }
+    const kept = [];
+    const expectLines = [];
+    for (const line of block.lines) {
+        const marker = MARKER_PATTERN.exec(line);
+        if (marker === null) {
+            kept.push(line);
+            continue;
+        }
+        if (marker[1] === 'BAD') {
+            expectLines.push(kept.length + 1);
+        }
+    }
+    return {
+        lang,
+        source: kept.join('\n'),
+        expectLines,
+    };
+}
+// a sentence ends at punctuation followed by whitespace, so `!` inside backticks does not cut it short
+function firstSentence(text) {
+    return text.split(/(?<=[.!?])\s+/, 1)[0]?.trim() ?? text;
+}
+function capitalize(text) {
+    return text.charAt(0).toUpperCase() + text.slice(1);
+}
+//# sourceMappingURL=rule.js.map

package/dist/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../src/rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE/E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,MAAM,CAAC,MAAM,IAAI,GAAG;IACnB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;CACjB,CAAC;AAIX,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAsB,CAAC;AAEnE,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;CACX,CAAC;AAIX,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAA8B,CAAC;AAEnF,MAAM,CAAC,MAAM,MAAM,GAAG;IACrB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;CACL,CAAC;AAIX,kGAAkG;AAClG,MAAM,CAAC,MAAM,OAAO,GAAG;IACtB,UAAU,EAAE,WAAW;IACvB,UAAU,EAAE,WAAW;IACvB,SAAS,EAAE,UAAU;CACZ,CAAC;AAIX,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAA4B,CAAC;AAExE,8GAA8G;AAC9G,2CAA2C;AAC3C,MAAM,gBAAgB,GAAG,CAAC;KACxB,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/E,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACzE,CAAC;KACD,MAAM,EAAE,CAAC;AAIX,MAAM,eAAe,GAAG,CAAC;KACvB,MAAM,CAAC;IACP,EAAE,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IAC/B,EAAE,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAEX,MAAM,iBAAiB,GAAG;IACzB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACvC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IACxD,CAAC;SACC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QAC7B,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;QACjD,GAAG,iBAAiB;KACpB,CAAC;SACD,MAAM,EAAE;IACV,CAAC;SACC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAC/B,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;QACzC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/C,GAAG,iBAAiB;KACpB,CAAC;SACD,MAAM,EAAE;CACV,CAAC,CAAC;AAqCH,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAChD,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAC3C,MAAM,WAAW,GAAG,KAAK,CAAC;AAC1B,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B,MAAM,OAAO,GAAG;IACf,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;CACT,CAAC;AAEX,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAgB;IAC/C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAClF,MAAM,KAAK,GAAG,OAAO;SACnB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;SACtE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;SAChD,IAAI,EAAE,CAAC;IAET,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,SAAS,CAAC,QAAgB,EAAE,IAAY,EAAE,OAAe;IACxE,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC/C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAEtD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAElG,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,wBAAwB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1F,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;IAE5E,MAAM,IAAI,GAAa;QACtB,GAAG,QAAQ;QACX,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ;QACnC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM;QAC/B,GAAG;QACH,OAAO;QACP,IAAI;QACJ,GAAG;QACH,IAAI;KACJ,CAAC;IAEF,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;QAC5C,OAAO;YACN,GAAG,IAAI;YACP,MAAM,EAAE,MAAM,CAAC,GAAG;YAClB,GAAG,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;SAC5D,CAAC;IACH,CAAC;IAED,OAAO;QACN,GAAG,IAAI;QACP,MAAM,EAAE,MAAM,CAAC,KAAK;QACpB,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACtE,cAAc,EAAE,WAAW,CAAC,IAAI,CAAC,cAAc;KAC/C,CAAC;AACH,CAAC;AAID,SAAS,aAAa,CAAC,QAAgB,EAAE,IAAY;IACpD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC;IAE9C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,wDAAwD,CAAC,CAAC;IACrF,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,+BAA+B,IAAI,GAAG,CAAC,CAAC;IACnE,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,2BAA2B,IAAI,GAAG,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAEnD,OAAO;QACN,EAAE,EAAE,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE;QAC7B,IAAI;QACJ,IAAI;QACJ,QAAQ;KACR,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAChC,OAAQ,cAAoC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,MAAM,CAAC,KAAa;IAC5B,OAAQ,UAAgC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,gHAAgH;AAChH,SAAS,YAAY,CACpB,IAAY,EACZ,IAAc,EACd,GAAuE;IAEvE,MAAM,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;IAE/B,IAAI,IAAI,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,oDAAoD,CAAC,CAAC;QACjF,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACxB,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,wCAAwC,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,oCAAoC,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,kHAAkH;AAClH,SAAS,aAAa,CAAC,IAAY;IAClC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,IAAI,OAA2B,CAAC;IAChC,IAAI,KAAK,GAAa,EAAE,CAAC;IACzB,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,OAAO,GAAG,CAAC,OAAO,CAAC;QACpB,CAAC;QAED,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YACjD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC3B,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACjE,KAAK,GAAG,EAAE,CAAC;YAEX,SAAS;QACV,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,QAA6B,EAAE,IAAY;IAChF,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;IAExC,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,eAAe,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,QAAkB,EAAE,OAA2B,EAAE,IAAY;IACjG,MAAM,QAAQ,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IAEjG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IAC5F,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAOD,QAAQ,CAAC,CAAC,YAAY,CAAC,OAAe;IACrC,IAAI,IAA6B,CAAC;IAClC,IAAI,KAAK,GAAa,EAAE,CAAC;IAEzB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;gBACrC,KAAK,GAAG,EAAE,CAAC;YACZ,CAAC;YAED,SAAS;QACV,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC;YACzB,IAAI,GAAG,SAAS,CAAC;YAEjB,SAAS;QACV,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;AACF,CAAC;AAED,SAAS,SAAS,CAAC,IAAY,EAAE,QAAkB,EAAE,KAAkB;IACtE,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,kDAAkD,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,iBAAiB,QAAQ,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhB,SAAS;QACV,CAAC;QAED,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,OAAO;QACN,IAAI;QACJ,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,WAAW;KACX,CAAC;AACH,CAAC;AAED,uGAAuG;AACvG,SAAS,aAAa,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC;AAC1D,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/dist/scan.d.ts

@@ -0,0 +1,14 @@
+import type { Judge } from './analyzers/judge.js';
+import type { Range } from './change.js';
+import type { Config } from './config.js';
+import type { Report } from './report.js';
+import type { Rule } from './rule.js';
+export type ScanOptions = {
+    repo: string;
+    range: Range;
+    config: Config;
+    rules: readonly Rule[];
+    judge?: Judge;
+    baseline?: string;
+};
+export declare function scan(options: ScanOptions): Promise<Report>;

package/dist/scan.js

@@ -0,0 +1,33 @@
+import { collectFindings } from './analyzer.js';
+import { astAnalyzer } from './analyzers/ast.js';
+import { readChanges } from './change.js';
+import { confirm } from './confirm.js';
+import { score } from './score.js';
+// the whole engine: read what changed, run every analyzer over it, confirm what needs confirming, score the rest.
+export async function scan(options) {
+    const { scored, rejected } = await scoreRange(options, options.range);
+    const baseline = options.baseline === undefined
+        ? undefined
+        : pickScore((await scoreRange(options, { base: options.baseline, head: options.range.base })).scored);
+    return {
+        ...scored,
+        ...(baseline && { baseline }),
+        ...(options.judge && { judge: options.judge.summary() }),
+        ...(rejected.length > 0 && { rejected }),
+    };
+}
+async function scoreRange(options, range) {
+    const enabled = options.rules.filter(rule => options.config.rules[rule.id] !== false);
+    const analyzers = [astAnalyzer, ...(options.judge ? [options.judge.analyze] : [])];
+    const changes = await readChanges(options.repo, range, options.config.ignore);
+    const findings = await collectFindings(changes, enabled, analyzers);
+    const { kept, rejected } = await confirm(findings, enabled, { repo: options.repo, ignore: options.config.ignore });
+    return {
+        scored: score(kept, changes, enabled, options.config.scoring),
+        rejected,
+    };
+}
+function pickScore({ overall, grade, axes }) {
+    return { overall, grade, axes };
+}
+//# sourceMappingURL=scan.js.map

package/dist/scan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan.js","sourceRoot":"","sources":["../src/scan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAIvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAcnC,kHAAkH;AAClH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAoB;IAC9C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAEtE,MAAM,QAAQ,GACb,OAAO,CAAC,QAAQ,KAAK,SAAS;QAC7B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAExG,OAAO;QACN,GAAG,MAAM;QACT,GAAG,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC7B,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACxD,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;KACxC,CAAC;AACH,CAAC;AAOD,KAAK,UAAU,UAAU,CAAC,OAAoB,EAAE,KAAY;IAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;IACtF,MAAM,SAAS,GAAe,CAAC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/F,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IACpE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnH,OAAO;QACN,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7D,QAAQ;KACR,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAU;IAClD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC"}

package/dist/score.d.ts

@@ -0,0 +1,147 @@
+import { z } from 'zod';
+import type { Change } from './change.js';
+import type { Finding } from './finding.js';
+import type { Rule } from './rule.js';
+export declare const scoringSchema: 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>;
+export type Scoring = z.infer<typeof scoringSchema>;
+export declare const Grade: {
+    readonly A: "A";
+    readonly B: "B";
+    readonly C: "C";
+    readonly D: "D";
+    readonly F: "F";
+};
+export type Grade = (typeof Grade)[keyof typeof Grade];
+export declare const scoredFindingSchema: 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>;
+export type ScoredFinding = z.infer<typeof scoredFindingSchema>;
+export declare const axisScoreSchema: z.ZodObject<{
+    score: z.ZodNumber;
+    points: z.ZodNumber;
+    density: z.ZodNumber;
+    findings: z.ZodNumber;
+}, z.core.$strip>;
+export type AxisScore = z.infer<typeof axisScoreSchema>;
+export declare const scoreSchema: 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>;
+export type Score = z.infer<typeof scoreSchema>;
+export declare const scoredSchema: 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>>;
+}, z.core.$strip>;
+export type Scored = z.infer<typeof scoredSchema>;
+export declare function score(findings: readonly Finding[], changes: readonly Change[], rules: readonly Rule[], scoring: Scoring): Scored;
+export declare function gradeFor(overall: number): Grade;