This repository was archived by the owner on Mar 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
chore(deps): update dependency typedoc to v0.23.21 #81
Open
renovate
wants to merge
1
commit into
main
Choose a base branch
from
renovate/typedoc-0.x
base: main
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
a40d81f to
86759bf
Compare
86759bf to
3985304
Compare
3985304 to
be36797
Compare
Pull Request Test Coverage Report for Build 3508950717
💛 - Coveralls |
be36797 to
d20d8f6
Compare
d20d8f6 to
9330a64
Compare
9330a64 to
fceabda
Compare
fceabda to
3240858
Compare
3240858 to
eea1584
Compare
eea1584 to
c94cb0b
Compare
c94cb0b to
dd317ec
Compare
dd317ec to
72bc7c8
Compare
72bc7c8 to
bc3cb15
Compare
bc3cb15 to
cf97aff
Compare
cf97aff to
4dd124e
Compare
4dd124e to
5579f1d
Compare
5579f1d to
d3c14dc
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.22.15->0.23.21Release Notes
TypeStrong/TypeDoc
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.pngandwidgets@2x.pngfiles 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!
v0.23.10Compare Source
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.9Compare Source
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.8Compare Source
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.7Compare Source
Bug Fixes
@jest/globalsin a comment will no longer be parsed as a tag #1990.v0.23.6Compare Source
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.5Compare Source
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.4Compare Source
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.3Compare Source
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.2Compare Source
Features
externalSymbolLinkMappings, #2102.Thanks!
v0.23.1Compare Source
Bug Fixes
titleLinkoption was not specified, #2085.Thanks!
v0.23.0Compare Source
Breaking Changes
{@​link}tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.For most cases, this will just work. See the documentation for details on how link resolution works.
[[ target ]]). Use{@​link target}instead. The{@​link}syntax will be recognized by TypeScript 4.3 and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for[[ target ]]style links.Support for
[[`links`]]with brackets + code ticks have been dropped.extendsin typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with./.DeclarationReflections,getSignatureis no longer a one-tuple.DeclarationReflections,setSignatureis no longer a one-tuple.DeclarationReflections,typeParameterhas been renamed totypeParameterssearchGroupBoostsoption must now be given the rendered group name rather than reflection kind names, and can be given custom group names.@inheritDocnow follows the behavior specified by TSDoc when copying comments with a reference.gaSiteoption has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846.hideLegendoption has been removed as the default theme no longer contains a legend.listInvalidSymbolLinksoption has been removed. Usevalidation.invalidLinkinstead.trueandfalsevalues have been removed from--emit, to migrate replacetruewith"both"andfalsewith"docs"(the default).validation.invalidLinkoption is now on by default.reflection.decorates,reflection.decorators, and their corresponding interfaces have been removed as no code in TypeDoc used them.Commentclass has changed significantly to support multiple tag kinds.Converter.EVENT_CREATE_TYPE_PARAMETERandConverter.EVENT_CREATE_DECLARATIONwill now never be passed ats.Nodeas their third argument.ReflectionFlag.Constflag set.reflection.defaultValueis no longer set for enum members. The same information is available onreflection.typewith more precision.removeReaderByName,addDeclarationsandremoveDeclarationByNamemethods onOptions.ProjectReflection.directory, it was unused by TypeDoc and not properly tested.ProjectReflection.files, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.ReflectionGroup.kindsince groups can now be created with the@grouptag.ReflectionKind.Event, the@eventtag is now an alias for@group Events. Note: This changes the value ofReflectionKind.Referencefrom16777216to8388608.Features
TypeDoc now supports the
@grouptag to group reflections in a page. If no@grouptag is specified, reflections will be grouped according to their kind, #1652.TypeDoc will now search for
typedoc.js(on)in the.configfolder in the current working directory.Entry point strategies
ResolveandExpandmay now specify globs, #1926.typedoc.jsonnow supports comments liketsconfig.json.TypeDoc will now read the
blockTags,inlineTags, andmodifierTagsout oftsdoc.jsonin the same directory astsconfig.jsonif it exists.It is recommended to add
"extends": ["typedoc/tsdoc.json"], which defines TypeDoc specific tags to yourtsdoc.jsonif you create one.If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855.
Improved support for JSDoc style
@exampletags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135.TypeDoc will now render members marked with
@deprecatedwith a line through their name, #1381.Added new
commentStyleoption which can be used to control what comments TypeDoc will parse./**//commentsTypeDoc will now warn if part of a comment will be overwritten due to use of
@inheritDocinstead of silently dropping part of the comment.Added support for inline
@inheritDoctags, #1480.It is now possible to link directly to a specific overload, #1326.
The JSON output will now include URLs to the file on the remote repository if possible.
Added a new
visibilityFiltersoption which controls the available filters on a page.TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, #1923.
Added
blockTags,inlineTags,modifierTagsto control which tags TypeDoc will allow when parsing comments.If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag.
Bug Fixes
Type Parametersheading if there are no type parameters in some cases.implementsby other interfaces/classes.@inheritDocon accessors, #1927.exports.foo = ...will now be converted as variables rather than properties.searchCategoryBoostsare now correctly computed for all categories, #1960.excludeNotDocumentedoption will no longer hide a module if it has a documentation comment, #1948.--excludeNotDocumentedfrom hiding properties of type literals (ainfunction fn(p: { a: string })), #1752.ctsandmtsextensions in packages resolution mode, #1952.Thanks!
v0.22.18 (2022-06-25)
Features
@enumstyle enums to also permit non-literal strings and numbers, #1956.Bug Fixes
searchGroupBoostswas only computing the boost for the first reflection in a group, #1958.Thanks!
v0.22.17 (2022-06-01)
Features
Bug Fixes
v0.22.16 (2022-05-30)
Features
@enum, #1918.typeset to either aLiteralTypewith a string or numeric value or anIntrinsicTypewith typenumber, #1942.Using
defaultValueonEnumMemberreflections is now deprecated, and will be broken in 0.23.Bug Fixes
enum-value-ascendingorenum-value-descendingsort strategies in mixed string/number enums.Thanks!
v0.22.15 (2022-04-10)
Features
abstractand enums which areconstwill now be indicated in their rendered documentation, #1874.compilerOptions, which can be used to override compiler options read fromtsconfig.json, #1891.content.begin,content.end,navigation.begin,navigation.endBug Fixes
undefined, #1907.Thanks!
v0.22.14 (2022-04-07)
Bug Fixes
@enumstyle enum members defined in declaration files, #1880.--validation.notDocumentedwarnings for functions/methods/type aliases, #1895, #1898.removeReflectionnot completely removing reflections from the project, #1898.@hidden/@ignore/@excludecomments on default exports with no associated variable, #1903.makeRecursiveVisitorwill now correctly call theintersectioncallback, #1910.Thanks!
v0.22.13 (2022-03-06)
Features
@paramcomments for nested members that target union and intersection types, #1876.Bug Fixes
--requiredToBeDocumentedoption, #1872.thisparameters in documentation for some functions, #1875.v0.22.12 (2022-02-20)
Features
--validation.notDocumentedoption to warn on items that are not documented, #1817.Bug Fixes
constvariables not properly marked asconst, #1866.Thanks!
v0.22.11 (2022-01-18)
Features
cnameoption for GitHub Pages custom domain support, #1803.ReferenceTypes which reference an external symbol will now includequalifiedNameandpackagein their serialized JSON.Bug Fixes
h1andh2elements being too low, #1796.addUnknownSymbolResolverwill now be correctly given the qualified name to the symbol being referenced, #1832.Thanks!
v0.22.10 (2021-11-25)
Features
Bug Fixes
default, thedefaultexport will now always be the renamed symbol, #1795.@types/nodeversions, Gerrit0/typedoc-plugin-missing-exports#5.v0.22.9 (2021-11-14)
Features
It will only work if both loaded TypeDocs are v0.22.9 or later.
typedoc-themein their keywords.Plugins which define a custom theme should include this keyword so that they can be automatically collected and displayed at https://typedoc.org/guides/themes/.
Bug Fixes
<meta charset="utf-8" />appears within the first 1024 bytes of generated pages, #1783.Thanks!
v0.22.8 (2021-11-07)
Features
See the documentation in custom-themes.md for details.
Bug Fixes
@categorytag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.7 (2021-10-25)
Features
githubprivate.comdomain, #1743.Bug Fixes
hideGeneratoris set, #1749.@categorytag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.6 (2021-10-17)
Features
@enumto all variables whose property types are string literals, #1740.Bug Fixes
as conststyle enums, #1727.@typeParamon type aliases, #1733.Thanks!
v0.22.5 (2021-10-02)
Features
@paramcomments for destructured parameters and rename__namedParametersto the name specifiedin the
@paramcomment if the number of@paramcomments match the number of parameters, resolves #1703.intentionallyNotExportedoption may now include file names/paths to limit its scope, for example, the followingwill suppress warnings from
Fooinsrc/foo.tsnot being exported, but will not suppress warnings if anotherFoodeclared in
src/utils/foo.tsis not exported.{ "intentionallyNotExported": ["src/foo.ts:Foo"] }--emitoption can now be used to more finely control what TypeDoc will emit.bothdocsnonetrueboth, for backwards compatibility. Will be removed in 0.23.falsedocs, for backwards compatibility. Will be removed in 0.23.Bug Fixes
<caption>elements from@exampletags, resolves #1679.emitDeclarationOnlycompiler option is now supported, resolves #1716..json, resolves #1712.globalThisnamespace, could only be caused by a plugin.Thanks!
v0.22.4 (2021-09-18)
Features
validationcan now be set to true/false to enable/disable all flags within them.githubPagesoption (default: true), which will create a.nojekyllpage in the generated output, resolves #1680.MarkdownEventis now exported, resolves #1696.Bug Fixes
Thanks!
v0.22.3 (2021-09-12)
Bug Fixes
light-plusanddark-plus, they were accidentally set tomin-lightandmin-darkin v0.22.0.Features
validationoption 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": { "notExported": true } }validationoption, deprecatedlistInvalidSymbolLinks, which will be removed in 0.23.v0.22.2 (2021-09-11)
Bug Fixes
v0.22.1 (2021-09-10)
Bug Fixes
v0.22.18Compare Source
Features
@enumstyle enums to also permit non-literal strings and numbers, #1956.Bug Fixes
searchGroupBoostswas only computing the boost for the first reflection in a group, #1958.Thanks!
v0.22.17Compare Source
Features
Bug Fixes
v0.22.16Compare Source
Features
@enum, #1918.typeset to either aLiteralTypewith a string or numeric value or anIntrinsicTypewith typenumber, #1942.Using
defaultValueonEnumMemberreflections is now deprecated, and will be broken in 0.23.Bug Fixes
enum-value-ascendingorenum-value-descendingsort strategies in mixed string/number enums.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.