@redocly/recheck 0.14.0 → 2.58.0

package/lib/core/readability.js

@@ -0,0 +1,34 @@
+import { computeTextStatistics, computeReadability } from '../metrics/index.js';
+import { parseMarkdown } from '../parser/index.js';
+import { extractScopes } from '../scopes/extractor.js';
+import { extractProse } from './prose-extract.js';
+export function computeDocumentReadability(content, options = {}) {
+    const tree = parseMarkdown(content, { markdoc: options.markdoc ?? false });
+    const segments = extractScopes(tree, content).filter((segment) => segment.scope === 'summary');
+    const blocks = extractProse(segments);
+    // Count each block separately so the end of a block always ends a sentence.
+    const stats = blocks.map(computeTextStatistics).reduce((sum, one) => ({
+        words: sum.words + one.words,
+        sentences: sum.sentences + one.sentences,
+        syllables: sum.syllables + one.syllables,
+        characters: sum.characters + one.characters,
+        complexWords: sum.complexWords + one.complexWords,
+    }), { words: 0, sentences: 0, syllables: 0, characters: 0, complexWords: 0 });
+    if (stats.words === 0 || stats.sentences === 0) {
+        return {
+            words: stats.words,
+            sentences: stats.sentences,
+            fleschReadingEase: null,
+            fleschKincaidGrade: null,
+            automatedReadabilityIndex: null,
+        };
+    }
+    return {
+        words: stats.words,
+        sentences: stats.sentences,
+        fleschReadingEase: computeReadability('flesch-reading-ease', stats),
+        fleschKincaidGrade: computeReadability('flesch-kincaid-grade', stats),
+        automatedReadabilityIndex: computeReadability('automated-readability', stats),
+    };
+}
+//# sourceMappingURL=readability.js.map

package/lib/core/readability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readability.js","sourceRoot":"","sources":["../../src/core/readability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAgBlD,MAAM,UAAU,0BAA0B,CACxC,OAAe,EACf,UAAiC,EAAE;IAEnC,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;IAC/F,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAEtC,4EAA4E;IAC5E,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACb,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK;QAC5B,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS;QACxC,SAAS,EAAE,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS;QACxC,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU;QAC3C,YAAY,EAAE,GAAG,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY;KAClD,CAAC,EACF,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CACzE,CAAC;IAEF,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,iBAAiB,EAAE,IAAI;YACvB,kBAAkB,EAAE,IAAI;YACxB,yBAAyB,EAAE,IAAI;SAChC,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,iBAAiB,EAAE,kBAAkB,CAAC,qBAAqB,EAAE,KAAK,CAAC;QACnE,kBAAkB,EAAE,kBAAkB,CAAC,sBAAsB,EAAE,KAAK,CAAC;QACrE,yBAAyB,EAAE,kBAAkB,CAAC,uBAAuB,EAAE,KAAK,CAAC;KAC9E,CAAC;AACJ,CAAC"}

package/lib/core/rule-filters.d.ts

@@ -0,0 +1,29 @@
+import type { NormalizedRule } from '../types/index.js';
+export interface FilterOptions {
+    severity?: 'off' | 'info' | 'warn' | 'warning' | 'error';
+    tags?: (string | number)[];
+    /** Run only these rules (see `matchesRuleName` for accepted spellings). */
+    rules?: string[];
+    /** Run everything except these rules. */
+    excludeRules?: string[];
+}
+export declare class UnknownRuleNameError extends Error {
+    readonly unknown: string[];
+    readonly available: string[];
+    constructor(unknown: string[], available: string[]);
+}
+/** Keeps only the named rules. Unknown names throw, so a typo is not mistaken for a clean run. */
+export declare function filterByRuleNames(rules: NormalizedRule[], names: string[]): NormalizedRule[];
+/** Removes the named rules. Matches names the same way as `filterByRuleNames`. */
+export declare function excludeByRuleNames(rules: NormalizedRule[], names: string[]): NormalizedRule[];
+export declare function filterEnabledRules(rules: NormalizedRule[]): {
+    enabled: NormalizedRule[];
+    disabledCount: number;
+};
+export declare function filterBySeverity(rules: NormalizedRule[], minSeverity: string): NormalizedRule[];
+export declare function filterByTags(rules: NormalizedRule[], tags: (string | number)[]): NormalizedRule[];
+export declare function applyFilters(rules: NormalizedRule[], options: FilterOptions): {
+    filtered: NormalizedRule[];
+    disabledCount: number;
+};
+//# sourceMappingURL=rule-filters.d.ts.map

