4.0.6

4.0.6 (2021-01-04)

Compare typedoc-plugin-external-module-name versions 4.0.5 and 4.0.6

Bug Fixes

• preferred: Fix preferred flag on modules (83a3281), closes #554

4.0.5

4.0.5 (2020-12-20)

Compare typedoc-plugin-external-module-name versions 4.0.4 and 4.0.5

Bug Fixes

• Do not crash when typedoc "disableSources" option is true (this turns off automatic module name feature) (8cfb30c), closes #507

4.0.4

4.0.4 (2020-12-17)

Compare typedoc-plugin-external-module-name versions 4.0.3 and 4.0.4

Bug Fixes

• If automatic name guesses '.', rename to 'root' instead. (52bb52c)
• rootFileNames can be an empty array. Use current dir as the base path instead of blowing up. (f3c75dd), closes #548

Features

• allow .cjs and .mjs extensions for custom mapping function file to accomodate "type": "module" in package.json (f47f8ec)
• support typedoc 0.19 (f787640)

4.0.3

4.0.3 (2020-06-06)

Compare typedoc-plugin-external-module-name versions 4.0.2 and 4.0.3

Bug Fixes

• windows: when calculating the common prefix, always use path.resolve() to map to native path separator, i.e. "" (09b2090)

4.0.2

4.0.2 (2020-06-06)

Compare typedoc-plugin-external-module-name versions 4.0.1 and 4.0.2

Bug Fixes

• Use the common parent directory of all entrypoints as the relative path to guess module names (f790eee)

4.0.1

4.0.1 (2020-06-05)

Compare typedoc-plugin-external-module-name versions 4.0.0 and 4.0.1

Features

• Add a --disableAutoModuleName flag (a8561e0)

4.0.0

4.0.0 (2020-05-31)

Compare typedoc-plugin-external-module-name versions 3.1.0 and 4.0.0

Features

• merge modules from the same directory into a single module by default (fd03f0b)
• Support a .typedoc-plugin-external-module-name.js file for custom generation of module names based on the reflection itself (ca0a9c7), closes #423

Bug Fixes

• fix createChildReflection ReflectionKind for typedoc < 0.17 (now creates a 0.17 Module, not a Namespace) (fc6b2b4)

BREAKING CHANGES

• This plugin now automatically applies a Module Name based on the file path.
  

3.1.0

3.1.0 (2020-04-27)

Compare typedoc-plugin-external-module-name versions 3.0.0 and 3.1.0

Features

• build with typedoc 0.17 and expand peerDependency semver range to include 0.17.x (00f0f96)

Bug Fixes

• < 0.17.0 fix isModuleOrNamespace compat (1ef1ad3)
• Re-add compatibility for typedoc < 0.17.0 (c255f1e)

3.0.0

3.0.0 (2020-01-16)

Compare typedoc-plugin-external-module-name versions 2.2.1 and 3.0.0

Bug Fixes

• emptycomment: Remove empty comments on source reflections that are being merged, just in case.. not sure if this is even necessary! (bd9b5cd)
• typedoc0.16: Some fixes for 0.16.x (WIP) (0089d19)

Features

• typedoc0.16.4: Support typedoc 0.16.4 (02aa15a)

BREAKING CHANGE

This plugin no longer attempts to work around the two comment problem in order to identify a comment as module documentation. I recommend using the @packageDocumentation annotation going forward. The issue comment states that TypeDoc will continue to support the two comment legacy mechanism.

Before:

/** @module foo */

After:

/** @packageDocumentation @module foo */

or

/** @packageDocumentation @module foo */ /** for typedoc */

2.2.1

2.2.1 (2020-01-15)

Compare typedoc-plugin-external-module-name versions 2.1.0 and 2.2.1

This release reduces semver compatibility to "typedoc": ">=0.7.0 <0.15.0" (between 0.7.0 and 0.14.x)

Bug Fixes

• module: Remove empty comment blocks of merge target modules (c800a22), closes #142
• reflections: Update symbol mappings for merged modules (248b806), closes #313 #193
• typedoc-0.14: Improve typedoc 0.14.0 compatibility to account for api change (68fc6e1)