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.4 to 0.26.7 #2772

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 9, 2024

Bumps typedoc from 0.26.4 to 0.26.7.

Release notes

Sourced from typedoc's releases.

v0.26.7

Features

  • Support TypeScript 5.6, #2699.
  • Added customJs option to include a script tag in generated HTML output, #2650.
  • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
  • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
  • Added support for the @abstract tag, #2692.

Bug Fixes

  • Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
  • @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
  • Fixed handling of @param tags on comments attached to function callback parameters, #2683.
  • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
  • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

v0.26.6

Features

  • Use of the @extends block tag no longer produces warnings, #2659. This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
  • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

  • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
  • Restored re-exports in the page navigation menu, #2671.
  • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod0.
  • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5

Features

  • TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

  • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
  • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
  • TypeDoc no longer crashes when @document includes an empty file, #2638.
  • API: Event listeners added later with the same priority will be called later, #2643.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.7 (2024-09-09)

Features

  • Support TypeScript 5.6, #2699.
  • Added customJs option to include a script tag in generated HTML output, #2650.
  • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
  • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
  • Added support for the @abstract tag, #2692.

Bug Fixes

  • Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
  • @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
  • Fixed handling of @param tags on comments attached to function callback parameters, #2683.
  • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
  • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

v0.26.6 (2024-08-18)

Features

  • Use of the @extends block tag no longer produces warnings, #2659. This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
  • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

  • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
  • Restored re-exports in the page navigation menu, #2671.
  • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod0.
  • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5 (2024-07-21)

Features

  • TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

  • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
  • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
  • TypeDoc no longer crashes when @document includes an empty file, #2638.
  • API: Event listeners added later with the same priority will be called later, #2643.

... (truncated)

Commits

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)

Summary by CodeRabbit

  • Chores
    • Updated the typedoc dependency to the latest version for improved performance and potential new features.

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 9, 2024
@justinr1234
Copy link
Collaborator

@CodeRabbit full review

@justinr1234
Copy link
Collaborator

@coderabbitai full review

Copy link

coderabbitai bot commented Sep 19, 2024

Actions performed

Full review triggered.

Copy link

coderabbitai bot commented Sep 19, 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.

Walkthrough

The pull request updates the typedoc dependency in the package.json file of the xrpl package, changing its version from 0.26.4 to 0.26.7. This modification may include various improvements such as bug fixes, performance enhancements, or new features. The specific impact of this update on the package's functionality is not detailed in the provided changes.

Changes

File Change Summary
packages/xrpl/package.json Updated typedoc version from 0.26.4 to 0.26.7

Sequence Diagram(s)

(No sequence diagrams generated as the changes are too simple to warrant such visualizations.)

Poem

🐇 In the garden of code, a change took flight,
With typedoc updated, the future looks bright.
From 0.26.4 to 0.26.7,
Bug fixes and features, oh what a heaven!
Hopping along, we celebrate this day,
For every small change leads us on our way! 🌼


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

@ckeshava
Copy link
Collaborator

@dependabot rebase

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.4 to 0.26.7.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.26.4...v0.26.7)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.26.7 branch from 6d0b5b9 to 3268445 Compare September 26, 2024 18:34
Copy link

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

Package New capabilities Transitives Size Publisher

🚮 Removed packages: npm/[email protected], npm/[email protected]

View full report↗︎

@ckeshava ckeshava merged commit a726a5a into main Sep 26, 2024
13 checks passed
@ckeshava ckeshava deleted the dependabot/npm_and_yarn/typedoc-0.26.7 branch September 26, 2024 19:08
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.

2 participants