feat: add exclude selectors input to accessibility scanner

Agent-Logs-Url: https://github.com/github/accessibility-scanner/sessions/13d504eb-d5cb-4e30-994f-b988560b788d

Co-authored-by: abdulahmad307 <204748719+abdulahmad307@users.noreply.github.com>

Author: Copilot

.github/actions/find/action.yml

@@ -22,6 +22,9 @@ inputs:
   color_scheme:
     description: 'Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme'
     required: false
+  exclude:
+    description: 'Stringified JSON array of CSS selectors to exclude from the Axe scan'
+    required: false
 
 outputs:
   findings_file:

.github/actions/find/src/findForUrl.ts

@@ -13,6 +13,7 @@ export async function findForUrl(
   includeScreenshots: boolean = false,
   reducedMotion?: ReducedMotionPreference,
   colorScheme?: ColorSchemePreference,
+  exclude?: string[],
 ): Promise<Finding[]> {
   const browser = await playwright.chromium.launch({
     headless: true,
@@ -56,7 +57,7 @@ export async function findForUrl(
     }
 
     if (scansContext.shouldPerformAxeScan) {
-      await runAxeScan({page, addFinding})
+      await runAxeScan({page, addFinding, exclude})
     }
   } catch (e) {
     core.error(`Error during accessibility scan: ${e}`)
@@ -69,13 +70,18 @@ export async function findForUrl(
 async function runAxeScan({
   page,
   addFinding,
+  exclude,
 }: {
   page: playwright.Page
   addFinding: (findingData: Finding, options?: {includeScreenshots?: boolean}) => Promise<void>
+  exclude?: string[]
 }) {
   const url = page.url()
   core.info(`Scanning ${url}`)
-  const rawFindings = await new AxeBuilder({page}).analyze()
+  const axeBuilder = exclude && exclude.length > 0
+    ? exclude.reduce((builder, selector) => builder.exclude(selector), new AxeBuilder({page}))
+    : new AxeBuilder({page})
+  const rawFindings = await axeBuilder.analyze()
 
   if (rawFindings) {
     for (const violation of rawFindings.violations) {

.github/actions/find/src/index.ts

@@ -34,10 +34,20 @@ export default async function () {
     colorScheme = colorSchemeInput as ColorSchemePreference
   }
 
+  const excludeInput = core.getInput('exclude', {required: false})
+  let exclude: string[] | undefined
+  if (excludeInput) {
+    try {
+      exclude = JSON.parse(excludeInput) as string[]
+    } catch {
+      throw new Error(`Input 'exclude' must be a valid JSON array of CSS selectors. Received: ${excludeInput}`)
+    }
+  }
+
   const findings = []
   for (const url of urls) {
     core.info(`Preparing to scan ${url}`)
-    const findingsForUrl = await findForUrl(url, authContext, includeScreenshots, reducedMotion, colorScheme)
+    const findingsForUrl = await findForUrl(url, authContext, includeScreenshots, reducedMotion, colorScheme, exclude)
     if (findingsForUrl.length === 0) {
       core.info(`No accessibility gaps were found on ${url}`)
       continue

README.md

@@ -58,6 +58,7 @@ jobs:
           # reduced_motion: no-preference # Optional: Playwright reduced motion configuration option
           # color_scheme: light # Optional: Playwright color scheme configuration option
           # scans: '["axe","reflow-scan"]' # Optional: An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.
+          # exclude: '["iframe","#third-party-widget"]' # Optional: A JSON array of CSS selectors to exclude from the Axe scan.
 ```
 
 > 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
@@ -130,6 +131,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 | `reduced_motion`          | No       | Playwright `reducedMotion` setting for scan contexts. Allowed values: `reduce`, `no-preference`                                                                                                     | `reduce`                                                    |
 | `color_scheme`            | No       | Playwright `colorScheme` setting for scan contexts. Allowed values: `light`, `dark`, `no-preference`                                                                                                | `dark`                                                      |
 | `scans`                   | No       | An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.                                                                        | `'["axe", "reflow-scan", ...other plugins]'`                                 |
+| `exclude`                 | No       | A stringified JSON array of CSS selectors to exclude from the Axe scan. Useful for iframes, third-party widgets, or user-generated content.                         | `'["iframe","#third-party-widget"]'`                         |
 
 ---
 

action.yml

@@ -51,6 +51,9 @@ inputs:
   scans:
     description: 'Stringified JSON array of scans to perform. If not provided, only Axe will be performed'
     required: false
+  exclude:
+    description: 'Stringified JSON array of CSS selectors to exclude from the Axe scan'
+    required: false
 
 outputs:
   results:
@@ -114,6 +117,7 @@ runs:
         reduced_motion: ${{ inputs.reduced_motion }}
         color_scheme: ${{ inputs.color_scheme }}
         scans: ${{ inputs.scans }}
+        exclude: ${{ inputs.exclude }}
     - name: File
       id: file
       uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/file