chore(deps): update devdependencies typedoc from v0.27.6 to v0.28.10 #81

renovate · 2025-02-17T03:44:30Z

This PR contains the following updates:

Package	Change	Age	Confidence
typedoc (source)	`0.27.6` -> `0.28.10`

Release Notes

TypeStrong/TypeDoc (typedoc)

`v0.28.10`

Compare Source

Bug Fixes

Fixed inconsistent anchors on module pages for re-exports, #2990.
Markdown references which appear to be footnotes will no longer be checked for links, #2991.

`v0.28.9`

Compare Source

Features

Add support for TypeScript 5.9, #2989.

Bug Fixes

Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, #2982.
Fixed automatic discovery of entry points when not running in packages mode, #2988.
Fixed discovery of package.json file when running with entry points containing a glob, #2985.

`v0.28.8`

Compare Source

Features

If using JS config files, the plugin function can now be given plugin functions to load.
Permit - within tag names to support typescript-json-schema's @TJS-type tag, #2972.
Exposed Context.createSymbolId for use by plugins.

Bug Fixes

Relative links in <img srcset> will now be discovered by TypeDoc, #2975.
Relative links in <source src> and <source srcset> elements will now be discovered by TypeDoc, #2975.
Improved inherited from/overwrites link discovery to point to parent properties in more cases, #2978

Thanks!

`v0.28.7`

Compare Source

Features

Introduced the @sortStrategy tag to override the sort option on a specific reflection, #2965.

Bug Fixes

Classes and functions exported with export { type X } are no longer missing comments, #2970.
Setting locale to an unknown value will now cause TypeDoc to operate in English instead of a debug locale.
Array options will now report an error if set to a non-array/non-string value.

`v0.28.6`

Compare Source

Features

TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #2961.
Declarations without comments will now check for comments on their export specifier, #2964.

Bug Fixes

Attempting to highlight a supported language which is not enabled is now a warning, not an error, #2956.
Improved compatibility with CommonMark's link parsing, #2959.
Classes, variables, and functions exported with export { type X } are now detected and converted as interfaces/type aliases, #2962.
Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #2967.
Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #2969.

Thanks!

@yGuy

`v0.28.5`

Compare Source

Bug Fixes

References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.
ignoredHighlightLanguages can now be used to prevent warnings for codeblocks containing languages
which are supported by Shiki but are not loaded, #2956.

`v0.28.4`

Compare Source

Features

The navigation in the default theme will now attempt to break long names onto multiple lines, #2940.
Added German (de) localization, #2941.

Bug Fixes

TypeDoc's default theme now uses the same chevron for all collapsible elements, #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, #2949.

Thanks!

`v0.28.3`

Compare Source

Bug Fixes

@inline now functions when referencing tuple types, #2932.
@link links to the current page are now rendered, #2934.
@includeCode now supports regions in TypeScript files with .mts and .cts file extensions, #2935.
Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.
Improved error reporting when paths including Windows separators are provided as globs, #2938.

`v0.28.2`

Compare Source

Features

@group none and @category none will now render their children without a section
heading in the default theme, #2922.
Added @disableGroups tag to completely disable the grouping mechanism for a
given reflection, #2922.

Bug Fixes

Variables using @class now correctly handle @category, #2914.
Variables using @class now include constructor parameters, #2914.
Variables using @class with a generic first constructor function now adopt
that function's type parameters as the class type parameters, #2914.
When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.
Inlining types can now handle more type variants, #2920.
Fixed behavior of externalSymbolLinkMappings option when URL is set to #, #2921.
Fixed broken links within module pages when structure-dir router was used, #2928.
Type parameters on JS classes defined with @typedef now correctly handle the constraint, #2929.
API: toString on types containing index signatures now behave correctly, #2917.
Added @inlineType to the list of tags excluded by default.

`v0.28.1`

Compare Source

Bug Fixes

Fixed inconsistent anchors on module pages for re-exports, #2990.
Markdown references which appear to be footnotes will no longer be checked for links, #2991.

`v0.28.0`

Compare Source

Breaking Changes

TypeDoc now expects all input globs paths to be specified with / path separators, #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, #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, #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, #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, #2111.
Introduced the @primaryExport modifier tag to provide more fine grained
control over export conversion order, #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, #2528.
Type packageOptions as Partial<TypeDocOptions>, #2878.
TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #2862.
Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #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, #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, #2876.
Fixed rendering of function types within arrays and union types, #2892.
Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.

Thanks!

`v0.27.9`

Compare Source

This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.

Features

Added support for TypeScript 5.8

`v0.27.8`

Compare Source

Features

The visibilityFilter option now supports individual signatures, #2846.
The favicon option may now be given a link starting with https?:// instead of a path, #2851.
TypeDoc now supports specifying # as the link in externalSymbolLinkMappings to indicate the type should not be linked to, #2853.

Bug Fixes

Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.
Unresolved external type references will no longer incorrectly linked to undefined, #2854.

Thanks!

`v0.27.7`

Compare Source

Features

@includeCode and @inline can now inject parts of files using region
names or line numbers, #2816.
Introduced ja translation options, deprecated jp in favor of ja, #2843.
Improved TypeDoc's --watch option to support watching files not caught by
TypeScript's watch mode, #2675.
The @inline tag now works in more places for generic types.
Visibility filters now consider individual signatures, #2846.

Bug Fixes

Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
Improved narrator support for labeling icons, #2832.
Fixed an issue with @class incorrectly handling mapped types, #2842.
TypeDoc will now consider symbols to be external only if all of their declarations are external
so that declaration merged members with global symbols can be documented, #2844.
Fixed an issue where TypeDoc would constantly rebuild, #2844.
Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.

Thanks!

Configuration

📅 Schedule: Branch creation - Between 12:00 AM and 03:59 AM, only on Monday ( * 0-3 * * 1 ) (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ 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.

If you want to rebase/retry this PR, check this box

github-actions