publish.js

/**
* This file is the required module for the Enyo.js JSDoc3 custom template.
*
* @file
*/
'use strict';

// nodejs built-ins
var util = require('util'),
	fs = require('fs'),
	path = require('path');
	
// internal
var helpers = require('./lib/helpers'),
	proc = require('./lib/processor'),
	resolveLinks = require('./lib/post_processors/common').process;

/**
* This is the entry point for the template. It is passed a TaffyDB database of everything that was
* parsed/interpreted by JSDoc and the options defined for JSDoc.
*/
exports.publish = function (db, opts) {
	
	// before anything else happens we initialize our stateful helpers
	helpers.init(db, opts);

	// for every doclet we have the opportunity to pre-process it before rendering its template
	// this is a separate routine from actually rendering and post-rendering routines (like
	// resolving links)
	db().each(proc.preProcess.bind(proc));

	// now we need to do rendering, post-processing and then publishing (writing) the files
	// note that the post-process routine is actually part of the rendering routine as well
	db().each(proc.render.bind(proc));
	
	// we allow for every kind of doclet to be rendered and post-processed prior to attempting to
	// actually publish the file in case of attempted re-use of some output or other more
	// intricate handling
	db().each(proc.publish.bind(proc));
	
	var namespaces = db({kind: 'namespace', subNamespace: {'!is': true}}).order('longname asec').get(),
		kinds = db({kind: 'class', ui: {isUndefined: true}}).order('longname asec').get(),
		controls = db({kind: 'class', ui: true}).order('longname asec').get(),
		utils = db({kind: 'function', utility: true}).order('longname asec').get();
	
	// publish our home (main) section of the site
	helpers.publish('home.html', helpers.render(
		'pages/home.html', {
			namespaces: namespaces,
			kinds: db({kind: 'class'}).order('longname asec').get()
		}
	));
	
	// publish the glossary
	helpers.publish('glossary.html', resolveLinks(helpers.render(
		'pages/glossary.html', {
			terms: db({kind: 'glossary'}).order('longname asec').get()
		}
	)));
	
	// publish the namespaces page
	helpers.publish('namespaces.html', helpers.render(
		'pages/namespaces.html', {
			namespaces: namespaces
		}
	));
	
	// publish the kinds page
	helpers.publish('kinds.html', helpers.render(
		'pages/kinds.html', {
			controls: controls,
			kinds: kinds
		}
	));
	
	// publish utilities page
	helpers.publish('utilities.html', resolveLinks(helpers.render(
		'pages/utilities.html', {
			utils: utils
		}
	)));
	
	// publish our index
	helpers.publish('index.html', helpers.render(
		'index.html', {
			generated: new Date().toLocaleDateString()
		}
	));
	
};