-
Notifications
You must be signed in to change notification settings - Fork 0
Update dependency typedoc to v0.28.3 #179
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
renovate
wants to merge
1
commit into
master
Choose a base branch
from
renovate/packages-that-may-break-with-minor-update
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update dependency typedoc to v0.28.3 #179
renovate
wants to merge
1
commit into
master
from
renovate/packages-that-may-break-with-minor-update
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37ba5c9
to
af87d85
Compare
|
f213e9c
to
6170611
Compare
3d71d6b
to
97631d0
Compare
75adff1
to
1148731
Compare
1148731
to
87f12a2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
None yet
0 participants
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.9
->0.28.3
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.28.3
Compare Source
Bug Fixes
@inline
now functions when referencing tuple types, #2932.@link
links to the current page are now rendered, #2934.@includeCode
now supports regions in TypeScript files with.mts
and.cts
file extensions, #2935.v0.28.2
Compare Source
Features
@group none
and@category none
will now render their children without a sectionheading in the default theme, #2922.
@disableGroups
tag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@class
now correctly handle@category
, #2914.@class
now include constructor parameters, #2914.@class
with a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappings
option when URL is set to#
, #2921.@typedef
now correctly handle the constraint, #2929.toString
on types containing index signatures now behave correctly, #2917.@inlineType
to the list of tags excluded by default.v0.28.1
Compare Source
Features
TypeDocOptions
interface now marks options as optional so it no longer has to be wrapped inPartial
for use in config files, #2901.
localStorage
without clearing it, #2908.Bug Fixes
--watch
can now infer entry points frompackage.json
as supported in non-watch mode, #2899.@include
with regions now works on files with CRLF line endings, #2902.module.exports = []
, #2909../
in relative links, #2910.Thanks!
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 - "on Sunday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ 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.