robojerk/codeql-action

jsdoc for fixInvalidNotificationsInFile

Browse source
This commit is contained in:
Stephan Brandauer 2023-05-24 12:09:28 +00:00
parent dddabd0d26
commit 153cab09da
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/util.ts
View file

@ -876,6 +876,16 @@ export function fixInvalidNotifications(
return newSarif; return newSarif;
} }
/**
* Removes duplicates from the sarif file.
*
* When `CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX` is set to true, this will
* simply rename the input file to the output file. Otherwise, it will parse the
* input file as JSON, remove duplicate locations from the SARIF notification
* objects, and write the result to the output file.
*
* For context, see documentation of:
* `CODEQL_ACTION_DISABLE_DUPLICATE_LOCATION_FIX`. */
export function fixInvalidNotificationsInFile( export function fixInvalidNotificationsInFile(
inputPath: string, inputPath: string,
outputPath: string, outputPath: string,