This repository was archived by the owner on Apr 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
chore(deps): update dependency typedoc to v0.24.4 #363
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.
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
Pull Request Test Coverage Report for Build 4719743300
💛 - Coveralls |
69b0b3f to
989f3d5
Compare
989f3d5 to
76a08cf
Compare
76a08cf to
6801629
Compare
6801629 to
52db0e0
Compare
52db0e0 to
329c280
Compare
329c280 to
782d573
Compare
782d573 to
3f0e139
Compare
9ce9918 to
1a78389
Compare
1a78389 to
76b1699
Compare
76b1699 to
765edb3
Compare
|
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward? This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
765edb3 to
c7260e5
Compare
c7260e5 to
e7def57
Compare
e7def57 to
53f22ec
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.23.10->0.24.4Release Notes
TypeStrong/TypeDoc
v0.24.4Compare Source
Bug Fixes
v0.24.3Compare Source
Bug Fixes
v0.24.2Compare 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
--hideParameterTypesInTitleoption.Bug Fixes
&showing as&and HTML text showing up in page contents navigation, #2224.source-ordersort strategy failing to compare reflections within a file.enum-member-source-orderspecialization of thesource-ordersort strategy which only compares enum members, #2237.__@​symbol name, #2234.--entryPointStrategy packages.Thanks!
v0.24.1Compare Source
Bug Fixes
@exampletags, #2222.v0.24.0Compare Source
Breaking Changes
@link,@linkcodeand@linkplaintags will now be resolved with TypeScript's link resolution by default. TheuseTsLinkResolutionoptioncan 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--pluginoption to indicate which modules should be loaded.packagesentry point strategy will now run TypeDoc in each provided package directory and then merge the results together.The previous
packagesstrategy has been preserved underlegacy-packagesand will be removed in 0.25. If the new strategy does not workfor your use case, please open an issue.
--loggeroption, to disable all logging, set thelogLeveloption tonone.[[link]]s, removed deprecatedReflection.findReflectionByName.@overloadto default ignored tags.API Breaking Changes
labelproperty onReflectionhas moved toComment.outoption has been changed from""to"./docs", #2195.DeclarationReflection#versiontoDeclarationReflection#projectVersionto match property onProjectReflection.Reflection#originalName.Reflection#kindString, useReflectionKind.singularString(reflection.kind)orReflectionKind.pluralString(reflection.kind)instead.named-tuple-memberandtemplate-literaltype kind have been replaced withnamedTupleMemberandtemplateLiteral, #2100.Reflection, includingurl,anchor,hasOwnDocument, andcssClasses.Application.bootstrapwill no longer load plugins. If you want to load plugins, useApplication.bootstrapWithPluginsinstead, #1635.Application.bootstrapwill 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.
sourcesproperty previously declared on baseReflectionclass toDeclarationReflectionandSignatureReflection.relevanceBoostfromContainerReflectiontoDeclarationReflectionsince setting it on the parent class has no effect.ReferenceType.getSymbol, reference types no longer reference thets.Symbolto enable generation from serialized JSON.OptionsReader.priorityhas been renamed toOptionsReader.orderto more accurately reflect how it works.ReferenceTypes 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.ReferenceTypes now longer include anidproperty for their target. They now instead include atargetproperty.Renderer.addExternalSymbolResolver, useConverter.addExternalSymbolResolverinstead.CallbackLogger.SerializeEventDatafrom serialization events.PageEventis now required forgetRenderContext. If caching the context object,pagemust be updated whengetRenderContextis called.PageEventno longer includes thetemplateproperty. TheTheme.rendermethod is now expected to take the template to render the page with as its second argument.secondaryNavigationmember onDefaultThemeRenderContext.navigationtosidebaronDefaultThemeRenderContextandnavigation.begin/navigation.endhooks tosidebar.begin/sidebar.end.Features
--useTsLinkResolutionoption (on by default) which tells TypeDoc to use TypeScript's@linkresolution.--jsDocCompatibilityoption (on by default) which controls TypeDoc's automatic detection of code blocks in@exampleand@defaulttags.@interfaceon type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519@namespaceon variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.@prop/@propertyto specify documentation for a child property of a symbol, intended for use with@interface.Promise<void>from theirloadfunction, #185.Renderer.preRenderAsyncJobsandRenderer.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.
typedocOptionskey inpackage.json, #2112.--cacheBustoption to tell TypeDoc to include include the generation time in files, #2124.--excludeReferencesoption to tell TypeDoc to omit re-exports of a symbol already included from the documentation.pageSidebar.beginandpageSidebar.end.Bug Fixes
namefield, #2190.@inheritDocon signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.vin versions, #2212.typeofon a reference with type arguments, #2220.Thanks!
v0.23.28 (2023-03-19)
Features
consttype parameters.@overloadtag.@satisfiestag.v0.23.27 (2023-03-16)
Features
--treatValidationWarningsAsErrorsto treat only validation warnings as errors without treating all warnings as errors, #2199.Bug Fixes
@privateand@protectedtags totypedoc/tsdoc.json, #2187.Thanks!
v0.23.26 (2023-02-26)
Features
Application.EVENT_VALIDATE_PROJECTevent for plugins which implement custom validation, #2183.Comment.displayPartsToMarkdownon for themes overwriting thecommenthelper, #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
excludeNotDocumentedKindsvariable to control which reflection types can be removedby the
excludeNotDocumentedoption, #2162.typedoc.jsonc,typedoc.config.js,typedoc.config.cjs,typedoc.cjsto the list of fileswhich TypeDoc will automatically use as configuration files.
Bug Fixes
node_moduleswill no longer be ignored, #2151.excludeNotDocumentedon arrow function-variables, #2156.package.jsonto exports declaration.Thanks!
v0.23.24 (2023-01-07)
Bug Fixes
Thanks!
v0.23.23 (2022-12-18)
Features
ts.Signatureto emittedEVENT_CREATE_SIGNATUREevent, #2002.Bug Fixes
src/andsrc/xare specified as entry points,src/will no longer be ignored, #2121.v0.23.22 (2022-12-11)
Features
Bug Fixes
@linktags within lists, #2103.v0.23.21 (2022-11-14)
Features
externalSymbolLinkMappings, #2102.Thanks!
v0.23.20 (2022-11-03)
Bug Fixes
@inheritDocif inheriting from a function type alias, #2087.v0.23.19 (2022-10-28)
Bug Fixes
titleLinkoption was not specified, #2085.Thanks!
v0.23.18 (2022-10-23)
Features
Bug Fixes
@paramcomment for the parameter if available, #1261.v0.23.17 (2022-10-18)
Features
titleLink,navigationLinksandsidebarLinksoptions to add additional links to the rendered output, #1830.sourceLinkTemplateoption to allow more flexible specification of remote urls.Deprecated now redundant
gitRevisiondetection 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>} Baztype declarations which forward type parameters to the importedsymbol as re-exports of that symbol, #2044.
Bug Fixes
widgets.pngand[email protected]files from generated assets folder.v0.23.14 (2022-09-03)
Features
externalSymbolLinkMappingsseethe documentation for usage examples and caveats, #2030.
addUnknownSymbolResolverwill now be checked when resolving@linktags, #2030.Note: To support this, resolution will now happen during conversion, and as such,
Renderer.addUnknownSymbolResolverhas beensoft deprecated in favor of
Converter.addUnknownSymbolResolver. Plugins should update to use the method onConverter.DefaultThemeRenderContext.attemptExternalResolutionhas also been deprecated since it will repeat work done during conversion,use
ReferenceType.externalUrlinstead.Converter.addUnknownSymbolResolverfor use by plugins supporting external links.Bug Fixes
v0.23.13 (2022-09-01)
Bug Fixes
v0.23.12 (2022-08-31)
Features
ParameterType.Objectfor declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_ENDevent emitted whenApplication.bootstrapis called.Bug Fixes
isIdentifierOrPrivateIdentifier.Thanks!
v0.23.11 (2022-08-26)
Features
skipErrorCheckingoption 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
@linktags resolved, #2029.DefaultThemeRenderContextnow contain all the HTML for their sections of the page, #2038.Thanks!
v0.23.10 (2022-07-31)
Features
sortoption.propasprop?, #2023.DefaultThemeRenderContext.markdownnow also accepts aCommentDisplayPart[]for rendering, #2004.Converter.resolveLinksmethod for use withConverter.parseRawComment, #2004.Bug Fixes
typedoc/tsdoc.jsonin TSDoc extends, #2015.@typedefcomments 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
excludeoption to filter them out.--includeVersionflag, #2010.v0.23.8 (2022-07-17)
Features
*.ghe.comand*.github.usGitHub enterprise domains for source links, #2001.Converter.parseRawCommentfor plugins to parse additional markdown files, #2004.Bug Fixes
{@​link}containing a URL, #1980.excludeNotDocumentedwill no longer remove functions/methods/accessors which are documented, #1994.sourcesproperty on signature reflections #1996.Thanks!
v0.23.7 (2022-07-09)
Bug Fixes
@jest/globalsin 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.jsontypedocfield. 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.--includeVersionoption will now be respected by--entryPointStrategy Packages. Also, for this combination, missingversionfield in the rootpackage.jsonwill not issue a warning.navigationpartial will now call the newsettings,primaryNavigation, andsecondaryNavigationpartials, #1987.Bug Fixes
Thanks!
v0.23.5 (2022-07-02)
Features
DEBUG_SEARCH_WEIGHTSglobal variable can now be set onwindowto add search scoring information in the search results.DefaultThemeRenderContext.iconsfor use/modification by themes.v0.23.4 (2022-07-02)
Bug Fixes
--entryPointStrategy Packagesis set, #1976.search.jsgenerated file.Features
--excludeoption will now be respected by--entryPointStrategy Packagesand can be used to exclude package directories, #1959.IndexEventon theRendererwhen preparing the search index, #1953.--searchInCommentsoption 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
@exampletag, #1967.intentionallyNotExportedwill now properly respect qualified names, #1972.export * as NSdeclarations, #1973.export const x = () => 123function variables, #1973.getandsetsignatures of an accessor have a comment.Features
--htmlLangoption to set thelangattribute in the generated HTML. Defaults toen, #1951.--basePathoption to override TypeDoc's detected root directory, #1924.:getterand:settermeaning keywords in declaration references.v0.23.2 (2022-06-28)
Bug Fixes
@modulecomments in the entry point, #1963.<= 0due tosearchCategoryBoostsorsearchGroupBoostswill be excluded from search.v0.23.1 (2022-06-26)
Bug Fixes
v0.23.28Compare Source
Features
consttype parameters.@overloadtag.@satisfiestag.v0.23.27Compare Source
Features
--treatValidationWarningsAsErrorsto treat only validation warnings as errors without treating all warnings as errors, #2199.Bug Fixes
@privateand@protectedtags totypedoc/tsdoc.json, #2187.Thanks!
v0.23.26Compare Source
Features
Application.EVENT_VALIDATE_PROJECTevent for plugins which implement custom validation, #2183.Comment.displayPartsToMarkdownon for themes overwriting thecommenthelper, #2115.Bug Fixes
export default undefined, #2175.Thanks!
v0.23.25Compare Source
Breaking Changes
material-<theme>, the value will need to be changed tomaterial-theme-<theme>, see the Shiki release notes.Features
excludeNotDocumentedKindsvariable to control which reflection types can be removedby the
excludeNotDocumentedoption, #2162.typedoc.jsonc,typedoc.config.js,typedoc.config.cjs,typedoc.cjsto the list of fileswhich TypeDoc will automatically use as configuration files.
Bug Fixes
node_moduleswill no longer be ignored, #2151.excludeNotDocumentedon arrow function-variables, #2156.package.jsonto exports declaration.Thanks!
v0.23.24Compare Source
Bug Fixes
Thanks!
v0.23.23Compare Source
Features
ts.Signatureto emittedEVENT_CREATE_SIGNATUREevent, #2002.Bug Fixes
src/andsrc/xare specified as entry points,src/will no longer be ignored, #2121.v0.23.22Compare Source
Features
Bug Fixes
@linktags within lists, #2103.v0.23.21Compare Source
Features
externalSymbolLinkMappings, #2102.Thanks!
v0.23.20Compare Source
Bug Fixes
@inheritDocif inheriting from a function type alias, #2087.v0.23.19Compare Source
Bug Fixes
titleLinkoption was not specified, #2085.Thanks!
v0.23.18Compare Source
Features
Bug Fixes
@paramcomment for the parameter if available, #1261.v0.23.17Compare Source
Features
titleLink,navigationLinksandsidebarLinksoptions to add additional links to the rendered output, #1830.sourceLinkTemplateoption to allow more flexible specification of remote urls.Deprecated now redundant
gitRevisiondetection starting withhttps?://introduced in v0.23.16, #2068.Thanks!
v0.23.16Compare Source
Features
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}in package.json, #2061.Bug Fixes
Thanks!
v0.23.15Compare Source
Features
@typedef {import("foo").Bar<Z>} Baztype declarations which forward type parameters to the importedsymbol as re-exports of that symbol, #2044.
Bug Fixes
widgets.pngand[email protected]files from generated assets folder.v0.23.14Compare Source
Features
externalSymbolLinkMappingsseethe documentation for usage examples and caveats, #2030.
addUnknownSymbolResolverwill now be checked when resolving@linktags, #2030.Note: To support this, resolution will now happen during conversion, and as such,
Renderer.addUnknownSymbolResolverhas beensoft deprecated in favor of
Converter.addUnknownSymbolResolver. Plugins should update to use the method onConverter.DefaultThemeRenderContext.attemptExternalResolutionhas also been deprecated since it will repeat work done during conversion,use
ReferenceType.externalUrlinstead.Converter.addUnknownSymbolResolverfor use by plugins supporting external links.Bug Fixes
v0.23.13Compare Source
Bug Fixes
v0.23.12Compare Source
Features
ParameterType.Objectfor declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_ENDevent emitted whenApplication.bootstrapis called.Bug Fixes
isIdentifierOrPrivateIdentifier.Thanks!
v0.23.11Compare Source
Features
skipErrorCheckingoption 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
@linktags resolved, #2029.DefaultThemeRenderContextnow contain all the HTML for their sections of the page, #2038.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 has been generated by Mend Renovate. View repository job log here.