@hyperframes/lint 0.8.3 → 0.8.5

package/dist/index.d.ts

@@ -9,12 +9,24 @@ type HyperframeLintFinding = {
     fixHint?: string;
     snippet?: string;
 };
+/**
+ * Where a single lint pass spent its time. Attributed per rule-source module
+ * ("gsap", "core", ...) rather than per rule, plus the single slowest rule as
+ * `<group>#<index-within-group>` so a pathological rule is locatable.
+ */
+type LintTimings = {
+    totalMs: number;
+    groupMs: Record<string, number>;
+    slowestRule: string;
+    slowestRuleMs: number;
+};
 type HyperframeLintResult = {
     ok: boolean;
     errorCount: number;
     warningCount: number;
     infoCount: number;
     findings: HyperframeLintFinding[];
+    timings?: LintTimings;
 };
 type HyperframeLinterOptions = {
     filePath?: string;
@@ -33,6 +45,20 @@ type HyperframeLinterOptions = {
     distributed?: boolean;
 };
 
+/**
+ * How many rules this build runs. `cli_version` already identifies the release,
+ * but a rule added or removed inside one version is invisible without this —
+ * and comparing findings-per-run across a rule change is the whole point of
+ * measuring them.
+ */
+declare const LINT_RULE_COUNT: number;
+/**
+ * How many rules each group runs. `slowest_rule` is reported as
+ * `<group>#<index>`, and that index shifts whenever a rule is added to or
+ * removed from its group. Comparing these counts between two builds tells a
+ * consumer exactly which groups' indices still mean the same thing.
+ */
+declare const LINT_RULE_GROUP_COUNTS: Readonly<Record<string, number>>;
 declare function lintHyperframeHtml(html: string, options?: HyperframeLinterOptions): Promise<HyperframeLintResult>;
 /**
  * Async lint pass: HEAD-checks every remote media URL in the HTML.
@@ -56,6 +82,7 @@ interface ProjectLintResult {
     results: Array<{
         file: string;
         result: HyperframeLintResult;
+        contentHash: string;
     }>;
     totalErrors: number;
     totalWarnings: number;
@@ -63,4 +90,4 @@ interface ProjectLintResult {
 }
 declare function lintProject(projectDir: string, entryFile?: string): Promise<ProjectLintResult>;
 
-export { type HyperframeLintFinding, type HyperframeLintResult, type HyperframeLintSeverity, type HyperframeLinterOptions, type ProjectLintResult, lintHyperframeHtml, lintMediaUrls, lintProject, shouldBlockRender };
+export { type HyperframeLintFinding, type HyperframeLintResult, type HyperframeLintSeverity, type HyperframeLinterOptions, LINT_RULE_COUNT, LINT_RULE_GROUP_COUNTS, type LintTimings, type ProjectLintResult, lintHyperframeHtml, lintMediaUrls, lintProject, shouldBlockRender };