Update dependency typedoc to ^0.28.0 #1195
Open
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.27.1
->^0.28.0
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.28.0
Compare Source
Breaking Changes
/
path separators, #2825.--entryPointStrategy merge
mode now requires JSON from at least version 0.28.0.jp
translations fromlang
, to migrate switch toja
.intentionallyNotExported
now use a package name/package relative path instead of an absolute path for matching.source-order
sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.json
file if--readme
is not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@function
tag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbol
andProjectReflection.getSymbolFromReflection
have been moved toContext
Path
andPathArray
parameter types now always contain normalized paths.Router
which is used for URL creation.Reflection.url
,Reflection.anchor
, andReflection.hasOwnDocument
have been removed.Deserializer.reviveProject(s)
no longer accepts an option to add project documents.Deserializer.reviveProjects
now requires analwaysCreateEntryPointModule
option.Comment.serializeDisplayParts
no longer requires a serializer argument.ReflectionSymbolId.fileName
is now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileName
property will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoost
attribute which was added for plugins, but never used.i18n
proxy is no longer passed to many functions, instead, referencei18n
exported from the module directly.ReflectionKind.singularString
andReflectionKind.pluralString
now returns translated strings.The methods on
Internationalization
to do this previously have been removed.DefaultThemeRenderContext
'stypeDeclaration
andtypeDetailsIfUseful
methods now require both a reflection and a type in order to support
@expandType
Features
--router
option which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@primaryExport
modifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentation
option forvalidation.notDocumented
, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browser
entrypoint for parsing and using serialized JSON files, #2528.packageOptions
asPartial<TypeDocOptions>
, #2878.packageOptions
, #2878.@function
tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDoc
global object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage
, #2872.@preventInline
and@inlineType
tags for further control extending the@inline
tag, #2862.@preventExpand
and@expandType
tags for further control extending the@expand
tag, #2862.DefaultThemeRenderContext.reflectionIcon
for more granular control over displayed reflection icons.Bug Fixes
Thanks!
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, 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.