package/lib/core/rule-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-filters.d.ts","sourceRoot":"","sources":["../../src/core/rule-filters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACzD,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3B,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;IAE3C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE;gBADnB,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,EAAE;CAK/B;AAcD,kGAAkG;AAClG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,CAU5F;AAED,kFAAkF;AAClF,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,CAU7F;AAUD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG;IAC3D,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;CACvB,CAIA;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,cAAc,EAAE,CAU/F;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,cAAc,EAAE,CAIjG;AAED,wBAAgB,YAAY,CAC1B,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,EAAE,aAAa,GACrB;IACD,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;CACvB,CAsBA"}

package/lib/core/rule-filters.js

@@ -0,0 +1,88 @@
+export class UnknownRuleNameError extends Error {
+    unknown;
+    available;
+    constructor(unknown, available) {
+        super(`no rule in this configuration matches ${unknown.map((n) => `"${n}"`).join(', ')}`);
+        this.unknown = unknown;
+        this.available = available;
+        this.name = 'UnknownRuleNameError';
+    }
+}
+/**
+ * A rule matches when the value equals its full config key (`recheck/us-spelling`)
+ * or its `shortName`, which is the name the report prints.
+ *
+ * `shortName` only drops the `recheck/` prefix, so `google/passive-voice` stays as is.
+ * Don't match on the last path segment: `no-trailing-punctuation` exists in `recheck/`,
+ * `google/` and `microsoft/`, so a bare name would select three rules.
+ */
+function matchesRuleName(rule, name) {
+    return rule.name === name || rule.shortName === name;
+}
+/** Keeps only the named rules. Unknown names throw, so a typo is not mistaken for a clean run. */
+export function filterByRuleNames(rules, names) {
+    if (!names.length)
+        return rules;
+    const unknown = names.filter((name) => !rules.some((rule) => matchesRuleName(rule, name)));
+    if (unknown.length > 0) {
+        throw new UnknownRuleNameError(unknown, rules.map((rule) => rule.name));
+    }
+    return rules.filter((rule) => names.some((name) => matchesRuleName(rule, name)));
+}
+/** Removes the named rules. Matches names the same way as `filterByRuleNames`. */
+export function excludeByRuleNames(rules, names) {
+    if (!names.length)
+        return rules;
+    const unknown = names.filter((name) => !rules.some((rule) => matchesRuleName(rule, name)));
+    if (unknown.length > 0) {
+        throw new UnknownRuleNameError(unknown, rules.map((rule) => rule.name));
+    }
+    return rules.filter((rule) => !names.some((name) => matchesRuleName(rule, name)));
+}
+const SEVERITY_LEVELS = {
+    off: -1,
+    info: 0,
+    warn: 1,
+    warning: 1,
+    error: 2,
+};
+export function filterEnabledRules(rules) {
+    const enabled = rules.filter((rule) => rule.severity !== 'off');
+    const disabledCount = rules.length - enabled.length;
+    return { enabled, disabledCount };
+}
+export function filterBySeverity(rules, minSeverity) {
+    const minLevel = SEVERITY_LEVELS[minSeverity];
+    if (minLevel === undefined)
+        return rules;
+    return rules.filter((rule) => {
+        // 'warning' is an old spelling of 'warn'.
+        const ruleSeverity = rule.severity === 'warning' ? 'warn' : rule.severity;
+        const ruleLevel = SEVERITY_LEVELS[ruleSeverity];
+        return ruleLevel >= minLevel;
+    });
+}
+export function filterByTags(rules, tags) {
+    if (!tags.length)
+        return rules;
+    return rules.filter((rule) => rule.tags?.some((tag) => tags.includes(tag)));
+}
+export function applyFilters(rules, options) {
+    const { enabled, disabledCount } = filterEnabledRules(rules);
+    let filtered = enabled;
+    if (options.severity) {
+        filtered = filterBySeverity(filtered, options.severity);
+    }
+    if (options.tags?.length) {
+        filtered = filterByTags(filtered, options.tags);
+    }
+    // Name filters run last, so they only narrow what the other filters kept.
+    if (options.rules?.length) {
+        filtered = filterByRuleNames(filtered, options.rules);
+    }
+    if (options.excludeRules?.length) {
+        filtered = excludeByRuleNames(filtered, options.excludeRules);
+    }
+    return { filtered, disabledCount };
+}
+//# sourceMappingURL=rule-filters.js.map

