jsdoc-to-markdown - npm Package Compare versions

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

es5/bin/cli.js

@@ -11,2 +11,6 @@ 'use strict';
 
+if (options['no-cache']) {
+  options.cache = false;
+}
+
 if (options.help) {
@@ -13,0 +17,0 @@ tool.printOutput(cli.usage);

es5/lib/cli-data.js

@@ -33,7 +33,3 @@ 'use strict';
   description: "Clears the cache."
-}, {
-  name: 'no-usage-stats', type: Boolean
-}, {
-  name: 'debug', type: Boolean
-}];
+}, { name: 'no-usage-stats', type: Boolean }, { name: 'debug', type: Boolean }, { name: 'no-cache', type: Boolean }];
 
@@ -111,3 +107,3 @@ var dmdDefinitions = [{ name: 'template', alias: 't', type: String, typeLabel: '<file>',
     optionList: jsdoc2mdDefinitions,
-    hide: ['no-usage-stats', 'debug']
+    hide: ['no-usage-stats', 'debug', 'no-cache']
   }, {
@@ -114,0 +110,0 @@ header: 'jsdoc options',

es5/lib/jsdoc-to-markdown.js

@@ -9,6 +9,15 @@ 'use strict';
 var UsageStats = require('usage-stats');
-var usageStats = new UsageStats({
-  appName: 'jsdoc2md',
+var homePath = require('home-path');
+var path = require('path');
+
+var cacheDir = path.resolve(homePath(), '.jsdoc2md');
+var jsdocApi = require('jsdoc-api');
+var dmd = require('dmd');
+jsdocApi.cache.dir = path.resolve(cacheDir, 'jsdoc-api');
+dmd.cache.dir = path.resolve(cacheDir, 'dmd');
+
+var usageStats = new UsageStats('UA-70853320-3', {
+  name: 'jsdoc2md',
   version: version,
-  tid: 'UA-70853320-3'
+  dir: cacheDir
 });
@@ -42,6 +51,5 @@
   options = options || {};
-  var dmd = require('dmd').async;
   var dmdOptions = new DmdOptions(options);
   return getTemplateData(options).then(function (templateData) {
-    return dmd(templateData, dmdOptions);
+    return dmd.async(templateData, dmdOptions);
   });
@@ -52,3 +60,2 @@ }
   options = options || {};
-  var dmd = require('dmd');
   var dmdOptions = new DmdOptions(options);
@@ -73,3 +80,2 @@ return dmd(getTemplateDataSync(options), dmdOptions);
   options = options || {};
-  var jsdocApi = require('jsdoc-api');
   var jsdocOptions = new JsdocOptions(options);
@@ -81,3 +87,2 @@ return jsdocApi.explain(jsdocOptions);
   options = options || {};
-  var jsdocApi = require('jsdoc-api');
   var jsdocOptions = new JsdocOptions(options);
@@ -88,4 +93,2 @@ return jsdocApi.explainSync(jsdocOptions);
 function clear() {
-  var jsdocApi = require('jsdoc-api');
-  var dmd = require('dmd');
   return jsdocApi.cache.clear().then(function () {
@@ -100,4 +103,5 @@ return dmd.cache.clear();
   options = options || {};
-  this.cache = true;
 
+  this.cache = options.cache === undefined ? true : options.cache;
+
   this.files = options.files;
@@ -147,3 +151,5 @@
 function stats(screenName, options, command, sync) {
-  if (options && options['no-usage-stats']) {
+  options = options || {};
+
+  if (options['no-usage-stats']) {
     usageStats.disable();
@@ -150,0 +156,0 @@ return command(options);

es5/test/async.js

@@ -11,3 +11,3 @@ 'use strict';
 test('.render({ files })', function () {
-  return jsdoc2md.render({ files: inputFile }).then(function (result) {
+  return jsdoc2md.render({ files: inputFile, cache: false }).then(function (result) {
     return a.ok(/a visible global/.test(result));
@@ -18,3 +18,3 @@ });
 test('.render({ files, heading-depth: 4 })', function () {
-  return jsdoc2md.render({ files: inputFile, 'heading-depth': 4 }).then(function (result) {
+  return jsdoc2md.render({ files: inputFile, cache: false, 'heading-depth': 4 }).then(function (result) {
     return a.ok(/#### visible/.test(result));
@@ -26,3 +26,3 @@ });
   var inputFile = 'src/test/fixture/params.js';
-  return jsdoc2md.render({ files: inputFile, 'param-list-format': 'list' }).then(function (result) {
+  return jsdoc2md.render({ files: inputFile, cache: false, 'param-list-format': 'list' }).then(function (result) {
     return a.ok(/- one/.test(result));
@@ -33,5 +33,11 @@ });
 test('.getTemplateData({ files })', function () {
-  return jsdoc2md.getTemplateData({ files: inputFile }).then(function (result) {
+  return jsdoc2md.getTemplateData({ files: inputFile, cache: false }).then(function (result) {
     return a.ok(result[0].id);
   });
+});
+
+test('.getJsdocData({ files })', function () {
+  return jsdoc2md.getJsdocData({ files: inputFile, cache: false }).then(function (result) {
+    return a.ok(result[0].longname);
+  });
 });

es5/test/cli.js

@@ -17,3 +17,3 @@ 'use strict';
   return new Promise(function (resolve, reject) {
-    var handle = spawn('node', ['bin.js', '--no-usage-stats', '--json', inputPath], { stdio: ['ignore', outputFile, 'ignore'] });
+    var handle = spawn('node', ['bin.js', '--no-usage-stats', '--no-cache', '--json', inputPath], { stdio: ['ignore', outputFile, 'ignore'] });
     handle.on('close', function () {
@@ -20,0 +20,0 @@ var json = fs.readFileSync('tmp/ignore.json', 'utf8');

es5/test/sync.js

@@ -12,3 +12,3 @@ 'use strict';
   test('.renderSync({ files })', function () {
-    var result = jsdoc2md.renderSync({ files: inputFile });
+    var result = jsdoc2md.renderSync({ files: inputFile, cache: false });
     a.ok(/a visible global/.test(result));
@@ -18,3 +18,3 @@ });
   test('.renderSync({ files, heading-depth: 4 })', function () {
-    var result = jsdoc2md.renderSync({ files: inputFile, 'heading-depth': 4 });
+    var result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'heading-depth': 4 });
     a.ok(/#### visible/.test(result));
@@ -25,3 +25,3 @@ });
     var inputFile = 'src/test/fixture/params.js';
-    var result = jsdoc2md.renderSync({ files: inputFile, 'param-list-format': 'list' });
+    var result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'param-list-format': 'list' });
     a.ok(/- one/.test(result));
@@ -31,5 +31,10 @@ });
   test('.getTemplateDataSync({ files })', function () {
-    var result = jsdoc2md.getTemplateDataSync({ files: inputFile });
+    var result = jsdoc2md.getTemplateDataSync({ files: inputFile, cache: false });
     a.ok(result[0].id);
   });
+
+  test('.getJsdocDataSync({ files })', function () {
+    var result = jsdoc2md.getJsdocDataSync({ files: inputFile, cache: false });
+    a.ok(result[0].longname);
+  });
 }

package.json

 {
   "name": "jsdoc-to-markdown",
   "author": "Lloyd Brookes",
-  "version": "2.0.0-alpha.10",
+  "version": "2.0.0-alpha.11",
   "description": "jsdoc-annotated source in, markdown API docs out.",
@@ -34,5 +34,6 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown",
     "feature-detect-es6": "^1.3.1",
+    "home-path": "^1.0.3",
     "jsdoc-api": "^1.2.4",
     "jsdoc-parse": "^2.0.5-0",
-    "usage-stats": "^0.1.5",
+    "usage-stats": "^0.2.1",
     "walk-back": "^2.0.1"
@@ -43,3 +44,3 @@ },
     "coveralls": "^2.11.12",
-    "test-runner": "^0.1.11"
+    "test-runner": "^0.1.12"
   },
@@ -46,0 +47,0 @@ "standard": {

src/bin/cli.js

@@ -10,2 +10,7 @@ 'use strict'
 
+/* jsdoc2md --no-cache */
+if (options['no-cache']) {
+  options.cache = false
+}
+
 /* jsdoc2md --help */
@@ -12,0 +17,0 @@ if (options.help) {

src/lib/cli-data.js

@@ -46,8 +46,5 @@ 'use strict'
   },
-  {
-    name: 'no-usage-stats', type: Boolean
-  },
-  {
-    name: 'debug', type: Boolean
-  }
+  { name: 'no-usage-stats', type: Boolean },
+  { name: 'debug', type: Boolean },
+  { name: 'no-cache', type: Boolean }
 ]
@@ -158,3 +155,3 @@
       optionList: jsdoc2mdDefinitions,
-      hide: [ 'no-usage-stats', 'debug' ]
+      hide: [ 'no-usage-stats', 'debug', 'no-cache' ]
     },
@@ -161,0 +158,0 @@ {

src/lib/jsdoc-to-markdown.js

 'use strict'
 const version = require('../../package').version
 const UsageStats = require('usage-stats')
-const usageStats = new UsageStats({
-  appName: 'jsdoc2md',
+const homePath = require('home-path')
+const path = require('path')
+
+const cacheDir = path.resolve(homePath(), '.jsdoc2md')
+const jsdocApi = require('jsdoc-api')
+const dmd = require('dmd')
+jsdocApi.cache.dir = path.resolve(cacheDir, 'jsdoc-api')
+dmd.cache.dir = path.resolve(cacheDir, 'dmd')
+
+const usageStats = new UsageStats('UA-70853320-3', {
+  name: 'jsdoc2md',
   version: version,
-  tid: 'UA-70853320-3'
+  dir: cacheDir
 })
@@ -57,6 +66,5 @@
   options = options || {}
-  const dmd = require('dmd').async
   const dmdOptions = new DmdOptions(options)
   return getTemplateData(options)
-    .then(templateData => dmd(templateData, dmdOptions))
+    .then(templateData => dmd.async(templateData, dmdOptions))
 }
@@ -77,3 +85,2 @@
   options = options || {}
-  const dmd = require('dmd')
   const dmdOptions = new DmdOptions(options)
@@ -125,3 +132,2 @@ return dmd(getTemplateDataSync(options), dmdOptions)
   options = options || {}
-  const jsdocApi = require('jsdoc-api')
   const jsdocOptions = new JsdocOptions(options)
@@ -141,3 +147,2 @@ return jsdocApi.explain(jsdocOptions)
   options = options || {}
-  const jsdocApi = require('jsdoc-api')
   const jsdocOptions = new JsdocOptions(options)
@@ -153,4 +158,2 @@ return jsdocApi.explainSync(jsdocOptions)
 function clear () {
-  const jsdocApi = require('jsdoc-api')
-  const dmd = require('dmd')
   return jsdocApi.cache.clear().then(() => dmd.cache.clear())
@@ -165,5 +168,9 @@ }
     options = options || {}
-    this.cache = true
 
     /**
+     * Set to false to disable memoisation cache. Defaults to true.
+     */
+    this.cache = options.cache === undefined ? true : options.cache
+
+    /**
      * One or more filenames to process. Either this or `source` must be supplied.
@@ -297,4 +304,5 @@ * @type {string|string[]}
 function stats (screenName, options, command, sync) {
+  options = options || {}
   /* when disabled, all usageStats methods are no-ops */
-  if (options && options['no-usage-stats']) {
+  if (options['no-usage-stats']) {
     usageStats.disable()
@@ -301,0 +309,0 @@ return command(options)

src/test/async.js

@@ -10,3 +10,3 @@ 'use strict'
 test('.render({ files })', function () {
-  return jsdoc2md.render({ files: inputFile })
+  return jsdoc2md.render({ files: inputFile, cache: false })
     .then(result => a.ok(/a visible global/.test(result)))
@@ -16,3 +16,3 @@ })
 test('.render({ files, heading-depth: 4 })', function () {
-  return jsdoc2md.render({ files: inputFile, 'heading-depth': 4 })
+  return jsdoc2md.render({ files: inputFile, cache: false, 'heading-depth': 4 })
     .then(result => a.ok(/#### visible/.test(result)))
@@ -23,3 +23,3 @@ })
   const inputFile = 'src/test/fixture/params.js'
-  return jsdoc2md.render({ files: inputFile, 'param-list-format': 'list' })
+  return jsdoc2md.render({ files: inputFile, cache: false, 'param-list-format': 'list' })
     .then(result => a.ok(/- one/.test(result)))
@@ -29,4 +29,9 @@ })
 test('.getTemplateData({ files })', function () {
-  return jsdoc2md.getTemplateData({ files: inputFile })
+  return jsdoc2md.getTemplateData({ files: inputFile, cache: false })
     .then(result => a.ok(result[0].id))
 })
+
+test('.getJsdocData({ files })', function () {
+  return jsdoc2md.getJsdocData({ files: inputFile, cache: false })
+    .then(result => a.ok(result[0].longname))
+})

src/test/cli.js

@@ -20,3 +20,3 @@ 'use strict'
       'node',
-      [ 'bin.js', '--no-usage-stats', '--json', inputPath ],
+      [ 'bin.js', '--no-usage-stats', '--no-cache', '--json', inputPath ],
       { stdio: [ 'ignore', outputFile, 'ignore' ] }
@@ -23,0 +23,0 @@ )

src/test/sync.js

@@ -11,3 +11,3 @@ 'use strict'
   test('.renderSync({ files })', function () {
-    const result = jsdoc2md.renderSync({ files: inputFile })
+    const result = jsdoc2md.renderSync({ files: inputFile, cache: false })
     a.ok(/a visible global/.test(result))
@@ -17,3 +17,3 @@ })
   test('.renderSync({ files, heading-depth: 4 })', function () {
-    const result = jsdoc2md.renderSync({ files: inputFile, 'heading-depth': 4 })
+    const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'heading-depth': 4 })
     a.ok(/#### visible/.test(result))
@@ -24,3 +24,3 @@ })
     const inputFile = 'src/test/fixture/params.js'
-    const result = jsdoc2md.renderSync({ files: inputFile, 'param-list-format': 'list' })
+    const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'param-list-format': 'list' })
     a.ok(/- one/.test(result))
@@ -30,5 +30,10 @@ })
   test('.getTemplateDataSync({ files })', function () {
-    const result = jsdoc2md.getTemplateDataSync({ files: inputFile })
+    const result = jsdoc2md.getTemplateDataSync({ files: inputFile, cache: false })
     a.ok(result[0].id)
   })
+
+  test('.getJsdocDataSync({ files })', function () {
+    const result =  jsdoc2md.getJsdocDataSync({ files: inputFile, cache: false })
+    a.ok(result[0].longname)
+  })
 }

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

61494

increased by2.65%

Lines of code

1125

increased by2.18%

Worsened metrics

Dependency count

11

increased by10%

Dependency changes

• + Addedhome-path@^1.0.3

• + Addedhome-path@1.0.7(transitive)

• + Addedusage-stats@0.2.1(transitive)

• - Removedusage-stats@0.1.5(transitive)

• Updatedusage-stats@^0.2.1