CHANGELOG.md

Unreleased

Features

• Added hooks which can be used to inject HTML without completely replacing a template, #1773. See the documentation in custom-themes.md for details.

Bug Fixes

• Actually fixed @category tag incorrectly appearing on function types if used on a type alias, #1745.
• Fix error in console when a page contains no documentation items.

v0.22.7 (2021-10-25)

Features

• Added support for GitHub enterprise projects with a githubprivate.com domain, #1743.
• Added support for GitLab repositories, #1728.

Bug Fixes

• Replaced O(n^2) with O(1) implementation for determining unique IDs in a rendered page, #1755.
• Fixed crash with when running in very large repositories, #1744.
• Fixed visible gap after footer in dark mode if hideGenerator is set, #1749.
• Fixed @category tag incorrectly appearing on function types if used on a type alias, #1745.
• Fixed incorrect JS to apply themes on page load, #1709 (again).
• Accessors and index signatures are now properly marked as inherited on declaration creation, #1742.

Thanks!

• @nlfurniss
• @RunDevelopment
• @srmagura

v0.22.6 (2021-10-17)

Features

• Added support for displaying identifiers & property access expressions in initializers, #1730.
• Expanded support for variables tagged with @enum to all variables whose property types are string literals, #1740.

Bug Fixes

• Fixed flash when navigating to a second page when OS theme does not match selected theme, #1709.
• Fixed improper quoting of as const style enums, #1727.
• Fixed handling of @typeParam on type aliases, #1733.
• Fixed handling of comment tags on function type aliases, #1734.
• Paths in warnings about non-exported symbols are now consistently displayed across platforms, #1738.

Thanks!

• @capraynor
• @srmagura

v0.22.5 (2021-10-02)

Features

• TypeDoc will now recognize @param comments for destructured parameters and rename __namedParameters to the name specified in the @param comment if the number of @param comments match the number of parameters, resolves #1703.
• The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo declared in src/utils/foo.ts is not exported.

  {
      "intentionallyNotExported": ["src/foo.ts:Foo"]
  }

• The --emit option can now be used to more finely control what TypeDoc will emit.

  Value	Behavior
  both	Emit both documentation and JS.
  docs	Emit documentation, but not JS (default).
  none	Emit nothing, just convert and run validation.
  true	Alias for both, for backwards compatibility. Will be removed in 0.23.
  false	Alias for docs, for backwards compatibility. Will be removed in 0.23.

Bug Fixes

• TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
• For compatibility with JSDoc, TypeDoc will now strip <caption> elements from @example tags, resolves #1679.
• TypeScript's emitDeclarationOnly compiler option is now supported, resolves #1716.
• Fixed discovery of tsconfig.json when the provided path ends in .json, resolves #1712.
• Fixed a crash when converting the globalThis namespace, could only be caused by a plugin.

Thanks!

• @Gudahtt
• @mgred
• @schlusslicht
• @srmagura

v0.22.4 (2021-09-18)

Features

• Flag option types like validation can now be set to true/false to enable/disable all flags within them.
• Source code links now work with Bitbucket repositories, resolves #1615.
• Added githubPages option (default: true), which will create a .nojekyll page in the generated output, resolves #1680.
• MarkdownEvent is now exported, resolves #1696.

Bug Fixes

• Fixed the hamburger menu not being visible on mobile devices, fixes #1699.
• Comments on function implementations with overloaded signatures will now be correctly handled, fixes #1697.

Thanks!

• @srmagura

v0.22.3 (2021-09-12)

Bug Fixes

• Switched the default highlighting themes back to light-plus and dark-plus, they were accidentally set to min-light and min-dark in v0.22.0.

Features

• Added new validation option which can be used to disable checks for non-exported symbols. On the command line, this can be specified with --validation.notExported true, or in an options file with:

  {
      "validation": {
          "notExported": true
      }
  }

• Added invalidLink to validation option, deprecated listInvalidSymbolLinks, which will be removed in 0.23.

