Moves @microsoft/eslint-formatter from sarif-sdk to sarif-js-sdk (#23)

Co-authored-by: Chris Raynor <[email protected]> Co-authored-by: Chris Meyer <[email protected]> Co-authored-by: Eddy Nakamura <[email protected]> Co-authored-by: Larry Golding <[email protected]> Co-authored-by: lukadlet <[email protected]> Co-authored-by: Mike Huguet <[email protected]> Co-authored-by: Rusty Scrivens <[email protected]> Co-authored-by: tosmolka <[email protected]>
microsoft · May 8, 2021 · 8222955 · 8222955
1 parent 599024f
commit 8222955
Show file tree

Hide file tree

Showing 7 changed files with 11,470 additions and 6,870 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
     "build": "tsc --build",
     "build:watch": "tsc --watch",
     "clean": "tsc --build --clean",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint . --ext .js,.ts",
     "prepare": "npm run build",
     "test": "npm run test --workspaces"
   },

diff --git a/packages/eslint-formatter-sarif/README.md b/packages/eslint-formatter-sarif/README.md
@@ -0,0 +1,43 @@
+# SARIF formatter for ESLint
+
+`eslint-formatter-sarif` is a formatter for [ESLint](https://www.npmjs.com/package/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](https://www.npmjs.com/package/@microsoft/eslint-formatter-sarif).
+
+# Installation and usage
+
+1. To install ESLint, follow the instructions at [Getting Started with ESLint](https://eslint.org/docs/3.0.0/user-guide/getting-started).
+
+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`. 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:
+
+```bat
+set SARIF_ESLINT_EMBED=true
+```
+
+To disable content embedding:
+
+```bat
+set SARIF_ESLINT_EMBED=
+```
+
+To run unit tests:
+
+```bat
+RunTests.cmd
+```