TypeStrong/TypeDoc
### [`v0.23.23`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02323-2022-12-18)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.22...v0.23.23)
##### Features
- Added `ts.Signature` to emitted `EVENT_CREATE_SIGNATURE` event, [#2002](https://togithub.com/TypeStrong/TypeDoc/issues/2002).
##### Bug Fixes
- Links to members hidden by filter settings now temporarily override the filter, [#2092](https://togithub.com/TypeStrong/TypeDoc/issues/2092).
- If `src/` and `src/x` are specified as entry points, `src/` will no longer be ignored, [#2121](https://togithub.com/TypeStrong/TypeDoc/issues/2121).
### [`v0.23.22`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02322-2022-12-11)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.21...v0.23.22)
##### Features
- Add support for defining the kind sort order, [#2109](https://togithub.com/TypeStrong/TypeDoc/issues/2109).
##### Bug Fixes
- Normalize all file paths on Windows, [#2113](https://togithub.com/TypeStrong/TypeDoc/issues/2113).
- Fix `@link` tags within lists, [#2103](https://togithub.com/TypeStrong/TypeDoc/issues/2103).
### [`v0.23.21`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02321-2022-11-14)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.20...v0.23.21)
##### Features
- Added support for a catch-all wildcard in `externalSymbolLinkMappings`, [#2102](https://togithub.com/TypeStrong/TypeDoc/issues/2102).
- Added support for TypeScript 4.9.
##### Thanks!
- [@mistic100](https://togithub.com/mistic100)
### [`v0.23.20`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02320-2022-11-03)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.19...v0.23.20)
##### Bug Fixes
- Fixed comment discovery for `@inheritDoc` if inheriting from a function type alias, [#2087](https://togithub.com/TypeStrong/TypeDoc/issues/2087).
### [`v0.23.19`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02319-2022-10-28)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.18...v0.23.19)
##### Bug Fixes
- Fixed title link if `titleLink` option was not specified, [#2085](https://togithub.com/TypeStrong/TypeDoc/issues/2085).
##### Thanks!
- [@krisztianb](https://togithub.com/krisztianb)
### [`v0.23.18`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02318-2022-10-23)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.17...v0.23.18)
##### Features
- Improved error reporting when failing to find entry points, [#2080](https://togithub.com/TypeStrong/TypeDoc/issues/2080), [#2082](https://togithub.com/TypeStrong/TypeDoc/issues/2082).
##### Bug Fixes
- Constructor parameter-properties will now use the `@param` comment for the parameter if available, [#1261](https://togithub.com/TypeStrong/TypeDoc/issues/1261).
- Fixed display of object types containing methods, [#1788](https://togithub.com/TypeStrong/TypeDoc/issues/1788).
- Fixed conversion of intrinsic string mapping types when converting without a type node, [#2079](https://togithub.com/TypeStrong/TypeDoc/issues/2079).
### [`v0.23.17`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02317-2022-10-18)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.16...v0.23.17)
##### Features
- Added `titleLink`, `navigationLinks` and `sidebarLinks` options to add additional links to the rendered output, [#1830](https://togithub.com/TypeStrong/TypeDoc/issues/1830).
- Added `sourceLinkTemplate` option to allow more flexible specification of remote urls.
Deprecated now redundant `gitRevision` detection starting with `https?://` introduced in v0.23.16, [#2068](https://togithub.com/TypeStrong/TypeDoc/issues/2068).
##### Thanks!
- [@futurGH](https://togithub.com/futurGH)
### [`v0.23.16`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02316-2022-10-10)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.15...v0.23.16)
##### Features
- Object types will now be pretty printed, [#1793](https://togithub.com/TypeStrong/TypeDoc/issues/1793).
- Added support for specifying the tsconfig.json file in packages mode with `{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}` in package.json, [#2061](https://togithub.com/TypeStrong/TypeDoc/issues/2061).
- In packages mode, readme files will now be automatically included if present, [#2065](https://togithub.com/TypeStrong/TypeDoc/issues/2065).
- Added support for specifying the base file url for links to source code, [#2068](https://togithub.com/TypeStrong/TypeDoc/issues/2068).
##### Bug Fixes
- Private parameter properties will no longer be ignored, [#2064](https://togithub.com/TypeStrong/TypeDoc/issues/2064).
##### Thanks!
- [@captainTorch](https://togithub.com/captainTorch)
### [`v0.23.15`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02315-2022-09-18)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.14...v0.23.15)
##### Features
- TypeDoc will now treat `@typedef {import("foo").Bar} Baz` type declarations which forward type parameters to the imported
symbol as re-exports of that symbol, [#2044](https://togithub.com/TypeStrong/TypeDoc/issues/2044).
##### Bug Fixes
- TypeDoc will now prefer comments on variable declarations over signature comments, [#2042](https://togithub.com/TypeStrong/TypeDoc/issues/2042).
- Fixed double rendering of "Type Parameters" header, [#2054](https://togithub.com/TypeStrong/TypeDoc/issues/2054).
- Fixed double rendering of "Hierarchy" header, [#2053](https://togithub.com/TypeStrong/TypeDoc/issues/2053).
- Removed unused `widgets.png` and `widgets@2x.png` files from generated assets folder.
### [`v0.23.14`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02314-2022-09-03)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.13...v0.23.14)
##### Features
- Added support for defining one-off external link mappings with `externalSymbolLinkMappings` see
[the documentation](https://typedoc.org/guides/options/#externalsymbollinkmappings) for usage examples and caveats, [#2030](https://togithub.com/TypeStrong/TypeDoc/issues/2030).
- External link resolvers defined with `addUnknownSymbolResolver` will now be checked when resolving `@link` tags, [#2030](https://togithub.com/TypeStrong/TypeDoc/issues/2030).
Note: To support this, resolution will now happen during conversion, and as such, `Renderer.addUnknownSymbolResolver` has been
soft deprecated in favor of `Converter.addUnknownSymbolResolver`. Plugins should update to use the method on `Converter`.
`DefaultThemeRenderContext.attemptExternalResolution` has also been deprecated since it will repeat work done during conversion,
use `ReferenceType.externalUrl` instead.
- Added `Converter.addUnknownSymbolResolver` for use by plugins supporting external links.
##### Bug Fixes
- Fixed conversion of object literal types containing construct signatures, [#2036](https://togithub.com/TypeStrong/TypeDoc/issues/2036).
- Fixed centering of title bar on wide displays, actually this time, [#2046](https://togithub.com/TypeStrong/TypeDoc/issues/2046).
### [`v0.23.13`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02313-2022-09-01)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.12...v0.23.13)
##### Bug Fixes
- Fixed packages mode bug introduced in 0.23.12, [#2043](https://togithub.com/TypeStrong/TypeDoc/issues/2043).
### [`v0.23.12`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02312-2022-08-31)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.11...v0.23.12)
##### Features
- Added a new `ParameterType.Object` for declaring object options which will be shallowly merged when read from user configuration.
- Added a new `Application.EVENT_BOOTSTRAP_END` event emitted when `Application.bootstrap` is called.
##### Bug Fixes
- TypeDoc will now work properly in packages mode when converting packages outside the current working directory, [#2043](https://togithub.com/TypeStrong/TypeDoc/issues/2043).
- Fixed deprecation warning for `isIdentifierOrPrivateIdentifier`.
- Fixed centering of title bar on wide displays, [#2046](https://togithub.com/TypeStrong/TypeDoc/issues/2046).
##### Thanks!
- [@citkane](https://togithub.com/citkane)
### [`v0.23.11`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02311-2022-08-26)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.10...v0.23.11)
##### Features
- Added support for TypeScript 4.8.
- Introduced a `skipErrorChecking` option which instructs TypeDoc to not ask TypeScript for compiler errors
before attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
- Added support for JS entry points when using packages mode, [#2037](https://togithub.com/TypeStrong/TypeDoc/issues/2037).
##### Bug Fixes
- Fixed crash when converting abstract mixin class, [#2011](https://togithub.com/TypeStrong/TypeDoc/issues/2011).
- Readme files within monorepos now have `@link` tags resolved, [#2029](https://togithub.com/TypeStrong/TypeDoc/issues/2029).
- Correctly resolve unqualified links to class members within parameters, [#2031](https://togithub.com/TypeStrong/TypeDoc/issues/2031).
- TypeDoc will now consider other reflections with the same name as parents when resolving links, [#2033](https://togithub.com/TypeStrong/TypeDoc/issues/2033).
- The "Hierarchy" and "Type Parameters" helpers on `DefaultThemeRenderContext` now contain all the HTML for their sections of the page, [#2038](https://togithub.com/TypeStrong/TypeDoc/issues/2038).
##### Thanks!
- [@citkane](https://togithub.com/citkane)
- [@kaphula](https://togithub.com/kaphula)
### [`v0.23.10`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02310-2022-07-31)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.9...v0.23.10)
##### Features
- Added support for detecting comments directly before parameters as the parameter comment, [#2019](https://togithub.com/TypeStrong/TypeDoc/issues/2019).
- Added support for using the comment directly before a constructor parameter that declares a property as the property comment, [#2019](https://togithub.com/TypeStrong/TypeDoc/issues/2019).
- Improved schema generation to give better autocomplete for the `sort` option.
- Optional properties are now visually distinguished in the index/sidebar by rendering `prop` as `prop?`, [#2023](https://togithub.com/TypeStrong/TypeDoc/issues/2023).
- `DefaultThemeRenderContext.markdown` now also accepts a `CommentDisplayPart[]` for rendering, [#2004](https://togithub.com/TypeStrong/TypeDoc/issues/2004).
- Expose `Converter.resolveLinks` method for use with `Converter.parseRawComment`, [#2004](https://togithub.com/TypeStrong/TypeDoc/issues/2004).
##### Bug Fixes
- Fixed schema URL for TSDoc preventing the use of `typedoc/tsdoc.json` in TSDoc extends, [#2015](https://togithub.com/TypeStrong/TypeDoc/issues/2015).
- Improved detection of package names in repositories using pnpm, [#2017](https://togithub.com/TypeStrong/TypeDoc/issues/2017).
- Fixed missing JSDoc style `@typedef` comments for properties, [#2020](https://togithub.com/TypeStrong/TypeDoc/issues/2020).
##### Thanks!
- [@bodil](https://togithub.com/bodil)
- [@nazarhussain](https://togithub.com/nazarhussain)
### [`v0.23.9`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0239-2022-07-24)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.8...v0.23.9)
##### Bug Fixes
- TypeDoc will no longer skip entry points which have no exports, [#2007](https://togithub.com/TypeStrong/TypeDoc/issues/2007).
If using `"entryPointStrategy": "expand"`, this change may result in new pages being added to your documentation.
If this is not desired, you can use the `exclude` option to filter them out.
- Fixed missing comments on callable variable-functions constructed indirectly, [#2008](https://togithub.com/TypeStrong/TypeDoc/issues/2008).
- Packages mode will now respect the `--includeVersion` flag, [#2010](https://togithub.com/TypeStrong/TypeDoc/issues/2010).
- Fixed multiple reflections mapping to the same file name on case insensitive file systems, [#2012](https://togithub.com/TypeStrong/TypeDoc/issues/2012).
### [`v0.23.8`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0238-2022-07-17)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.7...v0.23.8)
##### Features
- Added defined in links for classes, enums, [#180](https://togithub.com/TypeStrong/TypeDoc/issues/180).
- Added support for `*.ghe.com` and `*.github.us` GitHub enterprise domains for source links, [#2001](https://togithub.com/TypeStrong/TypeDoc/issues/2001).
- Expose `Converter.parseRawComment` for plugins to parse additional markdown files, [#2004](https://togithub.com/TypeStrong/TypeDoc/issues/2004).
##### Bug Fixes
- TypeDoc will no longer emit a warning for `{@link}` containing a URL, [#1980](https://togithub.com/TypeStrong/TypeDoc/issues/1980).
- `excludeNotDocumented` will no longer remove functions/methods/accessors which are documented, [#1994](https://togithub.com/TypeStrong/TypeDoc/issues/1994).
- Fixed missing `sources` property on signature reflections [#1996](https://togithub.com/TypeStrong/TypeDoc/issues/1996).
##### Thanks!
- [@cary-hu](https://togithub.com/cary-hu)
- [@chadhietala](https://togithub.com/chadhietala)
### [`v0.23.7`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0237-2022-07-09)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.6...v0.23.7)
##### Bug Fixes
- Tags must now contain whitespace after the tag name to be parsed as a tag, `@jest/globals` in a comment will no longer be parsed as a tag [#1990](https://togithub.com/TypeStrong/TypeDoc/issues/1990).
- The private member visibility option will now be respected in generated sites, [#1992](https://togithub.com/TypeStrong/TypeDoc/issues/1992).
- Overload rendering will no longer be broken if JavaScript is disabled, [#453](https://togithub.com/TypeStrong/TypeDoc/issues/453).
- All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, [#1100](https://togithub.com/TypeStrong/TypeDoc/issues/1100).
### [`v0.23.6`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0236-2022-07-08)
[Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.5...v0.23.6)
##### Features
- Improved support for `--entryPointStrategy Packages`. TypeDoc will now load package-specific configurations from `package.json` `typedoc` field. This configuration allows configuring a custom display name (`typedoc.displayName`) field, entry point (`typedoc.entryPoint` - this is equivalent and will override `typedocMain`), and path to a readme file to be rendered at the top of the package page (`typedoc.readmeFile`), [#1658](https://togithub.com/TypeStrong/TypeDoc/issues/1658).
- The `--includeVersion` option will now be respected by `--entryPointStrategy Packages`. Also, for this combination, missing `version` field in the root `package.json` will not issue a warning.
- The `navigation` partial will now call the new `settings`, `primaryNavigation`, and `secondaryNavigation` partials, [#1987](https://togithub.com/TypeStrong/TypeDoc/issues/1987).
##### Bug Fixes
- All warnings will be reported instead of only the first warning of a given type, [#1981](https://togithub.com/TypeStrong/TypeDoc/issues/1981).
- Include references will no longer be incorrectly parsed as links, [#1986](https://togithub.com/TypeStrong/TypeDoc/issues/1986).
- The generated schema.json on the website will now use enum values rather than enum names if possible.
##### Thanks!
- [@akphi](https://togithub.com/akphi)
- [@zamiell](https://togithub.com/zamiell)
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
0.23.5
->0.23.23
Release Notes
TypeStrong/TypeDoc
### [`v0.23.23`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02323-2022-12-18) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.22...v0.23.23) ##### Features - Added `ts.Signature` to emitted `EVENT_CREATE_SIGNATURE` event, [#2002](https://togithub.com/TypeStrong/TypeDoc/issues/2002). ##### Bug Fixes - Links to members hidden by filter settings now temporarily override the filter, [#2092](https://togithub.com/TypeStrong/TypeDoc/issues/2092). - If `src/` and `src/x` are specified as entry points, `src/` will no longer be ignored, [#2121](https://togithub.com/TypeStrong/TypeDoc/issues/2121). ### [`v0.23.22`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02322-2022-12-11) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.21...v0.23.22) ##### Features - Add support for defining the kind sort order, [#2109](https://togithub.com/TypeStrong/TypeDoc/issues/2109). ##### Bug Fixes - Normalize all file paths on Windows, [#2113](https://togithub.com/TypeStrong/TypeDoc/issues/2113). - Fix `@link` tags within lists, [#2103](https://togithub.com/TypeStrong/TypeDoc/issues/2103). ### [`v0.23.21`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02321-2022-11-14) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.20...v0.23.21) ##### Features - Added support for a catch-all wildcard in `externalSymbolLinkMappings`, [#2102](https://togithub.com/TypeStrong/TypeDoc/issues/2102). - Added support for TypeScript 4.9. ##### Thanks! - [@mistic100](https://togithub.com/mistic100) ### [`v0.23.20`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02320-2022-11-03) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.19...v0.23.20) ##### Bug Fixes - Fixed comment discovery for `@inheritDoc` if inheriting from a function type alias, [#2087](https://togithub.com/TypeStrong/TypeDoc/issues/2087). ### [`v0.23.19`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02319-2022-10-28) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.18...v0.23.19) ##### Bug Fixes - Fixed title link if `titleLink` option was not specified, [#2085](https://togithub.com/TypeStrong/TypeDoc/issues/2085). ##### Thanks! - [@krisztianb](https://togithub.com/krisztianb) ### [`v0.23.18`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02318-2022-10-23) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.17...v0.23.18) ##### Features - Improved error reporting when failing to find entry points, [#2080](https://togithub.com/TypeStrong/TypeDoc/issues/2080), [#2082](https://togithub.com/TypeStrong/TypeDoc/issues/2082). ##### Bug Fixes - Constructor parameter-properties will now use the `@param` comment for the parameter if available, [#1261](https://togithub.com/TypeStrong/TypeDoc/issues/1261). - Fixed display of object types containing methods, [#1788](https://togithub.com/TypeStrong/TypeDoc/issues/1788). - Fixed conversion of intrinsic string mapping types when converting without a type node, [#2079](https://togithub.com/TypeStrong/TypeDoc/issues/2079). ### [`v0.23.17`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02317-2022-10-18) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.16...v0.23.17) ##### Features - Added `titleLink`, `navigationLinks` and `sidebarLinks` options to add additional links to the rendered output, [#1830](https://togithub.com/TypeStrong/TypeDoc/issues/1830). - Added `sourceLinkTemplate` option to allow more flexible specification of remote urls. Deprecated now redundant `gitRevision` detection starting with `https?://` introduced in v0.23.16, [#2068](https://togithub.com/TypeStrong/TypeDoc/issues/2068). ##### Thanks! - [@futurGH](https://togithub.com/futurGH) ### [`v0.23.16`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02316-2022-10-10) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.15...v0.23.16) ##### Features - Object types will now be pretty printed, [#1793](https://togithub.com/TypeStrong/TypeDoc/issues/1793). - Added support for specifying the tsconfig.json file in packages mode with `{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}` in package.json, [#2061](https://togithub.com/TypeStrong/TypeDoc/issues/2061). - In packages mode, readme files will now be automatically included if present, [#2065](https://togithub.com/TypeStrong/TypeDoc/issues/2065). - Added support for specifying the base file url for links to source code, [#2068](https://togithub.com/TypeStrong/TypeDoc/issues/2068). ##### Bug Fixes - Private parameter properties will no longer be ignored, [#2064](https://togithub.com/TypeStrong/TypeDoc/issues/2064). ##### Thanks! - [@captainTorch](https://togithub.com/captainTorch) ### [`v0.23.15`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02315-2022-09-18) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.23.14...v0.23.15) ##### Features - TypeDoc will now treat `@typedef {import("foo").BarConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.