This repository has been archived by the owner on Oct 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Update dependency typedoc to v0.25.2 #544
Open
renovate
wants to merge
1
commit into
master
Choose a base branch
from
renovate/typedoc-0.x
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
Conversation
This file contains 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
2a63b2d
to
2e1f2f1
Compare
2e1f2f1
to
4073f99
Compare
4073f99
to
1a7d70a
Compare
1a7d70a
to
9ecf2d2
Compare
9ecf2d2
to
3318158
Compare
3318158
to
b975a68
Compare
b975a68
to
086f3e6
Compare
086f3e6
to
cb7a365
Compare
cb7a365
to
b7f8bf5
Compare
b7f8bf5
to
95710f4
Compare
95710f4
to
7da77d4
Compare
7da77d4
to
105667d
Compare
105667d
to
db9b91f
Compare
db9b91f
to
70ad080
Compare
70ad080
to
81ea966
Compare
81ea966
to
50f947c
Compare
50f947c
to
febe4b7
Compare
febe4b7
to
1715052
Compare
1715052
to
435dfb5
Compare
435dfb5
to
23a636f
Compare
23a636f
to
d08986a
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.22.17
->0.25.2
Release Notes
TypeStrong/TypeDoc (typedoc)
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.v0.24.8
Compare Source
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
Compare Source
Features
Bug Fixes
sort
option, #2272.v0.24.6
Compare Source
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
Compare Source
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
Compare Source
Bug Fixes
v0.24.3
Compare Source
Bug Fixes
v0.24.2
Compare Source
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
Compare Source
Bug Fixes
@example
tags, #2222.v0.24.0
Compare Source
Breaking Changes
@link
,@linkcode
and@linkplain
tags will now be resolved with TypeScript's link resolution by default. TheuseTsLinkResolution
optioncan be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.
node_modules
. Specify the--plugin
option to indicate which modules should be loaded.packages
entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.The previous
packages
strategy has been preserved underlegacy-packages
and will be removed in 0.25. If the new strategy does not workfor your use case, please open an issue.
--logger
option, to disable all logging, set thelogLevel
option tonone
.[[link]]
s, removed deprecatedReflection.findReflectionByName
.@overload
to default ignored tags.API Breaking Changes
label
property onReflection
has moved toComment
.out
option has been changed from""
to"./docs"
, #2195.DeclarationReflection#version
toDeclarationReflection#projectVersion
to match property onProjectReflection
.Reflection#originalName
.Reflection#kindString
, useReflectionKind.singularString(reflection.kind)
orReflectionKind.pluralString(reflection.kind)
instead.named-tuple-member
andtemplate-literal
type kind have been replaced withnamedTupleMember
andtemplateLiteral
, #2100.Reflection
, includingurl
,anchor
,hasOwnDocument
, andcssClasses
.Application.bootstrap
will no longer load plugins. If you want to load plugins, useApplication.bootstrapWithPlugins
instead, #1635.Application.bootstrap
will now be applied both before and after reading options files, which may cause a change in configurationif using a custom script to run TypeDoc that includes some options, but other options are set in config files.
sources
property previously declared on baseReflection
class toDeclarationReflection
andSignatureReflection
.relevanceBoost
fromContainerReflection
toDeclarationReflection
since setting it on the parent class has no effect.ReferenceType.getSymbol
, reference types no longer reference thets.Symbol
to enable generation from serialized JSON.OptionsReader.priority
has been renamed toOptionsReader.order
to more accurately reflect how it works.ReferenceType
s which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.ReferenceType
s now longer include anid
property for their target. They now instead include atarget
property.Renderer.addExternalSymbolResolver
, useConverter.addExternalSymbolResolver
instead.CallbackLogger
.SerializeEventData
from serialization events.PageEvent
is now required forgetRenderContext
. If caching the context object,page
must be updated whengetRenderContext
is called.PageEvent
no longer includes thetemplate
property. TheTheme.render
method is now expected to take the template to render the page with as its second argument.secondaryNavigation
member onDefaultThemeRenderContext
.navigation
tosidebar
onDefaultThemeRenderContext
andnavigation.begin
/navigation.end
hooks tosidebar.begin
/sidebar.end
.Features
--useTsLinkResolution
option (on by default) which tells TypeDoc to use TypeScript's@link
resolution.--jsDocCompatibility
option (on by default) which controls TypeDoc's automatic detection of code blocks in@example
and@default
tags.@interface
on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519@namespace
on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.@prop
/@property
to specify documentation for a child property of a symbol, intended for use with@interface
.Promise<void>
from theirload
function, #185.Renderer.preRenderAsyncJobs
andRenderer.postRenderAsyncJobs
, which may be used by plugins to perform async processing for rendering, #185.Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs.
typedocOptions
key inpackage.json
, #2112.--cacheBust
option to tell TypeDoc to include include the generation time in files, #2124.--excludeReferences
option to tell TypeDoc to omit re-exports of a symbol already included from the documentation.pageSidebar.begin
andpageSidebar.end
.Bug Fixes
name
field, #2190.@inheritDoc
on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.v
in versions, #2212.typeof
on a reference with type arguments, #2220.Thanks!
v0.23.28 (2023-03-19)
Features
const
type parameters.@overload
tag.@satisfies
tag.v0.23.27 (2023-03-16)
Features
--treatValidationWarningsAsErrors
to treat only validation warnings as errors without treating all warnings as errors, #2199.Bug Fixes
@private
and@protected
tags totypedoc/tsdoc.json
, #2187.Thanks!
v0.23.26 (2023-02-26)
Features
Application.EVENT_VALIDATE_PROJECT
event for plugins which implement custom validation, #2183.Comment.displayPartsToMarkdown
on for themes overwriting thecomment
helper, #2115.Bug Fixes
export default undefined
, #2175.Thanks!
v0.23.25 (2023-02-11)
Breaking Changes
material-<theme>
, the value will need to be changed tomaterial-theme-<theme>
, see the Shiki release notes.Features
excludeNotDocumentedKinds
variable to control which reflection types can be removedby the
excludeNotDocumented
option, #2162.typedoc.jsonc
,typedoc.config.js
,typedoc.config.cjs
,typedoc.cjs
to the list of fileswhich TypeDoc will automatically use as configuration files.
Bug Fixes
node_modules
will no longer be ignored, #2151.excludeNotDocumented
on arrow function-variables, #2156.package.json
to exports declaration.Thanks!
v0.23.24 (2023-01-07)
Bug Fixes
Thanks!
v0.23.23 (2022-12-18)
Features
ts.Signature
to emittedEVENT_CREATE_SIGNATURE
event, #2002.Bug Fixes
src/
andsrc/x
are specified as entry points,src/
will no longer be ignored, #2121.v0.23.22 (2022-12-11)
Features
Bug Fixes
@link
tags within lists, #2103.v0.23.21 (2022-11-14)
Features
externalSymbolLinkMappings
, #2102.Thanks!
v0.23.20 (2022-11-03)
Bug Fixes
@inheritDoc
if inheriting from a function type alias, #2087.v0.23.19 (2022-10-28)
Bug Fixes
titleLink
option was not specified, #2085.Thanks!
v0.23.18 (2022-10-23)
Features
Bug Fixes
@param
comment for the parameter if available, #1261.v0.23.17 (2022-10-18)
Features
titleLink
,navigationLinks
andsidebarLinks
options to add additional links to the rendered output, #1830.sourceLinkTemplate
option to allow more flexible specification of remote urls.Deprecated now redundant
gitRevision
detection starting withhttps?://
introduced in v0.23.16, #2068.Thanks!
v0.23.16 (2022-10-10)
Features
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}
in package.json, #2061.Bug Fixes
Thanks!
v0.23.15 (2022-09-18)
Features
@typedef {import("foo").Bar<Z>} Baz
type declarations which forward type parameters to the importedsymbol as re-exports of that symbol, #2044.
Bug Fixes
widgets.png
andwidgets@2x.png
files from generated assets folder.v0.23.14 (2022-09-03)
Features
externalSymbolLinkMappings
seethe documentation for usage examples and caveats, #2030.
addUnknownSymbolResolver
will now be checked when resolving@link
tags, #2030.Note: To support this, resolution will now happen during conversion, and as such,
Renderer.addUnknownSymbolResolver
has beensoft deprecated in favor of
Converter.addUnknownSymbolResolver
. Plugins should update to use the method onConverter
.DefaultThemeRenderContext.attemptExternalResolution
has also been deprecated since it will repeat work done during conversion,use
ReferenceType.externalUrl
instead.Converter.addUnknownSymbolResolver
for use by plugins supporting external links.Bug Fixes
v0.23.13 (2022-09-01)
Bug Fixes
v0.23.12 (2022-08-31)
Features
ParameterType.Object
for declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_END
event emitted whenApplication.bootstrap
is called.Bug Fixes
isIdentifierOrPrivateIdentifier
.Thanks!
v0.23.11 (2022-08-26)
Features
skipErrorChecking
option which instructs TypeDoc to not ask TypeScript for compiler errorsbefore attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
Bug Fixes
@link
tags resolved, #2029.DefaultThemeRenderContext
now contain all the HTML for their sections of the page, #2038.Thanks!
v0.23.10 (2022-07-31)
Features
sort
option.prop
asprop?
, #2023.DefaultThemeRenderContext.markdown
now also accepts aCommentDisplayPart[]
for rendering, #2004.Converter.resolveLinks
method for use withConverter.parseRawComment
, #2004.Bug Fixes
typedoc/tsdoc.json
in TSDoc extends, #2015.@typedef
comments for properties, #2020.Thanks!
v0.23.9 (2022-07-24)
Bug Fixes
If using
"entryPointStrategy": "expand"
, this change may result in new pages being added to your documentation.If this is not desired, you can use the
exclude
option to filter them out.--includeVersion
flag, #2010.v0.23.8 (2022-07-17)
Features
*.ghe.com
and*.github.us
GitHub enterprise domains for source links, #2001.Converter.parseRawComment
for plugins to parse additional markdown files, #2004.Bug Fixes
{@​link}
containing a URL, #1980.excludeNotDocumented
will no longer remove functions/methods/accessors which are documented, #1994.sources
property on signature reflections #1996.Thanks!
v0.23.7 (2022-07-09)
Bug Fixes
@jest/globals
in a comment will no longer be parsed as a tag #1990.v0.23.6 (2022-07-08)
Features
--entryPointStrategy Packages
. TypeDoc will now load package-specific configurations frompackage.json
typedoc
field. This configuration allows configuring a custom display name (typedoc.displayName
) field, entry point (typedoc.entryPoint
- this is equivalent and will overridetypedocMain
), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile
), #1658.--includeVersion
option will now be respected by--entryPointStrategy Packages
. Also, for this combination, missingversion
field in the rootpackage.json
will not issue a warning.navigation
partial will now call the newsettings
,primaryNavigation
, andsecondaryNavigation
partials, #1987.Bug Fixes
Thanks!
v0.23.5 (2022-07-02)
Features
DEBUG_SEARCH_WEIGHTS
global variable can now be set onwindow
to add search scoring information in the search results.DefaultThemeRenderContext.icons
for use/modification by themes.v0.23.4 (2022-07-02)
Bug Fixes
--entryPointStrategy Packages
is set, #1976.search.js
generated file.Features
--exclude
option will now be respected by--entryPointStrategy Packages
and can be used to exclude package directories, #1959.IndexEvent
on theRenderer
when preparing the search index, #1953.--searchInComments
option to include comment text in the search index, #1553.Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3 (2022-07-01)
Bug Fixes
@example
tag, #1967.intentionallyNotExported
will now properly respect qualified names, #1972.export * as NS
declarations, #1973.export const x = () => 123
function variables, #1973.get
andset
signatures of an accessor have a comment.Features
--htmlLang
option to set thelang
attribute in the generated HTML. Defaults toen
, #1951.--basePath
option to override TypeDoc's detected root directory, #1924.:getter
and:setter
meaning keywords in declaration references.v0.23.2 (2022-06-28)
Bug Fixes
@module
comments in the entry point, #1963.<= 0
due tosearchCategoryBoosts
orsearchGroupBoosts
will be excluded from search.v0.23.1 (2022-06-26)
Bug Fixes
v0.23.28
Compare Source
Features
const
type parameters.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 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 Mend Renovate. View repository job log here.