apidoc - npm Package Compare versions

Comparing version 0.2.8 to 0.3.0

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.3.0
+Replace deprecated node-markdown with [marked](https://github.com/chjj/marked).
+Add cli parameter for marked `--marked-...`, watch all params with`--help`.
+Upgrade all used node modules.
+
+#### 0.2.8
+Bugfix: executable line delimiters. (again).
+
 #### 0.2.7
@@ -4,0 +12,0 @@ Bugfix: Allow usage of structures and titles in the same block (https://github.com/apidoc/apidoc/issues/21)

lib/apidoc.js

@@ -11,3 +11,3 @@ var _ = require("underscore");
 var Filter = require("./filter");
-var markdown = require("node-markdown").Markdown;
+var markdown = require("marked");
 var colors = require("colors");
@@ -31,3 +31,13 @@
 	parsers: {},
-	workers: {}
+	workers: {},
+
+	marked: {
+		gfm:         true,
+		tables:      true,
+		breaks:      false,
+		pedantic:    false,
+		sanitize:    false,
+		smartLists:  false,
+		smartypants: false
+	}
 };
@@ -246,6 +256,6 @@
 	app.debug("write json file: " + options.dest + "api_data.json");
-	if( ! options.simulate) fs.writeFile(options.dest + "./api_data.json", json);
+	if( ! options.simulate) fs.writeFileSync(options.dest + "./api_data.json", json);
 
 	app.debug("write js file: " + options.dest + "api_data.js");
-	if( ! options.simulate) fs.writeFile(options.dest + "./api_data.js", "define({ api: " + json + " });");
+	if( ! options.simulate) fs.writeFileSync(options.dest + "./api_data.js", "define({ api: " + json + " });");
 
@@ -255,6 +265,6 @@ // api_project
 	app.debug("write json file: " + options.dest + "api_project.json");
-	if( ! options.simulate) fs.writeFile(options.dest + "./api_project.json", json);
+	if( ! options.simulate) fs.writeFileSync(options.dest + "./api_project.json", json);
 
 	app.debug("write js file: " + options.dest + "api_project.js");
-	if( ! options.simulate) fs.writeFile(options.dest + "./api_project.js", "define(" + json + ");");
+	if( ! options.simulate) fs.writeFileSync(options.dest + "./api_project.js", "define(" + json + ");");
 } // createOutputFiles
@@ -272,2 +282,5 @@
 
+	// marked (markdown) Settings.
+	markdown.setOptions(options.marked);
+
 	// Paths
@@ -274,0 +287,0 @@ options.src      = path.join(options.src, "./");

package.json

 {
   "name": "apidoc",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "description": "RESTful web API Documentation Generator",
@@ -25,17 +25,17 @@ "author": "Peter Rottmann <[e-mail]>",
   "dependencies": {
-    "wrench": "~1.5.1",
-    "underscore": "~1.4.4",
-    "semver": "~1.1.4",
-    "lodash": "~1.2.0",
-    "node-markdown": "~0.1.1",
-    "optimist": "~0.5.0",
-    "colors": "~0.6.0-1"
+    "wrench": "~1.5.4",
+    "underscore": "~1.5.2",
+    "semver": "~2.2.1",
+    "lodash": "~2.4.1",
+    "optimist": "~0.6.0",
+    "colors": "~0.6.2",
+    "marked": "~0.2.10"
   },
   "devDependencies": {
-    "grunt": "~0.4.1",
-    "grunt-contrib-clean": "~0.4.1",
-    "grunt-contrib-jshint": "~0.5.4",
+    "grunt": "~0.4.2",
+    "grunt-contrib-clean": "~0.5.0",
+    "grunt-contrib-jshint": "~0.7.2",
     "grunt-simple-mocha": "~0.4.0",
-    "should": "~1.2.2"
+    "should": "~2.1.1"
   }
-}
+}

test/fixtures/api_data.js

@@ -34,3 +34,3 @@ define({ api: [
     },
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -75,3 +75,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\title_and_structure.js"
+    "filename": "test/fixtures/example/title_and_structure.js"
   },
@@ -177,3 +177,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\_grouping.js"
+    "filename": "test/fixtures/example/_grouping.js"
   },
@@ -306,3 +306,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\param.js"
+    "filename": "test/fixtures/example/param.js"
   },
@@ -442,3 +442,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\param.js"
+    "filename": "test/fixtures/example/param.js"
   },
@@ -477,3 +477,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -512,3 +512,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -521,5 +521,5 @@ {
             "group": "Error 4xx",
-            "field": "error2Error",
+            "field": "error1Error",
             "optional": false,
-            "description": "This is Error 2."
+            "description": "This is Error 1."
           }
