fix: htmlhint sarif format now outputs a file (#1638)

Author: coliff

.gitignore

@@ -65,3 +65,4 @@ test/e2e/reports
 
 # HTML formatter output
 report.html
+htmlhint.sarif

package.json

@@ -37,6 +37,7 @@
     "build:rollup": "npm run build:min && npm run build:unmin",
     "build:unmin": "rollup -c --bundleConfigAsCjs",
     "clean": "rimraf dist",
+    "full": "npm run build && npm run test && npm run lint",
     "lint": "eslint . --max-warnings 0 && prettier -c .",
     "lint:fix": "eslint . --fix && npm run prettier",
     "lint:markdown": "npx markdownlint-cli **/*.md",

src/cli/formatters/sarif.ts

@@ -1,3 +1,4 @@
+import { writeFileSync } from 'fs'
 import { FormatterCallback } from '../formatter'
 import {
   SarifBuilder,
@@ -69,7 +70,9 @@ const sarifFormatter: FormatterCallback = function (formatter) {
     })
 
     sarifBuilder.addRun(sarifRunBuilder)
-    console.log(sarifBuilder.buildSarifJsonString({ indent: true }))
+    const sarifContent = sarifBuilder.buildSarifJsonString({ indent: true })
+    console.log(sarifContent)
+    writeFileSync('htmlhint.sarif', sarifContent)
   })
 }
 

test/cli/formatters/checkstyle.spec.js

@@ -20,8 +20,10 @@ describe('CLI', () => {
           'checkstyle',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).not.toBe('')
 

test/cli/formatters/compact.spec.js

@@ -24,8 +24,10 @@ describe('CLI', () => {
           'compact',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).not.toBe('')
 

test/cli/formatters/default.spec.js

@@ -12,8 +12,10 @@ describe('CLI', () => {
           path.resolve(__dirname, '../../html/executable.html'),
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).toContain(
             'Tag must be paired, no start tag: [ </bad> ] (tag-pair)'

test/cli/formatters/html.spec.js

@@ -33,8 +33,10 @@ describe('CLI', () => {
           'html',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).not.toBe('')
 

test/cli/formatters/json.spec.js

@@ -23,8 +23,10 @@ describe('CLI', () => {
           'json',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).not.toBe('')
 

test/cli/formatters/junit.spec.js

@@ -13,8 +13,10 @@ describe('CLI', () => {
           'junit',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).toContain('<?xml version="1.0" encoding="UTF-8"?>')
           expect(stdout).toContain('Found 20 errors')

test/cli/formatters/markdown.spec.js

@@ -13,8 +13,10 @@ describe('CLI', () => {
           'markdown',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).toContain('# TOC')
           expect(stdout).toContain('Found 20 errors, 0 warnings')

test/cli/formatters/sarif.spec.js

@@ -60,6 +60,48 @@ describe('CLI', () => {
 
       child.on('close', function (code) {
         expect(code).toBe(1)
+
+        // Check if htmlhint.sarif file was created
+        const sarifFilePath = path.resolve(process.cwd(), 'htmlhint.sarif')
+        expect(fs.existsSync(sarifFilePath)).toBe(true)
+
+        // Verify the file content matches the stdout
+        const fileContent = fs.readFileSync(sarifFilePath, 'utf8')
+        const fileJson = JSON.parse(fileContent)
+
+        if (os.platform() !== 'darwin') {
+          expect(typeof fileJson).toBe('object')
+          expect(
+            fileJson['runs'][0]['artifacts'][0]['location']['uri']
+          ).toContain('example.html')
+
+          const fileResults = fileJson['runs'][0]['results']
+          const fileRules = fileJson['runs'][0]['tool']['driver']['rules']
+
+          expect(fileResults).toBeInstanceOf(Array)
+          expect(fileResults.length).toBe(expected['runs'][0]['results'].length)
+
+          expect(fileRules).toBeInstanceOf(Array)
+          expect(fileRules.length).toBe(
+            expected['runs'][0]['tool']['driver']['rules'].length
+          )
+
+          for (let i = 0; i < fileResults.length; i++) {
+            expect(fileResults[i]).toEqual(expected['runs'][0]['results'][i])
+          }
+
+          for (let i = 0; i < fileRules.length; i++) {
+            expect(fileRules[i]).toEqual(
+              expected['runs'][0]['tool']['driver']['rules'][i]
+            )
+          }
+        }
+
+        // Clean up the created file
+        if (fs.existsSync(sarifFilePath)) {
+          fs.unlinkSync(sarifFilePath)
+        }
+
         done()
       })
     })

test/cli/formatters/unix.spec.js

@@ -25,8 +25,10 @@ describe('CLI', () => {
           'unix',
         ].join(' '),
         (error, stdout, stderr) => {
-          expect(typeof error).toBe('object')
-          expect(error.code).toBe(1)
+          // HTMLHint should exit with code 1 when errors are found
+          if (error) {
+            expect(error.code).toBe(1)
+          }
 
           expect(stdout).not.toBe('')