Skip to content

Releases: TypeStrong/typedoc

Option Parsing Fix

11 Jan 01:57
Compare
Choose a tag to compare

Fixes a bug where non-standard tsconfig.json and typedoc.json files were not located.

Fixes 🐛

  • Don't limit option files to standard names (#944)

TypeScript 3.2

03 Jan 17:00
Compare
Choose a tag to compare

Breaking Changes ⚠️

  • Output changed from es5 to es2015
    • Plugins may need to output es2015 if extending classes (#845 comment)
  • Known issue with --options argument parsing (#942) (fixed in v0.14.1)

Features ✨

  • Upgrade TypeScript to 3.2 (#922)
  • Add support for source links on GitHub enterprise instances (#843)
  • Improved reflection conversion performance (#890)

Fixes 🐛

  • Corrected JSON signature generation to return arrays (#721)
  • Added declarationMap to list of ignored tsconfig options. (#871)
  • Fix missing reflection flags in JSON output (#889)
  • General correction of glob patterns and config file locating (#742)
  • Avoid documenting excluded files. (#896)
  • Fix module merging with class (#876)

Documentation help 📖

  • fix README contribution guide link
  • Update README.md links (#909)
  • Add/improve tsdoc comments on a lot of core classes (#915)

Changed 📦

  • Use mocha's "before" instead of "it" to setup the App. (#874)
  • Enable strict null checks! (#845)
  • Remove greenkeeper badge from readme (#886)
  • Fix gitattributes. (#872)
  • Fix indentation rules in .editorconfig (#916)
  • Add test for let x: Promise<object> (#881)

Thanks 👏

Thanks to those who identified issues and for the following code contributors:

TypeScript 3.1

10 Oct 14:56
Compare
Choose a tag to compare

Thanks to everyone for their patience in getting this release out. TypeScript 3.1 is now supported.

Features ✨

  • Upgrade TypeScript to 3.1 (#863)
  • Allow exclusion of directories starting with a dot (#711)

Fixes 🐛

  • Deactivate theme resources correctly (#865)
  • Don't throw an error when adding plugins repeatedly (#847)

Changed 📦

  • Stricter lint config (#840)
  • Use dummy readme when testing the renderer (#857)

Documentation help 📖

  • Add contributing.md (#841)
  • Add localization plugin to readme.md (#850)

Thanks 👏

TypeScript 3.0

17 Aug 20:08
Compare
Choose a tag to compare

Thanks to everyone for their patience in getting this release out. TypeScript 3.0 is now supported.

Features ✨

  • Support for scoped npm plugins (#736)
  • Add @ignore as an alias @hidden (#750)
  • Traverse symlinked node_modues when scanning for plugins (#756)
  • Flatten messageText when no file is provided in diagnostic log output (#802)
  • Update typescript to 3.0 (#832)
  • Allow installing from git repo (#834)

Fixes 🐛

  • Fix interface merging flagged as static (#807)

Changed 📦

  • Mock plugins in tests (#726)
  • Correct running of tests (#762)
  • Rebuild specs (3716ba7)
  • Bump CI tests to node v6 & v10 (f75f378)

Documentation help 📖

  • Note tsconfig argument (#734)
  • Fix link to markedjs repo (#767)

Thanks 👏

Special thanks to the following contributors

Dependency Updates

09 Mar 05:08
Compare
Choose a tag to compare

Updates TypeScript to v2.7.2

Major Bug Fixes

05 Mar 07:13
Compare
Choose a tag to compare

Fixes 🐛

  • Correct null varible errors when using --excludeNotExported (#694 #716)
  • Don't write BOM in search index file (#705)
  • Correct argument handling (#610)

Changed 📦

  • Update copyright year (#715)

Breaking change ❗

Changes to the argument handling (#610) will fix sever issues with passing options to TypeDoc. However, since the current functionality has been published for a significant period of time, this may be a breaking change to some users.

Thanks 👏

Special thanks to the following contributors

TypeScript 2.7

01 Feb 11:44
Compare
Choose a tag to compare

Features ✨

  • Type operator type (#614)
  • Abstract, Const, and Let reflection flags (#611)
  • Support for generic type aliases (#622)
  • --excludeProtected option (#666)
  • Allow multiple excludes (#592)
  • TypeScript 2.7.1 support (#689)

Fixes 🐛

  • Make traverse safe for delete operations (#640)
  • Correctly remove components (#664)
  • Fix --plugin argument passing

Changed 📦

  • Refactor JSON serializers (#597)

Thanks 👏

Special thanks to the following contributors

Argument Specificity

06 Oct 03:40
Compare
Choose a tag to compare

Added

  • Use TypeScript project option (#588)
  • Support constructor parameters with readonly flag (#584)
  • Respect absolute URLs when rendering (#593)
  • Support @category tag (#566)
  • Export additional classes (#535)
  • Support ES2015-style exports for plugins (#594)

Changed

  • Improve argument order specificity (#587)
  • Gracefully handle GitHub plugin git exec failures (#545)

Fixed

  • Fix --tsconfig help description (#575)
  • Fix type converter removal (#581)
  • Fix enum type conversion (#591)

TypeScript 2.4

27 Jul 17:23
Compare
Choose a tag to compare

Changed

  • Update to TypeScript 2.4
  • Omit TypeScript help output from --help

Check for `symbol.declarations`

25 Jul 20:52
Compare
Choose a tag to compare

Fixed

  • Check for symbol.declarations before crashing