package/lib/core/rule-filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-filters.js","sourceRoot":"","sources":["../../src/core/rule-filters.ts"],"names":[],"mappings":"AAWA,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAElC;IACA;IAFX,YACW,OAAiB,EACjB,SAAmB;QAE5B,KAAK,CAAC,yCAAyC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAHjF,YAAO,GAAP,OAAO,CAAU;QACjB,cAAS,GAAT,SAAS,CAAU;QAG5B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,IAAoB,EAAE,IAAY;IACzD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC;AACvD,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,iBAAiB,CAAC,KAAuB,EAAE,KAAe;IACxE,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,oBAAoB,CAC5B,OAAO,EACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,kBAAkB,CAAC,KAAuB,EAAE,KAAe;IACzE,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,oBAAoB,CAC5B,OAAO,EACP,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,eAAe,GAA2B;IAC9C,GAAG,EAAE,CAAC,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,CAAC;CACT,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAAC,KAAuB;IAIxD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAuB,EAAE,WAAmB;IAC3E,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAEzC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,0CAA0C;QAC1C,MAAM,YAAY,GAAI,IAAI,CAAC,QAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QACtF,MAAM,SAAS,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAChD,OAAO,SAAS,IAAI,QAAQ,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAuB,EAAE,IAAyB;IAC7E,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAE/B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAa,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,KAAuB,EACvB,OAAsB;IAKtB,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC7D,IAAI,QAAQ,GAAG,OAAO,CAAC;IAEvB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QACzB,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,0EAA0E;IAC1E,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QAC1B,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;QACjC,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;AACrC,CAAC"}

package/lib/core/runner.d.ts

@@ -0,0 +1,60 @@
+import { type MarkdocSchema } from '../parser/markdoc/schema.js';
+import type { ScopeRuleContext } from '../rules/types.js';
+import type { NormalizedRule, Problem, Fix } from '../types/index.js';
+export interface RunnerOptions {
+    fix?: boolean;
+    /**
+     * Lint each input as embedded markdown instead of a whole document. A leading `---`
+     * is content, not front matter, and the rules in EMBEDDED_UNSUPPORTED_RULES are skipped.
+     */
+    embedded?: boolean;
+    /**
+     * Maximum number of problems to collect. Once a file reaches the cap, its extra
+     * problems are dropped and no more files are linted, and `truncated` is set.
+     * No limit by default.
+     */
+    maxProblems?: number;
+    /**
+     * All configured rule names, used to warn about unknown rule names in inline
+     * directives. Pass this when `rules` has the `severity: off` rules removed, so
+     * a directive that names one of them is not reported as unknown. Defaults to the
+     * names in `rules`.
+     */
+    knownRuleNames?: Set<string>;
+    /** Parse Markdoc tags. Off by default. */
+    markdoc?: boolean;
+    /**
+     * The Markdoc schema, used with `markdoc: true`. Without one, tags are still parsed and
+     * paired, `ctx.markdoc.schema` is `null`, and no tag counts as self-closing.
+     */
+    markdocSchema?: MarkdocSchema | null;
+}
+export interface FileInput {
+    path: string;
+    content: string;
+    metadata?: ScopeRuleContext['fileMetadata'];
+}
+export interface RunResult {
+    problems: Problem[];
+    fixedFiles: Map<string, string>;
+    /** The fixes that were applied to `fixedFiles`. */
+    fixes: Fix[];
+    /**
+     * Fixes that could not be applied, such as overlapping edits. For
+     * `runRulesUntilStable`, only the fixes still skipped after the last pass.
+     */
+    skippedFixes: Fix[];
+    /** True when `maxProblems` cut the run short. */
+    truncated: boolean;
+}
+export declare function runRules(files: FileInput[], rules: NormalizedRule[], options?: RunnerOptions): Promise<RunResult>;
+/**
+ * Runs the rules with fixes, then runs them again on the fixed content, until no more
+ * fixes apply or MAX_FIX_PASSES is reached. A single `--fix` run then fixes everything.
+ *
+ * `problems` come from the first pass, so they are the problems that were found before
+ * fixing. `fixedFiles` has the final content. `skippedFixes` has only the fixes still
+ * skipped after the last pass.
+ */
+export declare function runRulesUntilStable(files: FileInput[], rules: NormalizedRule[], options?: Omit<RunnerOptions, 'fix'>): Promise<RunResult>;
+//# sourceMappingURL=runner.d.ts.map

package/lib/core/runner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/core/runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAItF,OAAO,KAAK,EAAE,gBAAgB,EAAoB,MAAM,mBAAmB,CAAC;AAK5E,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAgBtE,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,mDAAmD;IACnD,KAAK,EAAE,GAAG,EAAE,CAAC;IACb;;;OAGG;IACH,YAAY,EAAE,GAAG,EAAE,CAAC;IACpB,iDAAiD;IACjD,SAAS,EAAE,OAAO,CAAC;CACpB;AAuDD,wBAAsB,QAAQ,CAC5B,KAAK,EAAE,SAAS,EAAE,EAClB,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,SAAS,CAAC,CA4MpB;AAKD;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,SAAS,EAAE,EAClB,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,GAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAAM,GACvC,OAAO,CAAC,SAAS,CAAC,CAmCpB"}

package/lib/core/runner.js

