making publish work

Author: justinbmeyer

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+temp/

.jshintrc

@@ -0,0 +1,50 @@
+{
+	"globals": {
+		"define": true,
+		"steal": true,
+		"can": true,
+		"QUnit": true,
+		"System": true,
+		"SimpleDOM": true,
+		"test": true,
+		"asyncTest": true,
+		"expect": true,
+		"module": true,
+		"ok": true,
+		"equal": true,
+		"notEqual": true,
+		"deepEqual": true,
+		"propEqual": true,
+		"notDeepEqual": true,
+		"strictEqual": true,
+		"notStrictEqual": true,
+		"raises": true,
+		"start": true,
+		"stop": true,
+		"global": true,
+		"describe": true,
+		"it": true
+	},
+	"strict": false,
+	"curly": true,
+	"eqeqeq": true,
+	"freeze": true,
+	"indent": false,
+	"latedef": 0,
+	"noarg": true,
+	"undef": true,
+	"unused": "vars",
+	"trailing": true,
+	"maxdepth": 4,
+	"boss" : true,
+	"jquery": true,
+	"eqnull": true,
+	"evil": true,
+	"loopfunc": true,
+	"smarttabs": true,
+	"maxerr" : 200,
+	"browser": true,
+	"phantom": true,
+	"node": true,
+	"esversion": 6
+}

bit-docs.js

@@ -0,0 +1,14 @@
+var tags = require("./tags");
+
+module.exports = function(bitDocs){
+	var pkg = require("./package.json");
+	var deps = {};
+
+	deps[pkg.name] = pkg.version;
+
+	bitDocs.register("html", {
+		dependencies: deps
+	});
+
+	bitDocs.register("tags", tags);
+};

highlight-line.js

@@ -0,0 +1,76 @@
+var $ = require("jquery");
+
+var getLines = function(lineString) {
+	var lineArray = lineString.split(',');
+	var result = {};
+
+	for (var i = 0; i < lineArray.length; i++) {
+		var val = lineArray[i];
+
+		// Matches any string with 1+ digits dash 1+ digits
+		// will ignore non matching strings
+		if (/^([\d]+-[\d]+)$/.test(val)) {
+			var values = val.split('-'),
+				start = (values[0] - 1),
+				finish = (values[1] - 1);
+
+			for (var j = start; finish >= j; j++) {
+				result[j] = true;
+			}
+			//matches one or more digits
+		} else if (/^[\d]+$/.test(val)) {
+			result[val - 1] = true;
+		}
+
+	}
+	return result;
+};
+
+function addHighlights() {
+
+	$('span[line-highlight]').each(function(i, el) {
+		var $el = $(el);
+		var lines = getLines($el.attr('line-highlight'));
+		var codeBlock = $el.parent().prev('pre').children('code');
+
+		var lineMap = [[]];
+		var k = 0;
+		codeBlock.children().each(function(i, el) {
+			var nodeText = $(el).text();
+			if (/\n/.test(nodeText)) {
+
+				var cNames = $(el).attr('class');
+				var str = nodeText.split('\n');
+				var l = str.length;
+
+				for (var j = 0; j < l; j++) {
+					var text = j === (l - 1) ? str[j] : str[j] + '\n';
+					var newNode = document.createElement('span');
+					newNode.className = cNames;
+					$(newNode).text(text);
+					lineMap[k].push(newNode);
+
+					if (j !== (l - 1)) {
+						k++;
+						lineMap[k] = [];
+					}
+				}
+			} else {
+				lineMap[k].push(el);
+			}
+		});
+
+		codeBlock.empty();
+
+		for (var key in lineMap) {
+			if (lineMap.hasOwnProperty(key)) {
+                var newNode = document.createElement('span');
+                 newNode.className = lines[key] ? 'line highlight': 'line' ;
+                 $(newNode).append(lineMap[key]);
+                 codeBlock.append(newNode);
+			}
+		}
+	});
+}
+
+addHighlights();

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "bit-docs-html-highlight-line",
+  "version": "0.0.1",
+  "description": "Highlight a line in source code",
+  "main": "highlight-line.js",
+  "scripts": {
+    "preversion": "npm test",
+    "test": "mocha test.js --reporter spec",
+    "release:patch": "npm version patch && npm publish",
+    "release:minor": "npm version minor && npm publish",
+    "release:major": "npm version major && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bit-docs/bit-docs-html-highlight-line.git"
+  },
+  "keywords": [
+    "bit-docs",
+    "donejs"
+  ],
+  "author": "Bitovi",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bit-docs/bit-docs-html-highlight-line/issues"
+  },
+  "homepage": "https://github.com/bit-docs/bit-docs-html-highlight-line#readme",
+  "dependencies": {
+    "jquery": "^2.2.4"
+  },
+  "devDependencies": {
+    "bit-docs-generate-html": "^0.0.3",
+    "connect": "^2.14.4",
+    "mocha": "^2.5.3",
+    "zombie": "^4.2.1"
+  }
+}

