apidoc - npm Package Compare versions

Comparing version 0.7.0 to 0.7.1

CHANGELOG.md

 # apiDoc Changelog
 
 
+#### 0.7.1
+
+Add type for `@apiExample {type} Title`, `@apiSuccessExample`, `@apiErrorExample`.
+
+Add type switch in template.
+
+Append filetype to fields at ajax reuqest testform.
+
+Bugfix: Same file handling with regexp under win32. (https://github.com/apidoc/apidoc/issues/109)
+
+
 #### 0.7.0
 
-Add rudimentary support for direct api calls from within the doc.
+Add rudimentary support for direct api calls (test requests) from within the doc.
+* New configuration var [sampleUrl](http://apidocjs.com#configuration-settings-sample-url) for `apidoc.json`.
+* [@apiSampleRequest](http://apidocjs.com#param-api-sample-request)
 
-Add configuration var `sampleUrl` parameter for `apidoc.json` (for the api calls).
-
 Added ability to have forward slash (/) in parameter field names.
@@ -11,0 +22,0 @@

lib/parsers/api_example.js

@@ -8,10 +8,13 @@ function parse(content, source)
 	var text = "";
+	var type;
 
 	// Search for [@apiexample title] and content
-	var parseRegExp = /^(@\w*)?\s?(.*)$/gm;
+	var parseRegExp = /^(@\w*)?\s?(?:(?:\{(.+?)\})\s*)?(.*)$/gm;
+
     var matches;
 	while(matches = parseRegExp.exec(source))
 	{
-		if(matches[1]) title += matches[2];
-		else if(matches[2]) text += matches[2] + "\n";
+		if(matches[1] && matches[3]) title += matches[3]; // @apiExample and title in the same line
+		if(matches[2]) type = matches[2];
+		else if(matches[3]) text += matches[3] + "\n";
 	} // while
@@ -22,3 +25,4 @@
 		title: title,
-		content: text
+		content: text,
+		type: type || "json"
 	};
@@ -25,0 +29,0 @@ } // parse

lib/utils/find_files.js

 var fs = require("fs");
 var path = require("path");
 var wrench = require("wrench");
+var os = require("os");
 
@@ -26,3 +27,5 @@ /**
 		filters.forEach(function(filter) {
-			if(filter.length > 0) regExpIncludeFilters.push( new RegExp(filter) );
+			if(filter.length > 0) {
+				regExpIncludeFilters.push( new RegExp(filter) );
+			}
 		}); // forEach
@@ -36,2 +39,7 @@
 			if(fs.statSync(fullFilename).isDirectory()) return 0;
+
+			if(os.platform() === "win32") {
+				filename = filename.replace(/\\/g, "/");
+			}
+
 			// Apply every filter
@@ -56,2 +64,7 @@ for(var i = 0; i < length; i += 1)
 		files = files.filter(function(filename) {
+
+			if(os.platform() === "win32") {
+				filename = filename.replace(/\\/g, "/");
+			}
+
 			// Apply every filter
@@ -58,0 +71,0 @@ for(var i = 0; i < length; i += 1)

package.json

 {
   "name": "apidoc",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "RESTful web API Documentation Generator",
@@ -5,0 +5,0 @@ "author": "Peter Rottmann <[e-mail]>",

README.md

@@ -73,3 +73,4 @@ # apiDoc 0.7.x
    
-   ```=pod
+   ```perl
+   =pod
    This is a comment.
@@ -76,0 +77,0 @@ =cut

template/handlebars_helper.js

@@ -15,2 +15,11 @@ define([
 	/**
+	 * Console log.
+	 * @param mixed obj
+	 */
+	Handlebars.registerHelper("cl", function(obj){
+		console.log(obj);
+		return "";
+	});
+
+	/**
 	 * Replace underscore with space.
@@ -157,2 +166,3 @@ * @param string text
 		var dataList = [];
+		var index = 0;
 		if(source)
@@ -170,6 +180,8 @@ {
 								source: sourceEntry,
-								compare: compareEntry
+								compare: compareEntry,
+								index: index
 							};
 							dataList.push(data);
 							found = true;
+							index++;
 						}
@@ -182,5 +194,7 @@ });
 						typeIns: true,
-						source: sourceEntry
+						source: sourceEntry,
+						index: index
 					};
 					dataList.push(data);
+					index++;
 				}
@@ -207,5 +221,7 @@ });
 						typeDel: true,
-						compare: compareEntry
+						compare: compareEntry,
+						index: index
 					};
 					dataList.push(data);
+					index++;
 				}
@@ -212,0 +228,0 @@ });

template/main.js

@@ -44,3 +44,3 @@ require.config({
 	"utilsSampleRequest",
-	"bootstrap"
+	"bootstrap",
 ], function($, _, locale, Handlebars, apiProject, apiData, prettyPrint, sampleRequest) {
@@ -96,3 +96,3 @@
 	$.each(apiByGroupAndName, function(index, groupEntries) {
-		// Titel der ersten Einträge von group[].name[] ermitteln (name hat Versionsliste)
+		// get titles from the first entry of group[].name[] (name has versioning)
 		var titles = {};
@@ -107,7 +107,7 @@ $.each(groupEntries, function(index, entries) {
 		}); // each
-		// Sortieren
+		// Sort
 		var values = Object.keys(titles);
 		values.sort();
 
-		// Einzelne Elemente der neuen Liste hinzufügen.
+		// Add single elements to the new list
 		values.forEach(function(name) {
@@ -120,3 +120,3 @@ var values = name.split( "#~#");
 	}); // each
-	// api überschreiben mit sortierter Liste.
+	// api overwrite with ordered list
 	api = newList;
@@ -311,4 +311,5 @@
 	 */
+	var $scrollSpy = $(this).scrollspy({ target: "#scrollingNav", offset: 25 });
 	$('[data-spy="scroll"]').each(function () {
-  		$(this).scrollspy('refresh');
+		$scrollSpy('refresh');
 	}); 
@@ -355,3 +356,3 @@
 	{
-	  // Bootstrap Popover.
+	  	// Bootstrap Popover.
 		$("a[data-toggle=popover]")
@@ -380,2 +381,12 @@ .popover()
 		
+		// Tabs
+		$('.nav-tabs-examples a').click(function (e) {
+	  		e.preventDefault();
+	  		$(this).tab('show');
+		});
+		// TODO: check to remove this silly timeout problem, tabs not activate but it is rendered
+		//setTimeout(function() {
+			$('.nav-tabs-examples').find('a:first').tab('show');	
+		//}, 10);
+
 	    /**
@@ -499,2 +510,10 @@ * Init Modules
 
+			// Add unique id
+			// TODO: replace all group-name-version in template with id.
+			fields.article.id = fields.article.group + '-' + fields.article.name + '-' + fields.article.version;
+			fields.article.id = fields.article.id.replace(/\./g, '_');
+
+			fields.compare.id = fields.compare.group + '-' + fields.compare.name + '-' + fields.compare.version;
+			fields.compare.id = fields.compare.id.replace(/\./g, '_');
+
 			var entry = sourceEntry;
@@ -563,7 +582,12 @@ if(entry.parameter && entry.parameter.fields) fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields);
 	{
-		if(entry.header && entry.header.fields) fields._hasTypeInHeaderFields = _hasTypeInFields(entry.header.fields);
+		// Add unique id
+		// TODO: replace all group-name-version in template with id.
+		fields.id = fields.article.group + '-' + fields.article.name + '-' + fields.article.version;
+		fields.id = fields.id.replace(/\./g, '_');
+
+		if(entry.header && entry.header.fields)       fields._hasTypeInHeaderFields    = _hasTypeInFields(entry.header.fields);
 		if(entry.parameter && entry.parameter.fields) fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields);
-		if(entry.error && entry.error.fields)         fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields);
-		if(entry.success && entry.success.fields)     fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields);
-		if(entry.info && entry.info.fields)           fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields);
+		if(entry.error && entry.error.fields)         fields._hasTypeInErrorFields     = _hasTypeInFields(entry.error.fields);
+		if(entry.success && entry.success.fields)     fields._hasTypeInSuccessFields   = _hasTypeInFields(entry.success.fields);
+		if(entry.info && entry.info.fields)           fields._hasTypeInInfoFields      = _hasTypeInFields(entry.info.fields);
 
@@ -570,0 +594,0 @@ // Add template settings

test/fixtures/api_data.js

@@ -87,3 +87,4 @@ define({ api: [
         "title": "Example usage:",
-        "content": "   curl -i http://localhost/escape/text\n   <b>curl -i http://localhost/escape/html</b>\n   <xml>curl -i http://localhost/escape/xml</xml>\n"
+        "content": "Example usage:\n   curl -i http://localhost/escape/text\n   <b>curl -i http://localhost/escape/html</b>\n   <xml>curl -i http://localhost/escape/xml</xml>\n",
+        "type": "json"
       }
@@ -95,3 +96,4 @@ ],
           "title": "Example Response",
-          "content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n"
+          "content": "Example Response\nHTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n",
+          "type": "json"
         }
@@ -113,3 +115,4 @@ ]
         "title": "Example usage:",
-        "content": "   curl -i http://localhost/escape/text-old\n   <b>curl -i http://localhost/escape/html-old</b>\n   <xml>curl -i http://localhost/escape/xml-old</xml>\n"
+        "content": "Example usage:\n   curl -i http://localhost/escape/text-old\n   <b>curl -i http://localhost/escape/html-old</b>\n   <xml>curl -i http://localhost/escape/xml-old</xml>\n",
+        "type": "json"
       }
@@ -121,3 +124,4 @@ ],
           "title": "Example Response",
-          "content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n"
+          "content": "Example Response\nHTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n",
+          "type": "json"
         }
@@ -130,2 +134,102 @@ ]
     "type": "get",
+    "url": "/example/",
+    "title": "Example",
+    "name": "GetExample",
+    "group": "Example",
+    "version": "0.7.1",
+    "description": "<p>Extended usage of @apiExample with different example types.</p>",
+    "examples": [
+      {
+        "title": "PHP Example (new)",
+        "content": "echo 'This is the content. (new)';\n",
+        "type": "PHP"
+      },
+      {
+        "title": "JS Example",
+        "content": "console.log('This is the content.');\n",
+        "type": "JS"
+      }
+    ],
+    "success": {
+      "examples": [
+        {
+          "title": "PHP Success Example (new)",
+          "content": "echo 'This is the success content. (new)';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Success Example",
+          "content": "console.log('This is the success content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "error": {
+      "examples": [
+        {
+          "title": "PHP Error Example",
+          "content": "echo 'This is the error content.';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Error Example",
+          "content": "console.log('This is the error content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "filename": "test/fixtures/example/example.js"
+  },
+  {
+    "type": "get",
+    "url": "/example/",
+    "title": "Example",
+    "name": "GetExample",
+    "group": "Example",
+    "version": "0.7.0",
+    "description": "<p>Extended usage of @apiExample with different example types.</p>",
+    "examples": [
+      {
+        "title": "PHP Example",
+        "content": "echo 'This is the content.';\n",
+        "type": "PHP"
+      },
+      {
+        "title": "JS Example (removed)",
+        "content": "console.log('This is the content. (removed)');\n",
+        "type": "JS"
+      }
+    ],
+    "success": {
+      "examples": [
+        {
+          "title": "PHP Success Example",
+          "content": "echo 'This is the success content.';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Success Example",
+          "content": "console.log('This is the success content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "error": {
+      "examples": [
+        {
+          "title": "PHP Error Example (removed)",
+          "content": "echo 'This is the error content. (removed)';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Error Example",
+          "content": "console.log('This is the error content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "filename": "test/fixtures/example/example.js"
+  },
+  {
+    "type": "get",
     "url": "/group/:id",
@@ -380,3 +484,4 @@ "title": "Group and Description",
           "title": "An example:",
-          "content": "   curl -i http://localhost/header/example/\n"
+          "content": "An example:\n   curl -i http://localhost/header/example/\n",
+          "type": "json"
         }
@@ -470,3 +575,4 @@ ]
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -486,3 +592,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -512,3 +619,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n\t    Line 4 indented (with tab at beginning).\n    Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n\t    Line 4 indented (with tab at beginning).\n    Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -528,3 +636,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -554,3 +663,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -570,3 +680,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -596,3 +707,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -612,3 +724,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -628,3 +741,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n     Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n     Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -654,3 +768,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -670,3 +785,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -696,3 +812,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -712,3 +829,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -715,0 +833,0 @@ ],

test/fixtures/api_data.json

@@ -87,3 +87,4 @@ [
         "title": "Example usage:",
-        "content": "   curl -i http://localhost/escape/text\n   <b>curl -i http://localhost/escape/html</b>\n   <xml>curl -i http://localhost/escape/xml</xml>\n"
+        "content": "Example usage:\n   curl -i http://localhost/escape/text\n   <b>curl -i http://localhost/escape/html</b>\n   <xml>curl -i http://localhost/escape/xml</xml>\n",
+        "type": "json"
       }
@@ -95,3 +96,4 @@ ],
           "title": "Example Response",
-          "content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n"
+          "content": "Example Response\nHTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n",
+          "type": "json"
         }
@@ -113,3 +115,4 @@ ]
         "title": "Example usage:",
-        "content": "   curl -i http://localhost/escape/text-old\n   <b>curl -i http://localhost/escape/html-old</b>\n   <xml>curl -i http://localhost/escape/xml-old</xml>\n"
+        "content": "Example usage:\n   curl -i http://localhost/escape/text-old\n   <b>curl -i http://localhost/escape/html-old</b>\n   <xml>curl -i http://localhost/escape/xml-old</xml>\n",
+        "type": "json"
       }
@@ -121,3 +124,4 @@ ],
           "title": "Example Response",
-          "content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n"
+          "content": "Example Response\nHTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n",
+          "type": "json"
         }
@@ -130,2 +134,102 @@ ]
     "type": "get",
+    "url": "/example/",
+    "title": "Example",
+    "name": "GetExample",
+    "group": "Example",
+    "version": "0.7.1",
+    "description": "<p>Extended usage of @apiExample with different example types.</p>",
+    "examples": [
+      {
+        "title": "PHP Example (new)",
+        "content": "echo 'This is the content. (new)';\n",
+        "type": "PHP"
+      },
+      {
+        "title": "JS Example",
+        "content": "console.log('This is the content.');\n",
+        "type": "JS"
+      }
+    ],
+    "success": {
+      "examples": [
+        {
+          "title": "PHP Success Example (new)",
+          "content": "echo 'This is the success content. (new)';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Success Example",
+          "content": "console.log('This is the success content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "error": {
+      "examples": [
+        {
+          "title": "PHP Error Example",
+          "content": "echo 'This is the error content.';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Error Example",
+          "content": "console.log('This is the error content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "filename": "test/fixtures/example/example.js"
+  },
+  {
+    "type": "get",
+    "url": "/example/",
+    "title": "Example",
+    "name": "GetExample",
+    "group": "Example",
+    "version": "0.7.0",
+    "description": "<p>Extended usage of @apiExample with different example types.</p>",
+    "examples": [
+      {
+        "title": "PHP Example",
+        "content": "echo 'This is the content.';\n",
+        "type": "PHP"
+      },
+      {
+        "title": "JS Example (removed)",
+        "content": "console.log('This is the content. (removed)');\n",
+        "type": "JS"
+      }
+    ],
+    "success": {
+      "examples": [
+        {
+          "title": "PHP Success Example",
+          "content": "echo 'This is the success content.';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Success Example",
+          "content": "console.log('This is the success content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "error": {
+      "examples": [
+        {
+          "title": "PHP Error Example (removed)",
+          "content": "echo 'This is the error content. (removed)';\n",
+          "type": "PHP"
+        },
+        {
+          "title": "JS Error Example",
+          "content": "console.log('This is the error content.');\n",
+          "type": "JS"
+        }
+      ]
+    },
+    "filename": "test/fixtures/example/example.js"
+  },
+  {
+    "type": "get",
     "url": "/group/:id",
@@ -380,3 +484,4 @@ "title": "Group and Description",
           "title": "An example:",
-          "content": "   curl -i http://localhost/header/example/\n"
+          "content": "An example:\n   curl -i http://localhost/header/example/\n",
+          "type": "json"
         }
@@ -470,3 +575,4 @@ ]
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -486,3 +592,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -512,3 +619,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n\t    Line 4 indented (with tab at beginning).\n    Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n\t    Line 4 indented (with tab at beginning).\n    Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -528,3 +636,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -554,3 +663,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -570,3 +680,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -596,3 +707,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -612,3 +724,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -628,3 +741,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n     Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n     Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -654,3 +768,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -670,3 +785,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -696,3 +812,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -712,3 +829,4 @@ ],
         "title": "Test for indented comment.",
-        "content": "This is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n"
+        "content": "Test for indented comment.\nThis is example line 2.\nThis is example line 3.\n  Line 4 indented (with tab at beginning).\n  Line 5 indented.\nThis is example line 6.\n",
+        "type": "json"
       }
@@ -715,0 +833,0 @@ ],

test/fixtures/api_project.js

@@ -14,5 +14,5 @@ define({
   "generator": {
-    "version": "0.7.0",
-    "time": "2014-08-22T14:39:03.051Z"
+    "version": "0.7.1",
+    "time": "2014-09-05T14:47:08.663Z"
   }
 });

test/fixtures/api_project.json

@@ -14,5 +14,5 @@ {
   "generator": {
-    "version": "0.7.0",
-    "time": "2014-08-22T14:39:03.051Z"
+    "version": "0.7.1",
+    "time": "2014-09-05T14:47:08.663Z"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

746719

increased by1.96%

Number of package files

152

increased by0.66%

Lines of code

9351

increased by3.69%

Number of lines in readme file

111

increased by0.91%

No dependency changes