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.2 #4895

Merged
merged 1 commit into from
Oct 22, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 9, 2023

Bumps typedoc from 0.24.8 to 0.25.2.

Release notes

Sourced from typedoc's releases.

v0.25.2

Features

  • Added navigationLeaves option to remove branches from the navigation tree, #2382.
  • Added sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #2393.
  • Improved support for multi-word searches, #2400.

Bug Fixes

  • Fixed conversion of @template constraints on JSDoc defined type parameters, #2389.
  • Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #2403.
  • Fixed tsconfig handling for projects using a solution-style tsconfig, #2406.
  • Fixed broken settings icons caused by icon caching introduced in 0.25.1, #2408.
  • Corrected module comment handling on declaration files containing a single declare module "foo", #2401.

Thanks!

v0.25.1

Features

  • Added stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.
  • Added --excludeCategories config option to remove reflections present in any excluded category, #1407.
  • If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
  • Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time with large projects and also provides large space benefits. Themes may now override DefaultTheme.buildNavigation to customize the displayed navigation tree, #2287. Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored. It will be removed in v0.26.
  • The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
  • TypeDoc will now attempt to cache icons when DefaultThemeRenderContext.icons is overwritten by a custom theme. Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within each page. TypeDoc does it in the defaultLayout template.
  • Cache URL derivation during generation, #2386.

Bug Fixes

  • @property now works as expected if used to override a method's documentation.
  • Deprecated functions/methods are now correctly rendered with a struck-out name.
  • --watch mode works again, #2378.
  • Improved support for optional names within JSDoc types, #2384.
  • Fixed duplicate rendering of reflection flags on signature parameters, #2385.
  • TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
  • --exclude is now respected when expanding globs in entry points, #2376.

Thanks!

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.25.2 (2023-10-08)

Features

  • Added navigationLeaves option to remove branches from the navigation tree, #2382.
  • Added sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #2393.
  • Improved support for multi-word searches, #2400.

Bug Fixes

  • Fixed conversion of @template constraints on JSDoc defined type parameters, #2389.
  • Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #2403.
  • Fixed tsconfig handling for projects using a solution-style tsconfig, #2406.
  • Fixed broken settings icons caused by icon caching introduced in 0.25.1, #2408.
  • Corrected module comment handling on declaration files containing a single declare module "foo", #2401.

Thanks!

v0.25.1 (2023-09-04)

Features

  • Added stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.
  • Added --excludeCategories config option to remove reflections present in any excluded category, #1407.
  • If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
  • Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time with large projects and also provides large space benefits. Themes may now override DefaultTheme.buildNavigation to customize the displayed navigation tree, #2287. Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored. It will be removed in v0.26.
  • The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
  • TypeDoc will now attempt to cache icons when DefaultThemeRenderContext.icons is overwritten by a custom theme. Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within each page. TypeDoc does it in the defaultLayout template.
  • Cache URL derivation during generation, #2386.

Bug Fixes

  • @property now works as expected if used to override a method's documentation.
  • Deprecated functions/methods are now correctly rendered with a struck-out name.
  • --watch mode works again, #2378.
  • Improved support for optional names within JSDoc types, #2384.
  • Fixed duplicate rendering of reflection flags on signature parameters, #2385.
  • TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
  • --exclude is now respected when expanding globs in entry points, #2376.

Thanks!

... (truncated)

Commits
  • 22fe25c Update changelog for release
  • 73d7f3a Bump version to 0.25.2
  • 4e16473 Bump dev dep versions
  • 6cb49b2 Add sortEntryPoints option
  • 130ba48 Handle @template constraints correctly
  • 8e0aaf7 Handle @module on declare module "foo"
  • b12258d Add navigationLeaves option
  • 2cabd22 Fix invalid link handling in packages mode
  • 608cf48 Fix solution style tsconfigs
  • 878e06a Fix broken settings icons
  • 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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Oct 9, 2023
@github-actions github-actions bot added the chore label Oct 9, 2023
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.24.8 to 0.25.2.
- [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.2)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.25.2 branch from 8bb261f to 6c4fd84 Compare October 13, 2023 15:37
@Jason3S Jason3S merged commit 3c7f16e into main Oct 22, 2023
80 checks passed
@Jason3S Jason3S deleted the dependabot/npm_and_yarn/typedoc-0.25.2 branch October 22, 2023 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore 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.

1 participant