index.js

/*!
 * grunt-assemble-wordcount <https://github.com/assemble/grunt-assemble-wordcount>
 *
 * Copyright (c) 2013-2015, Jon Schlinkert.
 * Licensed under the MIT License.
 */

var cheerio = require('cheerio');
var wordCount = require('wordcount');

module.exports = function(params, callback) {

  'use strict';

  var grunt = params.grunt;
  var opts = params.assemble.options.wordcount || {};

  // See http://onforb.es/1crk3KF
  opts.speed = opts.speed || 300;
  opts.seconds = opts.seconds || false;
  opts.placement = opts.placement || 'prepend';
  opts.selector = opts.selector || '.wordcount';
  opts.countSelector = opts.countSelector || '.label-wordcount';
  opts.timeSelector = opts.timeSelector || '.label-reading-time';

  // Skip over the plugin if it isn't defined in the options.
  grunt.verbose.subhead('Running:'.bold, '"assemble-config-wordcount"');
  grunt.verbose.writeln('Stage:  '.bold, '"render:post:page"\n');

  // load current page content
  var $ = cheerio.load(params.content);

  if ($(opts.selector) && $(opts.selector).length > 0) {
    var countable = $(opts.selector);

    // Strip HTML tags from content
    var content = countable.html().replace(/(<([^>]+)>)/ig, '');
    var count = wordCount(content);

    // Calculate reading time
    var min, mins, sec, secs, est;
    if (opts.seconds === true) {
      min = Math.floor(count / opts.speed);
      sec = Math.floor(count % opts.speed / (opts.speed / 60));
      mins = min + ' minute' + (min === 1 ? '' : 's') + ', ';
      secs = sec + ' second' + (sec === 1 ? '' : 's');
      est = (min > 0) ? mins + secs : secs;
    } else {
      min = Math.ceil(count / opts.speed);
      est = min + ' min';
    }

    // Render wordcount
    $(opts.countSelector).attr('data-wordcount', count);
    $(opts.countSelector)[opts.placement](String(count));

    // Render reading time
    $(opts.timeSelector).attr('data-reading-time', est);
    $(opts.timeSelector)[opts.placement](est);

    params.content = $.html();
  }
  callback();
};

module.exports.options = {
  stage: 'render:post:page'
};