Skip to content
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

build(deps-dev): bump typedoc from 0.26.11 to 0.27.5 #2854

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 Dec 16, 2024

Bumps typedoc from 0.26.11 to 0.27.5.

Release notes

Sourced from typedoc's releases.

v0.27.5

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
  • Cascaded modifier tags will no longer be copied into type literals, #2802.
  • @summary now works to describe functions within modules, #2803.
  • Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3

Features

  • Added support for PNG favicons, #2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

  • Add special handling for import types with type errors discarded with ts-expect-error, #2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.5 (2024-12-14)

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4 (2024-12-09)

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
  • Cascaded modifier tags will no longer be copied into type literals, #2802.
  • @summary now works to describe functions within modules, #2803.
  • Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3 (2024-12-04)

Features

  • Added support for PNG favicons, #2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

  • Add special handling for import types with type errors discarded with ts-expect-error, #2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

... (truncated)

Commits
  • 80e23a8 Update changelog for release
  • 9ffaf1d Bump version to 0.27.5
  • d9ec2dd Treat links under hostedBaseUrl as internal
  • 8acc237 Correct mismatched check between renderingIsUseful and applyAnchorUrl
  • 9eb1e05 Produce warnings if links cannot be resolved
  • e4f991d Update bug report template to ask reporters to disable plugins
  • b45d5ea Fix multiple issues with markdown parsing
  • ddc64e5 Update docs, changelog
  • 9d8737e Update JSX extension docs
  • 993c0f5 expose html global jsx attributes to enable extending them for custom element...
  • 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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 16, 2024
Copy link

coderabbitai bot commented Dec 16, 2024

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

socket-security bot commented Dec 16, 2024

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.27.5 branch from 1d28bec to 4d00aa4 Compare December 16, 2024 20:28
Copy link

socket-security bot commented Dec 16, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/prettier@2.8.8 environment, filesystem, unsafe 0 11.2 MB prettier-bot

View full report↗︎

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.11 to 0.27.5.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.26.11...v0.27.5)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.27.5 branch from 4d00aa4 to ffca1a5 Compare December 21, 2024 01:41
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant