preparing to try to produce some docs

Author: justinbmeyer

bit-docs.js

@@ -3,7 +3,7 @@ var processJavaScript = require("./process/javascript");
 module.exports = function(bitDocs){
     // register your tags
     bitDocs.register("tags", tags);
-    bitDocs.register("process", processJavaScript);
+    bitDocs.register("processor", processJavaScript);
 
     var dependencies = {},
         pack = require("./package.json");

package.json

@@ -4,7 +4,13 @@
   "description": "tags and templates for JS apps",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha test.js --reporter spec",
+    "postversion": "git push --tags && git push",
+    "preversion": "npm test",
+    "release:pre": "npm version prerelease && npm publish",
+    "release:patch": "npm version patch && npm publish",
+    "release:minor": "npm version minor && npm publish",
+    "release:major": "npm version major && npm publish"
   },
   "repository": {
     "type": "git",

tags/function_test.js

@@ -2,32 +2,32 @@ var func = require("./function"),
 	option = require("./option"),
 	assert = require("assert");
 
-	
-describe("documentjs/lib/tags/function",function(){
-	
+
+describe("bit-docs-js/tags/function",function(){
+
 	it("basic add",function(){
-		
+
 		var obj = {};
 		var docMap = {Foo: {name: "Foo", type: "constructor"}}
 		func.add.call(obj,"@function bar title",null,docMap.Foo, docMap );
-		
+
 		assert.deepEqual(obj,{
 			name: "Foo.bar",
 			type: "function",
 			title: "title",
 			parent: "Foo"
 		});
-		
+
 	});
-	
+
 	it("codeMatch", function(){
 		assert.ok(func.codeMatch.test("Thing = function(){}"));
 		assert.ok(func.codeMatch.test("Thing: function(){}"));
 		assert.ok(!func.codeMatch.test("foo: bar"))
 	});
-	
+
 	it("code",function(){
-		
+
 		assert.deepEqual(func.code("method: function(arg1, arg2){"),{
 			name: "method",
 			params: [
@@ -36,13 +36,13 @@ describe("documentjs/lib/tags/function",function(){
 			],
 			type: "function"
 		});
-		
+
 	});
-	
+
 	it("code with scope",function(){
-		
+
 		var docMap = {Foo: {name: "Foo", type: "constructor"}};
-		
+
 		assert.deepEqual(func.code("method: function(arg1, arg2){", docMap.Foo, docMap),{
 			name: "Foo.method",
 			params: [
@@ -52,11 +52,11 @@ describe("documentjs/lib/tags/function",function(){
 			type: "function",
 			parent: "Foo"
 		});
-		
+
 	});
-	
+
 	it("variable set to function before terinary", function(){
-		
+
 		var res = func.code("var keys = !nativeKeys ? shimKeys : function(object) {");
 		assert.deepEqual(res, {
 			name: "keys",
@@ -65,8 +65,8 @@ describe("documentjs/lib/tags/function",function(){
 			],
 			type: "function"
 		});
-		
+
 	});
 
-	
+
 });

tags/module_test.js

@@ -3,42 +3,42 @@ var mod = require('./module'),
 	option = require("./option"),
 	returns = require("./return"),
 	assert = require("assert");
-	
-	
-describe("documentjs/lib/tags/module", function(){
-	
+
+
+describe("bit-docs-js/tags/module", function(){
+
 	it("basic",function(){
-		
+
 		var obj = {};
 		var docMap = {Foo: {name: "Foo", type: "constructor"}}
 		mod.add.call(obj,"@module {{}} name title",null,docMap.Foo, docMap );
-		
+
 		assert.deepEqual(obj,{
 			name: "name",
 			title: "title",
 			type: "module",
 			types: [{type: "Object", options: []}]
 		})
-		
+
 	})
-	
-	
+
+
 	it("function module followed by params",function(){
-		
+
 		var obj = {};
 		var docMap = {Foo: {name: "Foo", type: "constructor"}}
 		mod.add.call(obj,"@module {function(String):Number} func(name) functionjunction",null,docMap.Foo, docMap );
 		param.add.call(obj,"@param {String} name DESCRIPTION",null,docMap.Foo, docMap );
 		returns.add.call(obj,"@return {Number} RET DESCRIPTION",null,docMap.Foo, docMap );
-		
+
 		delete obj._curParam;
 		delete obj._curReturn;
 		assert.deepEqual(obj,{
 			name: "func",
 			title: "functionjunction",
 			type: "module",
 			types: [{
-				type: "function", 
+				type: "function",
 				constructs: undefined,
 				context: undefined,
 				params:[{
@@ -54,15 +54,15 @@ describe("documentjs/lib/tags/module", function(){
 		        	description: "RET DESCRIPTION",
 		        	types: [
 		        		{
-		        			
+
 		        			type: "Number"
-		        			
+
 		        		}
 		        	]
 		        }
 			}]
 		});
-		
+
 	});
 
 	it("@option on a module with a template", function(){
@@ -88,7 +88,7 @@ describe("documentjs/lib/tags/module", function(){
 				}]
 			}]
 		});
-		
-		
+
+
 	});
 });

tags/option_test.js

@@ -3,17 +3,17 @@ var option = require('./option'),
 	property = require('./property'),
 	returns = require('./return'),
 	assert = require("assert");
-	
-describe("documentjs/lib/tags/option",function(){
-	
+
+describe("bit-docs-js/tags/option",function(){
+
 	it("@option",function(){
-		
+
 		var obj = {};
 		param.add.call(obj,"@param {{name: String, foo}=} thing a description");
 		option.add.call(obj, "@option name name description");
 		option.add.call(obj, "@option {Bar} [foo=thing] foo description");
 		option.add.call(obj, "@option {Extra} extra extra description");
-		
+
 		assert.deepEqual(obj.params[0],
 		{
 			name: "thing",
@@ -23,8 +23,8 @@ describe("documentjs/lib/tags/option",function(){
 				options: [
 					{types: [{type: "String"}], name: "name", description: "name description" },
 					{
-						types: [{type: "Bar"}], 
-						name: "foo", 
+						types: [{type: "Bar"}],
+						name: "foo",
 						description: "foo description",
 						defaultValue: "thing",
 						optional: true
@@ -33,17 +33,17 @@ describe("documentjs/lib/tags/option",function(){
 				]
 			}]
 		});
-		
+
 	});
-	
+
 	it("@option on Object",function(){
-		
+
 		var obj = {};
 		param.add.call(obj,"@param {Object} thing a description");
 		option.add.call(obj, "@option {String} name name description");
 		option.add.call(obj, "@option {Bar} [foo=thing] foo description");
 		option.add.call(obj, "@option {Extra} extra extra description");
-		
+
 		assert.deepEqual(obj.params[0],
 		{
 			name: "thing",
@@ -53,8 +53,8 @@ describe("documentjs/lib/tags/option",function(){
 				options: [
 					{types: [{type: "String"}], name: "name", description: "name description" },
 					{
-						types: [{type: "Bar"}], 
-						name: "foo", 
+						types: [{type: "Bar"}],
+						name: "foo",
 						description: "foo description",
 						defaultValue: "thing",
 						optional: true
@@ -63,17 +63,17 @@ describe("documentjs/lib/tags/option",function(){
 				]
 			}]
 		});
-		
+
 	});
-	
-	
+
+
 	it("@option - for function",function(){
-		
+
 		var obj = {}
 		param.add.call(obj,"@param {function(String,Bar)} thing(first,second) a description");
 		option.add.call(obj, "@option first first description");
 		option.add.call(obj, "@option second second description");
-		
+
 		assert.deepEqual(obj.params[0],
 		{
 			name: "thing",
@@ -85,24 +85,24 @@ describe("documentjs/lib/tags/option",function(){
 				params: [
 					{types: [{type: "String"}], name: "first", description: "first description" },
 					{
-						types: [{type: "Bar"}], 
-						name: "second", 
+						types: [{type: "Bar"}],
+						name: "second",
 						description: "second description",
 					}
 				],
 				returns : {types: [{type: "undefined"}]}
 			}]
 		});
-		
+
 	});
-	
+
 	it("@option on a property", function(){
-		
+
 		var obj = {}
 		property.add.call(obj,"@property {String|Thing} thing");
 		option.add.call(obj, "@option {String} String description");
 		option.add.call(obj, "@option {Thing} Thing description");
-		
+
 		assert.deepEqual(obj,
 		{
 			name: "thing",
@@ -116,17 +116,17 @@ describe("documentjs/lib/tags/option",function(){
 				description: "Thing description"
 			}]
 		});
-		
+
 	});
-	
+
 	it("@option on a @return value", function(){
-		
+
 		var obj = {}
 		returns.add.call(obj,"@return {Foo|Bar} ret description");
 		option.add.call(obj, "@option {Foo} Foo description");
 		option.add.call(obj, "@option {Bar} Bar description");
-		
-		
+
+
 		assert.deepEqual(obj.returns,
 		{
 			description: "ret description",
@@ -141,10 +141,10 @@ describe("documentjs/lib/tags/option",function(){
 				}
 			]
 		});
-		
-		
+
+
 	});
-	
+
 	it("@property with @function option with @option on returns", function(){
 		var obj = {};
 		property.add.call(obj,"@property {String|function} thing");
@@ -160,18 +160,18 @@ describe("documentjs/lib/tags/option",function(){
 			]);
 
 	});
-	
+
 	it("@option can add on a @param that is not an object (#72)", function(){
 		var obj = {};
 		param.add.call(obj,"@param {Something} thing a description");
 		option.add.call(obj, "@option {Foo} foo foo description");
-		
+
 		assert.deepEqual(obj.params[0].types[0].options,
 			[
 				{name: "foo", types: [{type:"Foo"}], description: "foo description"}
 			]);
-		
+
 	});
-	
-	
+
+
 });