You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: PLUGINS.md
+16-3Lines changed: 16 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,23 @@ This is the [playwright page](https://playwright.dev/docs/api/class-page) instan
18
18
19
19
#### `addFinding`
20
20
21
-
This is a function that will add a finding to the list. Findings are used to generate and file issues. This function has 2 arguments:
21
+
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:
22
22
23
-
1. 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).
24
-
2. An 'options' object that has an optional `includeScreenshots` field. This function will automatically generate a screenshot and add the screenshotId to the `Finding` data if `includeScreenshots` is true in either the action input, or in the options field of this function.
23
+
- 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).
24
+
- An [optional] 'options' object that has the following fields:
25
+
-[optional]`includeScreenshots` <bool>: Will automatically generate a screenshot and add the screenshotId to the `Finding` data if it's set to true.
0 commit comments