Skip to content

Update dependency typedoc to ^0.28.0 #4759

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

Merged
merged 4 commits into from
Mar 21, 2025
Merged

Update dependency typedoc to ^0.28.0 #4759

merged 4 commits into from
Mar 21, 2025

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 18, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) ^0.27.0 -> ^0.28.0 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

TypeStrong/TypeDoc (typedoc)

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 - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

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.

@renovate renovate bot added Dependencies Pull requests that update a dependency file T-Task Tasks for the team like planning labels Mar 18, 2025
@t3chguy
Copy link
Member

t3chguy commented Mar 18, 2025

Copy link
Contributor Author

renovate bot commented Mar 21, 2025

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

t3chguy added 2 commits March 21, 2025 12:49
Signed-off-by: Michael Telatynski <[email protected]>
@t3chguy t3chguy removed the X-Blocked label Mar 21, 2025
@t3chguy t3chguy marked this pull request as ready for review March 21, 2025 13:36
@t3chguy t3chguy requested a review from a team as a code owner March 21, 2025 13:36
@t3chguy t3chguy requested a review from florianduros March 21, 2025 13:36
@t3chguy t3chguy added this pull request to the merge queue Mar 21, 2025
Merged via the queue into develop with commit f4de883 Mar 21, 2025
33 of 34 checks passed
@t3chguy t3chguy deleted the renovate/typedoc branch March 21, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Pull requests that update a dependency file T-Task Tasks for the team like planning
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant