apidoc - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.4.1
+Add support for CoffeeScript comment-style. 
+
 #### 0.4.0
 Add support for other comment-style. Now apiDoc supports:
  * Erlang
- * JavaScript (DocStyle: e.g. also used C#, Go, Dart, Java, PHP)
+ * JavaScript (JavaDoc-Style: e.g. also useable in C#, Go, Dart, Java, PHP, TypeScript)
  * Python
@@ -79,2 +82,2 @@ * Ruby
 #### 0.1.5
-Official release
+Official release

lib/apidoc.js

@@ -17,3 +17,3 @@ var _ = require("underscore");
 	excludeFilters: [],
-	includeFilters: [ ".*\\.(cs|dart|erl|go|java|js|php?|py|rb|ts)$" ],
+	includeFilters: [ ".*\\.(coffee|cs|dart|erl|go|java|js|php?|py|rb|ts)$" ],
 
@@ -20,0 +20,0 @@ src: path.join(__dirname, "../example/"),

lib/parser.js

@@ -274,5 +274,13 @@ var fs = require("fs");
 
+	// TODO: make this more flexible with a plugin
 	// Blocksearch depending on file-extension
 	switch(self.extension)
 	{
+		case ".coffee":
+			// Find document blocks between "###" and "###"
+			docBlocksRegExp = /###\uffff(.+?)###/g;
+			// Remove not needed "	" (tabs) at the beginning
+			inlineRegExp = /^(\t+)?[ ]?/gm;
+			break;
+
 		case ".erl":
@@ -285,2 +293,3 @@ // Find document blocks between "%{" and "%}"
 			break;
+
 		case ".py":
@@ -292,2 +301,3 @@ // Find document blocks between """ and """
 			break;
+
 		case ".rb":
@@ -299,2 +309,3 @@ // Find document blocks between "=begin" and "=end"
 			break;
+
 		default:
@@ -301,0 +312,0 @@ // Find document blocks between "/**" and "*/"

package.json

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

README.md

@@ -1,2 +0,2 @@
-# apiDoc 0.4.0
+# apiDoc 0.4.1
 
@@ -11,3 +11,3 @@ Generates a RESTful web API Documentation.
 
- * **C#, Go, Dart, Java, JavaScript, PHP** (all DocStyle capable languages like ):
+ * **C#, Go, Dart, Java, JavaScript, PHP** (all DocStyle capable languages):
 
@@ -20,2 +20,10 @@ ```javascript
 
+ * **CoffeeScript**:
+
+   ```coffeescript
+   ###
+   This is a comment.
+   ###
+   ```
+
  * **Erlang**:
@@ -22,0 +30,0 @@

test/fixtures/api_data.js

@@ -179,2 +179,42 @@ define({ api: [
     "type": "get",
+    "url": "/language/coffeescript",
+    "title": "CoffeeScript",
+    "name": "GetLanguageCoffeeScript",
+    "group": "Language",
+    "version": "0.4.0",
+    "description": "Test for CoffeeScript Comment-Syntax.",
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
+    "url": "/language/coffeescript/indented1",
+    "title": "CoffeeScript indented 1",
+    "name": "GetLanguageCoffeeScriptIndented1",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "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"
+      }
+    ],
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
+    "url": "/language/coffeescript/indented2",
+    "title": "CoffeeScript indented 2",
+    "name": "GetLanguageCoffeeScriptIndented2",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "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"
+      }
+    ],
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
     "url": "/language/erlang",
@@ -713,5 +753,5 @@ "title": "Erlang",
             "group": "Parameter",
-            "field": "field2",
+            "field": "field1",
             "optional": false,
-            "description": "This is Field 2."
+            "description": "This is Field 1."
           }
@@ -733,5 +773,5 @@ ]
             "group": "Parameter",
-            "field": "field1",
+            "field": "field2",
             "optional": false,
-            "description": "This is Field 1."
+            "description": "This is Field 2."
           }
@@ -738,0 +778,0 @@ ]

test/fixtures/api_data.json

@@ -179,2 +179,42 @@ [
     "type": "get",
+    "url": "/language/coffeescript",
+    "title": "CoffeeScript",
+    "name": "GetLanguageCoffeeScript",
+    "group": "Language",
+    "version": "0.4.0",
+    "description": "Test for CoffeeScript Comment-Syntax.",
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
+    "url": "/language/coffeescript/indented1",
+    "title": "CoffeeScript indented 1",
+    "name": "GetLanguageCoffeeScriptIndented1",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "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"
+      }
+    ],
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
+    "url": "/language/coffeescript/indented2",
+    "title": "CoffeeScript indented 2",
+    "name": "GetLanguageCoffeeScriptIndented2",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "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"
+      }
+    ],
+    "filename": "test/fixtures/example/language.coffee"
+  },
+  {
+    "type": "get",
     "url": "/language/erlang",
@@ -713,5 +753,5 @@ "title": "Erlang",
             "group": "Parameter",
-            "field": "field2",
+            "field": "field1",
             "optional": false,
-            "description": "This is Field 2."
+            "description": "This is Field 1."
           }
@@ -733,5 +773,5 @@ ]
             "group": "Parameter",
-            "field": "field1",
+            "field": "field2",
             "optional": false,
-            "description": "This is Field 1."
+            "description": "This is Field 2."
           }
@@ -738,0 +778,0 @@ ]

test/fixtures/api_project.js

 define({
   "name": "apidoc",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "RESTful web API Documentation Generator",
   "apidoc": "",
   "generator": {
-    "version": "0.4.0",
-    "time": "2014-03-04T16:24:51.514Z"
+    "version": "0.4.1",
+    "time": "2014-03-06T10:06:46.135Z"
   }
 });

test/fixtures/api_project.json

 {
   "name": "apidoc",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "RESTful web API Documentation Generator",
   "apidoc": "",
   "generator": {
-    "version": "0.4.0",
-    "time": "2014-03-04T16:24:51.514Z"
+    "version": "0.4.1",
+    "time": "2014-03-06T10:06:46.135Z"
   }
 }

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

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

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

Improved metrics

Total package byte prevSize

1131872

increased by0.35%

Lines of code

9344

increased by0.94%

Number of lines in readme file

78

increased by11.43%

Worsened metrics

Number of low supply chain risk alerts

14

increased by7.69%

No dependency changes