@@ -533,3 +533,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -542,5 +542,5 @@ {
             "group": "Error 4xx",
-            "field": "error1Error",
+            "field": "error2Error",
             "optional": false,
-            "description": "This is Error 1."
+            "description": "This is Error 2."
           }
@@ -554,3 +554,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -563,5 +563,5 @@ {
             "group": "Parameter",
-            "field": "field2",
+            "field": "field1",
             "optional": false,
-            "description": "This is Field 2."
+            "description": "This is Field 1."
           }
@@ -575,3 +575,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -584,5 +584,5 @@ {
             "group": "Parameter",
-            "field": "field1",
+            "field": "field2",
             "optional": false,
-            "description": "This is Field 1."
+            "description": "This is Field 2."
           }
@@ -596,3 +596,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -616,3 +616,3 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -636,3 +636,3 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -656,4 +656,4 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\title_and_structure.js"
+    "filename": "test/fixtures/example/title_and_structure.js"
   }
 ] });

test/fixtures/api_data.json

@@ -34,3 +34,3 @@ [
     },
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -75,3 +75,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\title_and_structure.js"
+    "filename": "test/fixtures/example/title_and_structure.js"
   },
@@ -177,3 +177,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\_grouping.js"
+    "filename": "test/fixtures/example/_grouping.js"
   },
@@ -306,3 +306,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\param.js"
+    "filename": "test/fixtures/example/param.js"
   },
@@ -442,3 +442,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\param.js"
+    "filename": "test/fixtures/example/param.js"
   },
@@ -477,3 +477,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -512,3 +512,3 @@ {
     },
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -521,5 +521,5 @@ {
             "group": "Error 4xx",
-            "field": "error2Error",
+            "field": "error1Error",
             "optional": false,
-            "description": "This is Error 2."
+            "description": "This is Error 1."
           }
@@ -533,3 +533,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -542,5 +542,5 @@ {
             "group": "Error 4xx",
-            "field": "error1Error",
+            "field": "error2Error",
             "optional": false,
-            "description": "This is Error 1."
+            "description": "This is Error 2."
           }
@@ -554,3 +554,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\error_structure.js"
+    "filename": "test/fixtures/example/error_structure.js"
   },
@@ -563,5 +563,5 @@ {
             "group": "Parameter",
-            "field": "field2",
+            "field": "field1",
             "optional": false,
-            "description": "This is Field 2."
+            "description": "This is Field 1."
           }
@@ -575,3 +575,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -584,5 +584,5 @@ {
             "group": "Parameter",
-            "field": "field1",
+            "field": "field2",
             "optional": false,
-            "description": "This is Field 1."
+            "description": "This is Field 2."
           }
@@ -596,3 +596,3 @@ ]
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\structure.js"
+    "filename": "test/fixtures/example/structure.js"
   },
@@ -616,3 +616,3 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -636,3 +636,3 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\success_structure.js"
+    "filename": "test/fixtures/example/success_structure.js"
   },
@@ -656,4 +656,4 @@ {
     "version": "0.0.0",
-    "filename": "test\\fixtures\\example\\title_and_structure.js"
+    "filename": "test/fixtures/example/title_and_structure.js"
   }
 ]

test/fixtures/api_project.js

 define({
   "name": "apidoc",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "description": "RESTful web API Documentation Generator",
   "apidoc": "",
   "generator": {
-    "version": "0.2.7",
-    "time": "2013-11-30T10:04:13.365Z"
+    "version": "0.3.0",
+    "time": "2013-12-23T15:00:00.000Z"
   }
 });

test/fixtures/api_project.json

 {
   "name": "apidoc",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "description": "RESTful web API Documentation Generator",
   "apidoc": "",
   "generator": {
-    "version": "0.2.7",
-    "time": "2013-11-30T10:04:13.365Z"
+    "version": "0.3.0",
+    "time": "2013-12-23T15:00:00.000Z"
   }
 }

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

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

1112807

increased by0.16%

Lines of code

8878

increased by0.12%

Dependency changes

• + Addedmarked@~0.2.10

• + Addedlodash@2.4.2(transitive)

• + Addedmarked@0.2.10(transitive)

• + Addedminimist@0.0.10(transitive)

• + Addedoptimist@0.6.1(transitive)

• + Addedsemver@2.2.1(transitive)

• + Addedunderscore@1.5.2(transitive)

• - Removednode-markdown@~0.1.1

• - Removedlodash@1.2.1(transitive)

• - Removednode-markdown@0.1.1(transitive)

• - Removedoptimist@0.5.2(transitive)

• - Removedsemver@1.1.4(transitive)

• - Removedunderscore@1.4.4(transitive)

• Updatedcolors@~0.6.2

• Updatedlodash@~2.4.1

• Updatedoptimist@~0.6.0

• Updatedsemver@~2.2.1

• Updatedunderscore@~1.5.2

• Updatedwrench@~1.5.4