Skip to content

Commit 754a4c8

Browse files
chore(deps): update dependency typedoc to v0.28.5 (#788)
This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [typedoc](https://typedoc.org) ([source](https://redirect.github.com/TypeStrong/TypeDoc)) | [`0.28.4` -> `0.28.5`](https://renovatebot.com/diffs/npm/typedoc/0.27.7/0.28.5) | [![age](https://developer.mend.io/api/mc/badges/age/npm/typedoc/0.28.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typedoc/0.28.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typedoc/0.27.7/0.28.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typedoc/0.27.7/0.28.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>TypeStrong/TypeDoc (typedoc)</summary> ### [`v0.28.5`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0285-2025-05-26) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.4...v0.28.5) ##### Bug Fixes - References to type aliases defined as mapped types will now correctly create a reference to the type alias, [#&#8203;2954](https://redirect.github.com/TypeStrong/TypeDoc/issues/2954). - `ignoredHighlightLanguages` can now be used to prevent warnings for codeblocks containing languages which are supported by Shiki but are not loaded, [#&#8203;2956](https://redirect.github.com/TypeStrong/TypeDoc/issues/2956). ### [`v0.28.4`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0284-2025-05-04) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.3...v0.28.4) ##### Features - The navigation in the default theme will now attempt to break long names onto multiple lines, [#&#8203;2940](https://redirect.github.com/TypeStrong/TypeDoc/issues/2940). - Added German (de) localization, [#&#8203;2941](https://redirect.github.com/TypeStrong/TypeDoc/issues/2941). ##### Bug Fixes - TypeDoc's default theme now uses the same chevron for all collapsible elements, [#&#8203;2924](https://redirect.github.com/TypeStrong/TypeDoc/issues/2924) The `chevronSmall` helper is now deprecated and will be removed with v0.29.0. - Classes/interfaces marked with `@hidden` will no longer appear in the "Hierarchy" section of the docs. - TypeDoc now handles wildcard JSDoc types, [#&#8203;2949](https://redirect.github.com/TypeStrong/TypeDoc/issues/2949). ##### Thanks! - [@&#8203;blutorange](https://redirect.github.com/blutorange) - [@&#8203;bkeepers](https://redirect.github.com/bkeepers) ### [`v0.28.3`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0283-2025-04-20) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.2...v0.28.3) ##### Bug Fixes - `@inline` now functions when referencing tuple types, [#&#8203;2932](https://redirect.github.com/TypeStrong/TypeDoc/issues/2932). - `@link` links to the current page are now rendered, [#&#8203;2934](https://redirect.github.com/TypeStrong/TypeDoc/issues/2934). - `@includeCode` now supports regions in TypeScript files with `.mts` and `.cts` file extensions, [#&#8203;2935](https://redirect.github.com/TypeStrong/TypeDoc/issues/2935). - Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, [#&#8203;2937](https://redirect.github.com/TypeStrong/TypeDoc/issues/2937). - Improved error reporting when paths including Windows separators are provided as globs, [#&#8203;2938](https://redirect.github.com/TypeStrong/TypeDoc/issues/2938). ### [`v0.28.2`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0282-2025-04-07) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.1...v0.28.2) ##### Features - `@group none` and `@category none` will now render their children without a section heading in the default theme, [#&#8203;2922](https://redirect.github.com/TypeStrong/TypeDoc/issues/2922). - Added `@disableGroups` tag to completely disable the grouping mechanism for a given reflection, [#&#8203;2922](https://redirect.github.com/TypeStrong/TypeDoc/issues/2922). ##### Bug Fixes - Variables using `@class` now correctly handle `@category`, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - Variables using `@class` now include constructor parameters, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - Variables using `@class` with a generic first constructor function now adopt that function's type parameters as the class type parameters, [#&#8203;2914](https://redirect.github.com/TypeStrong/TypeDoc/issues/2914). - When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, [#&#8203;2918](https://redirect.github.com/TypeStrong/TypeDoc/issues/2918). - Inlining types can now handle more type variants, [#&#8203;2920](https://redirect.github.com/TypeStrong/TypeDoc/issues/2920). - Fixed behavior of `externalSymbolLinkMappings` option when URL is set to `#`, [#&#8203;2921](https://redirect.github.com/TypeStrong/TypeDoc/issues/2921). - Fixed broken links within module pages when structure-dir router was used, [#&#8203;2928](https://redirect.github.com/TypeStrong/TypeDoc/issues/2928). - Type parameters on JS classes defined with `@typedef` now correctly handle the constraint, [#&#8203;2929](https://redirect.github.com/TypeStrong/TypeDoc/issues/2929). - API: `toString` on types containing index signatures now behave correctly, [#&#8203;2917](https://redirect.github.com/TypeStrong/TypeDoc/issues/2917). - Added `@inlineType` to the list of tags excluded by default. ### [`v0.28.1`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0281-2025-03-20) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.28.0...v0.28.1) ##### Features - The `TypeDocOptions` interface now marks options as optional so it no longer has to be wrapped in `Partial` for use in config files, [#&#8203;2901](https://redirect.github.com/TypeStrong/TypeDoc/issues/2901). - API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports) - API: Expose method to disable TypeDoc usage of `localStorage` without clearing it, [#&#8203;2908](https://redirect.github.com/TypeStrong/TypeDoc/issues/2908). ##### Bug Fixes - `--watch` can now infer entry points from `package.json` as supported in non-watch mode, [#&#8203;2899](https://redirect.github.com/TypeStrong/TypeDoc/issues/2899). - `@include` with regions now works on files with CRLF line endings, [#&#8203;2902](https://redirect.github.com/TypeStrong/TypeDoc/issues/2902). - Generated page names now correctly handles UTF-8 characters requiring more than 16 bits [#&#8203;2905](https://redirect.github.com/TypeStrong/TypeDoc/issues/2905). - Fixed a crash when converting `module.exports = []`, [#&#8203;2909](https://redirect.github.com/TypeStrong/TypeDoc/issues/2909). - Fixed URL generation which introduced a superfluous `./` in relative links, [#&#8203;2910](https://redirect.github.com/TypeStrong/TypeDoc/issues/2910). ##### Thanks! - [@&#8203;jsmith2-coveo](https://redirect.github.com/jsmith2-coveo) - [@&#8203;romainmnr](https://redirect.github.com/romainmnr) ### [`v0.28.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0280-2025-03-15) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.27.9...v0.28.0) ##### Breaking Changes - TypeDoc now expects all input globs paths to be specified with `/` path separators, [#&#8203;2825](https://redirect.github.com/TypeStrong/TypeDoc/issues/2825). - TypeDoc's `--entryPointStrategy merge` mode now requires JSON from at least version 0.28.0. - Removed `jp` translations from `lang`, to migrate switch to `ja`. - File name references in `intentionallyNotExported` now use a package name/package relative path instead of an absolute path for matching. - The `source-order` sort ordering now considers package names / package relative paths instead of using the absolute paths to a file. - TypeDoc will only check for a project README file next to the discovered `package.json` file if `--readme` is not set this change improves handling of monorepo setups where some packages have readme files and others do not, [#&#8203;2875](https://redirect.github.com/TypeStrong/TypeDoc/issues/2875). - Function-like variable exports will now only be automatically converted as function types if they are initialized with a function expression. TypeDoc can be instructed to convert them as functions with the `@function` tag, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/2881). - Object literal type alias types will now be converted in a way which causes them to be rendered more similarly to how interfaces are rendered, [#&#8203;2817](https://redirect.github.com/TypeStrong/TypeDoc/issues/2817). ##### API Breaking Changes - `ProjectReflection.getReflectionFromSymbol` and `ProjectReflection.getSymbolFromReflection` have been moved to `Context` - `Path` and `PathArray` parameter types now always contain normalized paths. - Introduced a `Router` which is used for URL creation. `Reflection.url`, `Reflection.anchor`, and `Reflection.hasOwnDocument` have been removed. - `Deserializer.reviveProject(s)` no longer accepts an option to add project documents. - `Deserializer.reviveProjects` now requires an `alwaysCreateEntryPointModule` option. - `Comment.serializeDisplayParts` no longer requires a serializer argument. - `ReflectionSymbolId.fileName` is now optional, TypeDoc now stores a combination of a package name and package relative path instead. The `fileName` property will be present when initially created, but is not serialized. - Removed `DeclarationReflection.relevanceBoost` attribute which was added for plugins, but never used. - `i18n` proxy is no longer passed to many functions, instead, reference `i18n` exported from the module directly. - `ReflectionKind.singularString` and `ReflectionKind.pluralString` now returns translated strings. The methods on `Internationalization` to do this previously have been removed. - The HTML output structure for the search box has changed to support the new modal. - `DefaultThemeRenderContext`'s `typeDeclaration` and `typeDetailsIfUseful` methods now require both a reflection and a type in order to support `@expandType` ##### Features - Add support for TypeScript 5.8.x - The search modal in the HTML output has been rewritten to provide better mobile support - Added a `--router` option which can be used to modify TypeDoc's output folder structure. This can be extended with plugins, [#&#8203;2111](https://redirect.github.com/TypeStrong/TypeDoc/issues/2111). - Introduced the `@primaryExport` modifier tag to provide more fine grained control over export conversion order, [#&#8203;2856](https://redirect.github.com/TypeStrong/TypeDoc/issues/2856) - Introduced `packagesRequiringDocumentation` option for `validation.notDocumented`, TypeDoc will expect comments to be present for symbols in the specified packages. - TypeDoc now exports a `typedoc/browser` entrypoint for parsing and using serialized JSON files, [#&#8203;2528](https://redirect.github.com/TypeStrong/TypeDoc/issues/2528). - Type `packageOptions` as `Partial<TypeDocOptions>`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - TypeDoc will now warn if an option which should only be set at the root level is set in `packageOptions`, [#&#8203;2878](https://redirect.github.com/TypeStrong/TypeDoc/issues/2878). - Introduced `@function` tag to force TypeDoc to convert variable declarations with a type annotation as functions, [#&#8203;2881](https://redirect.github.com/TypeStrong/TypeDoc/issues/2881). - Exposed a `TypeDoc` global object in the HTML theme which can be used to prevent TypeDoc from using `localStorage`, [#&#8203;2872](https://redirect.github.com/TypeStrong/TypeDoc/issues/2872). - Introduced `@preventInline` and `@inlineType` tags for further control extending the `@inline` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - Introduced `@preventExpand` and `@expandType` tags for further control extending the `@expand` tag, [#&#8203;2862](https://redirect.github.com/TypeStrong/TypeDoc/issues/2862). - API: Introduced `DefaultThemeRenderContext.reflectionIcon` for more granular control over displayed reflection icons. ##### Bug Fixes - TypeDoc will now only create references for symbols re-exported from modules. - Variable-functions will now prefer placing the comment on the signature if there is only one signature present, [#&#8203;2824](https://redirect.github.com/TypeStrong/TypeDoc/issues/2824). - User filter settings will no longer sometimes cause the search to have fewer visible results than expected. - Fixed handling of expando functions which were also merged with a namespace, [#&#8203;2876](https://redirect.github.com/TypeStrong/TypeDoc/issues/2876). - Fixed rendering of function types within arrays and union types, [#&#8203;2892](https://redirect.github.com/TypeStrong/TypeDoc/issues/2892). - Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, [#&#8203;2894](https://redirect.github.com/TypeStrong/TypeDoc/issues/2894). ##### Thanks! - [@&#8203;crimx](https://redirect.github.com/crimx) - [@&#8203;jsmith2-coveo](https://redirect.github.com/jsmith2-coveo) - [@&#8203;phoneticallySAARTHaK](https://redirect.github.com/phoneticallySAARTHaK) - [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha) ### [`v0.27.9`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0279-2025-02-25) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.27.8...v0.27.9) This will be the last v0.27.x release, see [#&#8203;2868](https://redirect.github.com/TypeStrong/TypeDoc/issues/2868) for discussion on the 0.28 beta. ##### Features - Added support for TypeScript 5.8 ### [`v0.27.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0278-2025-02-21) [Compare Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.27.7...v0.27.8) ##### Features - The `visibilityFilter` option now supports individual signatures, [#&#8203;2846](https://redirect.github.com/TypeStrong/TypeDoc/issues/2846). - The `favicon` option may now be given a link starting with `https?://` instead of a path, [#&#8203;2851](https://redirect.github.com/TypeStrong/TypeDoc/issues/2851). - TypeDoc now supports specifying `#` as the link in `externalSymbolLinkMappings` to indicate the type should not be linked to, [#&#8203;2853](https://redirect.github.com/TypeStrong/TypeDoc/issues/2853). ##### Bug Fixes - Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, [#&#8203;2852](https://redirect.github.com/TypeStrong/TypeDoc/issues/2852). - Unresolved external type references will no longer incorrectly linked to `undefined`, [#&#8203;2854](https://redirect.github.com/TypeStrong/TypeDoc/issues/2854). ##### Thanks! - [@&#8203;pjeby](https://redirect.github.com/pjeby) - [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekday" in timezone Etc/UTC, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/ScaleLeap/amazon-marketplaces). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC4xNi4wIiwidXBkYXRlZEluVmVyIjoiNDAuMTYuMCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6WyJyZW5vdmF0ZWJvdCJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
1 parent 5e16258 commit 754a4c8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"rimraf": "6.0.1",
5454
"ts-jest": "29.2.6",
5555
"tsconfigs": "4.0.2",
56-
"typedoc": "0.28.4",
56+
"typedoc": "0.28.5",
5757
"typescript": "5.8.3"
5858
},
5959
"keywords": [

0 commit comments

Comments
 (0)