feat: Allow file numbering independetly in snapshot subdirectories

Author: prantlf

Gruntfile.js

@@ -125,7 +125,8 @@ module.exports = function (grunt) {
           },
           {
             options: {
-              doctype: ''
+              doctype: '',
+              fileNumbering: 'per-directory'
             },
             url: 'http://localhost:8881/test/pages/no-doctype.html',
             file: 'directory/no-doctype'

README.md

@@ -176,10 +176,12 @@ Default value: null
 Destination directory to write the viewport screenshots to. It will be created if it does not exist. Default value is `null`, which means, that no screenshots will be written out.
 
 #### fileNumbering
-Type: `Booolean`
+Type: `Booolean`|`String`
 Default value: `false`
 
-Enables prefixing names of snapshot and screenshot files with their index number, for example: "002.google-input.html".
+If set to `true`, enables prefixing names of snapshot and screenshot files with their index number, for example: "002.google-input.html". Every occurrence of the `file` instruction increases the file count.
+
+If set to "per-directory", the index number will be increased separately per sub-directory with snapshots. If the value of the `file` instruction contains a slash, it will put the snapshot to a sub-directory, which may be useful to organize many snapshots created by multiple tasks.
 
 #### fileNumberDigits
 Type: `Number`
@@ -506,6 +508,7 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-05-14  [v1.3.0]  Allow saving snapshots to sub-directories, file numbering per-directory
  * 2018-05-11  [v1.2.0]  Introduce delay after every instruction to be able to visually follow the actions when debugging
  * 2018-03-29  [v1.1.0]  Allow specifying all initialization parameters supported by WebdriverIO
  * 2018-03-28  [v1.0.2]  Stop Selenium and Chromedriver processes on unexpected Grunt process abortion
@@ -548,6 +551,7 @@ Licensed under the MIT license.
 [grunt-reg-viz]: https://github.com/prantlf/grunt-reg-viz
 [grunt-selenium-standalone]: https://github.com/zs-zs/grunt-selenium-standalone
 [keyboard key identifiers]: https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions
+[v1.3.0]: https://github.com/prantlf/grunt-html-dom-snapshot/releases/tag/v1.3.0
 [v1.2.0]: https://github.com/prantlf/grunt-html-dom-snapshot/releases/tag/v1.2.0
 [v1.1.0]: https://github.com/prantlf/grunt-html-dom-snapshot/releases/tag/v1.1.0
 [v1.0.2]: https://github.com/prantlf/grunt-html-dom-snapshot/releases/tag/v1.0.2

tasks/html-dom-snapshot.js

@@ -11,7 +11,7 @@
 
 const {writeFile} = require('fs')
 const pad = require('pad-left')
-const {dirname, isAbsolute, join} = require('path')
+const {basename, dirname, isAbsolute, join} = require('path')
 const mkdirp = require('mkdirp')
 const nodeCleanup = require('node-cleanup')
 const instructions = [
@@ -24,6 +24,7 @@ const instructions = [
   'isNotFocused', 'isNotSelected', 'isNotVisible',
   'isNotVisibleWithinViewport', 'abort'
 ].map(instruction => require('./instructions/' + instruction))
+const directoryCounts = {}
 let fileCount = 0
 
 module.exports = grunt => {
@@ -138,7 +139,7 @@ module.exports = grunt => {
             .reduce((scenarios, scenario) =>
               scenarios.concat(grunt.file.expand(scenario)), [])
             .reduce((scenarios, scenario) => {
-              grunt.log.ok('Load scenario  "' + scenario + '".')
+              grunt.verbose.writeln('Load scenario  "' + scenario + '".')
               if (!isAbsolute(scenario)) {
                 scenario = join(currentDirectory, scenario)
               }
@@ -226,18 +227,20 @@ module.exports = grunt => {
             }
           }), viewportSet)
         .then(() => {
-          if (snapshots && screenshots) {
-            ++fileCount
-            return performInstruction(
-              Promise.all([makeSnapshot(), makeScreenshot()]))
-          }
-          if (snapshots) {
-            ++fileCount
-            return performInstruction(makeSnapshot())
-          }
-          if (screenshots) {
-            ++fileCount
-            return performInstruction(makeScreenshot())
+          if (file) {
+            if (snapshots && screenshots) {
+              increaseFileCount(file)
+              return performInstruction(
+                Promise.all([makeSnapshot(), makeScreenshot()]))
+            }
+            if (snapshots) {
+              increaseFileCount(file)
+              return performInstruction(makeSnapshot())
+            }
+            if (screenshots) {
+              increaseFileCount(file)
+              return performInstruction(makeScreenshot())
+            }
           }
         })
 
@@ -260,62 +263,89 @@ module.exports = grunt => {
         }
 
         function saveContent (html) {
-          if (file) {
-            let fileName = file.toLowerCase()
-            fileName = fileName.endsWith('.html') ||
-                       fileName.endsWith('.htm') ? file : file + '.html'
-            if (fileNumbering) {
-              fileName = numberFileName(fileName)
-            }
-            fileName = join(snapshots, fileName)
-            grunt.log.ok('Write snapshot to "' + fileName + '".')
-            const directory = dirname(fileName)
-            return ensureDirectory(directory)
-              .then(() => new Promise((resolve, reject) =>
-                writeFile(fileName, commandOptions.doctype + html,
-                  error => {
-                    if (error) {
-                      reject(error)
-                    } else {
-                      ++snapshotCount
-                      resolve()
-                    }
-                  })
-              ))
+          let fileName = file.toLowerCase()
+          fileName = fileName.endsWith('.html') ||
+                     fileName.endsWith('.htm') ? file : file + '.html'
+          if (fileNumbering) {
+            fileName = numberFileName(fileName, fileNumbering)
           }
+          fileName = join(snapshots, fileName)
+          grunt.log.ok('Write snapshot to "' + fileName + '".')
+          const directory = dirname(fileName)
+          return ensureDirectory(directory)
+            .then(() => new Promise((resolve, reject) =>
+              writeFile(fileName, commandOptions.doctype + html,
+                error => {
+                  if (error) {
+                    reject(error)
+                  } else {
+                    ++snapshotCount
+                    resolve()
+                  }
+                })
+            ))
         }
 
         function saveImage (png) {
-          if (file) {
-            let fileName = file.toLowerCase()
-            fileName = fileName.endsWith('.html')
-                       ? file.substr(0, file.length - 5)
-                       : fileName.endsWith('.htm')
-                       ? file.substr(0, file.length - 4) : file
-            if (fileNumbering) {
-              fileName = numberFileName(fileName)
+          let fileName = file.toLowerCase()
+          fileName = fileName.endsWith('.html')
+                     ? file.substr(0, file.length - 5)
+                     : fileName.endsWith('.htm')
+                     ? file.substr(0, file.length - 4) : file
+          if (fileNumbering) {
+            fileName = numberFileName(fileName, fileNumbering)
+          }
+          fileName = join(screenshots, fileName + '.png')
+          grunt.log.ok('Write screenshot to "' + fileName + '".')
+          const directory = dirname(fileName)
+          return ensureDirectory(directory)
+            .then(() => new Promise((resolve, reject) =>
+              writeFile(fileName, Buffer.from(png.value, 'base64'),
+                error => {
+                  if (error) {
+                    reject(error)
+                  } else {
+                    ++screenshotCount
+                    resolve()
+                  }
+                })
+            ))
+        }
+
+        function increaseFileCount (file) {
+          ++fileCount
+          if (file.indexOf('/') > 0) {
+            const directory = dirname(file)
+            let directoryCount = directoryCounts[directory]
+            if (directoryCount) {
+              directoryCounts[directory] = directoryCount + 1
+            } else {
+              directoryCounts[directory] = 1
             }
-            fileName = join(screenshots, fileName + '.png')
-            grunt.log.ok('Write screenshot to "' + fileName + '".')
-            const directory = dirname(fileName)
-            return ensureDirectory(directory)
-              .then(() => new Promise((resolve, reject) =>
-                writeFile(fileName, Buffer.from(png.value, 'base64'),
-                  error => {
-                    if (error) {
-                      reject(error)
-                    } else {
-                      ++screenshotCount
-                      resolve()
-                    }
-                  })
-              ))
           }
         }
 
-        function numberFileName (fileName) {
-          return pad(fileCount.toString(), fileNumberDigits, '0') +
-                fileNumberSeparator + fileName
+        function numberFileName (fileName, fileNumbering) {
+          let directory, number
+          if (fileName.indexOf('/') > 0) {
+            directory = dirname(fileName)
+            if (fileNumbering === true) {
+              number = fileCount
+            } else {
+              number = directoryCounts[directory]
+            }
+          } else {
+            number = fileCount
+          }
+          if (directory) {
+            fileName = basename(fileName)
+          }
+          fileName = pad(number.toString(), fileNumberDigits, '0') +
+                     fileNumberSeparator + fileName
+          if (directory) {
+            fileName = join(directory, fileName)
+          }
+          return fileName
         }
       }
     })

test/test.js

@@ -68,7 +68,7 @@ exports['html-dom-snapshot'] = {
   },
 
   'no-doctype': function (test) {
-    const pages = readPages('no-doctype.html', 'directory/no-doctype.html')
+    const pages = readPages('no-doctype.html', 'directory/001.no-doctype.html')
     test.equal(pages.expected, pages.actual, 'no-doctype.html')
     test.done()
   },