Function runAudit

packages/devtools-a11y/src/core/utils/ally-audit.utils.ts:193–314

(
  options: A11yAuditOptions = {},
)

 * Run an accessibility audit using axe-core
 */
export async function runAudit(
  options: A11yAuditOptions = {},
): Promise<A11yAuditResult> {
  const {
    threshold = 'serious',
    context = document,
    ruleSet = 'wcag21aa',
    enabledRules,
    disabledRules,
    exclude = [],
    customRules = {},
  } = options

  // Merge user exclusions with default devtools exclusions
  const allExclusions = [...DEFAULT_EXCLUDE_SELECTORS, ...exclude]

  const startTime = performance.now()
  const contextDescription = getContextDescription(context)

  try {
    // Build axe-core options
    const axeOptions: RunOptions = {
      resultTypes: ['violations', 'passes', 'incomplete'],
      ...RULE_SET_CONFIGS[ruleSet],
    }

    // Handle specific rule configurations
    if (enabledRules && enabledRules.length > 0) {
      axeOptions.runOnly = {
        type: 'rule',
        values: enabledRules,
      }
    }

    // Build rules configuration for disabled rules
    if (disabledRules && disabledRules.length > 0) {
      const rules: RuleObject = {}
      for (const ruleId of disabledRules) {
        rules[ruleId] = { enabled: false }
      }
      axeOptions.rules = rules
    }

    // Determine the context to audit
    let auditContext: axe.ElementContext = context as axe.ElementContext

    // Add exclusions if specified (always include devtools exclusions)
    if (allExclusions.length > 0) {
      auditContext = {
        include: [auditContext as Element],
        exclude: allExclusions.map((sel) => [sel]),
      } as axe.ElementContext
    }

    // Run the axe-core audit
    const results = await axe.run(auditContext, axeOptions)

    // Convert axe-core results to our format