chore(deps): update dependency typedoc to ^0.27.5 #2239
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.26.11
->^0.27.5
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.27.5
Compare Source
Bug Fixes
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, #2808.
rendered document and the parent property/page will be linked to instead,
#2808. These warnings can be disabled with the
validation.rewrittenLink
option.
https://
links under thehostedBaseUrl
option's URL will nolonger be treated as external, #2809.
Thanks!
v0.27.4
Compare Source
Features
Converter.EVENT_CREATE_PROJECT
event which fires when a project is created by the converter, #2800.Bug Fixes
@include
and@includeCode
now work for comments on the entry point for projects with a single entry point, #2800.@summary
now works to describe functions within modules, #2803.v0.27.3
Compare Source
Features
Bug Fixes
highlightLanguages
option now permits Shiki aliases to be specified rather than just the language ID, #2798.Thanks!
v0.27.2
Compare Source
Bug Fixes
v0.27.1
Compare Source
Bug Fixes
@categoryDescription
and@groupDescription
on module pages, #2787.v0.27.0
Compare Source
Breaking Changes
result in a different file name structure, #2714.
have changed. They can be partially restored to the previous format by
setting
--sluggerConfiguration.lowercase false
. This change was made tomore closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
hideParameterTypesInTitle
option, this was originally added asa workaround for many signatures overflowing the available horizontal space
in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
so this option is no longer necessary.
kindSortOrder
to put references last.sort
order to usealphabetical-ignoring-documents
instead of
alphabetical
.suppressCommentWarningsInDeclarationFiles
totrue
(e.g.
X
, notnew X
)@group
,@category
,@groupDescription
and@categoryDescription
will no longer be removed from the reflections they are present on. They are
skipped during rendering with the
notRenderedTags
option.Features
package.json
exports if theyare not provided manually, #1937.
#anchor
links toreference a heading within them.
@param
comments with nested object types, #2555.@param
comments which reference a typealias/interface. Important properties on the referenced type can now be
highlighted with
@param options.foo
, which will result in the additionalnote being included under the documentation for that parameter, #2147. Note:
This feature is limited to references. It is not supported on other types of
types.
outputs
option which is an array of outputs. This can be usedto render the documentation multiple times with different rendering options
or output types, #2597.
@expand
tag which can be placed on type aliases andinterfaces. When a type with
@expand
is referenced and TypeDoc has a placeto include additional details about the type, the properties of the type
will be included in the page where
@expand
is found. Note that use of thistag can significantly increase the size of your generated documentation if
it is applied to commonly used types as it will result in inlining the
comments for those types everywhere they are referenced, #2303.
@inline
tag which can be placed on type aliases andinterfaces. When a type with
@inline
is referenced, TypeDoc will resolvethe referenced type and convert the type as if it was included directly
within the referencing type. Note that use of this tag can significantly
increase the size of your generated documentation if it is applied to
commonly used types as it will result in inlining the comments for those
types everywhere they are referenced, #2303.
@useDeclaredType
tag for type aliases which can sometimesimprove their documentation, #2654.
@mergeModuleWith
tag which can be used to tell TypeDoc toplace a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
@include
and@includeCode
inline tags to include files withincomments/documents.
notRenderedTags
option. This option is similar to theexcludeTags
option, but while
excludeTags
will result in the tag being completelyremoved from the documentation,
notRenderedTags
only prevents it frombeing included when rendering.
groupReferencesByType
option.navigation.excludeReferences
optionuseFirstParagraphOfCommentAsSummary
option to configure how TypeDochandles comments for module members without the
@summary
tag.favicon
option to specify a.ico
or.svg
favicon to reference.together and will expand/collapse together, #2335.
app.outputs
object for defining new output strategies.@layer typedoc
, #2782.Bug Fixes
readonly
index signatures.overloads if present, #2718.
@enum
if the type was declared before the variable, #2719.declared inside
declare global
, #2774declare module "foo"
as a module rather than a namespace, #2778.cases. This primarily affected destructured parameters.
yaml
to the highlight languages supported by default.txt
as an alias oftext
to indicate a code blockshould not be highlighted.
@ignore
or@hidden
but still referenced byother types will no longer produce warnings about not being exported.
module when resolving
@link
tags.JavaScript is disabled.
rather than when converting. This prevents issues where boosts used by just
one package were incorrectly reported as unused when running with
entryPointStrategy set to packages.
Thanks!
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 was generated by Mend Renovate. View the repository job log.