ndoc - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

bin/ndoc.js

@@ -10,3 +10,2 @@ #!/usr/bin/env node
 var path = require('path');
-var exec = require('child_process').exec;
 
@@ -27,8 +26,8 @@
 function exit(err) {
-    if (err) {
-      console.error(err.message || err);
-      process.exit(1);
-    }
+  if (err) {
+    console.error(err.message || err);
+    process.exit(1);
+  }
 
-    process.exit(0);
+  process.exit(0);
 }
@@ -35,0 +34,0 @@

HISTORY.md

@@ -0,2 +1,11 @@
+2.0.5 / 2013-02-16
+------------------
+
+* Fixed bug, that caused problems with new `argparse`
+* Updated dependencies
+* Updated linting rules
+
+
 2.0.4 / 2012-08-09
+------------------
 
@@ -3,0 +12,0 @@ * Fixed main index file path (when ndoc used as library)

lib/ndoc.js

@@ -25,3 +25,3 @@ /**
 // 3rd-party
-var _     = require('underscore');
+var _     = require('lodash');
 var async = require('async');
@@ -222,3 +222,3 @@
   // correct method types (class or entity)
-  _.each(nodes, function (node, id) {
+  _.each(nodes, function (node /*, id*/) {
     // aliases
@@ -225,0 +225,0 @@ if (node.alias_of && nodes[node.alias_of]) {

lib/ndoc/cli.js

@@ -46,7 +46,6 @@ /**
 var fs   = require('fs');
-var path = require('path');
 
 
 // 3rd-party
-var _               = require('underscore');
+var _               = require('lodash');
 var FsTools         = require('fs-tools');
@@ -68,3 +67,3 @@ var argparse        = require('argparse');
   addHelp:  true,
-  formatterClass: function(options) {
+  formatterClass: function (options) {
     options['maxHelpPosition'] = 40;
@@ -87,3 +86,2 @@ return new argparse.HelpFormatter(options);
   metavar:      'PATH',
-  action:       'append',
   nargs:        '+'
@@ -90,0 +88,0 @@ });

lib/ndoc/cli/lazy-choices.js

@@ -24,4 +24,4 @@ 'use strict';
 
-LazyChoices.prototype.call = function (parser, namespace, values, optionString) {
+LazyChoices.prototype.call = function (parser, namespace, values) {
   namespace.set(this.dest, values);
 };

lib/ndoc/cli/read-file.js

@@ -26,4 +26,4 @@ 'use strict';
 
-ReadFile.prototype.call = function (parser, namespace, values, optionString) {
+ReadFile.prototype.call = function (parser, namespace, values) {
   namespace.set(this.dest, fs.readFileSync(values.shift(), 'utf8'));
 };

lib/ndoc/cli/read-json.js

@@ -26,5 +26,5 @@ 'use strict';
 
-ReadJSON.prototype.call = function (parser, namespace, values, optionString) {
+ReadJSON.prototype.call = function (parser, namespace, values) {
   var str = fs.readFileSync(values.shift(), 'utf8');
   namespace.set(this.dest, JSON.parse(str));
 };

lib/ndoc/common.js

@@ -5,3 +5,3 @@ 'use strict';
 // 3rd-party
-var _ = require('underscore');
+var _ = require('lodash');
 
@@ -8,0 +8,0 @@

lib/ndoc/plugins/parsers/javascript.js

@@ -23,3 +23,3 @@ /** internal, section: Plugins
 // 3rd-party
-var _ = require('underscore');
+var _ = require('lodash');
 
@@ -36,3 +36,3 @@
   fs.readFile(file, 'utf8', function (err, source) {
-    var nodes, list = {}, tree, parted, sections, children;
+    var nodes, list = {};
 
@@ -55,3 +55,3 @@ if (err) {
     // do pre-distribute early work
-    _.each(nodes, function (node, id) {
+    _.each(nodes, function (node /*, id*/) {
       var clone;
@@ -58,0 +58,0 @@

lib/ndoc/plugins/renderers/html.js

@@ -39,3 +39,3 @@ /** internal, section: Plugins
 // 3rd-party
-var _       = require('underscore');
+var _       = require('lodash');
 var FsTools = require('fs-tools');
@@ -53,3 +53,3 @@ var Jade    = require('jade');
 // Markdown highlighter callback function
-var marked_highlight = function(code, lang) {
+var marked_highlight = function (code, lang) {
   if (lang) {
@@ -170,3 +170,3 @@ return hljs.highlight(lang, code).value;
       r += '(';
-      sig.args.forEach(function (arg, idx, args) {
+      sig.args.forEach(function (arg, idx) {
         var skip_first, a, value;
@@ -173,0 +173,0 @@ // skip the first bound argument for prototype methods

lib/ndoc/plugins/renderers/json.js

@@ -40,4 +40,4 @@ /** internal, section: Plugins
       date: (new Date()).toUTCString()
-    }), callback);
+    }, null, '  '), callback);
   });
 };

package.json

 {
   "name"            : "ndoc",
-  "version"         : "2.0.4",
+  "version"         : "2.0.5",
   "description"     : "JavaScript API documentor with simple syntax.",
@@ -24,15 +24,15 @@ "keywords"        : [
   "dependencies"    : {
-                        "async"       : "~0.1.22",
-                        "argparse"    : "~0.1.3",
+                        "async"       : "~0.2.4",
+                        "argparse"    : "~0.1.12",
                         "minimatch"   : "~0.2.5",
                         "mincer"      : "~0.2.2",
                         "uglify-js"   : "~1.3.2",
-                        "csso"        : "~1.2.14",
-                        "jade"        : "~0.27.2",
-                        "stylus"      : "~0.28.2",
-                        "nib"         : "~0.7.0",
+                        "csso"        : "~1.3.7",
+                        "jade"        : "~0.28.1",
+                        "stylus"      : "~0.32.0",
+                        "nib"         : "~0.9.1",
                         "marked"      : "~0.2.0",
-                        "underscore"  : "~1.3.0",
+                        "lodash"      : "~1.0.0",
                         "fs-tools"    : "~0.2.2",
-                        "highlight.js": "~7.0.1",
+                        "highlight.js": "~7.3.0",
                         "less"        : "~1.3.0"
@@ -39,0 +39,0 @@ },

README.md

@@ -23,3 +23,5 @@ # NDoc - JavaScript documentation generator
 
-    npm install -g ndoc
+``` bash
+npm install -g ndoc
+```
 
@@ -29,3 +31,3 @@
 
-```
+``` dos
 usage: ndoc [-h] [-v] [--exclude PATTERN] [-o PATH] [--use PLUGIN]
@@ -88,3 +90,5 @@ [--alias MAPPING] [-r RENDERER] [--link-format FORMAT]
 
-    make test
+``` bash
+make test
+```
 
@@ -91,0 +95,0 @@ Then open `./tests/prototype-doc/index.html`.

Fixed alerts

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

430032

increased by0.15%

Number of lines in readme file

140

increased by2.94%

Number of high supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

10089

decreased by-0.03%

Dependency changes

• + Addedlodash@~1.0.0

• + Addedcsso@1.3.12(transitive)

• + Addedhighlight.js@7.3.0(transitive)

• + Addedjade@0.28.2(transitive)

• + Addedlodash@1.0.2(transitive)

• + Addednib@0.9.2(transitive)

• + Addedstylus@0.31.00.32.1(transitive)

• - Removedunderscore@~1.3.0

• - Removedcoffee-script@1.4.0(transitive)

• - Removedcsso@1.2.18(transitive)

• - Removedhighlight.js@7.0.1(transitive)

• - Removedjade@0.27.7(transitive)

• - Removednib@0.7.1(transitive)

• - Removedstylus@0.28.2(transitive)

• Updatedargparse@~0.1.12

• Updatedasync@~0.2.4

• Updatedcsso@~1.3.7

• Updatedhighlight.js@~7.3.0

• Updatedjade@~0.28.1

• Updatednib@~0.9.1

• Updatedstylus@~0.32.0