middleware-utils - npm Package Compare versions

Comparing version 0.1.4 to 0.2.0

index.js

@@ -10,26 +10,37 @@ /*!
 
-var async = require('async');
-var red = require('ansi-red');
-var yellow = require('ansi-yellow');
+var each = require('async-each');
+var eachSeries = require('async-each-series');
 
 /**
- * Run middleware in series
+ * Run one or more middleware in series.
  *
  * ```js
- * var middleware = require('./middleware/');
+ * var utils = require('middleware-utils');
+
+ * app.preRender(/\.hbs$/, utils.series([
+ *   fn('foo'),
+ *   fn('bar'),
+ *   fn('baz')
+ * ]));
  *
- * template.onLoad(/\.js$/, utils.series([
- *   middleware.foo,
- *   middleware.bar,
- *   middleware.baz,
- * ]));
+ * function fn(name) {
+ *   return function(file, next) {
+ *     console.log(name);
+ *     next();
+ *   };
+ * }
  * ```
- * @param {Array} `fns` Array of middleware functions
+ * @param {Array|Function} `fns` Function or array of middleware functions
  * @api public
  */
 
-exports.series = function series(fns) {
-  return function (file, cb) {
-    async.eachSeries(fns, function (fn, next) {
-      fn(file, next);
+exports.series = function(fns) {
+  fns = arrayify.apply(null, arguments);
+  return function(view, cb) {
+    eachSeries(fns, function(fn, next) {
+      try {
+        fn(view, next);
+      } catch (err) {
+        next(err);
+      }
     }, cb);
@@ -40,21 +51,33 @@ };
 /**
- * Run middleware in parallel.
+ * Run one or more middleware in parallel.
  *
  * ```js
- * var middleware = require('./middleware/');
+ * var utils = require('middleware-utils');
+
+ * app.preRender(/\.hbs$/, utils.parallel([
+ *   fn('foo'),
+ *   fn('bar'),
+ *   fn('baz')
+ * ]));
  *
- * template.onLoad(/\.js$/, utils.parallel([
- *   middleware.foo,
- *   middleware.bar,
- *   middleware.baz,
- * ]));
+ * function fn(name) {
+ *   return function(file, next) {
+ *     console.log(name);
+ *     next();
+ *   };
+ * }
  * ```
- * @param {Array} `fns` Array of middleware functions
+ * @param {Array|Function} `fns` Function or array of middleware functions
  * @api public
  */
 
-exports.parallel = function parallel(fns) {
-  return function (file, cb) {
-    async.each(fns, function (fn, next) {
-      fn(file, next);
+exports.parallel = function(fns) {
+  fns = arrayify.apply(null, arguments);
+  return function(file, cb) {
+    each(fns, function(fn, next) {
+      try {
+        fn(file, next);
+      } catch (err) {
+        next(err);
+      }
     }, cb);
@@ -65,7 +88,8 @@ };
 /**
- * Output a formatted middleware error.
+ * Format errors for the middleware `done` function. Takes the name of the middleware method
+ * being handled.
  *
  * ```js
- * template.postRender(/./, function (file, next) {
- *   // do stuff to file
+ * app.postRender(/./, function(view, next) {
+ *   // do stuff to view
  *   next();
@@ -75,13 +99,18 @@ * }, utils.error('postRender'));
  *
- * @param {String} `methodName` The middleware method name (verb)
+ * @param {String} `method` The middleware method name
  * @api public
  */
 
-exports.error = function error(methodName) {
-  if (typeof methodName !== 'string') {
-    throw new Error('middleware-utils.error() expects `methodName` to be a string.');
-  }
-  return function (err, file, next) {
-    var message = yellow('.%s middleware error:\n%s\nFile: %s:');
-    if (err) console.error(message, methodName, err, JSON.stringify(file, null, 2));
+exports.error = function(method) {
+  return function(err, view, next) {
+    next = next || function() {
+      if (err) throw err;
+    };
+
+    if (err) {
+      err.method = method;
+      err.view = view;
+      next(err);
+      return;
+    }
     next();
@@ -92,22 +121,27 @@ };
 /**
- * Handle middleware errors for the `.handle()` method.
+ * Format errors for the `app.handle()` method.
  *
  * ```js
- * template.handle('onFoo', file, utils.handleError(file, 'onFoo'));
+ * app.handle('onFoo', view, utils.handleError(view, 'onFoo'));
  * ```
  *
- * @param {Object} `file` Vinyl file object or template object.
- * @param {String} `methodName` The middleware method name (verb)
+ * @param {Object} `view` View object
+ * @param {String} `method` The middleware method name
+ * @param {String} `next` Callback function
  * @api public
  */
 
-exports.handleError = function handleError(file, methodName) {
-  if (typeof methodName !== 'string') {
-    throw new Error('middleware-utils.handleError() expects `methodName` to be a string.');
-  }
-  return function (err) {
+exports.handleError = function(view, method, next) {
+  return function(err) {
+    next = next || function() {
+      if (err) throw err;
+    };
+
     if (err) {
-      console.error(red('Error running `' + methodName + '` middleware for:'), file.path);
-      throw err;
+      err.method = method;
+      err.view = view;
+      next(err);
+      return;
     }
+    next();
   };
@@ -117,17 +151,25 @@ };
 /**
- * Escape/unescape delimiters
+ * Returns a function for escaping and unescaping erb-style template delimiters.
+ *
+ * ```js
+ * var delims = mu.delims();
+ * app.preRender(/\.tmpl$/, delims.escape());
+ * app.postRender(/\.tmpl$/, delims.unescape());
+ * ```
+ * @param {Object} `options`
+ * @api public
  */
 
-exports.delims = function delims(options) {
+exports.delims = function(options) {
   options = options || {};
-  options.escapeString = options.escapeString || '__UTILS_DELIM__';
+  var escapeString = options.escapeString || '__UTILS_DELIM__';
   options.from = options.from || '{%%';
   options.to = options.to || '{%';
-  var res = {};
+  var delims = {};
 
   // escape
-  res.escape = function escape(from) {
+  delims.escape = function(from) {
     from = from || options.from;
-    return function(file, next) {
-      file.content = file.content.split(from).join(options.escapeString);
+    return function(view, next) {
+      view.content = view.content.split(from).join(escapeString);
       next();
@@ -138,10 +180,18 @@ };
   // unscape
-  res.unescape = function unescape(to) {
+  delims.unescape = function(to) {
     to = to || options.to;
-    return function(file, next) {
-      file.content = file.content.split(options.escapeString).join(to);
+    return function(view, next) {
+      view.content = view.content.split(escapeString).join(to);
       next();
     };
   };
-  return res;
+  return delims;
 };
+
+/**
+ * Cast `val` to an array
+ */
+
+function arrayify(val) {
+  return val ? (Array.isArray(val) ? val : [val]) : [];
+}

package.json

 {
   "name": "middleware-utils",
   "description": "Utils for Template middleware.",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "homepage": "https://github.com/jonschlinkert/middleware-utils",
-  "author": {
-    "name": "Jon Schlinkert",
-    "url": "https://github.com/jonschlinkert"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/jonschlinkert/middleware-utils.git"
-  },
+  "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
+  "repository": "jonschlinkert/middleware-utils",
   "bugs": {
     "url": "https://github.com/jonschlinkert/middleware-utils/issues"
   },
-  "license": {
-    "type": "MIT",
-    "url": "https://github.com/jonschlinkert/middleware-utils/blob/master/LICENSE"
-  },
+  "license": "MIT",
   "files": [
@@ -32,11 +23,14 @@ "index.js"
   "dependencies": {
-    "ansi-red": "^0.1.1",
-    "ansi-yellow": "^0.1.1",
-    "async": "^0.9.0"
+    "async-each": "^1.0.0",
+    "async-each-series": "^1.1.0"
   },
   "devDependencies": {
-    "engine-lodash": "^0.6.3",
-    "mocha": "*",
-    "should": "*",
-    "template": "^0.13.1"
+    "assemble-core": "^0.22.0",
+    "engine-base": "^0.1.2",
+    "gulp": "^3.9.1",
+    "gulp-eslint": "^2.0.0",
+    "gulp-format-md": "^0.1.9",
+    "gulp-istanbul": "^1.0.0",
+    "gulp-mocha": "^2.2.0",
+    "mocha": "^2.5.3"
   },
@@ -57,3 +51,20 @@ "keywords": [
     "verbutils"
-  ]
+  ],
+  "verb": {
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
+    },
+    "reflinks": [
+      "verb-readme-generator",
+      "verb"
+    ]
+  }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

2

decreased by-33.33%

Lines of code

170

increased by34.92%

Worsened metrics

Total package byte prevSize

6227

decreased by-26.22%

Dev dependency count

8

increased by100%

Number of package files

3

decreased by-25%

Number of medium quality alerts

1

increased byInfinity%

Number of lines in readme file

0

decreased by-100%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedasync-each@^1.0.0

• + Addedasync-each-series@^1.1.0

• + Addedasync-each@1.0.6(transitive)

• + Addedasync-each-series@1.1.0(transitive)

• - Removedansi-red@^0.1.1

• - Removedansi-yellow@^0.1.1

• - Removedasync@^0.9.0

• - Removedansi-red@0.1.1(transitive)

• - Removedansi-wrap@0.1.0(transitive)

• - Removedansi-yellow@0.1.1(transitive)

• - Removedasync@0.9.2(transitive)