jsdoc-to-markdown - npm Package Compare versions

Comparing version 2.0.0-alpha.11 to 2.0.0-alpha.12

es5/lib/jsdoc-to-markdown.js

@@ -145,3 +145,2 @@ 'use strict';
   options = options || {};
-
   if (options['no-usage-stats']) {
@@ -161,13 +160,22 @@ usageStats.disable();
       }
+      var req = usageStats.end().send({ debug: debug });
+      if (debug) {
+        req.then(function (response) {
+          response.data = response.data ? response.data.toString() : response.data;
+
+          console.error(require('util').inspect(response, { depth: 3, colors: true }));
+        });
+      }
+      req.catch(function (err) {
+        return console.error('.send() failed', err.stack);
+      });
+
       if (sync) {
         try {
-          var output = command(options);
-          var req = usageStats.end().send({ debug: debug });
-          if (debug) req.then(console.error);
           return {
-            v: output
+            v: command(options)
           };
+          usageStats.abort();
         } catch (err) {
-          usageStats.exception(err.message, 1);
-          throw err;
+          commandFailed(err, debug);
         }
@@ -177,10 +185,6 @@ } else {
           v: command(options).then(function (output) {
-            var req = usageStats.end().send({ debug: debug });
-            if (debug) req.then(console.error);
+            usageStats.abort();
             return output;
           }).catch(function (err) {
-            usageStats.exception(err.message, true);
-            var req = usageStats.end().send({ debug: debug });
-            if (debug) req.then(console.error);
-            throw err;
+            commandFailed(err, debug);
           })
@@ -193,2 +197,11 @@ };
   }
+}
+
+function commandFailed(err, debug) {
+  usageStats.exception(err.message, 1);
+  var req = usageStats.end().send({ debug: debug });
+  if (debug) req.then(function (response) {
+    console.error(require('util').inspect(response, { depth: 3, colors: true }));
+  });
+  throw err;
 }

es5/test/async.js

 'use strict';
 
-var test = require('test-runner');
+var TestRunner = require('test-runner');
 var jsdoc2md = require('../../');
@@ -8,5 +8,6 @@ var a = require('assert');
 
+var runner = new TestRunner();
 var inputFile = 'src/test/fixture/ignore.js';
 
