Skip to content

chore(deps): update dependency typedoc to v0.28.4 #701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 8, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) 0.27.9 -> 0.28.4 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc (typedoc)

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

Features
  • The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial
    for use in config files, #​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, #​2908.
Bug Fixes
  • --watch can now infer entry points from package.json as supported in non-watch mode, #​2899.
  • @include with regions now works on files with CRLF line endings, #​2902.
  • Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #​2905.
  • Fixed a crash when converting module.exports = [], #​2909.
  • Fixed URL generation which introduced a superfluous ./ in relative links, #​2910.
Thanks!

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!

Configuration

📅 Schedule: Branch creation - "after 3am and before 7am on Tuesday" in timezone America/Denver, 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.

@github-actions github-actions bot requested a review from xylo04 April 8, 2025 12:56
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.28.2 chore(deps): update dependency typedoc to v0.28.3 Apr 20, 2025
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 6392f79 to a6240f4 Compare April 20, 2025 02:06
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.28.3 chore(deps): update dependency typedoc to v0.28.4 May 4, 2025
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from a6240f4 to c34a5a2 Compare May 4, 2025 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants