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

chore: bump typedoc from 0.25.4 to 0.26.2 #257

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 Jun 24, 2024

Bumps typedoc from 0.25.4 to 0.26.2.

Release notes

Sourced from typedoc's releases.

v0.26.2

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1

Features

  • Improved Korean translation coverage, #2602.

Bug Fixes

  • Added @author to the default list of recognized tags, #2603.
  • Anchor links are no longer incorrectly checked for relative paths, #2604.
  • Fixed an issue where line numbers reported in error messages could be incorrect, #2605.
  • Fixed relative link detection for markdown links containing code in their label, #2606.
  • Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.
  • TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.
  • Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
  • Fixed an issue where modifier tags were not applied to top level modules in packages mode.
  • Fixed an issue where excluded tags were not removed from top level modules in packages mode.
  • .jsonc configuration files are now properly read as JSONC, rather than being passed to require.

Thanks!

v0.26.0

Breaking Changes

  • Drop support for Node 16.
  • Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting markedOptions needs to be updated to use markdownItOptions. Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
  • Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
  • Changed default of --excludePrivate to true.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.2 (2024-06-24)

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1 (2024-06-22)

Features

  • Improved Korean translation coverage, #2602.

Bug Fixes

  • Added @author to the default list of recognized tags, #2603.
  • Anchor links are no longer incorrectly checked for relative paths, #2604.
  • Fixed an issue where line numbers reported in error messages could be incorrect, #2605.
  • Fixed relative link detection for markdown links containing code in their label, #2606.
  • Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.
  • TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.
  • Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
  • Fixed an issue where modifier tags were not applied to top level modules in packages mode.
  • Fixed an issue where excluded tags were not removed from top level modules in packages mode.
  • .jsonc configuration files are now properly read as JSONC, rather than being passed to require.

Thanks!

v0.26.0 (2024-06-22)

Breaking Changes

  • Drop support for Node 16.
  • Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting markedOptions needs to be updated to use markdownItOptions. Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
  • Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
  • Changed default of --excludePrivate to true.

... (truncated)

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.25.4 to 0.26.2.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.4...v0.26.2)

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

Signed-off-by: dependabot[bot] <[email protected]>
Copy link
Contributor Author

dependabot bot commented on behalf of github Jun 24, 2024

The following labels could not be found: Dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants