@mt-gulp/responsive/lib/index.js

gulp responsive images with latest package dependencies working with node 12

'use strict';

var chalk = require('chalk');
var flog = require('fancy-log');
var through2 = require('through2');
var minimatch = require('minimatch');
var PluginError = require('plugin-error');
var _ = require('lodash');
var plur = require('plur');

var sharpVinyl = require('./sharp');
var prepareConfig = require('./config');

var PLUGIN_NAME = require('../package.json').name;

function gulpResponsive(config, options) {

  var statistics = {
    total: 0,
    matched: 0,
    created: 0,
    unmatched: 0,
    unmatchedBlocked: 0,
    unmatchedPassed: 0
  };

  options = _.defaults({}, options, {
    errorOnUnusedConfig: true,
    errorOnUnusedImage: true,
    errorOnEnlargement: true,
    passThroughUnused: false,
    silent: false,
    stats: true
  });

  config = prepareConfig(config || [], options);

  return through2.obj(function (file, enc, done) {
      var that = this;

      if (file.isNull()) {
        this.push(file);
        return done();
      }

      if (file.isStream()) {
        return done(new PluginError(PLUGIN_NAME, 'Streaming not supported'));
      }

      statistics.total++;
      var matched = config.filter(function (conf) {
        return minimatch(file.relative, conf.name);
      });

      if (matched.length === 0) {
        statistics.unmatched++;
        var message = 'File `' + file.relative + '`: Image does not match any config';
        if (options.errorOnUnusedImage) {
          return done(new PluginError(PLUGIN_NAME, message));
        } else if (options.passThroughUnused) {
          this.push(file);
          statistics.unmatchedPassed++;
          if (!options.silent) {
            flog(PLUGIN_NAME + ': (pass through without changes)', chalk.magenta(message));
          }
          return done();
        }
        statistics.unmatchedBlocked++;
        if (!options.silent) {
          flog(PLUGIN_NAME + ': (skip for processing)', chalk.magenta(message));
        }
        return done();
      }

      statistics.matched++;

      var allPromises = [];

      matched.forEach(conf => {
        // config item matched (can be matched multiple times)
        conf.matched = true;
        allPromises.push(sharpVinyl(file, conf, options));
      });

      Promise.all(allPromises)
        .then(result => {
          result.forEach(newFile => {
            if (newFile) {
              that.push(newFile);
              statistics.created++;
            }
          });
          done();
        })
        .catch(reason => {
          return done(reason);
        });

    }, function (cb) {
      var notMatched = config.filter(function (conf) {
        return !conf.matched;
      });

      if (options.stats && !(options.silent && statistics.created === 0)) {
        var msg =
          'Created ' + statistics.created + ' ' + plur('image', statistics.created) +
          chalk.dim.white(' (matched ' + statistics.matched + ' of ' +
            statistics.total + ' ' + plur('image', statistics.total) + ')');

        flog(PLUGIN_NAME + ':', chalk.green(msg));
      }

      if (notMatched.length > 0 && (!options.silent || options.errorOnUnusedConfig)) {
        var message = 'Available images do not match the following config:';
        notMatched.forEach(function (conf) {
          message += '\n  - `' + conf.name + '`';
        });
        if (options.errorOnUnusedConfig) {
          return cb(new PluginError(PLUGIN_NAME, message));
        } else {
          flog(PLUGIN_NAME + ':', chalk.magenta(message));
        }
      }
      cb();
    }
  );
}

module.exports = gulpResponsive;