index.ts — astro Source File

Source Code

import { settings } from '../../../settings.js';
import type { DefinedIcon } from '../../../ui-library/icons.js';
import { a11y } from './a11y.js';
import { perf } from './perf.js';

type DynamicString = string | ((element: Element) => string);

export interface AuditRule {
	code: string;
	title: DynamicString;
	message: DynamicString;
	description?: DynamicString;
}

export interface ResolvedAuditRule {
	code: string;
	title: string;
	message: string;
	description?: string;
}

export interface AuditRuleWithSelector extends AuditRule {
	selector: string;
	match?: (
		element: Element,
	) =>
		| boolean
		| null
		| undefined
		| void
		| Promise<boolean>
		| Promise<void>
		| Promise<null>
		| Promise<undefined>;
}

interface RuleCategory {
	code: string;
	name: string;
	icon: DefinedIcon;
	rules: AuditRule[];
}

export const rulesCategories = [
	{ code: 'a11y', name: 'Accessibility', icon: 'person-arms-spread', rules: a11y },
	{ code: 'perf', name: 'Performance', icon: 'gauge', rules: perf },
] satisfies RuleCategory[];

const dynamicAuditRuleKeys: Array<keyof AuditRule> = ['title', 'message', 'description'];

export function resolveAuditRule(rule: AuditRule, element: Element): ResolvedAuditRule {
	let resolved: ResolvedAuditRule = { ...rule } as any;
	for (const key of dynamicAuditRuleKeys) {
		const value = rule[key];
		if (typeof value === 'string') continue;
		try {
			if (!value) {
				resolved[key] = '';
				continue;
			}

			resolved[key] = value(element);
		} catch (err) {
			settings.logger.error(`Error resolving dynamic audit rule ${rule.code}'s ${key}: ${err}`);
			resolved[key] = 'Error resolving dynamic rule';
		}
	}
	return resolved;
}

export function getAuditCategory(rule: AuditRule): 'perf' | 'a11y' {
	return rule.code.split('-')[0] as 'perf' | 'a11y';
}

export const categoryLabel = {
	perf: 'performance',
	a11y: 'accessibility',
};