128 lines
2.8 KiB
JavaScript
128 lines
2.8 KiB
JavaScript
/**
|
|
* Dependencies
|
|
*/
|
|
var consolidate = require('consolidate');
|
|
var debug = require('debug')('metalsmith-in-place');
|
|
var each = require('async').each;
|
|
var extend = require('extend');
|
|
var omit = require('lodash.omit');
|
|
|
|
/**
|
|
* Helpers
|
|
*/
|
|
var readPartials = require('./helpers/read-partials');
|
|
var check = require('./helpers/check');
|
|
|
|
/**
|
|
* Expose `plugin`
|
|
*/
|
|
module.exports = plugin;
|
|
|
|
/**
|
|
* Settings
|
|
*
|
|
* Options supported by metalsmith-in-place
|
|
*/
|
|
var settings = ['engine', 'partials', 'pattern'];
|
|
|
|
/**
|
|
* Metalsmith plugin for in-place templating.
|
|
*
|
|
* @param {String or Object} options
|
|
* @property {String} engine
|
|
* @property {String} partials (optional)
|
|
* @property {String} pattern (optional)
|
|
* @return {Function}
|
|
*/
|
|
function plugin(opts){
|
|
/**
|
|
* Init
|
|
*/
|
|
opts = opts || {};
|
|
|
|
// Accept string option to specify the engine
|
|
if (typeof opts === 'string') {
|
|
opts = {engine: opts};
|
|
}
|
|
|
|
// An engine should be specified
|
|
if (!opts.engine) {
|
|
throw new Error('"engine" option required');
|
|
}
|
|
|
|
// Throw an error for unsupported engines or typos
|
|
if (!consolidate[opts.engine]) {
|
|
throw new Error('Unknown template engine: "' + opts.engine + '"');
|
|
}
|
|
|
|
// Map options to local variables
|
|
var engine = opts.engine;
|
|
var partials = opts.partials;
|
|
var pattern = opts.pattern;
|
|
|
|
// Move all unrecognised options to params
|
|
var params = omit(opts, settings);
|
|
|
|
/**
|
|
* Main plugin function
|
|
*/
|
|
return function(files, metalsmith, done){
|
|
var metadata = metalsmith.metadata();
|
|
var matches = {};
|
|
|
|
/**
|
|
* Process any partials and pass them to consolidate as a partials object
|
|
*/
|
|
if (partials) {
|
|
if (typeof partials === 'string') {
|
|
params.partials = readPartials(partials, metalsmith);
|
|
} else {
|
|
params.partials = partials;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Stringify files that pass the check, and store in matches
|
|
*/
|
|
Object.keys(files).forEach(function(file){
|
|
if (!check(files, file, pattern)) {
|
|
return;
|
|
}
|
|
|
|
debug('stringifying file: %s', file);
|
|
var data = files[file];
|
|
data.contents = data.contents.toString();
|
|
matches[file] = data;
|
|
});
|
|
|
|
/**
|
|
* Render files
|
|
*/
|
|
function convert(file, done){
|
|
debug('converting file: %s', file);
|
|
var data = files[file];
|
|
|
|
// Deep clone params (by passing 'true')
|
|
var clonedParams = extend(true, {}, params);
|
|
var clone = extend({}, clonedParams, metadata, data);
|
|
var str = clone.contents;
|
|
var render = consolidate[engine].render;
|
|
|
|
render(str, clone, function(err, str){
|
|
if (err) {
|
|
return done(err);
|
|
}
|
|
|
|
data.contents = new Buffer(str);
|
|
debug('converted file: %s', file);
|
|
done();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Render all matched files
|
|
*/
|
|
each(Object.keys(matches), convert, done);
|
|
};
|
|
}
|