chore: Update dependency typedoc to v0.22.7 #2089
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.21.9
->0.22.7
Release Notes
TypeStrong/TypeDoc
v0.22.7
Compare Source
Features
githubprivate.com
domain, #1743.Bug Fixes
hideGenerator
is set, #1749.@category
tag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.6
Compare Source
Features
@enum
to all variables whose property types are string literals, #1740.Bug Fixes
as const
style enums, #1727.@typeParam
on type aliases, #1733.Thanks!
v0.22.5
Compare Source
Features
@param
comments for destructured parameters and rename__namedParameters
to the name specifiedin the
@param
comment if the number of@param
comments match the number of parameters, resolves #1703.intentionallyNotExported
option may now include file names/paths to limit its scope, for example, the followingwill suppress warnings from
Foo
insrc/foo.ts
not being exported, but will not suppress warnings if anotherFoo
declared in
src/utils/foo.ts
is not exported.--emit
option can now be used to more finely control what TypeDoc will emit.both
docs
none
true
both
, for backwards compatibility. Will be removed in 0.23.false
docs
, for backwards compatibility. Will be removed in 0.23.Bug Fixes
<caption>
elements from@example
tags, resolves #1679.emitDeclarationOnly
compiler option is now supported, resolves #1716..json
, resolves #1712.globalThis
namespace, could only be caused by a plugin.Thanks!
v0.22.4
Compare Source
Features
validation
can now be set to true/false to enable/disable all flags within them.githubPages
option (default: true), which will create a.nojekyll
page in the generated output, resolves #1680.MarkdownEvent
is now exported, resolves #1696.Bug Fixes
Thanks!
v0.22.3
Compare Source
Bug Fixes
light-plus
anddark-plus
, they were accidentally set tomin-light
andmin-dark
in v0.22.0.Features
validation
option which can be used to disable checks for non-exported symbols.On the command line, this can be specified with
--validation.notExported true
, or in an options file with:validation
option, deprecatedlistInvalidSymbolLinks
, which will be removed in 0.23.v0.22.2
Compare Source
Bug Fixes
v0.22.1
Compare Source
Bug Fixes
v0.22.0
Compare Source
Breaking Changes
packages
andentryPoints
options have been combined.To migrate configurations which used
packages
, replacepackages
withentryPoints
and setentryPointStrategy
topackages
.disableOutputCheck
tocleanOutputDir
to more clearly reflect its behavior.highlightTheme
option has been split intolightHighlightTheme
anddarkHighlightTheme
.toc
option.This change provides major performance benefits, reducing rendering time by up to 10x for several benchmarked projects.
It also allows themes to be easily type checked, preventing mistakes when creating custom themes.
Removing Handlebars also fixed memory leaks when
--watch
was specified due to Handlebar's caching mechanism.This change breaks all existing custom themes, so a theme created for v0.21 or earlier will not work in v0.22.
See internal-docs/custom-themes.md for documentation on how to create a custom theme in v0.22.
entryPointStrategy
fromexpand
toresolve
.Features
customCss
option, closes #1060.for documentation on how to create a plugin which enables this.
Support for linking to MDN for global types is provided by typedoc-plugin-mdn-links.
entryPointStrategy
to reduce confusion from new TypeDoc users on handling of entry points.There are three possible options:
<directory>/index
as the entry point.--packages
in v0.21, behaves as documented in the Monorepo section in the readme.typedocMain
in package.json when using thepackages
strategy for resolving entry points.application.validate(project)
.as const
enums", closes #1675.hideLegend
option, closes #1108.--logLevel Verbose
)Bug Fixes
@param
, the name will not be dropped when rendering, closes #1410.API Breaking Changes
"export"
key inpackage.json
, preventing plugins from importing internal paths.TypeDoc should now export all necessary structures (potentially marked with
@internal
if likely to change) from the root export.ReflectionKind
values forProject
,Module
,Namespace
, andEnum
have changed.export=
. Plugins are now required to export aload
function.TypeParameterType
, references to type parameters have produced aReferenceType
since v0.20.0.clone
method. It inconsistently performed deep or shallow clones, and was not used by TypeDoc.equals
method. It was occasionally correct for medium-complexity types, and always incorrect for more complicated types.Thanks!
v0.21.9 (2021-08-29)
Bug Fixes
Thanks!
v0.21.8 (2021-08-28)
Features
Thanks!
v0.21.7 (2021-08-27)
Features
v0.21.6 (2021-08-19)
Features
Bug Fixes
Thanks!
v0.21.5 (2021-07-31)
Features
Bug Fixes
Thanks!
v0.21.4 (2021-07-12)
Bug Fixes
v0.21.3 (2021-07-10)
Breaking Changes
Bug Fixes
Thanks!
v0.21.2 (2021-06-27)
Bug Fixes
v0.21.1 (2021-06-25)
Bug Fixes
readme
could not be set tonone
in a config file, closes #1608Configuration
📅 Schedule: "on the first day of the month" (UTC).
🚦 Automerge: Enabled.
♻ 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 WhiteSource Renovate. View repository job log here.