typedoc-plugin-rename-defaults

0.7.0 • Public • Published

typedoc-plugin-rename-defaults

A TypeDoc plugin that renames the default exports to their original name.

Why?

Since TypeDoc 0.20, the default exports fields do not get documented with their original names, but with the name "default". This plugin restores the behavior of TypeDoc 0.19 by keeping the original field name in the documentation. See typedoc#1521 for more context.

Usage

Install the plugin:

npm install --save-dev typedoc-plugin-rename-defaults

Then, add --plugin typedoc-plugin-rename-defaults (required since TypeDoc 0.24) and --entrypointStrategy expand (required since TypeDoc 0.22) to the typedoc command. Example:

// package.json

{
  "scripts": {
    "build-docs": "typedoc --plugin typedoc-plugin-rename-defaults --entryPointStrategy expand src/"
  }
}

Credits

The initial implementation of this plugin was proposed by @Gerrit0 at typedoc#1521.

Package Sidebar

Install

npm i typedoc-plugin-rename-defaults

Weekly Downloads

16,849

Version

0.7.0

License

MIT

Unpacked Size

4.77 kB

Total Files

4

Last publish

Collaborators

  • felipecrs