grunt-html-snapshots 1.0.2 → 4.0.1

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+tmp/

package/.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "ecmaFeatures": {
+      "impliedStrict": true
+    }
+  },
+  "env": {
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended"
+  ],
+  "rules": {
+  }
+}

package/.github/workflows/verify.yml

@@ -0,0 +1,29 @@
+name: Verify
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  verify:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3.0.0
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - name: Lint
+      run: npm run lint
+    - name: Test
+      if: ${{ success() }}
+      run: npm test

package/Gruntfile.js

@@ -2,27 +2,14 @@
  * grunt-html-snapshots
  * https://github.com/localnerve/grunt-html-snapshots
  *
- * Copyright (c) 2013, 2014 Alex Grant
+ * Copyright (c) 2013 - 2022 Alex Grant
  * Licensed under the MIT license.
  */
 
-'use strict';
-
-module.exports = function(grunt) {
+module.exports = function (grunt) {
 
   // Project configuration.
   grunt.initConfig({
-    jshint: {
-      all: [
-        'Gruntfile.js',
-        'tasks/*.js',
-        '<%= nodeunit.tests %>',
-      ],
-      options: {
-        jshintrc: '.jshintrc',
-      },
-    },
-
     // Before generating any new files, remove any previously-created files.
     clean: {
       tests: ['tmp'],
@@ -74,23 +61,22 @@ module.exports = function(grunt) {
   grunt.loadTasks('tasks');
 
   // These plugins provide necessary tasks.
-  grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-clean');
   grunt.loadNpmTasks('grunt-contrib-nodeunit');
 
   // Register the test server
   grunt.registerTask('test_server1', 'serve the test files', function(){
-    var options = this.options();
-    var server = require('./test/server');
+    const options = this.options();
+    const server = require('./test/server');
     server.start('./test/server', options.port);
     grunt.log.writeln("running test server on port "+options.port);
     grunt.log.ok();
   });
 
-  grunt.registerTask('html_snapshots_options', 'prepare options for html_snapshots', function() {
-    var optionsHelper = require("./test/helpers/options");
-    var done = this.async();
-    optionsHelper.detector(function(globalPhantom) {
+  grunt.registerTask('html_snapshots_options', 'prepare options for html_snapshots', function(){
+    const optionsHelper = require("./test/helpers/options");
+    const done = this.async();
+    optionsHelper.detector(globalPhantom => {
       if (globalPhantom) {
         var htmlSnapshots = grunt.config.get("html_snapshots");
         htmlSnapshots.options.phantomjs = "phantomjs";
@@ -106,6 +92,6 @@ module.exports = function(grunt) {
   grunt.registerTask('target2', ['clean', 'html_snapshots_options', 'html_snapshots:target2', 'nodeunit:target2']);
 
   // By default, lint and run all tests.
-  grunt.registerTask('default', ['jshint', 'test']);
+  grunt.registerTask('default', ['test']);
 
 };

package/{LICENSE-MIT → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Alex Grant
+Copyright (c) 2013 - 2022 Alex Grant
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -1,17 +1,14 @@
 # grunt-html-snapshots
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/localnerve/grunt-html-snapshots.svg)](https://greenkeeper.io/)
-
 [![npm version](https://badge.fury.io/js/grunt-html-snapshots.svg)](http://badge.fury.io/js/grunt-html-snapshots)
-[![Build Status](https://secure.travis-ci.org/localnerve/grunt-html-snapshots.svg?branch=master)](http://travis-ci.org/localnerve/grunt-html-snapshots)
+![Verify](https://github.com/localnerve/grunt-html-snapshots/workflows/Verify/badge.svg)
 [![Dependency Status](https://david-dm.org/localnerve/grunt-html-snapshots.svg)](https://david-dm.org/localnerve/grunt-html-snapshots)
-[![devDependency Status](https://david-dm.org/localnerve/grunt-html-snapshots/dev-status.svg)](https://david-dm.org/localnerve/grunt-html-snapshots#info=devDependencies)
-[![devDependency Status](https://david-dm.org/localnerve/grunt-html-snapshots/peer-status.svg)](https://david-dm.org/localnerve/grunt-html-snapshots#info=peerDependencies)
 
 > The grunt task for [html-snapshots](http://github.com/localnerve/html-snapshots)
 
 ## Getting Started
-This plugin requires Grunt `>=0.4.0`
+This plugin requires Grunt `>=1.0.0`  
+*To use an older Grunt, use this library at tag `#v1.0.2`*
 
 If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "grunt-html-snapshots",
   "description": "The grunt task for html-snapshots",
-  "version": "1.0.2",
+  "version": "4.0.1",
   "homepage": "https://github.com/localnerve/grunt-html-snapshots",
   "author": {
     "name": "Alex Grant",
@@ -18,22 +18,23 @@
   "license": "MIT",
   "main": "Gruntfile.js",
   "engines": {
-    "node": ">= 4.x"
+    "node": ">= 14"
   },
   "scripts": {
-    "test": "grunt test"
+    "test": "grunt test",
+    "lint": "eslint ."
   },
   "dependencies": {
-    "html-snapshots": ">= 0.14.0"
+    "html-snapshots": "^0.18.1"
   },
   "devDependencies": {
-    "grunt-contrib-jshint": "^1.0.0",
-    "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-nodeunit": "^2.0.0",
-    "grunt": ">=0.4.5"
+    "eslint": "^8.12.0",
+    "grunt-contrib-clean": "^2.0.1",
+    "grunt-contrib-nodeunit": "^4.0.0",
+    "grunt": ">=1.0.0"
   },
   "peerDependencies": {
-    "grunt": ">=0.4.5"
+    "grunt": ">=1.0.0"
   },
   "keywords": [
     "SEO",

package/tasks/html_snapshots.js

@@ -2,45 +2,41 @@
  * grunt-html-snapshots
  * https://github.com/localnerve/grunt-html-snapshots
  *
- * Copyright (c) 2013 - 2017, LocalNerve, Alex Grant
+ * Copyright (c) 2013 - 2022, LocalNerve, Alex Grant
  * Licensed under the MIT license.
  */
-module.exports = function (grunt) {
-
-  var html_snapshots = require('html-snapshots');
-
-  grunt.registerMultiTask('html_snapshots', 'Generate html snapshots.',
-  function () {
+const html_snapshots = require('html-snapshots');
 
+module.exports = function (grunt) {
+  grunt.registerMultiTask('html_snapshots', 'Generate html snapshots.', function () {
     // Merge task-specific and/or target-specific options with these defaults.
-    var options = this.options({
+    const options = this.options({
       force: false
     });
 
     // Report html_snapshot errors but dont fail the task
-    var force = options.force;
+    const force = options.force;
     delete options.force;
 
     grunt.verbose.writeflags(options, 'html_snapshots options');
 
     // Setup for async
-    var done = this.async();
+    const done = this.async();
 
     // Take the snapshots
     html_snapshots.run(options)
-      .then(function (completed) {
+      .then(() => {
         grunt.log.ok();
       })
-      .catch(function (err) {
+      .catch(err => {
         grunt.log.error('html_snapshots failed');
         if (force) {
-          grunt.log.error(''+err);
+          grunt.log.error(err);
         }
         return err;
       })
-      .then(function (err) {
+      .then(err => {
         done(force ? undefined : err);
       });
   });
-
 };

package/test/helpers/options.js

@@ -8,22 +8,22 @@
  * In some test environments (travis), local phantomjs will not install if a global is found.
  */
 
-var spawn = require("child_process").spawn;
+const spawn = require("child_process").spawn;
 
 module.exports = {
 
   // for now, callback is passed true if global phantomjs should be used
-  detector: function(callback) {
+  detector: callback => {
     // try to run phantom globally
-    var cp = spawn("phantomjs", ["--version"]);
+    const cp = spawn("phantomjs", ["--version"]);
 
     // if it fails, use local per the defaults
-    cp.on("error", function(err) {
+    cp.on("error", () => {
       callback(false);
     });
 
     // if it succeeds, use the global
-    cp.on("exit", function(code) {
+    cp.on("exit", code => {
       if (code === 0) {
         callback(true);
       }

package/test/html_snapshots_target1.js

@@ -1,41 +1,29 @@
-'use strict';
-
-var grunt = require('grunt');
-var fs = require('fs');
-
-/*
-  ======== A Handy Little Nodeunit Reference ========
-  https://github.com/caolan/nodeunit
-
-  Test methods:
-    test.expect(numAssertions)
-    test.done()
-  Test assertions:
-    test.ok(value, [message])
-    test.equal(actual, expected, [message])
-    test.notEqual(actual, expected, [message])
-    test.deepEqual(actual, expected, [message])
-    test.notDeepEqual(actual, expected, [message])
-    test.strictEqual(actual, expected, [message])
-    test.notStrictEqual(actual, expected, [message])
-    test.throws(block, [error], [message])
-    test.doesNotThrow(block, [error], [message])
-    test.ifError(value)
-*/
+/**
+ * tests, target1
+ */
+/* global Promise */
+const grunt = require('grunt');
+const { pathExists } = require('./utils');
 
 exports.html_snapshots = {
-  setUp: function(done) {
+  setUp: done => {
     // setup here if necessary
     done();
   },
 
-  target1: function(test) {
+  target1: test => {
     test.expect(3);
 
-    grunt.file.read('test/expected/target1').split('\n').forEach(function(line){
-      test.equal(true, fs.existsSync(line), line+" should exist");
+    const results = [];
+
+    grunt.file.read('test/expected/target1').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(true, exists, `${line} should exist`);
+      }));
     });
 
-    test.done();
+    Promise.all(results).finally(()=> {
+      test.done();
+    })
   }
 };

package/test/html_snapshots_target2.js

@@ -1,41 +1,29 @@
-'use strict';
-
-var grunt = require('grunt');
-var fs = require('fs');
-
-/*
-  ======== A Handy Little Nodeunit Reference ========
-  https://github.com/caolan/nodeunit
-
-  Test methods:
-    test.expect(numAssertions)
-    test.done()
-  Test assertions:
-    test.ok(value, [message])
-    test.equal(actual, expected, [message])
-    test.notEqual(actual, expected, [message])
-    test.deepEqual(actual, expected, [message])
-    test.notDeepEqual(actual, expected, [message])
-    test.strictEqual(actual, expected, [message])
-    test.notStrictEqual(actual, expected, [message])
-    test.throws(block, [error], [message])
-    test.doesNotThrow(block, [error], [message])
-    test.ifError(value)
-*/
+/**
+ * tests, target2
+ */
+/* global Promise */
+const grunt = require('grunt');
+const { pathExists } = require('./utils');
 
 exports.html_snapshots = {
-  setUp: function(done) {
+  setUp: done => {
     // setup here if necessary
     done();
   },
 
-  target2: function(test) {
+  target2: test => {
     test.expect(3);
     
-    grunt.file.read('test/expected/target2').split('\n').forEach(function(line){
-      test.equal(false, fs.existsSync(line), line+" should not exist");
+    const results = [];
+
+    grunt.file.read('test/expected/target2').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(false, exists, `${line} should not exist`);
+      }));
     });
 
-    test.done();
+    Promise.all(results).finally(() => {
+      test.done();
+    });
   }
 };

package/test/html_snapshots_test.js

@@ -1,30 +1,13 @@
-'use strict';
-
-var grunt = require('grunt');
-var fs = require('fs');
-
-/*
-  ======== A Handy Little Nodeunit Reference ========
-  https://github.com/caolan/nodeunit
-
-  Test methods:
-    test.expect(numAssertions)
-    test.done()
-  Test assertions:
-    test.ok(value, [message])
-    test.equal(actual, expected, [message])
-    test.notEqual(actual, expected, [message])
-    test.deepEqual(actual, expected, [message])
-    test.notDeepEqual(actual, expected, [message])
-    test.strictEqual(actual, expected, [message])
-    test.notStrictEqual(actual, expected, [message])
-    test.throws(block, [error], [message])
-    test.doesNotThrow(block, [error], [message])
-    test.ifError(value)
-*/
+/**
+ * Test the task
+ */
+/* global Promise */
+
+const grunt = require('grunt');
+const { pathExists } = require('./utils');
 
 exports.html_snapshots = {
-  setUp: function(done) {
+  setUp: function (done) {
     // setup here if necessary
     done();
   },
@@ -32,20 +15,32 @@ exports.html_snapshots = {
   target1: function(test) {
     test.expect(3);
 
-    grunt.file.read('test/expected/target1').split('\n').forEach(function(line){
-      test.equal(true, fs.existsSync(line), line+" should exist");
+    const results = [];
+
+    grunt.file.read('test/expected/target1').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(true, exists, `${line} should exist`);
+      }));      
     });
 
-    test.done();
+    Promise.all(results).finally(() => {
+      test.done();
+    });
   },
 
   target2: function(test) {
     test.expect(3);
     
-    grunt.file.read('test/expected/target2').split('\n').forEach(function(line){
-      test.equal(false, fs.existsSync(line), line+" should not exist");
+    const results = [];
+
+    grunt.file.read('test/expected/target2').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(false, exists, `${line} should not exist`);
+      }));
     });
 
-    test.done();
+    Promise.all(results).finally(() => {
+      test.done();
+    });
   }
 };

package/test/utils.js

@@ -0,0 +1,14 @@
+/**
+ * test utils
+ */
+const fs = require('fs').promises;
+
+function pathExists (path) {
+  return fs.access(path)
+    .then(() => true)
+    .catch(() => false);
+}
+
+module.exports = {
+  pathExists
+};

package/.jshintrc

@@ -1,13 +0,0 @@
-{
-  "curly": true,
-  "eqeqeq": true,
-  "immed": true,
-  "latedef": true,
-  "newcap": true,
-  "noarg": true,
-  "sub": true,
-  "undef": true,
-  "boss": true,
-  "eqnull": true,
-  "node": true
-}

package/.travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - 4
-  - 6
-before_script:
-  - npm install -g grunt-cli