@@ -0,0 +1,305 @@
+import { parseMarkdown } from '../parser/index.js';
+import { computeMarkdocPairing, emptyMarkdocPairing } from '../parser/markdoc/pairing.js';
+import { selfClosingTagNames } from '../parser/markdoc/schema.js';
+import { resolveAssertion } from '../rules/registry.js';
+import { clearHtmlCommentText } from '../rules/token/helpers.js';
+import { formatTokenMessage } from '../rules/token/messages.js';
+import { shouldProcessFile, shouldSkipLine } from '../rules/utils.js';
+import { extractScopes } from '../scopes/extractor.js';
+import { compileSelector } from '../scopes/selector.js';
+import { applyFixesToContent } from './auto-fix.js';
+import { parseDirectives } from './directives.js';
+import { newLineRe } from './line-endings.js';
+import { markdocTagSpans, protectMarkdocTags } from './markdoc-tags.js';
+// Rules that don't work on embedded markdown, because they check the whole document
+// or links to anchors that embedded content doesn't have.
+const EMBEDDED_UNSUPPORTED_RULES = new Set([
+    'single-h1',
+    'first-line-h1',
+    'front-matter',
+    'single-trailing-newline',
+    'link-fragments',
+]);
+function wholeFileSegment(content) {
+    const lines = content.split(newLineRe);
+    return {
+        scope: 'all',
+        content,
+        startLine: 1,
+        startColumn: 1,
+        endLine: lines.length,
+        endColumn: (lines[lines.length - 1]?.length ?? 0) + 1,
+        tokens: [],
+    };
+}
+/**
+ * Returns a filter that drops repeated scope rule findings (same rule, file, position
+ * and message) and keeps the first one.
+ *
+ * Scope segments overlap (a paragraph, its summary and its sentences cover the same
+ * text), so one match can be reported once per segment.
+ *
+ * Token rule findings are not filtered, because markdownlint can report the same
+ * finding twice and we match its output.
+ */
+function createFindingDeduper() {
+    const seen = new Set();
+    return (problem) => {
+        const key = [
+            problem.ruleName,
+            problem.file,
+            problem.line,
+            problem.column,
+            problem.message,
+        ].join('\u0000');
+        if (seen.has(key))
+            return false;
+        seen.add(key);
+        return true;
+    };
+}
+function internalError(file, ruleName, error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return {
+        file,
+        line: 1,
+        column: 1,
+        text: '',
+        match: '',
+        ruleName: 'recheck/internal-error',
+        severity: 'warn',
+        message: `Rule ${ruleName} failed: ${message}`,
+    };
+}
+export async function runRules(files, rules, options = {}) {
+    if (options.embedded === true) {
+        rules = rules.filter((rule) => !EMBEDDED_UNSUPPORTED_RULES.has(rule.shortName));
+    }
+    const problems = [];
+    const fixesByFile = new Map();
+    // Markdoc tag spans of each file, only collected when fixing. Used to protect tags from fixes.
+    const tagSpansByFile = new Map();
+    const isFirstOccurrence = createFindingDeduper();
+    const selectors = new Map(rules.map((rule) => [rule.name, compileSelector(rule.scope)]));
+    const knownRuleNames = options.knownRuleNames ?? new Set(rules.map((r) => r.name));
+    // Skip `extractScopes` when every rule is a token rule, since those don't use segments.
+    const hasScopeRules = rules.some((rule) => Object.keys(rule.assertions).some((assertionId) => {
+        try {
+            return resolveAssertion(assertionId).kind === 'scope';
+        }
+        catch {
+            return false;
+        }
+    }));
+    // Skip the tag pairing when no rule uses it. Rules that use it have the `markdoc` tag.
+    // `ctx.markdoc` is still provided, so rules that only read the schema keep working.
+    const hasMarkdocRules = rules.some((rule) => Object.keys(rule.assertions).some((assertionId) => {
+        try {
+            const resolved = resolveAssertion(assertionId);
+            return resolved.kind === 'token' && resolved.rule.tags.includes('markdoc');
+        }
+        catch {
+            return false;
+        }
+    }));
+    // The same for every file, so work it out once.
+    const markdocSchema = options.markdocSchema ?? null;
+    const markdocSelfClosingTags = markdocSchema
+        ? selfClosingTagNames(markdocSchema)
+        : new Set();
+    let truncated = false;
+    for (const { path, content, metadata } of files) {
+        // At the problem limit, skip the remaining files.
+        if (options.maxProblems !== undefined && problems.length >= options.maxProblems) {
+            truncated = true;
+            break;
+        }
+        const tree = parseMarkdown(content, {
+            markdoc: options.markdoc === true,
+            embedded: options.embedded === true,
+        });
+        // Unknown rule names are reported even if the whole file is disabled.
+        const directives = parseDirectives(tree, path, knownRuleNames);
+        problems.push(...directives.warnings);
+        if (directives.fileDisabled)
+            continue;
+        if (options.fix)
+            tagSpansByFile.set(path, markdocTagSpans(tree, content));
+        const allSegments = hasScopeRules ? extractScopes(tree, content) : [];
+        // Split with newLineRe, not '\n', so CRLF files have no '\r' left on the lines.
+        const fileLines = content.split(newLineRe);
+        // Token rules read lines with HTML comment text blanked out, so content inside a
+        // comment is not checked. Positions are the same as in the raw `fileLines`, which
+        // are used for `Problem.text` and for skipping lines.
+        const commentClearedLines = clearHtmlCommentText(content).split(newLineRe);
+        // Undefined when Markdoc parsing is off, so a rule can check `if (!ctx.markdoc) return;`.
+        const markdocCtx = options.markdoc === true
+            ? {
+                schema: markdocSchema,
+                selfClosingTags: markdocSelfClosingTags,
+                pairing: hasMarkdocRules
+                    ? computeMarkdocPairing(tree, { selfClosingTags: markdocSelfClosingTags })
+                    : emptyMarkdocPairing(),
+            }
+            : undefined;
+        for (const rule of rules) {
+            if (!shouldProcessFile(path, rule))
+                continue;
+            const selector = selectors.get(rule.name) ?? null;
+            const lineExcepted = (line) => shouldSkipLine(fileLines[line - 1] ?? '', rule);
+            const problemAllowed = (line) => !lineExcepted(line) && !directives.isSuppressed(rule.name, line);
+            // Filtered on first use and reused by the rule's other assertions.
+            let segments = null;
+            for (const assertionId of Object.keys(rule.assertions)) {
+                let resolved;
+                try {
+                    resolved = resolveAssertion(assertionId);
+                }
+                catch (error) {
+                    problems.push(internalError(path, rule.name, error));
+                    continue;
+                }
+                if (resolved.kind === 'scope') {
+                    if (segments === null) {
+                        segments = selector ? allSegments.filter(selector) : [wholeFileSegment(content)];
+                    }
+                    const scopeRule = resolved.rule;
+                    const ctx = { segments, content, tree, fileMetadata: metadata };
+                    // Whether `--fix` could fix this rule's findings. A rule can still mark
+                    // individual problems as not fixable.
+                    const canFix = Boolean(scopeRule.fixable && scopeRule.fix && rule.fix !== false);
+                    try {
+                        const ruleProblems = await scopeRule.execute(rule, path, ctx);
+                        problems.push(...ruleProblems
+                            .filter((problem) => problemAllowed(problem.line))
+                            .filter(isFirstOccurrence)
+                            .map((problem) => ({ ...problem, fixable: canFix && (problem.fixable ?? true) })));
+                        if (options.fix && scopeRule.fixable && scopeRule.fix && rule.fix !== false) {
+                            const ruleFixes = await scopeRule.fix(rule, path, ctx);
+                            const fileFixes = fixesByFile.get(path) ?? [];
+                            fileFixes.push(...ruleFixes.filter((fix) => problemAllowed(fix.lineNumber)));
+                            fixesByFile.set(path, fileFixes);
+                        }
+                    }
+                    catch (error) {
+                        problems.push(internalError(path, rule.name, error));
+                    }
+                    continue;
+                }
+                const tokenRule = resolved.rule;
+                const tokenProblems = [];
+                const tokenFixes = [];
+                const tokenCtx = {
+                    tree,
+                    lines: commentClearedLines,
+                    filePath: path,
+                    markdoc: markdocCtx,
+                    config: {
+                        ...tokenRule.defaults,
+                        ...rule.assertions[assertionId],
+                    },
+                    onError(info) {
+                        tokenProblems.push({
+                            file: path,
+                            line: info.line,
+                            column: info.column ?? 1,
+                            text: fileLines[info.line - 1] ?? '',
+                            match: info.context ?? '',
+                            ruleName: rule.name,
+                            // A rule can set its own severity per finding. Otherwise the configured severity is
+                            // used.
+                            severity: info.severity ?? rule.severity,
+                            message: formatTokenMessage(rule.message, tokenRule, info),
+                            // Some findings of a fixable rule have no fix.
+                            fixable: Boolean(tokenRule.fixable && rule.fix !== false && info.fixInfo),
+                        });
+                        if (options.fix && tokenRule.fixable && rule.fix !== false && info.fixInfo) {
+                            tokenFixes.push({ file: path, ruleName: rule.name, ...info.fixInfo });
+                        }
+                    },
+                };
+                try {
+                    tokenRule.check(tokenCtx);
+                    problems.push(...tokenProblems.filter((problem) => problemAllowed(problem.line)));
+                    if (tokenFixes.length > 0) {
+                        const fileFixes = fixesByFile.get(path) ?? [];
+                        fileFixes.push(...tokenFixes.filter((fix) => problemAllowed(fix.lineNumber)));
+                        fixesByFile.set(path, fileFixes);
+                    }
+                }
+                catch (error) {
+                    problems.push(internalError(path, rule.name, error));
+                }
+            }
+        }
+    }
+    // The last file may have gone over the limit.
+    if (options.maxProblems !== undefined && problems.length > options.maxProblems) {
+        problems.length = options.maxProblems;
+        truncated = true;
+    }
+    const fixedFiles = new Map();
+    const fixes = [];
+    const skippedFixes = [];
+    if (options.fix) {
+        for (const [path, fileFixes] of fixesByFile) {
+            const original = files.find((file) => file.path === path);
+            if (original && fileFixes.length > 0) {
+                // Fixes must not change a Markdoc tag. `protectMarkdocTags` keeps the tag
+                // in the edit where it can, and drops the edit otherwise.
+                const guarded = protectMarkdocTags(fileFixes, tagSpansByFile.get(path) ?? [], original.content);
+                skippedFixes.push(...guarded.dropped);
+                const { content, applied, skipped } = applyFixesToContent(original.content, guarded.fixes);
+                // Only report the file as fixed if an edit was applied.
+                if (applied.length > 0)
+                    fixedFiles.set(path, content);
+                fixes.push(...applied);
+                skippedFixes.push(...skipped);
+            }
+        }
+    }
+    return { problems, fixedFiles, fixes, skippedFixes, truncated };
+}
+// Maximum number of fix passes, in case a rule's fixes never settle.
+const MAX_FIX_PASSES = 5;
+/**
+ * Runs the rules with fixes, then runs them again on the fixed content, until no more
+ * fixes apply or MAX_FIX_PASSES is reached. A single `--fix` run then fixes everything.
+ *
+ * `problems` come from the first pass, so they are the problems that were found before
+ * fixing. `fixedFiles` has the final content. `skippedFixes` has only the fixes still
+ * skipped after the last pass.
+ */
+export async function runRulesUntilStable(files, rules, options = {}) {
+    const firstPass = await runRules(files, rules, { ...options, fix: true });
+    const fixedFiles = new Map(firstPass.fixedFiles);
+    const allFixes = [...firstPass.fixes];
+    let skippedFixes = firstPass.skippedFixes;
+    let currentFiles = files.map((file) => ({
+        ...file,
+        content: fixedFiles.get(file.path) ?? file.content,
+    }));
+    for (let pass = 1; pass < MAX_FIX_PASSES && fixedFiles.size > 0; pass++) {
+        const nextPass = await runRules(currentFiles, rules, { ...options, fix: true });
+        // Fixes skipped in earlier passes are either proposed again in this pass or no longer needed.
+        skippedFixes = nextPass.skippedFixes;
+        if (nextPass.fixedFiles.size === 0)
+            break;
+        for (const [path, content] of nextPass.fixedFiles) {
+            fixedFiles.set(path, content);
+        }
+        allFixes.push(...nextPass.fixes);
+        currentFiles = currentFiles.map((file) => ({
+            ...file,
+            content: nextPass.fixedFiles.get(file.path) ?? file.content,
+        }));
+    }
+    return {
+        problems: firstPass.problems,
+        fixedFiles,
+        fixes: allFixes,
+        skippedFixes,
+        truncated: firstPass.truncated,
+    };
+}
+//# sourceMappingURL=runner.js.map