v0.22.2 (2021-09-11)

Bug Fixes

• Fix background color of tables in dark mode, closes #1684.

v0.22.1 (2021-09-10)

Bug Fixes

• Validation for non-exported symbols will now only produce one warning per symbol, instead of one warning per reference.
• Syntax highlighting when the preferred color scheme is dark but dark theme is not explicitly selected will now properly use the dark highlighting theme.

v0.22.0 (2021-09-10)

Breaking Changes

• The packages and entryPoints options have been combined. To migrate configurations which used packages, replace packages with entryPoints and set entryPointStrategy to packages.
• Renamed disableOutputCheck to cleanOutputDir to more clearly reflect its behavior.
• The highlightTheme option has been split into lightHighlightTheme and darkHighlightTheme.
• Removed poorly documented / poorly behaved toc option.
• HTML output is now rendered with JSX instead of Handlebars, closes #1631. This change provides major performance benefits, reducing rendering time by up to 10x for several benchmarked projects. It also allows themes to be easily type checked, preventing mistakes when creating custom themes. Removing Handlebars also fixed memory leaks when --watch was specified due to Handlebar's caching mechanism. This change breaks all existing custom themes, so a theme created for v0.21 or earlier will not work in v0.22. See internal-docs/custom-themes.md for documentation on how to create a custom theme in v0.22.
• Removed the minimal theme that has been mostly broken for a long time.
• Changed the default entryPointStrategy from expand to resolve.

Features

• Added support for light/dark mode to the default theme, closes #1641.
• Added support for custom CSS with the new customCss option, closes #1060.
• Added support for linking to third party documentation sites, closes #131. See internal-docs/third-party-symbols.md for documentation on how to create a plugin which enables this. Support for linking to MDN for global types is provided by typedoc-plugin-mdn-links.
• Added entryPointStrategy to reduce confusion from new TypeDoc users on handling of entry points. There are three possible options:

  Option	Behavior
  resolve (default)	Expects all entry points to be contained within the root level tsconfig project. If a directory is given, includes <directory>/index as the entry point.
  expand	Expects all entry points to be contained within the root level tsconfig project. If a directory is given, files within it are recursively expanded. This was the default behavior in v0.21.
  packages	Corresponds to --packages in v0.21, behaves as documented in the Monorepo section in the readme.

• Added support for typedocMain in package.json when using the packages strategy for resolving entry points.
• Produce warnings when documentation is missing exports, closes #1653. If using TypeDoc's API, this behavior is available through calling application.validate(project).
• Added support for detecting "as const enums", closes #1675.
• Added hideLegend option, closes #1108.
• Added performance measurements to debug logging (--logLevel Verbose)
• String literal indexed access types will create links to their referencing member if possible, closes #1226.

Bug Fixes

• Support inclusion patterns when expanding input files, closes #1399.
• Arrow keys can no longer select hidden search results.
• The Legend header will no longer be included if there is nothing in the legend.
• If a non-function uses @param, the name will not be dropped when rendering, closes #1410.

API Breaking Changes

• TypeDoc now specifies the "export" key in package.json, preventing plugins from importing internal paths. TypeDoc should now export all necessary structures (potentially marked with @internal if likely to change) from the root export.
• The ReflectionKind values for Project, Module, Namespace, and Enum have changed.
• Removed deprecated logger functions.
• Dropped support for legacy plugins which use export=. Plugins are now required to export a load function.
• Remove TypeParameterType, references to type parameters have produced a ReferenceType since v0.20.0.
• Types no longer have a clone method. It inconsistently performed deep or shallow clones, and was not used by TypeDoc.
• Types no longer contain an equals method. It was occasionally correct for medium-complexity types, and always incorrect for more complicated types.

Thanks!

• @cspotcode
• @itsjamie

v0.21.9 (2021-08-29)

Bug Fixes

