@zamiell/typedoc-plugin-not-exported not working with latest version of TypeDoc

[alexdametto]

Search Terms

plugin, not-exported, documentation

Problem

The documentation is listing @zamiell/typedoc-plugin-not-exported (v0.3.0) in the plugins section for TypeDoc, but this is not compatible with the latest version of TypeDoc (v0.28.8, but we had this issue also on v0.28.5).

TypeDoc exiting with unexpected error:
TypeError: context.project.getSymbolFromReflection is not a function
    at lookForFakeExports (node_modules/@zamiell/typedoc-plugin-not-exported/dist/main.js:39:44)
    at Converter.trigger (node_modules/typedoc/dist/lib/utils-common/events.js:46:13)
    at Context.finalizeDeclarationReflection (node_modules/typedoc/dist/lib/converter/context.js:165:24)
    at Converter.convertExports (node_modules/typedoc/dist/lib/converter/converter.js:460:25)
    at Converter.compile (node_modules/typedoc/dist/lib/converter/converter.js:435:22)
    at Converter.convert (node_modules/typedoc/dist/lib/converter/converter.js:311:18)
    at Application.convert (node_modules/typedoc/dist/lib/application.js:364:44)
    at run (node_modules/typedoc/dist/lib/cli.js:68:31)
    at main (node_modules/typedoc/dist/lib/cli.js:25:32)

Suggested Solution

I guess you could:

• remove it from the plugins page
• contact the developer to update and maintain the library
• implement the @notExported in typedoc itself (this would be nice)

[Gerrit0]

Notice that the plugin is listed under the 0.26 heading, not 0.28. Plugins listed only under an older version aren't expected to work with the latest version.

The plugin will not be added to typedoc itself. It produces behavior useful to some, but which contradicts TypeDoc's intended purpose of documenting a library's public API.