Docs for a class couldn't be generated after require statements

[niklauslee]

Successfully generates docs for the following code:

/**
 * A table object
 * @param {number} width
 * @param {number} height
 */
class Table {
  constructor(width, height) {
    this.width = width;
    this.height = height;
  }
}

But, just adding a require statement results that it couldn't generate docs for the Table class.

const _ = require('lodash')

/**
 * A table object
 * @param {number} width
 * @param {number} height
 */
class Table {
  constructor(width, height) {
    this.width = width;
    this.height = height;
  }
}

How can I fix this problem?

[tmcw]

These examples correctly produce the same documentation in my local environment. Can you elaborate on "it couldn't produce docs": is there an error, or is it blank? What version of documentation.js are you using, and how are you invoking it?

[niklauslee]

version is 4.0.0-rc1.

command I used is:

documentation build test.js -f html -o docs

Lint result is:

$ documentation lint test.js
/Users/niklaus/git/staruml-electron/test.js
  3:1  warning  could not determine @name for hierarchy

The generated docs files are attached.
docs.zip

[tmcw]

Okay, so to be clearer, the issue is that the require statement causes the name Table to be lost, but the documentation for Table is still there?

[niklauslee]

OK, I found the reason. The problem is resolved by adding semicolon to the last of the require statement. But, removing the semicolon causes the problem again.

I think this problem should be resolved. I'm using ESLint with JavsScript Standard Style. The standard style don't allow adding unnecessary semicolon in the last of statements.

So, please fix this problem in the next release :)

Thank you for your response.

[tmcw]

I certainly hope to, and agree that this is an important issue! Might I also suggest that, as a community project, you might be interested in helping out? You can test the AST that this example generates in astexplorer.net - most likely, if the AST changes depending on that semicolon but the JavaScript's behavior is the same, the appropriate resolution would be to file a bug report and testcase upstream at babylon's repository, the JavaScript parser that documentation.js uses.

[niklauslee]

I've just tested on astexplorer.net. In babylon-6.17.1 it works well. Current version of documentation is using babylon-6.11.4. So, I replaced the module by the new version babylon-6.17.1. It works well!!!. I think this problem can be resolved by just replacing the babylon by the new version.

[tmcw]

Thanks for digging in! I've just pushed a yarn.lock update that points to 6.17 and will momentarily bump the minimum required version in package.json. I'll publish this as soon as I finish up the backlog for rc2.

Thanks again - makes my day to get some help on this project 💕 !