grunt-autonav/tasks/autonav.js

Add active classes to navigation menus in static files.

/*
 * grunt-autonav
 * https://github.com/vmasto/grunt-autonav
 *
 * Copyright (c) 2015 vmasto
 * Licensed under the MIT license.
 */

'use strict';

module.exports = function(grunt) {

  grunt.registerMultiTask('autonav', 'Add active classes to navigation menus in static files.', function() {
		var cheerio = require('cheerio');
		var path = require('path');

    var options = this.options({
			parent: '.navigation',
			childtype: 'li',
			activeclass: 'active',
			parentclass: 'active-parent',
			ancestorclass: 'active-ancestor'
    });

    // Iterate over all specified file groups.
    this.files.forEach(function(f) {

			var src = f.src.filter(function(filepath) {
				if ( !grunt.file.exists(filepath) ) {
					grunt.log.warn('Source file "' + filepath + '" not found.');
					return false;
				} else {
					return true;
				}
			});

			var $ = cheerio.load(grunt.file.read(src));
			var filename = path.basename(src);
			var nav = $(options.parent);
			var navnodes = nav.find(options.childtype);
			var navlinks = navnodes.find('> a');

			if ( !nav.length ) {
				grunt.log.warn(f.dest + ': Parent selector ' + options.parent + ' not found. Skipping file.');
				return false;
			}

			if ( !navlinks.length ) {
				grunt.log.warn(f.dest + ': Could not find any links inside the specified elements. Skipping file.');
				return false;
			}

			navnodes.removeClass(options.activeclass, options.parentclass, options.ancestorclass);
			navlinks.each(function() {
				var _that = $(this);
				var immediateParent = _that.parent(options.childtype);

				if ( _that.attr('href') === filename ) {
					immediateParent.addClass(options.activeclass);
					immediateParent.parent().closest(options.childtype).addClass(options.parentclass);
					immediateParent.parents(options.childtype).addClass(options.ancestorclass);
				}
			});

			var content = $.html();

			grunt.file.write(f.dest, content);
			grunt.log.writeln('File "' + f.dest + '" done.');
    });
  });

};