chore(deps): update dependency typedoc to v0.28.20

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
typedoc (source)	0.28.2 → 0.28.20

---

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.28.20

Compare Source

Features

• Group/category section headings (<h2>) in the default theme now include an id attribute so they can be linked to via fragment identifiers (e.g. modules.html#classes), #​3029.
• Added a @reexport modifier tag to have TypeDoc convert variable/type references as a re-export instead of a new symbol, #​3096.
• API: Introduced generateOutputsBegin and generateOutputsEnd events on Application for plugin use.

Bug Fixes

• When --emit none is used, TypeDoc will now report warnings about missing relative paths previously reported when rendering, #​3078.
• Improved performance via asynchronously performing git and file write operations, more performant JSX rendering, and source code bundling, #​3103.
• A @hidden tag on a constructor parameter-property will now only hide the property, not both the property and the parameter, #​3111.
• Custom @group and @category titles with the same sort weight are now ordered consistently with the alphabetical reflection sort, #​3120.

Thanks!

• @​greymoth-jp
• @​jonathanhefner
• @​kcastellino
• @​Metbcy
• @​StoneCypher
• @​wotan-allfather

v0.28.19

Compare Source

Features

• Added French translations for the TypeDoc interface and help descriptions.
• Added support for triple-slash comment style, which requires exactly three slashes in the comment, #​3089.

Bug Fixes

• Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme.
• Fixed short summary comment handling on module pages when the project source files use Windows line endings, #​3093.

Thanks!

• @​avivkeller
• @​hyosua
• @​marijnh
• @​Pistonight

v0.28.18

Compare Source

Features

• Support TypeScript 6.0, #​3084.

v0.28.17

Compare Source

Bug Fixes

• Improved handling of comments for type aliases which have been declaration merged with functions, #​3064.
• Fixed anchor link generation to members named $, #​3065.
• Corrected typing of the plugin option to permit functions, #​3066.
• Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
  the suppressCommentWarningsInDeclarationFiles option is enabled, #​3070.
• Fixed conversion of types referencing type parameters on functions, #​3071.

Thanks!

• @​pjeby

v0.28.16

Compare Source

Bug Fixes

• Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #​3052.
• Fixed an issue preventing automatic entry point discovery on Windows, #​3057.
• Improved vertical positioning of text icons, #​3056.
• TypeDoc no longer includes source location information for type literal reflections. This could sometimes
  cause TypeDoc to infer the wrong path when resolving base paths for display.
• Adjusted markdown rendering to allow markdownItLoader to override more rendering #​3055.

Features

• Added support for regions for @include in .tsx, .cjs, and .mjs file references #​3048.
• Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@mod}.
  This makes it possible to add modifier tags to these members, which previously was not possible as
  TypeScript's parsing stops for these members at the next non-braced tag, #​2916 and #​3050.
• A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
  configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
  and will automatically be picked up when writing typedoc.json files if you are using VSCode, #​3054.

Thanks!

• @​a10nik
• @​kozi
• @​Lakuna

v0.28.15

Compare Source

Features

• The gitRevision option now accepts the special value {branch}, which indicates source links should use
  the current git branch for links, #​3041.
• Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
  do not exist when building the documentation, #​3033.
• API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
  during TypeDoc's normal validation step, #​3033.

v0.28.14

Compare Source

Features

• Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should
  be copied to the output documentation, #​3020.
  API: Introduced typeAnnotation on CommentTag
• Added excludePrivateClassFields option to hide #private members while allowing private members, #​3017.
• Added support for TypeScript's @this tag for JS files which describe this parameters, #​3026.

v0.28.13

Compare Source

Features

• The basePath option now also affects relative link resolution, TypeDoc will also check for
  paths relative to the provided base path. If you instead want TypeDoc to only change the rendered
  base path for sources, use the displayBasePath option, #​3009.

Bug Fixes

• Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #​3007.
• @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #​3012.
• The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #​3014.

v0.28.12

Compare Source

Bug Fixes

• Variables marked with @enum now work for symbols imported from another module, #​3003.
• Improved magic introduced with #​2999 to work with imported symbols, #​3003.
• Fixed relative link resolution to file names containing percent encoded URLs, #​3006.
• Linking to the project's README file with a relative link will now behave as expected, #​3006.
• Reduced unnecessary HTML element rendering in default theme.
  API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

v0.28.11

Compare Source

Features

• Object properties declared with shorthand property assignment will now use the variable's comment
  if they do not have their own comment, #​2999.

Bug Fixes

• Fixed link resolution not working correctly in first comment on the file in some cases, #​2994.
• Optional methods are now rendered with a trailing ? in the reflection preview and signature, #​2995.
• The compilerOptions option now functions properly with non-boolean options, #​3000.
• Configuration errors within the compilerOptions option are now handled gracefully, #​3000.
• Fixed improper casing of "Type Declaration" header, #​3002.

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!

• @​jonathanhefner
• @​laymonage

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!

• @​blutorange
• @​bkeepers

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.

---

Configuration

📅 Schedule: (UTC)

• 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 was generated by Mend Renovate. View the repository job log.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1bb6f6e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR