Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 15, 2025

Bumps typedoc from 0.28.9 to 0.28.13.

Release notes

Sourced from typedoc's releases.

v0.28.13

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

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

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

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

Sourced from typedoc's changelog.

v0.28.13 (2025-09-14)

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 (2025-09-01)

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 (2025-08-25)

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 (2025-08-10)

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.
Commits
  • 7240906 Update changelog for release
  • a57c48e Bump version to 0.28.13
  • 33e4eb9 Fix externalSymbolLinkMappings with inherited methods
  • 3b84d2d Use basePath option for relative links
  • 12a3f3a Fix tests
  • 8f94288 Fix #3012
  • df88357 Merge pull request #3010 from boneskull/boneskull/packagedocumentation-link
  • e0fd143 docs(tags): fix link to packageDocumentation
  • 1269e3a Make parent links even more restrictive
  • b3a4869 Update changelog for release
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Important

Bump typedoc from 0.28.9 to 0.28.13 with improved link resolution and bug fixes.

  • Dependency Update:
    • Bump typedoc from 0.28.9 to 0.28.13 in package.json.
  • Features:
    • basePath option now affects relative link resolution.
    • Shorthand property assignments use variable comments if no own comment.
  • Bug Fixes:
    • Fix rendering issues with mixin classes.
    • Correct @inheritDoc behavior for @remarks and @returns.
    • Improve externalSymbolLinkMappings for inherited signatures.

This description was created by Ellipsis for a2de028. You can customize this summary. It will automatically update as commits are pushed.

Disclaimer: Experimental PR review

Greptile Summary

Updated On: 2025-09-15 05:32:38 UTC

This PR is an automated dependency update from Dependabot that bumps the TypeDoc package from version 0.28.9 to 0.28.13. TypeDoc is a documentation generation tool used exclusively for building API documentation from TypeScript code, as evidenced by the docs script in the project's package.json which runs TypeDoc to generate documentation.

The update includes four patch releases (0.28.10 through 0.28.13) that collectively bring several bug fixes and minor feature improvements to TypeDoc. Key improvements include:

  • Enhanced basePath option functionality for relative link resolution
  • Fixes for mixin class rendering issues that were preventing documentation generation
  • Improved @inheritDoc tag behavior for documentation inheritance
  • Better handling of external symbol link mappings
  • Various improvements to link resolution and HTML rendering

Since TypeDoc is a development dependency used solely for documentation generation and not part of the runtime SDK code, this update only affects the quality and functionality of generated documentation. The change maintains the existing caret range (^0.28.13) in the dependency specification, ensuring compatibility with future patch releases.

Confidence score: 5/5

  • This PR is extremely safe to merge with virtually no risk of breaking production functionality
  • Score reflects that TypeDoc is a development-only tool for documentation generation with no runtime impact
  • No files require special attention as this is a straightforward dependency update

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Sep 15, 2025
@vercel
Copy link

vercel bot commented Sep 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
langfuse-js Ready Ready Preview Oct 1, 2025 9:27am

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.9 to 0.28.13.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.28.9...v0.28.13)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.13
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Oct 13, 2025

Superseded by #663.

@dependabot dependabot bot closed this Oct 13, 2025
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.28.13 branch October 13, 2025 05:17
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 javascript Pull requests that update javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants