Merge pull request #20 from bit-docs/sidebar

Add fields required by the new CanJS sidebar

Author: chasenlehara

generators/search-map.js

@@ -24,33 +24,32 @@ module.exports = function(docMap, siteConfig) {
 		var searchMap = {};
 		var name;
 		for (name in docMap) {
-			if (docMap.hasOwnProperty(name)) {
-				var docObj = docMap[name];
-				var description = docObj.description && docObj.description.trim();
-				var signaturesHaveContent = docObj.signatures && docObj.signatures.some(function(signature){
-					return signature.params || signature.return || signature.options;
-				});
-				// If there is no body, it's likely we don't want to index it
-				if ((description && description !== 'undefined') || signaturesHaveContent) {
-					var helpers = bitDocsHelpers(docMap, siteConfig, function(){
-						return docObj;
-					}, {});
+			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 descriptionAsHTML = helpers.makeLinks(helpers.makeHtml(description));
+				// 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']);
+				// Only allow certain HTML elements
+				var descriptionAsStrippedHTML = striptags(descriptionAsHTML, ['a', 'code', 'em', 'strong']);
 
-					var searchObj = {
-						name: docObj.name,
-						title: docObj.title,
-						description: descriptionAsStrippedHTML,
-						url: filename(docObj, siteConfig),
-						dest: 'doc/'
-					};
-					searchMap[name] = searchObj;
-				}
+				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;
 			}
 		}
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bit-docs-generate-searchmap",
-  "version": "0.1.7",
+  "version": "0.2.0-pre.3",
   "description": "Generates a searchmap from the docMap",
   "main": "index.js",
   "scripts": {

test.js

@@ -42,6 +42,14 @@ describe("bitDocs.generators.searchMap",function(){
 		});
 	});
 
+	it("(bitDocs.generators.searchMap.searchMap) Excludes docObjects with @hide", function(){
+		return docMapPromise.then(function(docMap){
+			return searchMap(docMap, siteConfig).then(function(searchMapResult){
+				assert.ok(!searchMapResult['guides/what-is-canjs']);
+			});
+		});
+	});
+
 	it("(bitDocs.generators.searchMap.searchMap) Strips HTML from the description", function(){
 		return docMapPromise.then(function(docMap){
 			return searchMap(docMap, siteConfig);
@@ -60,18 +68,18 @@ describe("bitDocs.generators.searchMap",function(){
 		});
 	});
 
-	it("(bitDocs.generators.searchMap.searchMap) Filters hidden and empty docObjects", function(){
+	it("(bitDocs.generators.searchMap.searchMap) Does not filter hidden and empty docObjects", function(){
 		return docMapPromise.then(function(docMap){
 			return searchMap(docMap, siteConfig).then(function(searchMapResult){
-				assert.ok(!searchMapResult.Component);
+				assert.ok(searchMapResult.Component);
 			});
 		});
 	});
 
-	it("(bitDocs.generators.searchMap.searchMap) Filters docObjects with only “undefined\n” as their description", function(){
+	it("(bitDocs.generators.searchMap.searchMap) Does not filter docObjects with only “undefined\n” as their description", function(){
 		return docMapPromise.then(function(docMap){
 			return searchMap(docMap, siteConfig).then(function(searchMapResult){
-				assert.ok(!searchMapResult['can.Control']);
+				assert.ok(searchMapResult['can.Control']);
 			});
 		});
 	});

testDocMap.json

@@ -178,5 +178,11 @@
     "description": "undefined\n",
     "url": "can.Control.html",
     "dest": "doc/"
+  },
+  "guides/what-is-canjs": {
+    "description": "\n",
+    "name": "guides/what-is-canjs",
+    "title": "What is CanJS?",
+    "hide": true
   }
 }