christopherthielen / typedoc-plugin-external-module-name

Specify the Typedoc Module of a file using @module annotation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Breaking Change incoming from Typedoc master change to getJSDocCommentRanges

stevenalanstark opened this issue · comments

This commit to typedoc will break things once it's pulled in here:

TypeStrong/typedoc@26202da#diff-166f9f38d3914bf0531440336664ea68R102

Currently, this isn't a dependency on this project.

In my fork, I have fixed this by copying the whole getJSDocCommentRanges into getRawComments, but that is very much overkill.

It looks as if the intent is to make this function internal only, and not part of the _ts API

Seems like this issue can be transformed to bug.
Latest typedoc (0.15.0) does not work with latest plugin version (2.1.0).

You have to create comment right after @module declaration to detect it.
(reference: #6)

Does anyone have a sense of how feasible it is to fix this? I am completely unfamiliar with typedoc or this plugin but if nobody else is looking into it I could have a go. We updated to TypeScript 3.7, which requires us to use the newest version of typedoc, which prevents us from using this plugin.

commented

Will we need @packageDescription?

@williamkbentley Yes.

It looks like that's the direction the TypeDoc team is taking that issue so that's what I'm recommending as well. I've updated the README and release notes to indicate this.

commented

Works for me! Thanks for the hard work