metalsmith-layouts/lib/helpers/check.js

/**
 * Dependencies
 */
var match = require('multimatch');
var utf8 = require('is-utf8');

/**
 * Expose `check`
 */
module.exports = check;

/**
 * Helper for checking whether a file should be processed.
 *
 * @param {Object} files
 * @param {String} file
 * @param {String} pattern
 * @return {Boolean}
 */
function check(files, file, pattern, def){
  var data = files[file];

  // Only process utf8 encoded files (so no binary)
  if (!utf8(data.contents)) {
    return false;
  }

  // Only process files that match the pattern (if there is a pattern)
  if (pattern && !match(file, pattern)[0]) {
    return false;
  }

  // Only process files with a specified layout or default template. Allow the
  // default template to be cancelled by layout: false.
  return 'layout' in data ? data.layout : def;
}