types.ts

import type { ActionsCacheList, ActionsCacheUsage } from "@kesin11/gha-utils";
import type { JobSummary, RunSummary } from "../workflow_summariser.ts";

export const severityList = ["high", "medium", "low", "unknown"] as const;
export type Severity = typeof severityList[number];
export type RuleResult = {
  ruleId: string;
  ruleUrl?: string;
  severity: Severity;
  fixable: boolean;
  description: string;
  codeUrl?: string;
  messages: string[];
  helpMessage?: string;
  code?: string;
  data?: unknown;
};
export type RuleArgs = {
  actionsCacheUsage: ActionsCacheUsage;
  actionsCacheList: ActionsCacheList;
  jobSummaries: JobSummary[];
  runSummaries: RunSummary[];
  config: unknown;
};
export type RuleFunc = (args: RuleArgs) => Promise<RuleResult[]>;

export type Config = {
  rules: RuleFunc[];
};