Add SARIF support

Author: shaopeng-gh

CHANGELOG.md

@@ -1,3 +1,7 @@
+### Features
+
+* add support format: sarif ([#1045](https://github.com/htmlhint/HTMLHint/issues/1045))
+
 ## [1.1.4](https://github.com/htmlhint/HTMLHint/compare/v1.1.3...v1.1.4) (2022-04-11)
 
 

dist/cli/formatters/sarif.js

@@ -28,6 +28,7 @@ Options are:
 - `html`
 - `junit`
 - `markdown`
+- `sarif`
 
 ## `ignore`
 

docs/user-guide/usage/options.md

@@ -63,6 +63,7 @@
     "glob": "^8.0.3",
     "is-glob": "^4.0.3",
     "node-fetch": "^2.6.2",
+    "node-sarif-builder": "^2.0.3",
     "strip-json-comments": "3.1.0",
     "xml": "1.0.1"
   },

package-lock.json

@@ -0,0 +1,76 @@
+import { FormatterCallback } from '../formatter'
+import {
+  SarifBuilder,
+  SarifResultBuilder,
+  SarifRuleBuilder,
+  SarifRunBuilder,
+} from 'node-sarif-builder'
+import * as path from 'path'
+import { pathToFileURL } from 'url'
+import { Result } from 'sarif'
+
+const pkg = require('../../../package.json')
+
+const sarifFormatter: FormatterCallback = function (formatter) {
+  formatter.on('end', (event) => {
+    const arrAllMessages = event.arrAllMessages
+
+    // SARIF builder
+    const sarifBuilder = new SarifBuilder()
+
+    // SARIF Run builder
+    const sarifRunBuilder = new SarifRunBuilder().initSimple({
+      toolDriverName: 'HTMLHint',
+      toolDriverVersion: pkg.version,
+      url: 'https://htmlhint.com/',
+    })
+
+    // SARIF rules
+    const addedRuleSet = new Set<string>()
+    arrAllMessages.forEach((result) => {
+      result.messages.forEach((message) => {
+        const rule = message.rule
+        if (addedRuleSet.has(rule.id)) {
+          return
+        }
+        addedRuleSet.add(rule.id)
+        const sarifRuleBuiler = new SarifRuleBuilder().initSimple({
+          ruleId: rule.id,
+          shortDescriptionText: rule.description,
+          helpUri: rule.link,
+        })
+        sarifRunBuilder.addRule(sarifRuleBuiler)
+      })
+    })
+
+    // Add SARIF results (individual errors)
+    arrAllMessages.forEach((result) => {
+      result.messages.forEach((message) => {
+        const sarifResultBuilder = new SarifResultBuilder()
+        const ruleId = message.rule.id
+        const sarifResultInit = {
+          level:
+            message.type === 'info'
+              ? 'note'
+              : (message.type.toString() as Result.level),
+          messageText: message.message,
+          ruleId: ruleId,
+          fileUri: process.env.SARIF_URI_ABSOLUTE
+            ? pathToFileURL(result.file).toString()
+            : path.relative(process.cwd(), result.file).replace(/\\/g, '/'),
+          startLine: message.line,
+          startColumn: message.col,
+          endLine: message.line,
+          endColumn: message.col,
+        } as const
+        sarifResultBuilder.initSimple(sarifResultInit)
+        sarifRunBuilder.addResult(sarifResultBuilder)
+      })
+    })
+
+    sarifBuilder.addRun(sarifRunBuilder)
+    console.log(sarifBuilder.buildSarifJsonString({ indent: true }))
+  })
+}
+
+module.exports = sarifFormatter

package.json

@@ -0,0 +1,70 @@
+const ChildProcess = require('child_process')
+const fs = require('fs')
+const path = require('path')
+const os = require('os')
+
+describe('CLI', () => {
+  describe('Formatter: sarif', () => {
+    it('should have stdout output with formatter sarif', (done) => {
+      const expectedFileContent = fs
+        .readFileSync(path.resolve(__dirname, 'sarif.sarif'), 'utf8')
+        .replace(
+          /\{\{path\}\}/g,
+          path.resolve(__dirname, 'example.html').replace(/\\/g, '\\\\')
+        )
+
+      const expected = JSON.parse(expectedFileContent)
+
+      var child = ChildProcess.spawn('node', [
+        path.resolve(__dirname, '../../../bin/htmlhint'),
+        path.resolve(__dirname, 'example.html'),
+        '--format',
+        'sarif',
+      ])
+
+      child.stdout.on('data', function (stdout) {
+        expect(stdout).not.toBe('')
+
+        if (os.platform() !== 'darwin') {
+          const jsonStdout = JSON.parse(stdout)
+          expect(typeof jsonStdout).toBe('object')
+          expect(
+            jsonStdout['runs'][0]['artifacts'][0]['location']['uri']
+          ).toContain('example.html')
+
+          const stdoutResults = jsonStdout['runs'][0]['results']
+          const stdoutRules = jsonStdout['runs'][0]['tool']['driver']['rules']
+
+          expect(stdoutResults).toBeInstanceOf(Array)
+          expect(stdoutResults.length).toBe(
+            expected['runs'][0]['results'].length
+          )
+
+          expect(stdoutRules).toBeInstanceOf(Array)
+          expect(stdoutRules.length).toBe(
+            expected['runs'][0]['tool']['driver']['rules'].length
+          )
+
+          for (let i = 0; i < stdoutResults.length; i++) {
+            expect(stdoutResults[i]).toEqual(expected['runs'][0]['results'][i])
+          }
+
+          for (let i = 0; i < stdoutRules.length; i++) {
+            expect(stdoutRules[i]).toEqual(
+              expected['runs'][0]['tool']['driver']['rules'][i]
+            )
+          }
+        }
+      })
+
+      child.stderr.on('data', function (stderr) {
+        expect(stderr).toBe('')
+      })
+
+      child.on('close', function (code) {
+        expect(code).toBe(1)
+        done()
+      })
+    })
+  })
+})