-test('.render({ files })', function () {
+runner.test('.render({ files })', function () {
   return jsdoc2md.render({ files: inputFile, cache: false }).then(function (result) {
@@ -17,3 +18,3 @@ return a.ok(/a visible global/.test(result));
 
-test('.render({ files, heading-depth: 4 })', function () {
+runner.test('.render({ files, heading-depth: 4 })', function () {
   return jsdoc2md.render({ files: inputFile, cache: false, 'heading-depth': 4 }).then(function (result) {
@@ -24,3 +25,3 @@ return a.ok(/#### visible/.test(result));
 
-test('.render({ files, param-list-format: list })', function () {
+runner.test('.render({ files, param-list-format: list })', function () {
   var inputFile = 'src/test/fixture/params.js';
@@ -32,3 +33,3 @@ return jsdoc2md.render({ files: inputFile, cache: false, 'param-list-format': 'list' }).then(function (result) {
 
-test('.getTemplateData({ files })', function () {
+runner.test('.getTemplateData({ files })', function () {
   return jsdoc2md.getTemplateData({ files: inputFile, cache: false }).then(function (result) {
@@ -39,3 +40,3 @@ return a.ok(result[0].id);
 
-test('.getJsdocData({ files })', function () {
+runner.test('.getJsdocData({ files })', function () {
   return jsdoc2md.getJsdocData({ files: inputFile, cache: false }).then(function (result) {
@@ -42,0 +43,0 @@ return a.ok(result[0].longname);

es5/test/cli.js

 'use strict';
 
-var test = require('test-runner');
+var TestRunner = require('test-runner');
 var fs = require('fs');
@@ -8,2 +8,3 @@ var spawn = require('child_process').spawn;
 
+var runner = new TestRunner();
 var inputPath = 'src/test/fixture/ignore.js';
@@ -15,3 +16,3 @@
 
-test('cli: json option', function () {
+runner.test('cli: json option', function () {
   var outputFile = fs.openSync('tmp/ignore.json', 'w');
@@ -18,0 +19,0 @@ return new Promise(function (resolve, reject) {

es5/test/sync.js

 'use strict';
 
-var test = require('test-runner');
+var TestRunner = require('test-runner');
 var jsdoc2md = require('../../');
@@ -8,6 +8,7 @@ var a = require('assert');
 
+var runner = new TestRunner();
 var inputFile = 'src/test/fixture/ignore.js';
 
 if (require('child_process').spawnSync) {
-  test('.renderSync({ files })', function () {
+  runner.test('.renderSync({ files })', function () {
     var result = jsdoc2md.renderSync({ files: inputFile, cache: false });
@@ -17,3 +18,3 @@ a.ok(/a visible global/.test(result));
 
-  test('.renderSync({ files, heading-depth: 4 })', function () {
+  runner.test('.renderSync({ files, heading-depth: 4 })', function () {
     var result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'heading-depth': 4 });
@@ -23,3 +24,3 @@ a.ok(/#### visible/.test(result));
 
-  test('.renderSync({ files }, { param-list-format: list })', function () {
+  runner.test('.renderSync({ files }, { param-list-format: list })', function () {
     var inputFile = 'src/test/fixture/params.js';
@@ -30,3 +31,3 @@ var result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'param-list-format': 'list' });
 
-  test('.getTemplateDataSync({ files })', function () {
+  runner.test('.getTemplateDataSync({ files })', function () {
     var result = jsdoc2md.getTemplateDataSync({ files: inputFile, cache: false });
@@ -36,3 +37,3 @@ a.ok(result[0].id);
 
-  test('.getJsdocDataSync({ files })', function () {
+  runner.test('.getJsdocDataSync({ files })', function () {
     var result = jsdoc2md.getJsdocDataSync({ files: inputFile, cache: false });
@@ -39,0 +40,0 @@ a.ok(result[0].longname);

package.json

 {
   "name": "jsdoc-to-markdown",
   "author": "Lloyd Brookes",
-  "version": "2.0.0-alpha.11",
+  "version": "2.0.0-alpha.12",
   "description": "jsdoc-annotated source in, markdown API docs out.",
@@ -13,3 +13,3 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown",
   "scripts": {
-    "test": "test-runner es5/test/*.js",
+    "test": "node test.js",
     "docs": "node src/bin/cli.js --separators src/lib/jsdoc-to-markdown.js > docs/API.md; echo ",
@@ -31,3 +31,3 @@ "cover": "istanbul cover ./node_modules/.bin/test-runner src/test/*.js && cat coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf coverage; echo",
     "command-line-tool": "^0.6.3",
-    "config-master": "^2.0.3",
+    "config-master": "^2.0.4",
     "core-js": "^2.4.1",
@@ -37,5 +37,5 @@ "dmd": "^2.0.3-0",
     "home-path": "^1.0.3",
-    "jsdoc-api": "^1.2.4",
+    "jsdoc-api": "^2.0.1",
     "jsdoc-parse": "^2.0.5-0",
-    "usage-stats": "^0.2.1",
+    "usage-stats": "^0.3.1",
     "walk-back": "^2.0.1"
@@ -46,3 +46,3 @@ },
     "coveralls": "^2.11.12",
-    "test-runner": "^0.1.12"
+    "test-runner": "^0.2.1"
   },
@@ -49,0 +49,0 @@ "standard": {

src/lib/jsdoc-to-markdown.js

@@ -299,4 +299,4 @@ 'use strict'
   options = options || {}
-  /* when disabled, all usageStats methods are no-ops */
   if (options['no-usage-stats']) {
+    /* when disabled, all usageStats methods are no-ops */
     usageStats.disable()
@@ -314,11 +314,20 @@ return command(options)
     }
+    const req = usageStats.end().send({ debug })
+    if (debug) {
+      req.then(response => {
+        // responses = responses.map(response => {
+        response.data = response.data ? response.data.toString() : response.data
+        //   return response
+        // })
+        console.error(require('util').inspect(response, { depth: 3, colors: true }))
+      })
+    }
+    req.catch(err => console.error('.send() failed', err.stack))
+
     if (sync) {
       try {
-        const output = command(options)
-        const req = usageStats.end().send({ debug })
-        if (debug) req.then(console.error)
-        return output
+        return command(options)
+        usageStats.abort()
       } catch (err) {
-        usageStats.exception(err.message, 1)
-        throw err
+        commandFailed(err, debug)
       }
@@ -328,11 +337,7 @@ } else {
         .then(output => {
-          const req = usageStats.end().send({ debug })
-          if (debug) req.then(console.error)
+          usageStats.abort()
           return output
         })
         .catch(err => {
-          usageStats.exception(err.message, true)
-          const req = usageStats.end().send({ debug })
-          if (debug) req.then(console.error)
-          throw err
+          commandFailed(err, debug)
         })
@@ -342,1 +347,10 @@ }
 }
+
+function commandFailed (err, debug) {
+  usageStats.exception(err.message, 1)
+  const req = usageStats.end().send({ debug })
+  if (debug) req.then(response => {
+    console.error(require('util').inspect(response, { depth: 3, colors: true }))
+  })
+  throw err
+}

src/test/async.js

 'use strict'
-const test = require('test-runner')
+const TestRunner = require('test-runner')
 const jsdoc2md = require('../../')
@@ -7,5 +7,6 @@ const a = require('assert')
 
+const runner = new TestRunner()
 const inputFile = 'src/test/fixture/ignore.js'
 
-test('.render({ files })', function () {
+runner.test('.render({ files })', function () {
   return jsdoc2md.render({ files: inputFile, cache: false })
@@ -15,3 +16,3 @@ .then(result => a.ok(/a visible global/.test(result)))
 
-test('.render({ files, heading-depth: 4 })', function () {
+runner.test('.render({ files, heading-depth: 4 })', function () {
   return jsdoc2md.render({ files: inputFile, cache: false, 'heading-depth': 4 })
@@ -21,3 +22,3 @@ .then(result => a.ok(/#### visible/.test(result)))
 
-test('.render({ files, param-list-format: list })', function () {
+runner.test('.render({ files, param-list-format: list })', function () {
   const inputFile = 'src/test/fixture/params.js'
@@ -28,3 +29,3 @@ return jsdoc2md.render({ files: inputFile, cache: false, 'param-list-format': 'list' })
 
-test('.getTemplateData({ files })', function () {
+runner.test('.getTemplateData({ files })', function () {
   return jsdoc2md.getTemplateData({ files: inputFile, cache: false })
@@ -34,5 +35,5 @@ .then(result => a.ok(result[0].id))
 
-test('.getJsdocData({ files })', function () {
+runner.test('.getJsdocData({ files })', function () {
   return jsdoc2md.getJsdocData({ files: inputFile, cache: false })
     .then(result => a.ok(result[0].longname))
 })

src/test/cli.js

 'use strict'
-const test = require('test-runner')
+const TestRunner = require('test-runner')
 const fs = require('fs')
@@ -7,2 +7,3 @@ const spawn = require('child_process').spawn
 
+const runner = new TestRunner()
 const inputPath = 'src/test/fixture/ignore.js'
@@ -16,3 +17,3 @@
 
-test('cli: json option', function () {
+runner.test('cli: json option', function () {
   const outputFile = fs.openSync('tmp/ignore.json', 'w')
@@ -19,0 +20,0 @@ return new Promise((resolve, reject) => {

src/test/sync.js

 'use strict'
-const test = require('test-runner')
+const TestRunner = require('test-runner')
 const jsdoc2md = require('../../')
@@ -7,6 +7,7 @@ const a = require('assert')
 
+const runner = new TestRunner()
 const inputFile = 'src/test/fixture/ignore.js'
 
 if (require('child_process').spawnSync) {
-  test('.renderSync({ files })', function () {
+  runner.test('.renderSync({ files })', function () {
     const result = jsdoc2md.renderSync({ files: inputFile, cache: false })
@@ -16,3 +17,3 @@ a.ok(/a visible global/.test(result))
 
-  test('.renderSync({ files, heading-depth: 4 })', function () {
+  runner.test('.renderSync({ files, heading-depth: 4 })', function () {
     const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'heading-depth': 4 })
@@ -22,3 +23,3 @@ a.ok(/#### visible/.test(result))
 
-  test('.renderSync({ files }, { param-list-format: list })', function () {
+  runner.test('.renderSync({ files }, { param-list-format: list })', function () {
     const inputFile = 'src/test/fixture/params.js'
@@ -29,3 +30,3 @@ const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'param-list-format': 'list' })
 
-  test('.getTemplateDataSync({ files })', function () {
+  runner.test('.getTemplateDataSync({ files })', function () {
     const result = jsdoc2md.getTemplateDataSync({ files: inputFile, cache: false })
@@ -35,3 +36,3 @@ a.ok(result[0].id)
 
-  test('.getJsdocDataSync({ files })', function () {
+  runner.test('.getJsdocDataSync({ files })', function () {
     const result =  jsdoc2md.getJsdocDataSync({ files: inputFile, cache: false })
@@ -38,0 +39,0 @@ a.ok(result[0].longname)

No alert changes

Improved metrics

Total package byte prevSize

62782

increased by2.09%

Number of package files

27

increased by3.85%

Lines of code

1162

increased by3.29%

Dependency changes

• + Addedcommand-line-commands@1.0.4(transitive)

• + Addedjsdoc-api@2.0.6(transitive)

• + Addedreq-then@0.4.1(transitive)

• + Addedusage-stats@0.3.2(transitive)

• - Removedasap@2.0.6(transitive)

• - Removedjsdoc-api@1.2.4(transitive)

• - Removedpromise@7.3.1(transitive)

• - Removedpromise.prototype.finally@1.0.1(transitive)

• - Removedreq-then@0.3.4(transitive)

• - Removedthen-fs@2.0.0(transitive)

• - Removedusage-stats@0.2.1(transitive)

• Updatedconfig-master@^2.0.4

• Updatedjsdoc-api@^2.0.1

• Updatedusage-stats@^0.3.1