gulp-expect-file 1.0.2 → 3.0.0

package/README.md

@@ -1,8 +1,8 @@
-# gulp-expect-file [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
+# gulp-expect-file [![NPM version][npm-image]][npm-url] [![Build Status][gh-image]][gh-url]
 
-> Expectation on generated files for gulp 3/4
+> Expectation on generated files for Gulp 4
 
-This plugin is intended for testing other gulp plugin.
+This plugin is intended for testing other Gulp plugin.
 
 ![Screen Shot](http://pioug.github.io/gulp-expect-file/screenshot.png)
 
@@ -19,11 +19,8 @@ Then, add it to your `gulpfile.js`:
 ```js
 var expect = require("gulp-expect-file");
 
-gulp.task("copy", function() {
-  gulp
-    .src(["src/foo.txt"])
-    .pipe(gulp.dest("dest/"))
-    .pipe(expect("dest/foo.txt"));
+gulp.task("copy", function () {
+  gulp.src(["src/foo.txt"]).pipe(gulp.dest("dest/")).pipe(expect("dest/foo.txt"));
 });
 ```
 
@@ -114,9 +111,7 @@ Default: `false`
 If true, it also checks if the real file exists on the file system by `fs.exists()`.
 
 ```js
-gulp
-  .src(["exist.txt", "nonexist.txt"])
-  .pipe(expect({ checkRealFile: true }, "*.txt"));
+gulp.src(["exist.txt", "nonexist.txt"]).pipe(expect({ checkRealFile: true }, "*.txt"));
 
 // => FAIL: nonexist.txt not exists on filesystem
 ```
@@ -132,7 +127,7 @@ If true, it emits `error` event when expectations got failed.
 gulp
   .src(["a.txt"])
   .pipe(expect({ errorOnFailure: true }, ["b.txt"]))
-  .on("error", function(err) {
+  .on("error", function (err) {
     console.error(err);
   });
 ```
@@ -157,7 +152,5 @@ This is just a shortcut for `expect({ checkRealFile: true }, expectation)`.
 
 [npm-url]: https://npmjs.org/package/gulp-expect-file
 [npm-image]: https://img.shields.io/npm/v/gulp-expect-file.svg
-[travis-url]: https://travis-ci.org/pioug/gulp-expect-file
-[travis-image]: https://img.shields.io/travis/pioug/gulp-expect-file.svg
-[daviddm-url]: https://david-dm.org/pioug/gulp-expect-file
-[daviddm-image]: https://img.shields.io/david/pioug/gulp-expect-file.svg
+[gh-url]: https://github.com/pioug/gulp-expect-file/actions/workflows/test.yml
+[gh-image]: https://github.com/pioug/gulp-expect-file/actions/workflows/test.yml/badge.svg

package/index.js

@@ -5,17 +5,16 @@ var ExpectationError = require("./lib/errors").ExpectationError;
 var log = require("fancy-log");
 var PluginError = require("plugin-error");
 var through = require("through2");
-var xtend = require("xtend");
 var colors = require("ansi-colors");
 
 module.exports = expect;
 
-module.exports.real = function(options, expectation) {
+module.exports.real = function (options, expectation) {
   if (!expectation) {
     expectation = options;
     options = {};
   }
-  options = xtend({ checkRealFile: true }, options);
+  options = Object.assign({ checkRealFile: true }, options);
   return expect(options, expectation);
 };
 
@@ -28,16 +27,16 @@ function expect(options, expectation) {
     throw new PluginError("gulp-expect-file", "Expectation required");
   }
 
-  options = xtend(
+  options = Object.assign(
     {
       reportUnexpected: true,
       reportMissing: true,
       checkRealFile: false,
       errorOnFailure: false,
       silent: false,
-      verbose: false
+      verbose: false,
     },
-    options
+    options,
   );
 
   try {
@@ -59,7 +58,7 @@ function expect(options, expectation) {
     numTests++;
 
     var _this = this;
-    fileTester.test(file, function(err) {
+    fileTester.test(file, function (err) {
       if (err && !options.reportUnexpected) {
         if (err instanceof ExpectationError && err.message === "unexpected") {
           err = null;
@@ -95,10 +94,7 @@ function expect(options, expectation) {
     if (numFailures > 0 && options.errorOnFailure) {
       this.emit(
         "error",
-        new PluginError(
-          "gulp-expect-file",
-          "Failed " + numFailures + " expectations"
-        )
+        new PluginError("gulp-expect-file", "Failed " + numFailures + " expectations"),
       );
     }
 
@@ -108,20 +104,13 @@ function expect(options, expectation) {
 
   function reportFailure(file, err) {
     if (err instanceof ExpectationError) {
-      options.silent ||
-        log(
-          colors.red("\u2717 FAIL:"),
-          colors.magenta(file.relative),
-          "is",
-          err.message
-        );
+      if (!options.silent) {
+        log(colors.red("\u2717 FAIL:"), colors.magenta(file.relative), "is", err.message);
+      }
     } else {
-      options.silent ||
-        log(
-          colors.red("\u2717 ERROR:"),
-          colors.magenta(file.relative) + ":",
-          err.message || err
-        );
+      if (!options.silent) {
+        log(colors.red("\u2717 ERROR:"), colors.magenta(file.relative) + ":", err.message || err);
+      }
     }
   }
 
@@ -133,7 +122,7 @@ function expect(options, expectation) {
 
   function reportMissing(rules) {
     var missings = rules
-      .map(function(r) {
+      .map(function (r) {
         return r.toString();
       })
       .join(", ");
@@ -143,13 +132,13 @@ function expect(options, expectation) {
         "Missing",
         colors.cyan(rules.length),
         "expected files:",
-        colors.magenta(missings)
+        colors.magenta(missings),
       );
     }
   }
 
   function reportSummary() {
-    options.silent ||
+    if (!options.silent) {
       log(
         "Tested",
         colors.cyan(numTests),
@@ -158,8 +147,9 @@ function expect(options, expectation) {
         "passes,",
         colors.cyan(numFailures),
         "failures:",
-        numFailures > 0 ? colors.bgRed.white("FAIL") : colors.green("PASS")
+        numFailures > 0 ? colors.bgRed.white("FAIL") : colors.green("PASS"),
       );
+    }
   }
 
   return through.obj(eachFile, endStream);

package/lib/file-tester.js

@@ -7,13 +7,12 @@ var wrapAssertion = require("./util").wrapAssertion;
 var Minimatch = require("minimatch").Minimatch;
 var fs = require("fs");
 var async = require("async");
-var xtend = require("xtend");
 
 module.exports = FileTester;
 
 function FileTester(expectation, options) {
   this.rules = parseExpectation(expectation);
-  this.options = xtend({ checkRealFile: false }, options);
+  this.options = Object.assign({ checkRealFile: false }, options);
 }
 
 function parseExpectation(expectation) {
@@ -27,11 +26,8 @@ function parseExpectation(expectation) {
     case "function":
       return [new Rule(null, expectation)];
     case "object":
-      return Object.keys(expectation).map(function(path) {
-        return new Rule(
-          path,
-          expectation[path] === true ? null : expectation[path]
-        );
+      return Object.keys(expectation).map(function (path) {
+        return new Rule(path, expectation[path] === true ? null : expectation[path]);
       });
     default:
       throw new TypeError("Unknown expectation type");
@@ -39,7 +35,7 @@ function parseExpectation(expectation) {
 }
 
 function checkFileExists(file, callback) {
-  fs.exists(file.path, function(exists) {
+  fs.exists(file.path, function (exists) {
     if (exists) {
       callback();
     } else {
@@ -48,19 +44,19 @@ function checkFileExists(file, callback) {
   });
 }
 
-FileTester.prototype.test = function(file, callback) {
+FileTester.prototype.test = function (file, callback) {
   var _this = this;
   var matchedAny = false;
   async.eachSeries(
     this.rules,
-    function(rule, next) {
+    function (rule, next) {
       if (!rule.matchFilePath(file.relative)) {
         return next(null);
       }
       matchedAny = true;
       rule.testFile(file, next);
     },
-    function(err) {
+    function (err) {
       if (err) {
         return callback(err);
       }
@@ -73,12 +69,12 @@ FileTester.prototype.test = function(file, callback) {
       } else {
         callback();
       }
-    }
+    },
   );
 };
 
-FileTester.prototype.getUnusedRules = function() {
-  return this.rules.filter(function(rule) {
+FileTester.prototype.getUnusedRules = function () {
+  return this.rules.filter(function (rule) {
     return !rule.isUsed();
   });
 };
@@ -90,7 +86,7 @@ function Rule(path, tester) {
   this.used = false;
 }
 
-Rule.prototype.matchFilePath = function(path) {
+Rule.prototype.matchFilePath = function (path) {
   if (this.minimatch) {
     return this.minimatch.match(path);
   } else {
@@ -98,7 +94,7 @@ Rule.prototype.matchFilePath = function(path) {
   }
 };
 
-Rule.prototype.testFile = function(file, callback) {
+Rule.prototype.testFile = function (file, callback) {
   this.used = true;
   if (this.tester) {
     this.tester(file, callback);
@@ -107,23 +103,22 @@ Rule.prototype.testFile = function(file, callback) {
   }
 };
 
-Rule.prototype.isUsed = function() {
+Rule.prototype.isUsed = function () {
   return this.used;
 };
 
-Rule.prototype.toString = function() {
+Rule.prototype.toString = function () {
   return this.path || "(custom)";
 };
 
-Rule.wrapTester = function(tester) {
+Rule.wrapTester = function (tester) {
   if (typeof tester === "function") {
     return wrapAssertion(tester);
   }
 
-  var stringTester =
-    tester instanceof StringTester ? tester : new StringTester(tester);
+  var stringTester = tester instanceof StringTester ? tester : new StringTester(tester);
   var streamTester = new StreamTester(stringTester);
-  return function(file, callback) {
+  return function (file, callback) {
     if (file.isNull()) {
       callback(new ExpectationError("not read"));
     } else if (file.isStream()) {

package/lib/stream-tester.js

@@ -13,36 +13,40 @@ function StreamTester(contentsTester) {
   }
 }
 
-StreamTester.prototype.test = function(stream, callback) {
+StreamTester.prototype.test = function (stream, callback) {
   var spyStream = this.createStream();
   var yielded = false;
   return stream
     .pipe(spyStream)
-    .on("error", function(err) {
-      yielded || callback(err);
+    .on("error", function (err) {
+      if (!yielded) {
+        callback(err);
+      }
       yielded = true;
     })
-    .on("end", function() {
-      yielded || callback(null);
+    .on("end", function () {
+      if (!yielded) {
+        callback(null);
+      }
       yielded = true;
     });
 };
 
-StreamTester.prototype.createStream = function() {
+StreamTester.prototype.createStream = function () {
   var contentsTester = this.contentsTester;
   var contents = "";
   return through(
-    function(chunk, encoding, cb) {
+    function (chunk, encoding, cb) {
       contents += chunk.toString();
       this.push(chunk);
       return cb();
     },
-    function(cb) {
+    function (cb) {
       var _this = this;
-      contentsTester.test(contents, function(err) {
+      contentsTester.test(contents, function (err) {
         _this.emit("error", err);
         cb();
       });
-    }
+    },
   );
 };

package/lib/string-tester.js

@@ -9,14 +9,14 @@ function StringTester(expectation) {
   this.tester = this.parseExpectation(expectation);
 }
 
-StringTester.prototype.test = function(target, callback) {
+StringTester.prototype.test = function (target, callback) {
   this.tester(target, callback);
 };
 
-StringTester.prototype.parseExpectation = function(expectation) {
+StringTester.prototype.parseExpectation = function (expectation) {
   if (expectation instanceof Array) {
     var expectations = expectation.map(this.parseExpectation.bind(this));
-    return function(target, callback) {
+    return function (target, callback) {
       async.applyEachSeries(expectations, target)(callback);
     };
   }
@@ -26,12 +26,15 @@ StringTester.prototype.parseExpectation = function(expectation) {
   }
 
   if (typeof expectation === "string") {
-    return wrapAssertion(function(target) {
-      return target.indexOf(expectation) >= 0;
-    }, "not containing " + JSON.stringify(expectation));
+    return wrapAssertion(
+      function (target) {
+        return target.indexOf(expectation) >= 0;
+      },
+      "not containing " + JSON.stringify(expectation),
+    );
   }
   if (expectation instanceof RegExp) {
-    return wrapAssertion(function(target) {
+    return wrapAssertion(function (target) {
       return expectation.test(target);
     }, "not matching " + expectation.toString());
   }

package/lib/util.js

@@ -2,13 +2,13 @@
 
 var ExpectationError = require("./errors").ExpectationError;
 
-module.exports.wrapAssertion = function(func, errorMessage) {
+module.exports.wrapAssertion = function (func, errorMessage) {
   if (!errorMessage) {
     errorMessage = "failed assertion" + (func.name ? " on " + func.name : "");
   }
-  return function(target, callback) {
+  return function (target, callback) {
     var yielded = false;
-    var castReturn = function(result) {
+    var castReturn = function (result) {
       if (yielded) return;
       if (result === true || result === null || result === undefined) {
         callback(null);

package/package.json

@@ -1,41 +1,46 @@
 {
   "name": "gulp-expect-file",
-  "version": "1.0.2",
-  "author": "Kota Saito <kotas.nico@gmail.com>",
-  "copyright": "2014 Kota Saito",
+  "version": "3.0.0",
   "description": "Expect files in pipes for gulp.js",
-  "license": "MIT",
+  "keywords": [
+    "expect",
+    "gulpplugin",
+    "test"
+  ],
   "homepage": "https://github.com/pioug/gulp-expect-file/",
   "bugs": "https://github.com/pioug/gulp-expect-file/issues",
+  "license": "MIT",
+  "author": "Kota Saito <kotas.nico@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git://github.com/pioug/gulp-expect-file.git"
   },
   "main": "index.js",
   "scripts": {
-    "test": "node_modules/.bin/mocha"
+    "test": "node_modules/.bin/mocha",
+    "lint": "oxlint --deny-warnings . --ignore-path .oxignore",
+    "format": "oxfmt --write \"**/*.{js,json,yml,yaml,md}\"",
+    "format:check": "oxfmt --check \"**/*.{js,json,yml,yaml,md}\""
   },
-  "keywords": [
-    "gulpplugin",
-    "test",
-    "expect"
-  ],
   "dependencies": {
     "ansi-colors": "^4.1.1",
-    "async": "^3.1.0",
-    "fancy-log": "^1.3.3",
-    "minimatch": "^3.0.4",
-    "plugin-error": "^1.0.1",
-    "through2": "^3.0.1",
-    "vinyl": "^2.2.0",
-    "xtend": "^4.0.2"
+    "async": "^3.2.0",
+    "fancy-log": "^2.0.0",
+    "minimatch": "^10.2.2",
+    "plugin-error": "^2.0.1",
+    "through2": "^4.0.2",
+    "vinyl": "^3.0.1"
   },
   "devDependencies": {
-    "eslint": "^6.7.1",
-    "mocha": "^6.2.2",
+    "mocha": "^12.0.0-beta-9",
     "mock-require": "^3.0.3",
-    "prettier": "^1.19.1",
+    "oxfmt": "^0.34.0",
+    "oxlint": "^1.49.0",
     "should": "^13.2.3",
-    "temp": "^0.9.1"
-  }
+    "temp": "^0.9.4"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "copyright": "2014 Kota Saito"
 }

package/.eslintrc

@@ -1,7 +0,0 @@
-{
-  "extends": "eslint:recommended",
-  "env": {
-    "node": true,
-    "mocha": true
-  }
-}