feat: Allow generating an empty report with all validated files

Introduce a new boolean option "includeUnreported" to enable such report.
Recognize a new "input" parameter in the sub-task object with all input
files to include in the rport.

Author: prantlf

Gruntfile.js

@@ -48,6 +48,14 @@ module.exports = function (grunt) {
         },
         src: 'tests/expected/report.json',
         dest: 'tests/actual/'
+      },
+      includeUnreported: {
+        options: {
+          includeUnreported: true
+        },
+        input: 'tests/actual/deprecated.*',
+        src: 'tests/expected/missing.json',
+        dest: 'tests/actual/unreported.html'
       }
     },
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Ferdinand Prantl
+Copyright (c) 2017-2018 Ferdinand Prantl
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -62,9 +62,18 @@ Type: `Boolean`
 Default: `false`
 
 If the `src` property does not point to any files, or if it is missing,
-the task will make the Grunt run fail.  If you set the `ignoreMissing`
+the task will make the Grunt run fail. If you set the `ignoreMissing`
 option to `true`, Grunt will continue executing other tasks.
 
+#### includeUnreported
+Type: `Boolean`
+Default: `false`
+
+If the `src` property does not point to any files, or if it is missing,
+the task will assume, that no messages existed for the input files, which
+which were above the configured severity. It will create the report
+nevertheless and include all input files there.
+
 #### targetExtension
 Type: `String`
 Default: ".html:
@@ -73,8 +82,8 @@ If the `dest` property specified only the target directory, the converted report
 
 ### Task Data
 
-The configuration consists of `src` and `dest` property pairs.  The `src`
-property has to point to an existing source path.  The `dest` property has
+The configuration consists of `src` and `dest` property pairs. The `src`
+property has to point to an existing source path. The `dest` property has
 to point to the path, where the converted report should be written.
 
 If you do not end the `dest` path by the path separator (slash, for example), the `dest` path will be considered as if it includes the converted report file name too.
@@ -84,6 +93,21 @@ converted report will be created using the source report name with the HTML expe
 
 If you specify more source files or directories, or use wildcards, the target path should be a directory - ended by the path separator (slash, for example).
 
+If you set `includeUnreported` to true and you expect all input files reported with zero messages, include the `input` property. Set it to the files, which were input of the `htmllint` task. For example:
+
+```js
+'html-html-report-converter': {
+  options: {
+    includeUnreported: true
+  },
+  all: {
+    input: 'snapshots/*.html',
+    src: 'results/report.json',
+    dest: 'results/report.html'
+  }
+}
+```
+
 #### src
 Type: `String` or `Array`
 
@@ -94,6 +118,11 @@ Type: `String`
 
 Path to the file, which will be the HTML report written to. Or only the path to the directory, where it should be written, if the source report name with the HTML expension shoudl be used.
 
+#### input
+Type: `String|Array|Object`
+
+Files, which were input of the `htmllint` task. The format is the same as for the `src` parameter - the Grunt source file specification.
+
 ### Loading
 
 Load the plugin in `Gruntfile.js`:
@@ -162,13 +191,14 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-01-27   v0.1.0   Allow generating an empty report with all validated files
  * 2017-11-25   v0.0.3   Fix appending the HTML extension to the target report file
  * 2017-11-25   v0.0.2   Upgrade the reporter dependency to support Node.js < 7
  * 2017-11-25   v0.0.1   Initial release
 
 ## License
 
-Copyright (c) 2017 Ferdinand Prantl
+Copyright (c) 2017-2018 Ferdinand Prantl
 
 Licensed under the MIT license.
 

package.json

