@microsoft/eslint-formatter-sarif
v3.1.0
Published
ESLint formatter for the SARIF (Static Analysis Results Interchange Format) v2.1.0 file format
Downloads
261,781
Readme
SARIF formatter for ESLint
eslint-formatter-sarif
is a formatter for ESLint that produces output in the SARIF (Static Analysis Results Interchange Format) v2.1.0 format.
It is available as an npm module @microsoft/eslint-formatter-sarif.
Installation and usage
To install ESLint, follow the instructions at Getting Started with ESLint.
To install the ESLint SARIF formatter:
npm install @microsoft/eslint-formatter-sarif --save-dev
To run ESLint with the SARIF formatter:
./node-modules/.bin/eslint -f @microsoft/eslint-formatter-sarif -o yourfile.sarif yourfile.js
Note that you cannot use the abbreviated form -f sarif
, because that only works when the npm module name is of the form eslint-formatter-example
, and the ESLint SARIF formatter module is not eslint-formatter-sarif
; it's @microsoft/eslint-formatter-sarif
. Alternatively, you can use the form -f @microsoft/sarif
.
Developer details
To embed the contents of the analyzed source files in the resulting SARIF file:
set SARIF_ESLINT_EMBED=true
To disable content embedding:
set SARIF_ESLINT_EMBED=
To run unit tests:
RunTests.cmd