feat: Write report to a file as JSON

prantlf · prantlf · commit bce6c519c63e · 2018-03-06T11:11:16.000+01:00
Add the option "report" pointing to the file to write the report to.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -50,7 +50,8 @@ module.exports = function (grunt) {
       },
       incomplete: {
         options: {
-          quiet: true
+          quiet: true,
+          report: 'test/work/incomplete.json'
         },
         src: 'test/work/incomplete.html'
       },
diff --git a/README.md b/README.md
@@ -70,6 +70,7 @@ grunt.initConfig({
       options: {
         force: false,
         quiet: false,
+        report: '',
         ignoreMissing: false,
         tidyOptions: {}
       },
@@ -95,6 +96,33 @@ Default: `false`
 Suppresses printing of errors and warnings about problems found in input
 files on the console. if set to `true`.
 
+#### report
+Type: `String`
+Default: ''
+
+Path to the file, where the report will be written. If specified, the file
+will contain an array of objects describing every problem found, for example:
+
+```json
+[
+  {
+    "type": "warning",
+    "firstColumn": 1,
+    "lastColumn": 1,
+    "lastLine": 1,
+    "message": "missing <!DOCTYPE> declaration",
+    "extract": "<html></html>",
+    "hiliteStart": 0,
+    "hiliteLength": 0,
+    "file":"test/work/incomplete.html"
+  }
+]
+```
+
+The file will have the JSON format compatible with the JSON report produced by
+[grunt-html], which is backed up by gthe [Nu Html Checker (v.Nu)]. Marking the
+invalid code excerps is not supported.
+
 #### ignoreMissing
 Type: `Boolean`
 Default: `false`
@@ -117,11 +145,12 @@ as a property value in the object.
 'tidy-html5': {
   accessibility: {
     options: {
+      report: 'output/report.json',
       tidyOptions: {
         'accessibility-check': 2
       }
     },
-    src: ['*.html']
+    src: ['input/*.html']
   }
 }
 ```
@@ -134,6 +163,7 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-03-06   v0.1.0   Write report to a file as JSON
  * 2018-02-26   v0.0.1   Initial release
 
 ## License
@@ -155,3 +185,6 @@ Licensed under the MIT license.
 [options]: https://github.com/gagern/node-libtidy/blob/master/API.md#TidyDoc.options
 [libtidy options]: https://github.com/gagern/node-libtidy/blob/master/README.md#options
 [all HTML Tidy options]: http://api.html-tidy.org/tidy/quickref_5.4.0.html
+[grunt-html]: https://github.com/jzaefferer/grunt-html
+[Nu Html Checker (v.Nu)]: https://validator.github.io/validator/
+
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
   },
   "main": "tasks/tidy-html5.js",
   "scripts": {
-    "security": "test `node --version | cut -c 2` -ne 4 && nsp check || echo 'No vulnerabilities check possible on Node.js 4'",
+    "prepare": "test `node --version | cut -c 2` -ne 4 && nsp check || echo 'No vulnerabilities check possible on Node.js 4'",
     "test": "grunt",
     "coverage": "grunt instrument && GRUNT_TIDY_HTML5_COVERAGE=1 grunt",
     "coveralls": "test `node --version | cut -c 2` -eq 8 && npm run coverage && grunt coveralls",
@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "chalk": "^2.3.1",
+    "mkdirp": "^0.5.1",
     "libtidy": "^0.3.7"
   },
   "devDependencies": {
diff --git a/tasks/tidy-html5.js b/tasks/tidy-html5.js
@@ -11,22 +11,27 @@
 const fs = require('fs')
 const chalk = require('chalk')
 const libtidy = require('libtidy')
+const mkdirp = require('mkdirp')
+const path = require('path')
 
 module.exports = function (grunt) {
   grunt.registerMultiTask('tidy-html5', 'Checks and fixes HTML files using tidy-html5.', function () {
     const done = this.async()
     const options = this.options({
       force: false,
       quiet: false,
+      report: '',
       ignoreMissing: false,
       tidyOptions: {}
     })
     const force = options.force
     const quiet = options.quiet
+    const report = options.report
     const ignoreMissing = options.ignoreMissing
     const tidyOptions = options.tidyOptions
     const files = this.files
     const warn = force ? grunt.log.warn : grunt.fail.warn
+    const reports = []
     let processed = 0
     let failed = 0
 
@@ -48,22 +53,23 @@ module.exports = function (grunt) {
 
     files.reduce(function (previous, file) {
       return previous.then(function () {
-        return file.src.reduce(process, Promise.resolve())
+        return file.src.reduce(processFile, Promise.resolve())
       })
     }, Promise.resolve())
     .then(function () {
       const ok = failed ? force ? grunt.log.warn : grunt.fail.warn
                         : grunt.log.ok
       ok(processed + ' ' + grunt.util.pluralize(processed,
           'file/files') + ' processed, ' + failed + ' failed.')
+      return writeReport()
     }, function (error) {
       grunt.verbose.error(error.stack)
       grunt.log.error(error)
       warn('Processing HTML files failed.')
     })
     .then(done)
 
-    function process (previous, source) {
+    function processFile (previous, source) {
       return previous.then(function () {
         const document = libtidy.TidyDoc()
         document.options = tidyOptions
@@ -82,13 +88,101 @@ module.exports = function (grunt) {
           return document.parseBuffer(buffer)
         })
         .then(function (result) {
-          const errors = result.errlog
-          if (errors.length) {
+          const messages = result.errlog
+          if (messages.length) {
             if (!quiet) {
-              grunt.log.write(errors)
+              grunt.log.write(messages)
             }
             ++failed
           }
+          return addReport(source, messages)
+        })
+      })
+    }
+
+    function writeReport () {
+      function writeReport () {
+        return writeFile(report, JSON.stringify(reports))
+      }
+
+      if (report) {
+        const directory = path.dirname(report)
+        grunt.verbose.writeln('Writing report to "' + chalk.cyan(report) + '".')
+        if (directory) {
+          return ensureDirectory(directory).then(writeReport)
+        }
+        return writeReport()
+      }
+    }
+
+    function addReport (source, messages) {
+      if (messages) {
+        return readFile(source).then(function (content) {
+          reportFile(source, content, messages)
+        })
+      }
+    }
+
+    function reportFile (name, content, messages) {
+      const contentLines = content.split(/\r?\n/)
+      messages.split(/\r?\n/).forEach(function (line) {
+        const message = parseMessage(line)
+        const place = contentLines[message.lastLine - 1] || ''
+        message.extract = place.substr(message.firstColumn - 1)
+        message.hiliteLength = message.hiliteStart = 0
+        message.file = name
+        reports.push(message)
+      })
+    }
+
+    function parseMessage (message) {
+      const parsed = /^line (\d+) column (\d+) - (\w+):/.exec(message)
+      var column
+      if (parsed) {
+        column = parseInt(parsed[2])
+        return parsed && {
+          type: parsed[3].toLowerCase(),
+          firstColumn: column,
+          lastColumn: column,
+          lastLine: parseInt(parsed[1]),
+          message: message.substr(parsed[0].length + 1)
+        }
+      }
+      return {}
+    }
+
+    function ensureDirectory (name) {
+      return new Promise(function (resolve, reject) {
+        mkdirp(name, function (error) {
+          if (error) {
+            reject(error)
+          } else {
+            resolve()
+          }
+        })
+      })
+    }
+
+    function writeFile (name, content) {
+      return new Promise(function (resolve, reject) {
+        fs.writeFile(name, content, function (error) {
+          if (error) {
+            reject(error)
+          } else {
+            resolve()
+          }
+        })
+      })
+    }
+
+    function readFile (name) {
+      return new Promise(function (resolve, reject) {
+        fs.readFile(name, 'utf-8', function (error, content) {
+          if (error) {
+            reject(error)
+          } else {
+            resolve(content)
+          }
         })
       })
     }
diff --git a/test/expected/incomplete.json b/test/expected/incomplete.json
@@ -0,0 +1 @@
+[{"type":"warning","firstColumn":1,"lastColumn":1,"lastLine":1,"message":"missing <!DOCTYPE> declaration","extract":"<html></html>","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"type":"warning","firstColumn":7,"lastColumn":7,"lastLine":1,"message":"discarding unexpected </html>","extract":"</html>","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"type":"warning","firstColumn":14,"lastColumn":14,"lastLine":1,"message":"inserting missing 'title' element","extract":"","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"extract":"","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"}]
diff --git a/test/tidy-html5_test.js b/test/tidy-html5_test.js
@@ -2,28 +2,30 @@
 
 const fs = require('fs')
 
-function readPage (path) {
-  const content = fs.readFileSync('test/' + path + '.html', 'utf-8')
+function readFile (path) {
+  const content = fs.readFileSync('test/' + path, 'utf-8')
   return content.replace(/\r|\n/g, '')
 }
 
-function readPages (name) {
+function readFiles (name) {
   return {
-    expected: readPage('expected/' + name),
-    work: readPage('work/' + name)
+    expected: readFile('expected/' + name),
+    work: readFile('work/' + name)
   }
 }
 
 exports['tidy-html5'] = {
   incomplete: function (test) {
-    const pages = readPages('incomplete')
-    test.expect(1)
+    const pages = readFiles('incomplete.html')
+    const reports = readFiles('incomplete.json')
+    test.expect(2)
     test.equal(pages.expected, pages.work, 'incomplete.html')
+    test.equal(reports.expected, reports.work, 'incomplete.json')
     test.done()
   },
 
   minimal: function (test) {
-    const pages = readPages('minimal')
+    const pages = readFiles('minimal.html')
     test.expect(1)
     test.equal(pages.expected, pages.work, 'minimal.html')
     test.done()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+[{"type":"warning","firstColumn":1,"lastColumn":1,"lastLine":1,"message":"missing <!DOCTYPE> declaration","extract":"<html></html>","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"type":"warning","firstColumn":7,"lastColumn":7,"lastLine":1,"message":"discarding unexpected </html>","extract":"</html>","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"type":"warning","firstColumn":14,"lastColumn":14,"lastLine":1,"message":"inserting missing 'title' element","extract":"","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"},{"extract":"","hiliteStart":0,"hiliteLength":0,"file":"test/work/incomplete.html"}]