tags.js

@@ -0,0 +1,14 @@
+exports.demo = {
+    add: function(line, curData) {
+        var lines = line.replace("@highlight","").trim();
+        var html = "<span line-highlight='"+lines+"'></span>";
+        var validCurData =  (curData && curData.length !== 2);
+        var useCurData = validCurData && (typeof curData.description === "string") && !curData.body;
+
+        if(useCurData) {
+            curData.description += html;
+        } else {
+            this.body += html;
+        }
+    }
+};

test.js

@@ -0,0 +1,99 @@
+var assert = require("assert");
+var generate = require("bit-docs-generate-html/generate");
+var path = require("path");
+
+var Browser = require("zombie"),
+	connect = require("connect");
+
+var find = function(browser, property, callback, done){
+	var start = new Date();
+	var check = function(){
+		if(browser.window && browser.window[property]) {
+			callback(browser.window[property]);
+		} else if(new Date() - start < 2000){
+			setTimeout(check, 20);
+		} else {
+			done("failed to find "+property);
+		}
+	};
+	check();
+};
+
+var waitFor = function(browser, checker, callback, done){
+	var start = new Date();
+	var check = function(){
+		if(checker(browser.window)) {
+			callback(browser.window);
+		} else if(new Date() - start < 2000){
+			setTimeout(check, 20);
+		} else {
+			done(new Error("checker was never true"));
+		}
+	};
+	check();
+};
+
+
+var open = function(url, callback, done){
+	var server = connect().use(connect.static(path.join(__dirname))).listen(8081);
+	var browser = new Browser();
+	browser.visit("http://localhost:8081/"+url)
+		.then(function(){
+			callback(browser, function(){
+				server.close();
+			});
+		}).catch(function(e){
+			server.close();
+			done(e);
+		});
+};
+
+describe("bit-docs-tag-demo", function(){
+	it("basics works", function(done){
+		this.timeout(60000);
+
+		var docMap = Promise.resolve({
+			index: {
+				name: "index",
+				demo: "path/to/demo.html",
+				body: ("```"+`
+				        var a = "bar";
+						var b = "bar";
+						var c = "bar";
+						var d = "bar";\n`+
+					 "```\n"+
+					 "<span line-highlight='1-2'></span>").replace(/\n\s+/g,"\n")
+			}
+		});
+
+		generate(docMap, {
+			html: {
+				dependencies: {
+					"bit-docs-prettify": "^0.0.3",
+					"bit-docs-html-highlight-line": __dirname
+				}
+			},
+			dest: path.join(__dirname, "temp"),
+			parent: "index",
+			forceBuild: true,
+			debug: true,
+			minifyBuild: false
+		}).then(function(){
+
+			open("temp/index.html",function(browser, close){
+				waitFor(browser, function(window){
+					return window.document.getElementsByClassName("highlight").length;
+				}, function(){
+					var doc = browser.window.document;
+					var highlights = doc.getElementsByClassName("highlight");
+					// NOTE: there should be 2 lines.  But it seems
+					// like prettify doesn't work in zombie right.
+					assert.ok(highlights.length,  "there are 2 tabs");
+
+					close();
+					done();
+				}, done);
+			},done);
+		}, done);
+	});
+});