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.26.7 to 0.27.0 #735

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 27, 2024

Bumps typedoc from 0.26.7 to 0.27.0.

Release notes

Sourced from typedoc's releases.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
  • API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
  • Relative links to markdown files may now include #anchor links to reference a heading within them.
  • Improved support for @param comments with nested object types, #2555.
  • Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note: This feature is limited to references. It is not supported on other types of types.
  • Added a new outputs option which is an array of outputs. This can be used to render the documentation multiple times with different rendering options or output types, #2597.
  • Added support for rendering alerts (or callouts) in markdown.
  • Add support for an @expand tag which can be placed on type aliases and interfaces. When a type with @expand is referenced and TypeDoc has a place to include additional details about the type, the properties of the type will be included in the page where @expand is found. Note that use of this

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
  • API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
  • Relative links to markdown files may now include #anchor links to reference a heading within them.
  • Improved support for @param comments with nested object types, #2555.
  • Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note: This feature is limited to references. It is not supported on other types of types.
  • Added a new outputs option which is an array of outputs. This can be used to render the documentation multiple times with different rendering options or output types, #2597.
  • Added support for rendering alerts (or callouts) in markdown.
  • Add support for an @expand tag which can be placed on type aliases and interfaces. When a type with @expand is referenced and TypeDoc has a place to include additional details about the type, the properties of the type will be included in the page where @expand is found. Note that use of this

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

---
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 Nov 27, 2024

The following labels could not be found: dependabot.

Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 28, 2024

Superseded by #736.

@dependabot dependabot bot closed this Nov 28, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/chore/dependabot/typedoc-0.27.0 branch November 28, 2024 22:57
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