@@ -38,7 +38,7 @@
   "devDependencies": {
     "grunt": "^1.0.1",
     "grunt-standard": "^3.1.0",
-    "semantic-release": "^11.0.2"
+    "semantic-release": "^12.4.1"
   },
   "peerDependencies": {
     "grunt": ">=0.4.5"

tasks/grunt-html-html-report-converter.js

@@ -15,10 +15,12 @@ module.exports = function (grunt) {
         const options = this.options({
           targetExtension: '.html',
           ignoreMissing: false,
+          includeUnreported: false,
           force: false
         })
         const targetExtension = options.targetExtension
         const ignoreMissing = options.ignoreMissing
+        const includeUnreported = options.includeUnreported
         const force = options.force
         const warn = force ? grunt.log.warn : grunt.fail.warn
         var files = this.files
@@ -34,6 +36,7 @@ module.exports = function (grunt) {
           files = [
             {
               orig: {
+                input: [],
                 src: input,
                 dest: output
               },
@@ -62,7 +65,25 @@ module.exports = function (grunt) {
         }
 
         function convertFiles (file) {
-          const src = file.src
+          let src = file.src
+          if (!src.length && includeUnreported) {
+            const input = file.input
+            if (input) {
+              const report = grunt.file.expand(input)
+                                  .map(function (file) {
+                                    return {
+                                      file: file
+                                    }
+                                  })
+              if (report.length) {
+                const output = file.orig.src[0]
+                fs.writeFileSync(output, JSON.stringify(report), 'utf-8')
+                src = [output]
+              }
+            } else {
+              warn('No input files specificed for ' + chalk.cyan(file.orig.src) + '.')
+            }
+          }
           if (src.length) {
             src.forEach(convertFile.bind(null, file))
           } else {

tests/expected/missing.json

@@ -0,0 +1 @@
+[{"file":"tests/actual/deprecated.html"}]

tests/expected/unreported.html

@@ -0,0 +1,76 @@
+<html>
+  <head>
+    <title>HTML Validation Report</title>
+    <style>
+      body {font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, “Fira Sans”, “Droid Sans”, "Helvetica Neue", Arial, sans-serif;}
+      pre {font-family: Monaco, Consolas, "Andale Mono", "Ubuntu Mono", monospace;}
+      #summary {font-size: 38px; color:#555}
+      .error-count {color:red;}
+      .warning-count {color:orange}
+      .notice-count {color:blue}
+      .file-count {color:black;}
+
+      #files {}
+      .file {padding:20px 5px; border-bottom:2px solid #ccc; font-size:22px;}
+      .file .file-info {display:none;}
+      .file a:link {border-bottom:1px dotted #888; text-decoration:none; color:black;}
+      .file a:link:hover {border-bottom:none;}
+
+      .errors {padding:5px 15px; margin:5px 0; border-left:3px solid red; font-size:16px;}
+      .warnings {padding:0 15px; border-left:3px solid orange; font-size:18px; color:#666;}
+      .notices {padding:0 15px; border-left:3px solid blue; font-size:18px; color:#999;}
+
+      .error, .warning, .notice {padding:5px 0; border-bottom:1px solid #DDD;}
+      .error .info, .warning .info, .notice .info {color:#666; font-size:15px;}
+      .error .extract, .warning .extract, .notice .extract {color:#333; font-size:12px;}
+
+      .file:last-child, .error:last-child, .warning:last-child, .notice:last-child {border-bottom:none;}
+    </style>
+    <script type="text/javascript">
+      document.addEventListener('click', function (event) {
+        var target = event.target
+        if (target.tagName === 'A') {
+          var fileInfo = event.target.parentNode.querySelector('.file-info')
+          if (fileInfo.offsetParent === null) {
+            fileInfo.style.display = 'block'
+          } else {
+            fileInfo.style.display = 'none'
+          }
+        }
+      })
+    </script>
+  </head>
+  <body>
+    <div id="summary">
+      Summary: <span class="error-count">0</span> errors,
+               <span class="warning-count">0</span> warnings
+               and <span class="notice-count">1</span> notices
+               in <span class="file-count">1</span> files
+    </div>
+    <div id="files">
+        <div class="file">
+          <a href="javascript:void(null)">tests/actual/deprecated.html</a>
+          <b>
+            (<span class="error-count">0</span> /
+            <span class="warning-count">0</span> /
+            <span class="notice-count">1</span>)
+          </b>
+          <div class="file-info">
+            <div class="errors">
+            </div>
+            <div class="warnings">
+            </div>
+            <div class="notices">
+                <div class="notice">
+                  
+                  <div class="info">
+                    <u>at line , column </u>
+                    <pre class="extract"></pre>
+                  </div>
+                </div>
+            </div>
+          </div>
+        </div>
+    </div>
+  </body>
+</html>

tests/test.js

@@ -24,5 +24,9 @@ exports['htmllint-html-report-converter'] = {
 
   extension: function (test) {
     compare(test, 'report.html', 'report.htm')
+  },
+
+  unreported: function (test) {
+    compare(test, 'unreported.html', 'unreported.html')
   }
 }