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(deps): bump typedoc from 0.24.8 to 0.25.0 #1999

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 30, 2023

Bumps typedoc from 0.24.8 to 0.25.0.

Release notes

Sourced from typedoc's releases.

v0.25.0

Breaking Changes

  • Bump minimum Node version to 16.
  • Removed legacy-packages option for --entryPointStrategy.
  • Changed default value of --categorizeByGroup to false.
  • Specifying a link as the gitRemote is no longer supported.
  • An Application instance must now be retrieved via Application.bootstrap or Application.bootstrapWithPlugins, #2268.
  • Removed ReflectionKind.ObjectLiteral that was never used by TypeDoc.
  • Removed deprecated members DefaultThemeRenderContext.comment and DefaultThemeRenderContext.attemptExternalResolution.

Features

  • Added support for TypeScript 5.2
  • TypeDoc config files now support options default-exported from an ESM config file, #2268.
  • TypeDoc config files may now export a promise containing configuration, #2268.
  • Added --preserveLinkText option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, #2355.
  • Added a no-results placeholder when no search results are available, #2347.
  • Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds.
  • Added --disableGit option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.
  • Added support for tags @showGroups, @hideGroups, @showCategories, @hideCategories to configure the navigation pane on a per-reflection basis, #2329.
  • With --jsDocCompatibility.defaultTags set, @defaultValue is now implicitly a code block if the text contains no code, #2370.

Bug Fixes

  • Fixed link discovery if nested (Foo#bar) links were used and --useTsLinkResolution is enabled in some cases, #2360.
  • Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
  • Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
  • @inheritDoc was not properly resolved across packages in packages mode, #2331.
  • Added warning for attempted @interface use on union types, #2352.
  • Fixed misleading type annotation on Theme.getUrls, #2318.
  • Fixed duplicate namespace in documentation if @namespace is used on a variable with an associated namespace, #2364.
  • Fixed @namespace property discovery if merged with a type and the type was declared first #2364.
  • Tables in markdown are now styled, #2366.
  • Sidebar links no longer open in a new tab, #2353.
  • Headers now include some padding before rendering text, #2316.
  • Symbol locations for signatures on reflection.sources now considers the node's name like non-signature location discovery does.

Thanks!

Changelog

Sourced from typedoc's changelog.

v0.25.0 (2023-08-25)

Breaking Changes

  • Bump minimum Node version to 16.
  • Removed legacy-packages option for --entryPointStrategy.
  • Changed default value of --categorizeByGroup to false.
  • Specifying a link as the gitRemote is no longer supported.
  • An Application instance must now be retrieved via Application.bootstrap or Application.bootstrapWithPlugins, #2268.
  • Removed ReflectionKind.ObjectLiteral that was never used by TypeDoc.
  • Removed deprecated members DefaultThemeRenderContext.comment and DefaultThemeRenderContext.attemptExternalResolution.

Features

  • Added support for TypeScript 5.2, #2373.
  • TypeDoc config files now support options default-exported from an ESM config file, #2268.
  • TypeDoc config files may now export a promise containing configuration, #2268.
  • Added --preserveLinkText option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, #2355.
  • Added a no-results placeholder when no search results are available, #2347.
  • Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds.
  • Added --disableGit option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.
  • Added support for tags @showGroups, @hideGroups, @showCategories, @hideCategories to configure the navigation pane on a per-reflection basis, #2329.
  • With --jsDocCompatibility.defaultTags set, @defaultValue is now implicitly a code block if the text contains no code, #2370.

Bug Fixes

  • Fixed link discovery if nested (Foo#bar) links were used and --useTsLinkResolution is enabled in some cases, #2360.
  • Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
  • Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
  • @inheritDoc was not properly resolved across packages in packages mode, #2331.
  • Added warning for attempted @interface use on union types, #2352.
  • Fixed misleading type annotation on Theme.getUrls, #2318.
  • Fixed duplicate namespace in documentation if @namespace is used on a variable with an associated namespace, #2364.
  • Fixed @namespace property discovery if merged with a type and the type was declared first #2364.
  • Tables in markdown are now styled, #2366.
  • Sidebar links no longer open in a new tab, #2353.
  • Headers now include some padding before rendering text, #2316.
  • Symbol locations for signatures on reflection.sources now considers the node's name like non-signature location discovery does.

Thanks!

Commits
  • 8d822e9 Update changelog for release
  • fc6f648 Bump version to 0.25.0
  • d4db571 Add preserveLinkText option
  • 3d8ff29 defaultValue is implicitly code only with JSDoc compat
  • 028a141 feat(default-value): treat as code block for better styling (#2370)
  • c83f2c3 Add support for TS 5.2
  • 5c977ae Support ESM config files
  • 76c918c Headers now include some padding before rendering text
  • 0cc6e58 Sidebar links no longer open in a new tab, closes #2353.
  • 3207ae5 Lint
  • Additional commits viewable in compare view

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

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested a review from a team as a code owner August 30, 2023 11:49
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Aug 30, 2023
@ghost ghost mentioned this pull request Aug 31, 2023
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Aug 31, 2023

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

@dependabot dependabot bot closed this Aug 31, 2023
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.25.0 branch August 31, 2023 08:58
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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants