bit-docs-generate-searchmap/generators/search-map.js

Generates a searchmap from the docMap

var fs = require('fs');
var path = require('path');
var filename = require("../util/filename");
var Q = require('q');
var writeFile = Q.denodeify(fs.writeFile);
var mkdirs = Q.denodeify(require("fs-extra").mkdirs);
var striptags = require("striptags");
var bitDocsHelpers = require('bit-docs-generate-html/build/make_default_helpers');

/**
 * @function bitDocs.generators.searchMap.searchMap
 * @parent bitDocs.generators.searchMap.methods
 *
 * Writes out a simplified [documentjs.process.docMap docMap] to be used for searching.
 *
 * @signature `searchMap(docMap, siteConfig)`
 *
 * @param {documentjs.process.docMap} docMap
 * @param {Object} siteConfig
 * @return {Promise} Resolves when searchMap has been written.
 */
module.exports = function(docMap, siteConfig) {
	return new Promise(function(resolve, reject) {
		var searchMap = {};
		var name;
		for (name in docMap) {
			var docObj = (docMap.hasOwnProperty(name)) ? docMap[name] : null;
			if (docObj && !docObj.hide) {

				var helpers = bitDocsHelpers(docMap, siteConfig, function(){
					return docObj;
				}, {});

				// Convert bit-docs markdown to HTML
				var description = docObj.description && docObj.description.trim();
				var descriptionAsHTML = helpers.makeLinks(helpers.makeHtml(description));

				// Only allow certain HTML elements
				var descriptionAsStrippedHTML = striptags(descriptionAsHTML, ['a', 'code', 'em', 'strong']);

				var searchObj = {
					collection: docObj.collection || undefined,
					description: descriptionAsStrippedHTML || undefined,
					name: docObj.name || undefined,
					order: docObj.order,
					parent: docObj.parent || undefined,
					subchildren: docObj.subchildren || undefined,
					title: docObj.title || undefined,
					type: docObj.type || undefined,
					url: filename(docObj, siteConfig) || undefined
				};
				searchMap[name] = searchObj;
			}
		}

		var dest = path.join(siteConfig.dest, 'searchMap.json');

		mkdirs(siteConfig.dest).then(function(){
			writeFile(dest, JSON.stringify(searchMap)).then(function(){
				resolve(searchMap);
			}, reject);
		}, reject);
	});
};