Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @microsoft/eslint-formatter-sarif with all npm packages installed. Try it out:

var eslintFormatterSarif = require("@microsoft/eslint-formatter-sarif")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@microsoft/eslint-formatter-sarif v2.1.5

ESLint formatter for the SARIF (Static Analysis Results Interchange Format) v2.1.0 file format

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

  1. To install ESLint, follow the instructions at Getting Started with ESLint.

  2. To install the ESLint SARIF formatter:

    npm install @microsoft/eslint-formatter-sarif --save-dev
    
  3. 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.

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
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free