add await to 'addFinding'

Author: abdulahmad307

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

@@ -79,16 +79,18 @@ async function runAxeScan({
   core.info(`Scanning ${url}`)
   const rawFindings = await new AxeBuilder({page}).analyze()
 
-  rawFindings?.violations.forEach(violation =>
-    addFinding({
-      scannerType: 'axe',
-      url,
-      html: violation.nodes[0].html.replace(/'/g, '''),
-      problemShort: violation.help.toLowerCase().replace(/'/g, '''),
-      problemUrl: violation.helpUrl.replace(/'/g, '''),
-      ruleId: violation.id,
-      solutionShort: violation.description.toLowerCase().replace(/'/g, '''),
-      solutionLong: violation.nodes[0].failureSummary?.replace(/'/g, '''),
-    }),
-  )
+  if (rawFindings) {
+    for (const violation of rawFindings.violations) {
+      await addFinding({
+        scannerType: 'axe',
+        url,
+        html: violation.nodes[0].html.replace(/'/g, '''),
+        problemShort: violation.help.toLowerCase().replace(/'/g, '''),
+        problemUrl: violation.helpUrl.replace(/'/g, '''),
+        ruleId: violation.id,
+        solutionShort: violation.description.toLowerCase().replace(/'/g, '''),
+        solutionLong: violation.nodes[0].failureSummary?.replace(/'/g, '''),
+      })
+    }
+  }
 }

PLUGINS.md

@@ -18,7 +18,7 @@ This is the [playwright page](https://playwright.dev/docs/api/class-page) instan
 
 #### `addFinding`
 
-A function that will add a finding to the list (findings are used to generate and file issues). It will also generate a screenshot and add the `screenshotId` to the finding data if `includeScreenshots` is true in the scanner action input. It has the following arguments:
+A async function (you must use `await` or `.then` when invoking this function) that will add a finding to the list (findings are used to generate and file issues). It will also generate a screenshot and add the `screenshotId` to the finding data if `includeScreenshots` is true in the scanner action input. It has the following arguments:
 
 - 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).