typedoc-plugin-resolve-by-name

A plugin for TypeDoc that enables unresolved type reflections to be resolved using only their name (as opposed to their fully qualified identifier).

Caution: If all exported type/interface/function/class/etc names are not unique within your project, results may be unpredictable.

Installation

npm i -D typedoc-plugin-resolve-by-name typedoc
# yarn add -D typedoc-plugin-resolve-by-name typedoc 

Usage

TypeDoc automatically loads all installed plugins, so just run the typedoc command:

npx typedoc
# yarn typedoc 

Example

Example typedoc.js file (in project root):

module.exports = {
  name: 'PROJECT NAME',
  mode: 'modules',
  out: 'docs',
  exclude: [
    // exclude index.ts files to ignore re-exports
    '**/index.ts',
    // exclude node_modules directories
    '**/node_modules/**',
    // exclude built output from tsc
    '**/packages/**/lib/**',
    // exclude files in __tests__ directories
    '**/__tests__/**',
    // exclude unit tests
    '**/*.test.ts'
  ],
  excludePrivate: true,
  excludeProtected: true,
  excludeExternals: true,
  excludeNotExported: true
};

License

MIT

Author

Adam Jarret