[Snyk] Upgrade typedoc from 0.23.28 to 0.25.1

[szikszail]

This PR was automatically created by Snyk using the credentials of a real user.

Snyk has created this PR to upgrade typedoc from 0.23.28 to 0.25.1.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

---

• The recommended version is 19 versions ahead of your current version.
• The recommended version was released 2 months ago, on 2023-09-04.

Release notes

Package name: typedoc

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

  • @ ajesshope
  • @ HemalPatil
  • @ hrueger
  • @ typhonrt
• 0.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
  • 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!

  • @ camc314
  • @ cprussin
  • @ roggervalf
  • @ Th3S4mur41
• 0.24.8 - 2023-06-04
  

  Features

  • Added support for TypeScript 5.1, #2296.
  • Added navigation.fullTree to control rendering the full navigation tree on each page, #2287.
    This option will likely be replaced in 0.25 with dynamic loading of the full tree.
  • TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
  • Optimized icon caching to reduce file size in generated HTML documentation, #2287.
  • Render property description of "roughly top level" object types, #2276.
  • Added MarkdownEvent.INCLUDE for plugins, #2284.

  Bug Fixes

  • When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
    and any other block tags in the order they are defined in the comment, #2285.
  • Comments are no longer removed from classes/interfaces containing call signatures, #2290.

  Thanks!

  • @ krisztianb
  • @ WikiRik
• 0.24.7 - 2023-05-08
  

  Features

  • TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.

  Bug Fixes

  • Category children are now sorted according to the sort option, #2272.
  • Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
  • Fixed module/namespace links in navigation when viewed in Safari, #2275.
• 0.24.6 - 2023-04-24
  Read more
• 0.24.5 - 2023-04-22
  Read more
• 0.24.4 - 2023-04-16
  

  Bug Fixes

  • Fixed broken semantic coloring, #2247.
  • Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #2244.
  • Underline color of index links now matches the text color, #2245.
  • Increased contract for active menu item text in dark mode.
• 0.24.3 - 2023-04-16
  Read more
• 0.24.2 - 2023-04-15
  Read more
• 0.24.1 - 2023-04-09
  Read more
• 0.24.0 - 2023-04-08
• 0.24.0-beta.8 - 2023-04-03
• 0.24.0-beta.7 - 2023-03-26
• 0.24.0-beta.6 - 2023-03-25
• 0.24.0-beta.5 - 2023-03-25
• 0.24.0-beta.4 - 2023-03-25
• 0.24.0-beta.3 - 2023-03-12
• 0.24.0-beta.2 - 2023-03-06
• 0.24.0-beta.1 - 2023-03-05
• 0.23.28 - 2023-03-19

from typedoc GitHub release notes

Commit messages

Package name: typedoc

• 265bf49 Bump version to 0.25.1
• 0985616 Handle projects without tsconfig files
• bcf3e04 Add excludeCategories option
• 653b281 Respect --exclude when expanding globs in entry points
• a6823cf Cache URL derivation during generation
• 1f88a1f Compress search index too
• d68ca2a Update changelog
• dc4a16d feat: `stripYamlFrontmatter` option (#2387)
• 67ee6ac Dynamically load navigation
• bba61bc Migrate to ES decorators, fix deprecated strikethrough
• aefeac0 Fixed duplicate rendering of reflection flags
• bd54dc0 Improve tag name extraction
• 55fa03e Latest npm no longer supports node 16
• 055ae5a Update changelog
• b367539 Do not exit when in watch mode (#2379)
• 6f3fb57 Fix `@ property` on methods
• 3117703 How did that git missed in the changelog
• 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

Compare

---

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

[github-actions]

Coverage Report 🎉

Totals
Statements:	100% ( 138 / 138 )
Methods:	100% ( 15 / 15 )
Lines:	100% ( 101 / 101 )
Branches:	100% ( 22 / 22 )