feat(formatters): add sarif formatter

docs/guides/2-cli.md

@@ -33,8 +33,8 @@ Other options include:
           [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
   -f, --format                   formatters to use for outputting results, more than one can be given joining them with
                                  a comma
-        [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions"] [default:
-                                                                                                              "stylish"]
+        [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions", "sarif"]
+                                                                                                    [default: "stylish"]
   -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or
                                  missing to print to stdout                                                     [string]
       --stdin-filepath           path to a file to pretend that stdin comes from                                [string]

karma.conf.ts

@@ -21,6 +21,8 @@ module.exports = (config: Config): void => {
     exclude: [
       'packages/cli/**',
       'packages/formatters/src/pretty.ts',
+      'packages/formatters/src/github-actions.ts',
+      'packages/formatters/src/sarif.ts',
       'packages/formatters/src/index.node.ts',
       'packages/ruleset-bundler/src/plugins/commonjs.ts',
       '**/*.jest.test.ts',

packages/cli/src/commands/__tests__/lint.test.ts

@@ -48,7 +48,7 @@ describe('lint', () => {
   ];
 
   beforeEach(() => {
-    (lint as jest.Mock).mockResolvedValueOnce(results);
+    (lint as jest.Mock).mockResolvedValueOnce({ results: results, resolvedRuleset: {} });
     (formatOutput as jest.Mock).mockReturnValueOnce('<formatted output>');
     (writeOutput as jest.Mock).mockResolvedValueOnce(undefined);
   });
@@ -148,7 +148,7 @@ describe('lint', () => {
 
   it.each(['json', 'stylish'])('calls formatOutput with %s format', async format => {
     await run(`lint -f ${format} ./__fixtures__/empty-oas2-document.json`);
-    expect(formatOutput).toBeCalledWith(results, format, { failSeverity: DiagnosticSeverity.Error });
+    expect(formatOutput).toBeCalledWith(results, format, { failSeverity: DiagnosticSeverity.Error }, expect.anything());
   });
 
   it('writes formatted output to a file', async () => {

packages/cli/src/commands/lint.ts

@@ -182,7 +182,7 @@ const lintCommand: CommandModule = {
     };
 
     try {
-      let results = await lint(documents, {
+      const linterResult = await lint(documents, {
         format,
         output,
         encoding,
@@ -194,18 +194,23 @@ const lintCommand: CommandModule = {
       });
 
       if (displayOnlyFailures) {
-        results = filterResultsBySeverity(results, failSeverity);
+        linterResult.results = filterResultsBySeverity(linterResult.results, failSeverity);
       }
 
       await Promise.all(
         format.map(f => {
-          const formattedOutput = formatOutput(results, f, { failSeverity: getDiagnosticSeverity(failSeverity) });
+          const formattedOutput = formatOutput(
+            linterResult.results,
+            f,
+            { failSeverity: getDiagnosticSeverity(failSeverity) },
+            linterResult.resolvedRuleset,
+          );
           return writeOutput(formattedOutput, output?.[f] ?? '<stdout>');
         }),
       );
 
-      if (results.length > 0) {
-        process.exit(severeEnoughToFail(results, failSeverity) ? 1 : 0);
+      if (linterResult.results.length > 0) {
+        process.exit(severeEnoughToFail(linterResult.results, failSeverity) ? 1 : 0);
       } else if (config.quiet !== true) {
         const isErrorSeverity = getDiagnosticSeverity(failSeverity) === DiagnosticSeverity.Error;
         process.stdout.write(