• Support highlighting language aliases (#1673), closes #1672

Thanks!

• @StoneCypher

v0.21.8 (2021-08-28)

Features

• Upgrade Shiki to 0.9.8, adds support for several new highlighting languages

Thanks!

• @StoneCypher

v0.21.7 (2021-08-27)

Features

• Support for TypeScript 4.4, closes #1664

v0.21.6 (2021-08-19)

Features

• Add support for NO_COLOR environment variable (#1650)

Bug Fixes

• Handle undefined symbols in query types, closes #1660

Thanks!

• @krisztianb

v0.21.5 (2021-07-31)

Features

• Support Node v12.10 (#1632), closes #1628

Bug Fixes

• Implicitly set noEmit unless --emit is provided, closes #1639

Thanks!

• @betaorbust

v0.21.4 (2021-07-12)

Bug Fixes

• Constructors did not have source information set, closes #1626

v0.21.3 (2021-07-10)

Breaking Changes

• Options may not be set once conversion starts. Enables a small perf improvement.

Bug Fixes

• Improve detection for "property methods" to convert as methods, closes #1624
• Two members differing only by case produced broken links, closes #1585
• Resolve some memory leaks

Thanks!

• @cspotcode

v0.21.2 (2021-06-27)

Bug Fixes

• Postpone resolution of inherited classes until their parents have been resolved, closes #1580

v0.21.1 (2021-06-25)

Bug Fixes

• Exclude empty modules from documentation, closes #1607
• readme could not be set to none in a config file, closes #1608
• Correctly handle minimatch excludes on Windows, closes #1610

v0.21.0 (2021-06-18)

Breaking Changes

• Drop support for Node v10
• Plugins are now passed Application directly
• Drop support for TypeScript 3.9

Features

• Improve monorepos by adding support for TS entry points (#1596)
• Support for monorepos
• Support for TypeScript 4.3
• Add support for sorting reflections based on user criteria, closes #112
• Add the --treatWarningsAsErrors option, closes #1568
• The exclude option will now remove symbols re-exported from excluded files, closes #1578

Bug Fixes

• Correctly handle comments on function type aliases, closes #799
• Setters should always have a void return type, closes #1215
• Resolve paths in option files according to the config directory, closes #1598, #1442
• Pick up doc comments for properties declared within a class's constructor, closes #1255
• Inherit comments from parent methods, closes #1580
• Correct handling for intentionally broken references
• Inheritance from multiple Partial types was incorrectly converted, closes #1579

Thanks!

• efokschaner
• Martin

v0.20.37 (2021-06-16)

Features

• Add disableAliases option (#1576), closes #1571

Bug Fixes

• Pin marked dependency to 2.0.x (#1602), closes #1601

Thanks!

• Martin
• Nick

v0.20.36 (2021-04-23)

Features

• use 'pretty' option when generating json
• create 'pretty' option

Bug Fixes

• Always write to stdout, even if redirected, closes #1566
• Create directories when writing JSON output

Thanks!

• cAttte

v0.20.35 (2021-04-03)

Features

• Include debugging information in highlighting error messages (#1561)

Bug Fixes

• Relax simple expression requirements for default values, closes #1552
• Handle #private getters + methods, closes #1564

Thanks!

• Masato Makino

v0.20.34 (2021-03-25)

Bug Fixes

• Crash when converting recursive type alias, closes #1547
• Discover module comments for global files, closes #1549
• Detect references when export * is used, closes #1551

v0.20.33 (2021-03-22)

Bug Fixes

• Static properties of Error class incorrectly converted, closes #1541, #572

v0.20.32 (2021-03-14)

Bug Fixes

• Correct crash with reflection types, closes #1538

v0.20.31 (2021-03-14)

Bug Fixes

• readonly tuples were recognized as arrays, closes #1534
• Constructors were improperly reported as inherited, closes #1528, #1527

Thanks!

• Vladimir Ivakin

v0.20.30 (2021-03-06)

Bug Fixes

• Categories should only appear once if specified multiple times, closes #1522
• Support JSDocNullableType, JSDocNonNullableType, closes #1524
• Remove undefined from optional property types, closes #1525

v0.20.29 (2021-03-04)

Features

• Support for TypeScript 4.2, closes #1517

v0.20.28 (2021-02-23)

Bug Fixes

• Detect visibility modifiers on accessors, closes #1516

v0.20.27 (2021-02-20)

Features

• preserve spaces in code blocks

Bug Fixes

• Detect and normalize unique symbol names, closes #1514

Thanks!

• michaelf

v0.20.26 (2021-02-20)

Bug Fixes

• Pick up optional/readonly from mapped types, closes #1509

v0.20.25 (2021-02-15)

Features

• Support for specifying comments on export declarations, closes #1504

v0.20.24 (2021-02-11)

Features

• add support for non .com gh enterprise domains (#1507)

Thanks!

• TUNER88

v0.20.23 (2021-02-06)

Bug Fixes

• Missing namespace members when ns is created by re-exporting an entire module, closes #1499
• Set inheritedFrom on accessor signatures, closes #1497, #1498

Thanks!

• Siddharth VP

v0.20.22 (2021-02-06)

Bug Fixes

• Import from shiki rather than shiki-themes, closes #1496

v0.20.21 (2021-02-05)

Bug Fixes

• Missing exported members in file-as-namespace reflection, closes #1493

v0.20.20 (2021-01-31)

Features

• add highlight theme option

Bug Fixes

• Missing comments on optional methods, closes #1490
• Avoid crash with removed project reflection, closes #1489
• function-namespaces were converted incorrectly, closes #1483
• add validation to highlightTheme option

Thanks!

• Matthias Law

v0.20.19 (2021-01-25)

Features

• Support for --watch, --preserveWatchOutput, --emit

v0.20.18 (2021-01-24)

Bug Fixes

• Static methods added to the class manually in JS, closes #1481

v0.20.17 (2021-01-23)

Features

• Add support for copying item’s documentation by copying it from another API item

Bug Fixes

• CommonJS export= with type exports, closes #1476

Thanks!

• dergash

v0.20.16 (2021-01-17)

Bug Fixes

• Comments on projects were broken
• Constructors were a bit broken

v0.20.15 (2021-01-16)

Features

• Support for excludeInternal, closes #1469
• add option to read more categories from doc

Bug Fixes

• Crash when converting @types/ws, closes #1463
• replace return with continue
• excludeNotDocumented incorrectly ignored some symbols, closes #1465
• Support for JSDoc @enum tags, closes #1464

Thanks!

• Bruno Zorić

v0.20.14 (2021-01-09)

Bug Fixes

• Crash with destructured export const, closes #1462
• Add support for optional types, closes #1312
• Add support for rest types, closes #1457
• Avoid using process.exit (#1461)

Thanks!

• Krisztián Balla

v0.20.13 (2021-01-06)

Bug Fixes

• Use type nodes if converting a regular function, closes #1454

v0.20.12 (2021-01-05)

Bug Fixes

• Arrow methods did not have modifiers set properly, closes #1452
• Add support for import types, closes #1453
• Don't document type arguments if there are none (#1451)

Thanks!

• Krisztián Balla

v0.20.11 (2021-01-04)

Bug Fixes

• Crash when converting a generic with a tuple constraint, closes #1449

v0.20.10 (2021-01-03)

Bug Fixes

• Errors due to bad options in tsconfig file were dropped, closes #1444

v0.20.9 (2021-01-02)

Bug Fixes

• Regression caused by 1886304f327da5642097834feac0387fd1b78b6e
• Parameter declarations might not exist, closes #1443

v0.20.8 (2021-01-01)

Bug Fixes

• CLI should not exit cleanly on unexpected error

v0.20.7 (2020-01-01)

Bug Fixes

• Tuples could cause a crash

v0.20.6 (2020-01-01)

Features

• Support for JSDoc types, closes #1214, #1437

Bug Fixes

• Properly resolve type parameters, closes #1438

v0.20.5 (2020-12-30)

Bug Fixes

• Functions might not have a parent in global files, closes #1436

v0.20.4 (2020-12-30)

Bug Fixes

• --excludeNotDocumented didn't remove reflections, closes #1435

v0.20.3 (2020-12-29)

Features

• Improved support for global files, closes #1424

v0.20.2 (2020-12-29)

Features

• Better detection for declaration files defining a module

Bug Fixes

• Negative literal types were converted incorrectly, closes #1427
• ArgumentsReader should warn if missing a value, closes #1429
• TS 3 converters for null, this types
• Literal boolean converter in TS 3
• Map bash, sh, shell to shellscript when highlighting, closes #1432

v0.20.1 (2020-12-29)

Bug Fixes

• Initializers should only be included if "simple", closes #1288, #1224, #764

v0.20.0 (2020-12-28)

Breaking Changes

• Remove EVENT_FUNCTION_IMPLEMENTATION
• Switch to Shiki for syntax highlighting
• Unify several inconsistent methods, closes #1403
• Remove EVENT_FILE_BEGIN
• TypeDoc no longer accepts TS options
• Remove "mode" option
• Remove ignoreCompilerErrors option

Features

• new option "markedOptions" (#1412)
• Initial attempt at support for project references
• Colors in console output
• Options may specify a validation function (#1398)
• Support for @module tag
• Support for TS 4.1 mapped types + string literal types, closes #1397
• Add logLevel option
• Partial support for global files
• Automatically generate schema for typedoc.json
• Switch back to search.js, closes #1339
• Support for the remaining literal types
• Support for mapped types
• Mostly working library mode

Bug Fixes

• ConstructorType node support
• Reintroduce support for index signatures
• Categorization was broken with a single entry point
• Normalize unions, closes #571
• Somehow didn't save a file
• Missing comments on variable functions, closes #1421
• Resolve type parameters in concrete subclasses
• Use entryPoints to search for readme
• Only create extra programs when dealing with solution style tsconfigs
• A typo in description of DefaultTheme.getMapping (#1416)
• Correct handling of arrays in generic constraints, closes #1408
• Type converters threw on older TS versions
• Accessor with a set signature was converted incorrectly
• Declaration merged namespaces sometimes produced multiple reflections
• TypeDoc should warn users about missing entry points
• isExternal flag wasn't set properly
• JSON schema had incorrect value types, closes #1389
• Hidden module-namespaces, closes #1396
• Some issues with inheritence
• We pick up all properties now
• Support for specify a directory as an entry point
• Lint
• Array types were converted incorrectly
• Change target back to ES2018
• Missing default exports
• Fix bug in ReferenceType equality check, closes #1383
• fixes #1383, closes #1383
• Reference types should always be given resolved symbols
• Rendering works again
• A few of the issues with the type converter

Thanks!

• Denis Sikuler
• Krisztián Balla
• Soc Sieng

v0.19.2 (2020-09-21)

Bug Fixes

• Export declarations within namespaces weren't detected, closes #1366

v0.19.1 (2020-09-05)

Features

• Re-introduce support for TS 3.9, closes #1362

Thanks!

• Constantine Dergachev

v0.19.0 (2020-08-28)

Features

• Support for named tuples, closes #1357
• Upgrade to TS 4.0
• Support for defaulted type parameters

Bug Fixes

• Check for missing declarations, closes #1329
• Add converter for parenthesized type nodes, closes #1346
• Support for type operators readonly & unique
• Address typo in log statement

Thanks!

• Eric ZHANG
• Krisztián Balla
• MathBunny

v0.18.0 (2020-08-09)

Breaking Changes

• Bump minimum node version to 10

Bug Fixes

• Improve support for type aliases, closes #1330
• Examples don't run (#1327)
• Use baseUrl to determine file paths (#1313), closes #1294
• Support resolveJsonModule, closes #1323
• Do not ignore the properties of object type literals (#1308)
• GithubPlugin: read correct remote when multiple github repos exist
• Only set inputFiles from tsconfig if not already set, closes #1263
• Options.isDefault was always false when passed non-literals., closes #1263

Thanks!

• Brandon Istenes
• Chris Thielen
• Nickolay Platonov
• TheBrokenRail

v0.17.7 (2020-05-17)

Breaking Changes

• Any plugins which referenced ReflectionKind.ExternalModule or ReflectionKind.Module need to be updated to reference ReflectionKind.Module and ReflectionKind.Namespace respectively., closes #109
• createMinimatch is no longer a public function.

Features

• Allow every possible number as a defaultValue for a number option (#1296), closes #1291
• Number options may require min and max values (#1278)
• Add detecting read-only properties (#1268)
• Remove Result object, closes #1238
• Generate search index before rendering theme (#1252)
• Support for @template, closes #860
• Support for private fields
• Move TypeScript to a peer dependency, closes #880
• Support disabling sources, closes #808
• Allow user to set git remote, closes #1130
• Only generate legend for items that are displayed on the page (#1187), closes #1136

Bug Fixes

• copy inherited parameter descriptions (#1303), closes #787
• TypeDoc fails to resolve @types packages outside of cwd, closes #1300
• Trim whitespace when parsing links, closes #1302
• Module declaration parsed as namespace (#1301), closes #1284
• Correct prepublish script
• Do not silently swallow missing include/media file errors (#1277)
• Fix extends option in tsconfig.json doesn't work (#1273), closes #1272
• Improve output for object's computed property names (#1275)
• Enable lax overloads only in release
• Map type options should not have their default value validated (#1250)
• Empty legend on most pages
• Pin marked to 0.8.0, closes #1240
• Report errors from setting bad options on CLI, closes #1237
• Missed a test configuration update
• Rename external modules to modules, closes #109
• Check for compiler errors before converting
• Moved @types/minimatch dependency to devDepencencies (#1206)
• Plugin resolution for relative paths (#1194), closes #1188

Thanks!

• Alexander Cerutti
• Krisztián Balla
• Martin
• Nickolay Platonov
• Radics Laszlo
• Sergei Grishchenko
• Soc Sieng
• Stephan Bijzitter
• William Johnes

v0.16.11 (2020-02-28)

Features

• Add support for `` inside of Marked Link Brackets (#1091)
• Support for extended config in typedoc.json, closes #493, #1115
• Config option to exclude not explicitly documented symbols (#996), closes #995

Bug Fixes

• Support code blocks with four spaces, closes #1218
• Ensure child comment tags get set (#1221)
• Re-export TypeScript namespace (#1217), closes #1213
• Logger extensions now also count the warnings (#1210)

Thanks!

• Adam Epling
• Emily Marigold Klassen
• Khải
• Nickolay Platonov
• Richie Bendall
• Robin Stevens

v0.16.10 (2020-02-16)

Features

• Allow excluding tags from comments, closes #815
• Count warnings (#1205)

Bug Fixes

• Remove tags containing redundant type info, closes #1198
• Don't remove braces containing a tag, closes #1001
• Mixin symbols might not have declarations (#1208)

Thanks!

• Raynor Chen
• Robin Stevens
• Zack Slayton

v0.16.9 (2020-01-25)

Bug Fixes

• use util.readFile everywhere to handle BOM issues

Thanks!

• Anton Golub

v0.16.8 (2020-01-21)

Bug Fixes

• Correctly handle export * from..., closes #1186

v0.16.7 (2020-01-17)

Features

• Support for query types

Bug Fixes

• Add test for {} and fix generation

Thanks!

• Robin Stevens

v0.16.6 (2020-01-16)

Bug Fixes

• removeReflection does not fully remove reflections, closes #1176