wip

Author: abdulahmad307

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

@@ -6,12 +6,11 @@ import {generateScreenshots} from './generateScreenshots.js'
 import {loadPlugins, invokePlugin} from './pluginManager.js'
 import {getScansContext} from './scansContextProvider.js'
 import * as core from '@actions/core'
-import {FindingWithContext} from './types.d.js'
 
 export async function findForUrl(
   url: string,
   authContext?: AuthContext,
-  includeScreenshotsInput: boolean = false,
+  includeScreenshots: boolean = false,
   reducedMotion?: ReducedMotionPreference,
   colorScheme?: ColorSchemePreference,
 ): Promise<Finding[]> {
@@ -29,12 +28,9 @@ export async function findForUrl(
   await page.goto(url)
 
   const findings: Finding[] = []
-  const addFinding = async (
-    findingData: FindingWithContext,
-    {includeScreenshots = false}: {includeScreenshots?: boolean} = {},
-  ) => {
+  const addFinding = async (findingData: Finding) => {
     let screenshotId
-    if (includeScreenshotsInput || includeScreenshots) {
+    if (includeScreenshots) {
       screenshotId = await generateScreenshots(page)
     }
     findings.push({...findingData, screenshotId})
@@ -53,7 +49,7 @@ export async function findForUrl(
             page,
             addFinding,
             // - this will be coming soon
-            // runAxeScan: () => runAxeScan({page, includeScreenshots: includeScreenshotsInput, findings}),
+            // runAxeScan: () => runAxeScan({page, includeScreenshots, findings}),
           })
         } else {
           core.info(`Skipping plugin ${plugin.name} because it is not included in the 'scans' input`)
@@ -77,7 +73,7 @@ async function runAxeScan({
   addFinding,
 }: {
   page: playwright.Page
-  addFinding: (findingData: FindingWithContext, options?: {includeScreenshots?: boolean}) => Promise<void>
+  addFinding: (findingData: Finding, options?: {includeScreenshots?: boolean}) => Promise<void>
 }) {
   const url = page.url()
   core.info(`Scanning ${url}`)

.github/actions/find/src/types.d.ts

@@ -8,10 +8,10 @@ export type Finding = {
   screenshotId?: string
 }
 
-export type FindingWithContext = Finding & {
-  scannerType: string
-  ruleId?: string
-}
+// export type FindingWithContext = Finding & {
+//   scannerType: string
+//   ruleId?: string
+// }
 
 export type Cookie = {
   name: string

PLUGINS.md

@@ -18,23 +18,9 @@ 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 either the scanner action input OR in the arguments to this function (see below). It has the following arguments:
+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:
 
 - 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).
-- An [optional] 'options' object that has the following fields:
-  - [optional] `includeScreenshots` <bool>: Will automatically generate a screenshot and add the screenshotId to the `Finding` data if it's set to true.
-
-Example usage:
-
-```
-addFinding({ ...findingTypeData })
-addFinding({
-  ...findingTypeData
-}, {
-  includeScreenshots: true
-})
-
-```
 
 ## How to create plugins