Dmd now prints a warning if a malformed input data edge case is detec…

…ted. #89

Fixes a 'maximum call stack size exceeded' error.

bin/generate-partial-cache.js

@@ -0,0 +1,22 @@
+const FileSet = require('file-set')
+const fs = require('fs')
+const path = require('path')
+
+const fileSet = new FileSet()
+
+async function start () {
+  await fileSet.add('./partials/**/*.hbs')
+  const map = new Map()
+  for (const file of fileSet.files) {
+    map.set(
+      path.basename(file, '.hbs'),
+      fs.readFileSync(file, 'utf8') || ''
+    )
+  }
+  console.log('module.exports = ' + JSON.stringify(Array.from(map), null, '  '))
+}
+start()
+
+/*
+node bin/generate-partial-cache.js > partials/partial-cache.js
+*/

helpers/ddata.js

@@ -7,6 +7,8 @@ const where = require('test-value').where
 const flatten = require('reduce-flatten')
 const state = require('../lib/state')
 
+let malformedDataWarningIssued = false
+
 /**
  * ddata is a collection of handlebars helpers for working with the documentation data output by [jsdoc-parse](https://github.com/75lb/jsdoc-parse).
  * @module
@@ -447,7 +449,6 @@ function _orphans (options) {
  */
 function _identifiers (options) {
   const query = {}
-
   for (const prop in options.hash) {
     if (/^-/.test(prop)) {
       query[prop.replace(/^-/, '!')] = options.hash[prop]
@@ -472,6 +473,15 @@ return the identifiers which are a `memberof` this one. Exclude externals withou
 */
 function _children (options) {
   if (!this.id) return []
+  if (this.id === this.memberof) {
+    if (!malformedDataWarningIssued) {
+      console.warn('Jsdoc data looks malformed. Typically, this can be fixed by ensuring the sourcecode file has a `@module tag`. ')
+      console.warn('Please see the "Document an ES2015 module" section in the wiki')
+      console.warn('https://github.com/jsdoc2md/jsdoc-to-markdown/wiki')
+      malformedDataWarningIssued = true
+    }
+    return []
+  }
   const min = options.hash.min
   delete options.hash.min
   options.hash.memberof = this.id
@@ -501,10 +511,10 @@ function descendants (options) {
   const output = []
   function iterate (childrenList) {
     if (childrenList.length) {
-      childrenList.forEach(function (child) {
+      for (const child of childrenList) {
         output.push(child)
         iterate(_children.call(child, options))
-      })
+      }
     }
   }
   iterate(_children.call(this, options))

helpers/helpers.js

@@ -104,9 +104,10 @@ function tableRow () {
   const options = args.pop()
   const cols = args
   let output = ''
+  let data
 
   if (options.data) {
-    var data = handlebars.createFrame(options.data)
+    data = handlebars.createFrame(options.data)
     cols.forEach(function (col, index) {
       const colNumber = index + 1
       data['col' + colNumber] = containsData(rows, col)
@@ -305,12 +306,13 @@ function examples (options) {
   if (this.examples) {
     return this.examples.reduce(function (prev, example) {
       const lines = example.split(/\r\n|\r|\n/)
+      let exampleLangSubtag
 
       /* Process @lang */
       const exampleLangOptions = ddata.option('example-lang', options)
       let matches = lines[0].match(/@lang\s+(\w+)\s*/)
       if (matches) {
-        var exampleLangSubtag = matches[1]
+        exampleLangSubtag = matches[1]
         lines[0] = lines[0].replace(matches[0], '')
         if (lines[0].length === 0) {
           lines.splice(0, 1)

index.js

@@ -4,6 +4,7 @@ const DmdOptions = require('./lib/dmd-options')
 const dmdVersion = require('./package').version
 const FileSet = require('file-set')
 const os = require('os')
+const partialCache = require('./partials/partial-cache.js')
 
 /**
  * Transforms doclet data into markdown documentation.
@@ -77,8 +78,10 @@ async function generate (templateData, options) {
   state.templateData = templateData
   state.options = options
 
-  /* register all dmd partials. */
-  await registerPartials(path.resolve(__dirname, 'partials', '**', '*.hbs'))
+  /* register all internal dmd partials. */
+  for (const [name, content] of partialCache) {
+    handlebars.registerPartial(name, content)
+  }
 
   /* if plugins were specified, register the helpers/partials from them too */
   if (options.plugin) {

package.json

@@ -31,7 +31,7 @@
     "common-sequence": "^2.0.2",
     "file-set": "^6.0.1",
     "handlebars": "^4.7.8",
-    "marked": "^14.0.0",
+    "marked": "^14.1.0",
     "object-get": "^2.1.1",
     "reduce-flatten": "^3.0.1",
     "reduce-unique": "^2.0.1",