package/lib/core/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../src/core/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAsB,MAAM,6BAA6B,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAuB,MAAM,mBAAmB,CAAC;AAE7F,oFAAoF;AACpF,0DAA0D;AAC1D,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAC;IACzC,WAAW;IACX,eAAe;IACf,cAAc;IACd,yBAAyB;IACzB,gBAAgB;CACjB,CAAC,CAAC;AAmDH,SAAS,gBAAgB,CAAC,OAAe;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,OAAO;QACP,SAAS,EAAE,CAAC;QACZ,WAAW,EAAE,CAAC;QACd,OAAO,EAAE,KAAK,CAAC,MAAM;QACrB,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC;QACrD,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB;IAC3B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,MAAM,GAAG,GAAG;YACV,OAAO,CAAC,QAAQ;YAChB,OAAO,CAAC,IAAI;YACZ,OAAO,CAAC,IAAI;YACZ,OAAO,CAAC,MAAM;YACd,OAAO,CAAC,OAAO;SAChB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjB,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,QAAgB,EAAE,KAAc;IACnE,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,CAAC;QACP,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE,wBAAwB;QAClC,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,QAAQ,QAAQ,YAAY,OAAO,EAAE;KAC/C,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,KAAkB,EAClB,KAAuB,EACvB,UAAyB,EAAE;IAE3B,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC9B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,0BAA0B,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAClF,CAAC;IACD,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,IAAI,GAAG,EAAiB,CAAC;IAC7C,+FAA+F;IAC/F,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4B,CAAC;IAC3D,MAAM,iBAAiB,GAAG,oBAAoB,EAAE,CAAC;IAEjD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnF,wFAAwF;IACxF,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QAChD,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,WAAW,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC;QACxD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,uFAAuF;IACvF,oFAAoF;IACpF,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAC/C,OAAO,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC7E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,gDAAgD;IAChD,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC;IACpD,MAAM,sBAAsB,GAAG,aAAa;QAC1C,CAAC,CAAC,mBAAmB,CAAC,aAAa,CAAC;QACpC,CAAC,CAAE,IAAI,GAAG,EAAkC,CAAC;IAE/C,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,KAAK,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,KAAK,EAAE,CAAC;QAChD,kDAAkD;QAClD,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YAChF,SAAS,GAAG,IAAI,CAAC;YACjB,MAAM;QACR,CAAC;QACD,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,EAAE;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI;YACjC,QAAQ,EAAE,OAAO,CAAC,QAAQ,KAAK,IAAI;SACpC,CAAC,CAAC;QACH,sEAAsE;QACtE,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QAC/D,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,UAAU,CAAC,YAAY;YAAE,SAAS;QACtC,IAAI,OAAO,CAAC,GAAG;YAAE,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,gFAAgF;QAChF,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3C,iFAAiF;QACjF,kFAAkF;QAClF,sDAAsD;QACtD,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3E,0FAA0F;QAC1F,MAAM,UAAU,GACd,OAAO,CAAC,OAAO,KAAK,IAAI;YACtB,CAAC,CAAC;gBACE,MAAM,EAAE,aAAa;gBACrB,eAAe,EAAE,sBAAsB;gBACvC,OAAO,EAAE,eAAe;oBACtB,CAAC,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE,eAAe,EAAE,sBAAsB,EAAE,CAAC;oBAC1E,CAAC,CAAC,mBAAmB,EAAE;aAC1B;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC;gBAAE,SAAS;YAC7C,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;YAClD,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;YACvF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE,CACtC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnE,mEAAmE;YACnE,IAAI,QAAQ,GAA2B,IAAI,CAAC;YAE5C,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvD,IAAI,QAAQ,CAAC;gBACb,IAAI,CAAC;oBACH,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;gBAC3C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBACrD,SAAS;gBACX,CAAC;gBAED,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC9B,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACtB,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;oBACnF,CAAC;oBACD,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC;oBAChC,MAAM,GAAG,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;oBAChE,wEAAwE;oBACxE,sCAAsC;oBACtC,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC;oBACjF,IAAI,CAAC;wBACH,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;wBAC9D,QAAQ,CAAC,IAAI,CACX,GAAG,YAAY;6BACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;6BACjD,MAAM,CAAC,iBAAiB,CAAC;6BACzB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CACpF,CAAC;wBACF,IAAI,OAAO,CAAC,GAAG,IAAI,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,EAAE,CAAC;4BAC5E,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;4BACvD,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;4BAC9C,SAAS,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;4BAC7E,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;wBACnC,CAAC;oBACH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;oBACvD,CAAC;oBACD,SAAS;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAChC,MAAM,aAAa,GAAc,EAAE,CAAC;gBACpC,MAAM,UAAU,GAAU,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAqB;oBACjC,IAAI;oBACJ,KAAK,EAAE,mBAAmB;oBAC1B,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE,UAAU;oBACnB,MAAM,EAAE;wBACN,GAAG,SAAS,CAAC,QAAQ;wBACrB,GAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAyC;qBACzE;oBACD,OAAO,CAAC,IAAI;wBACV,aAAa,CAAC,IAAI,CAAC;4BACjB,IAAI,EAAE,IAAI;4BACV,IAAI,EAAE,IAAI,CAAC,IAAI;4BACf,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC;4BACxB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;4BACpC,KAAK,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;4BACzB,QAAQ,EAAE,IAAI,CAAC,IAAI;4BACnB,oFAAoF;4BACpF,QAAQ;4BACR,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;4BACxC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC;4BAC1D,+CAA+C;4BAC/C,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC;yBAC1E,CAAC,CAAC;wBACH,IAAI,OAAO,CAAC,GAAG,IAAI,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;4BAC3E,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;wBACxE,CAAC;oBACH,CAAC;iBACF,CAAC;gBACF,IAAI,CAAC;oBACH,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAC1B,QAAQ,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAClF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC1B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAC9C,SAAS,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;wBAC9E,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBACnC,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QAC/E,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QACtC,SAAS,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,MAAM,YAAY,GAAU,EAAE,CAAC;IAC/B,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC1D,IAAI,QAAQ,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,0EAA0E;gBAC1E,0DAA0D;gBAC1D,MAAM,OAAO,GAAG,kBAAkB,CAChC,SAAS,EACT,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAC9B,QAAQ,CAAC,OAAO,CACjB,CAAC;gBACF,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;gBACtC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC3F,wDAAwD;gBACxD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;oBAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACtD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;gBACvB,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;AAClE,CAAC;AAED,qEAAqE;AACrE,MAAM,cAAc,GAAG,CAAC,CAAC;AAEzB;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,KAAkB,EAClB,KAAuB,EACvB,UAAsC,EAAE;IAExC,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;IAE1C,IAAI,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACtC,GAAG,IAAI;QACP,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO;KACnD,CAAC,CAAC,CAAC;IAEJ,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,cAAc,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC;QACxE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAChF,8FAA8F;QAC9F,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;QACrC,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;YAAE,MAAM;QAE1C,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;YAClD,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QACjC,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzC,GAAG,IAAI;YACP,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO;SAC5D,CAAC,CAAC,CAAC;IACN,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,UAAU;QACV,KAAK,EAAE,QAAQ;QACf,YAAY;QACZ,SAAS,EAAE,SAAS,CAAC,SAAS;KAC/B,CAAC;AACJ,CAAC"}

