[Snyk] Upgrade typedoc from 0.22.18 to 0.25.13 #3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR was automatically created by Snyk using the credentials of a real user.
Snyk has created this PR to upgrade typedoc from 0.22.18 to 0.25.13.
ℹ️ 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 68 versions ahead of your current version.
The recommended version was released a month ago, on 2024-04-07.
Release notes
Package name: typedoc
Features
gitRevision:short
placeholder option to--sourceLinkTemplate
option, #2529.Links generated by TypeDoc will now default to using the non-short git revision.
<footer>
tag, addedfooter.begin
andfooter.end
render hooks for use by custom plugins, #2532.
Bug Fixes
NoInfer
missing type parameter reference, #2539."This member is normally hidden due to your filter settings" for every member.
Thanks!
Features
Bug Fixes
Thanks!
Bug Fixes
h1>h2>h3
process, #2515.Bug Fixes
@ interface
, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
Features
Bug Fixes
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.Thanks!
Features
--sitemapBaseUrl
option. When specified, TypeDoc will generate asitemap.xml
in your output folder that describes the site, #2480.@ class
tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
@ groupDescription
and@ categoryDescription
to provide a description of groups and categories, #2494.Context.getNodeComment
for plugin use, #2498.Bug Fixes
Context.programs
will no longer contain duplicates, #2498.Bug Fixes
Bug Fixes
Features
--navigation.includeFolders
(default:true
) option to create nested navigation for projects which include many entry points, #2388.Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
@ param
tags which do not apply, #2368.this
or acceptingthis
as a parameter, #2458.Note: This will only happen if a method is declared as
method(): this
, it will not happen if the method implicitly returnsthis
as the compiler strips that information when creating types for a class instance.
namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
with a namespace. If the properties are added via
Object.assign
or via property assignment on the functionTypeDoc will now instead add the properties to the function's page, #2461.
Bug Fixes
notDocumented
validation will no longer require documentation for data within parameters that cannot be documented via@ param
, #2291.typedocOptions
fields from extended tsconfig files, #2334.@ group
and@ category
organization is now applied later to allow inherited comments to create groups/categories, #2459.this
, #2466.M
icon rather than sharing with the namespace icon.Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.
Features
This can be controlled through the new
DefaultThemeRenderContext.reflectionPreview
helper.Bug Fixes
gitRevision
will now be replaced insourceLinkTemplate
, #2434.Object.assign
, #2436.skipLibCheck
is used to ignore some compiler errors, #2438.@ example
tag titles will now be rendered in the example heading, #2440.@ namespace
-created namespaces, #2444.Thanks!
Commit messages
Package name: typedoc
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
Note: This is a default PR template raised by Snyk. Find out more about how you can customise Snyk PRs in our documentation.