Skip to content

build(deps-dev): bump typedoc from 0.27.9 to 0.28.3 #2967

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

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 21, 2025

Bumps typedoc from 0.27.9 to 0.28.3.

Release notes

Sourced from typedoc's releases.

v0.28.3

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

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

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.3 (2025-04-20)

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 (2025-04-07)

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 (2025-03-20)

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.

... (truncated)

Commits
  • e75f47f Update changelog for release
  • 066a6c9 Bump version to 0.28.3
  • 209acb5 Improve error reporting for Windows path separators
  • 5824623 Add mts and cts file extension aliases (#2936)
  • 911faff Resolve aliased symbols before checking exclusion
  • 81c59bc Fix failing test
  • fff32ef Render links to the current page
  • 42af237 Handle @inline on tuple types
  • 4bf00b5 Update changelog for release
  • c463af3 Bump version to 0.28.2
  • Additional commits viewable in compare view

Most Recent Ignore Conditions Applied to This Pull Request
Dependency Name Ignore Conditions
typedoc [< 0.26, > 0.25.0]

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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.9 to 0.28.3.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.27.9...v0.28.3)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.3
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Apr 21, 2025
Copy link

coderabbitai bot commented Apr 21, 2025

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (1)
  • build(

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

2 participants