Copilot updates + minor issue body changes

Author: lindseywild

.github/actions/file/src/generateIssueBody.ts

@@ -19,9 +19,9 @@ export function generateIssueBody(finding: Finding, screenshotRepo: string): str
   }
 
   const acceptanceCriteria = `## Acceptance Criteria
-  - [ ] The specific axe violation reported in this issue is no longer reproducible.
+  - [ ] The specific violation reported in this issue is no longer reproducible.
   - [ ] The fix MUST meet WCAG 2.1 guidelines OR the accessibility standards specified by the repository or organization.
-  - [ ] A test SHOULD be added to ensure this specific axe violation does not regress.
+  - [ ] A test SHOULD be added to ensure this specific violation does not regress.
   - [ ] This PR MUST NOT introduce any new accessibility issues or regressions.
   `
 

.github/actions/file/src/updateFilingsWithNewFindings.ts

@@ -5,7 +5,7 @@ function getFilingKey(filing: ResolvedFiling | RepeatedFiling): string {
 }
 
 function getFindingKey(finding: Finding): string {
-  return `${finding.url};${finding.ruleId ?? ''};${finding.html ?? ''}`
+  return `${finding.url};${finding.scannerType};${finding.problemUrl}`
 }
 
 export function updateFilingsWithNewFindings(

.github/actions/find/src/pluginManager.ts

@@ -12,7 +12,7 @@ const __dirname = path.dirname(__filename)
 
 type PluginDefaultParams = {
   page: playwright.Page
-  addFinding: (findingData: Finding) => void
+  addFinding: (findingData: Finding) => Promise<void>
   url: string
 }
 

.github/scanner-plugins/reflow-scan/index.js

@@ -11,11 +11,11 @@ export default async function reflowScan({ page, addFinding, url } = {}) {
       await addFinding({
         scannerType: 'reflow-scan',
         url,
-        problemShort: 'Page requires horizontal scrolling at 320x256 viewport',
+        problemShort: 'page requires horizontal scrolling at 320x256 viewport',
         problemUrl: 'https://www.w3.org/WAI/WCAG21/Understanding/reflow.html',
-        solutionShort: 'Ensure content is responsive and does not require horizontal scrolling at small viewport sizes',
-        solutionLong: `The page has a scroll width of ${scrollWidth}px but a client width of only ${clientWidth}px at 320x256 viewport, requiring horizontal scrolling. This violates WCAG 2.1 Level AA Success Criterion 1.4.10 (Reflow).`
-      });
+        solutionShort: 'ensure content is responsive and does not require horizontal scrolling at small viewport sizes',
+        solutionLong: `The page has a scroll width of ${scrollWidth}px but a client width of only ${clientWidth}px at 320x256 viewport, requiring horizontal scrolling. This violates WCAG 2.1 Level AA Success Criterion 1.4.10 (Reflow).`,
+      })
     }
   } catch (e) {
     console.error('Error checking horizontal scroll:', e);

.github/workflows/test.yml

@@ -80,6 +80,7 @@ jobs:
           repository: ${{ env.TESTING_REPOSITORY }}
           token: ${{ secrets.GH_TOKEN }}
           cache_key: ${{ steps.cache_key.outputs.cache_key }}
+          scans: "['axe', 'reflow-scan']"
 
       - name: Retrieve cached results
         uses: ./.github/actions/gh-cache/restore

PLUGINS.md

@@ -22,6 +22,10 @@ A async function (you must use `await` or `.then` when invoking this function) t
 
 - An object that should match the [`Finding` type](https://github.com/github/accessibility-scanner/blob/main/.github/actions/find/src/types.d.ts#L1-L9).
 
+#### `url`
+
+Passes in the URL of the page being scanned to be used when a finding is added.
+
 ## How to create plugins
 
 As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For a plugin to work, it needs to meet the following criteria:

README.md

@@ -56,7 +56,7 @@ jobs:
           # open_grouped_issues: false # Optional: Set to true to open an issue grouping individual issues per violation
           # reduced_motion: no-preference # Optional: Playwright reduced motion configuration option
           # color_scheme: light # Optional: Playwright color scheme configuration option
-          # scans #Optional: An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.
+          # scans: '["axe","reflow-scan"]' #Optional: An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.
 ```
 
 > 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.

sites/site-with-errors/404.html

@@ -15,11 +15,17 @@
     line-height: 1;
     letter-spacing: -1px;
   }
+  .wide-element {
+    width: 500px;
+    background: #eee;
+    padding: 10px;
+  }
 </style>
 
 <div class="container">
   <h1>404</h1>
 
   <p><strong>Page not found :(</strong></p>
   <p>The requested page could not be found.</p>
+  <div class="wide-element">This element is too wide for small viewports.</div>
 </div>

tests/site-with-errors.test.ts

@@ -38,15 +38,15 @@ describe('site-with-errors', () => {
   })
 
   it('cache has expected results', () => {
-    const actual = results.map(({issue: {url: issueUrl}, findings}) => {
+    const actual = results.map(;({issue: {url: issueUrl}, findings}) => {
       const {problemUrl, solutionLong, screenshotId, ...finding} = findings[0]
       // Check volatile fields for existence only
       expect(issueUrl).toBeDefined()
       expect(problemUrl).toBeDefined()
-      expect(solutionLong).toBeDefined()
-      // Check `problemUrl`, ignoring axe version
-      expect(problemUrl.startsWith('https://dequeuniversity.com/rules/axe/')).toBe(true)
-      expect(problemUrl.endsWith(`/${finding.ruleId}?application=playwright`)).toBe(true)
+      // solutionLong is optional for non-axe scans
+      if (finding.scannerType === 'axe') {
+        expect(solutionLong).toBeDefined()
+      }
       // screenshotId is only present when include_screenshots is enabled
       if (screenshotId !== undefined) {
         expect(screenshotId).toMatch(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/)