Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

npm(deps-dev): bump typedoc from 0.26.6 to 0.26.7 #37

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps typedoc from 0.26.6 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!

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!

Commits

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.26.6 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.6...v0.26.7)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 9, 2024
Copy link

gooroo-dev bot commented Sep 9, 2024

Please double check the following review of the pull request:

Issues counts

🐞Mistake 🤪Typo 🚨Security 🚀Performance 💪Best Practices 📖Readability ❓Others
0 0 0 0 0 0 0

Changes in the diff

  • 🛠️ Updated typedoc from version 0.26.6 to 0.26.7.
  • 🛠️ Updated @shikijs/core from version 1.10.0 to 1.16.2.
  • ➕ Added new dependency @shikijs/vscode-textmate version 9.2.0.
  • ➕ Added new dependency @types/hast version 3.0.4.
  • ➕ Added new dependency @types/unist version 3.0.3.
  • 🛠️ Updated shiki from version 1.10.0 to 1.16.2.
  • 🛠️ Updated yaml from version 2.4.5 to 2.5.1.
  • 🛠️ Updated typescript peer dependency range in typedoc to include 5.6.x.

Identified Issues

ID Type Details Severity Confidence
1 💪Best Practices Ensure new dependencies are necessary and do not introduce redundancy. 🟡Low 🟡Low

Issue 1: Ensure new dependencies are necessary and do not introduce redundancy.

Details:

  • File: package-lock.json
  • Lines: Multiple lines where new dependencies @shikijs/vscode-textmate, @types/hast, and @types/unist are added.

Explanation:
Adding new dependencies can introduce redundancy or bloat if they are not strictly necessary. It is important to verify that these dependencies are required and do not overlap with existing ones.

Suggested Fix:
Review the necessity of the newly added dependencies and ensure they are not redundant.

Code:
No specific code change is required here, but a thorough review of the necessity of these dependencies should be conducted.

Missing Tests

Since the changes are primarily dependency updates and do not introduce new functionality or modify existing code, no new tests are required. However, it is important to run the existing test suite to ensure that the updates do not introduce any regressions.

Summon me to re-review when updated! Yours, Gooroo.dev
React or reply to share your feedback with me!

Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 10, 2024

Looks like typedoc is up-to-date now, so this is no longer needed.

@dependabot dependabot bot closed this Sep 10, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.26.7 branch September 10, 2024 00:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants