Update dependency typedoc to v0.25.10 #189
Merged
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 contains the following updates:
0.24.8
->0.25.10
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.25.10
Compare Source
Bug Fixes
@interface
, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
v0.25.9
Compare Source
Features
Bug Fixes
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.Thanks!
v0.25.8
Compare Source
v0.25.7
Compare Source
Bug Fixes
v0.25.6
Compare Source
Bug Fixes
v0.25.5
Compare Source
v0.25.4
Compare Source
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!
v0.25.3
Compare Source
Features
--sourceLinkExternal
option to render source code links as external, #2415.declarationMap
option to be set to true to handle cross-package links in packages mode, #2416.external-last
option for the--sort
option, #2418.Bug Fixes
Thanks!
v0.25.2
Compare Source
Features
navigationLeaves
option to remove branches from the navigation tree, #2382.sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393.Bug Fixes
@template
constraints on JSDoc defined type parameters, #2389.declare module "foo"
, #2401.Thanks!
v0.25.1
Compare Source
Features
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381.--excludeCategories
config option to remove reflections present in any excluded category, #1407.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.
DefaultThemeRenderContext.icons
is overwritten by a custom theme.Note: To perform this optimization, TypeDoc relies on
DefaultThemeRenderContext.iconCache
being rendered withineach page. TypeDoc does it in the
defaultLayout
template.Bug Fixes
@property
now works as expected if used to override a method's documentation.--watch
mode works again, #2378.intrinsic
keyword if TS intrinsic types are included in documentation.--exclude
is now respected when expanding globs in entry points, #2376.Thanks!
v0.25.0
Compare Source
Breaking Changes
legacy-packages
option for--entryPointStrategy
.--categorizeByGroup
tofalse
.gitRemote
is no longer supported.Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.ReflectionKind.ObjectLiteral
that was never used by TypeDoc.DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is includedin the output when no override is specified, #2355.
site from ~5.6 seconds to ~5.4 seconds.
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on aper-reflection basis, #2329.
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.@inheritDoc
was not properly resolved across packages in packages mode, #2331.@interface
use on union types, #2352.Theme.getUrls
, #2318.@namespace
is used on a variable with an associated namespace, #2364.@namespace
property discovery if merged with a type and the type was declared first #2364.reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
v0.24.8 (2023-06-04)
Features
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.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7 (2023-05-08)
Features
Bug Fixes
sort
option, #2272.v0.24.6 (2023-04-24)
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.Thanks!
v0.24.5 (2023-04-22)
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4 (2023-04-16)
Bug Fixes
v0.24.3 (2023-04-16)
Bug Fixes
v0.24.2 (2023-04-15)
Features
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitle
option.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237.__@​
symbol name, #2234.--entryPointStrategy packages
.Thanks!
v0.24.1 (2023-04-09)
Bug Fixes
@example
tags, #2222.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.