TypeDoc doesn't render comments with Handlebars 4.6.0

[socsieng]

• I have checked issues with bug label and found no duplicates

Expected Behavior

Comments should be rendered when generating documents using globally installed typedoc. (i.e. npm install typedoc --global)

Note that it works as expected when installed locally.

# doesn't work - documentation rendered without comments
typedoc --out docs

# works - documentation rendered with comments
node_modules/.bin/typedoc --out docs

Expected:

Actual Behavior

Comments aren't included when run using typedoc global install.

The comment section is missing from the html output:

<section class="tsd-panel tsd-comment">
  <div class="tsd-comment tsd-typography">
    <div class="lead">
      <p>Base class for animals</p>
    </div>
  </div>
</section>

Steps to reproduce the bug

Command:

npm install typedoc --global

git clone https://github.com/socsieng/typedoc-plugin-typescript-declaration.git
cd typedoc-plugin-typescript-declaration/example
typedoc --out docs
open docs/classes/_index_.example.animal.html

Environment

• Typedoc version: 0.15.6
• Node.js version: 8.16.0
• npm version: 6.4.1
• nvm version: 0.34.0
• OS: macOS Catalina 10.15.1 (19B88)

[jeremyrea]

I'm experiencing a similar issue, although it's the local installation that's not rendering the comments in the HTML output.

When I add the --json flag, I can see that my tags and shortText are properly picked-up in the object's comment property.

[kobezzza]

+1

[Gerrit0]

This is.... really weird. I can confirm the global/local issue, no idea what's causing it yet. Looking into it.

@jeremyrea could you provide a repo with a repro for the issue when run locally?

[Gerrit0]

It seems like the global install has been broken for a long time... TypeDoc@0.10.0 also has this issue.

[jeremyrea]

@Gerrit0 https://github.com/jeremyrea/typedoc-comment-repro

Let me know how it goes or if there's anything else I can do.

[Gerrit0]

Looks like Handlebars is the cause of this break (global + local I'm guessing, I bet the local install that works has a lower version of handlebars pinned in package-lock.json) - handlebars-lang/handlebars.js#1633...

I'm not exactly sure how we should go about fixing this... listing out all of the prototype methods that we expect a template (as suggested in the handlebars PR) to be able to access isn't feasible and is very likely to break in the future whenever a new method is added.

For now, I'll pin handlebars to a lower version and release a patch with that change.

[Gerrit0]

Fixed in v0.15.7, thanks for the report @socsieng + @jeremyrea!

Leaving this open to track finding a better solution. I don't want to be stuck on an old version of handlebars forever.

[socsieng]

Thanks @Gerrit0, can confirm that it works for me.

[nknapp]

Handlebars 4.7.0 has been release with options to disable prototype restrictions:
https://handlebarsjs.com/api-reference/runtime-options.html#options-to-control-prototype-access

[Gerrit0]

Thanks @nknapp!

I'll release 0.15.8 with a handlebars version bump to 4.7.0 later today :)

[Gerrit0]

v0.15.8 is released

[PFight]

For those, who use old versions of typedoc, there workaround. Add -D handlebars@4.5.3 to npm install, or use "overrides" in package.json. For example:

npm i typedoc@0.11.1 -g -D handlebars@4.5.3