package/lib/core/summary.d.ts

@@ -0,0 +1,4 @@
+import type { Problem, RuleBreakdown, Summary } from '../types/index.js';
+export declare function getBreakdownStats(problems: Problem[]): RuleBreakdown;
+export declare function buildSummary(problems: Problem[], fileCount: number, baseline?: Summary['baseline']): Summary;
+//# sourceMappingURL=summary.d.ts.map

package/lib/core/summary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/core/summary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEzE,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,aAAa,CAwBpE;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,OAAO,EAAE,EACnB,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAC7B,OAAO,CAeT"}

package/lib/core/summary.js

@@ -0,0 +1,37 @@
+export function getBreakdownStats(problems) {
+    const breakdown = {};
+    for (const problem of problems) {
+        if (!breakdown[problem.ruleName]) {
+            breakdown[problem.ruleName] = { errors: 0, warnings: 0, info: 0, total: 0 };
+        }
+        breakdown[problem.ruleName].total++;
+        switch (problem.severity) {
+            case 'error':
+                breakdown[problem.ruleName].errors++;
+                break;
+            case 'warn':
+                breakdown[problem.ruleName].warnings++;
+                break;
+            case 'info':
+                breakdown[problem.ruleName].info++;
+                break;
+        }
+    }
+    return breakdown;
+}
+export function buildSummary(problems, fileCount, baseline) {
+    const breakdown = getBreakdownStats(problems);
+    const totalErrors = problems.filter((problem) => problem.severity === 'error').length;
+    const totalWarnings = problems.filter((problem) => problem.severity === 'warn').length;
+    const totalInfo = problems.filter((problem) => problem.severity === 'info').length;
+    return {
+        filesScanned: fileCount,
+        totalIssues: problems.length,
+        ...(baseline === undefined ? {} : { baseline }),
+        totalErrors,
+        totalWarnings,
+        totalInfo,
+        breakdown,
+    };
+}
+//# sourceMappingURL=summary.js.map

