Update typedoc → 0.25.1 (unknown)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ typedoc (^0.17.4 → ^0.25.1) · Repo · Changelog

Release Notes

0.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!

• @ajesshope
• @HemalPatil
• @hrueger
• @typhonrt

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 18 commits:

• Update changelog for release
• Bump version to 0.25.1
• Handle projects without tsconfig files
• Add excludeCategories option
• Respect --exclude when expanding globs in entry points
• Cache URL derivation during generation
• Compress search index too
• Update changelog
• feat: `stripYamlFrontmatter` option (#2387)
• Dynamically load navigation
• Migrate to ES decorators, fix deprecated strikethrough
• Fixed duplicate rendering of reflection flags
• Improve tag name extraction
• Latest npm no longer supports node 16
• Update changelog
• Do not exit when in watch mode (#2379)
• Fix `@property` on methods
• How did that git missed in the changelog

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)

[depfu]

Closed in favor of #519.