package/lib/core/summary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/core/summary.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,iBAAiB,CAAC,QAAmB;IACnD,MAAM,SAAS,GAAkB,EAAE,CAAC;IAEpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAC9E,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;QAEpC,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;YACzB,KAAK,OAAO;gBACV,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;gBACrC,MAAM;YACR,KAAK,MAAM;gBACT,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACvC,MAAM;YACR,KAAK,MAAM;gBACT,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;gBACnC,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,QAAmB,EACnB,SAAiB,EACjB,QAA8B;IAE9B,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IACtF,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACvF,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IAEnF,OAAO;QACL,YAAY,EAAE,SAAS;QACvB,WAAW,EAAE,QAAQ,CAAC,MAAM;QAC5B,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,WAAW;QACX,aAAa;QACb,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC"}

package/lib/core/timing.d.ts

@@ -0,0 +1,9 @@
+export declare function formatElapsedTime(elapsedMs: number): string;
+export declare class Timer {
+    private startTime;
+    constructor();
+    elapsed(): number;
+    elapsedString(): string;
+    reset(): void;
+}
+//# sourceMappingURL=timing.d.ts.map

package/lib/core/timing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timing.d.ts","sourceRoot":"","sources":["../../src/core/timing.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAS;;IAM1B,OAAO,IAAI,MAAM;IAIjB,aAAa,IAAI,MAAM;IAIvB,KAAK,IAAI,IAAI;CAGd"}