chore(deps): update dependency typedoc to v0.27.5 #1667
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
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
❌ Deploy Preview for aquamarine-blini-95325f failed. Why did it fail? →
|
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
a2a888c to
3efc304
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.24.8->0.27.5Release Notes
TypeStrong/TypeDoc (typedoc)
v0.27.5Compare Source
Bug Fixes
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, #2808.
rendered document and the parent property/page will be linked to instead,
#2808. These warnings can be disabled with the
validation.rewrittenLinkoption.
https://links under thehostedBaseUrloption's URL will nolonger be treated as external, #2809.
Thanks!
v0.27.4Compare Source
Features
Converter.EVENT_CREATE_PROJECTevent which fires when a project is created by the converter, #2800.Bug Fixes
@includeand@includeCodenow work for comments on the entry point for projects with a single entry point, #2800.@summarynow works to describe functions within modules, #2803.v0.27.3Compare Source
Features
Bug Fixes
highlightLanguagesoption now permits Shiki aliases to be specified rather than just the language ID, #2798.Thanks!
v0.27.2Compare Source
Bug Fixes
v0.27.1Compare Source
Bug Fixes
@categoryDescriptionand@groupDescriptionon module pages, #2787.v0.27.0Compare Source
Breaking Changes
result in a different file name structure, #2714.
have changed. They can be partially restored to the previous format by
setting
--sluggerConfiguration.lowercase false. This change was made tomore closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
hideParameterTypesInTitleoption, this was originally added asa workaround for many signatures overflowing the available horizontal space
in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
so this option is no longer necessary.
kindSortOrderto put references last.sortorder to usealphabetical-ignoring-documentsinstead of
alphabetical.suppressCommentWarningsInDeclarationFilestotrue(e.g.
X, notnew X)@group,@category,@groupDescriptionand@categoryDescriptionwill no longer be removed from the reflections they are present on. They are
skipped during rendering with the
notRenderedTagsoption.Features
package.jsonexports if theyare not provided manually, #1937.
#anchorlinks toreference a heading within them.
@paramcomments with nested object types, #2555.@paramcomments which reference a typealias/interface. Important properties on the referenced type can now be
highlighted with
@param options.foo, which will result in the additionalnote being included under the documentation for that parameter, #2147. Note:
This feature is limited to references. It is not supported on other types of
types.
outputsoption which is an array of outputs. This can be usedto render the documentation multiple times with different rendering options
or output types, #2597.
@expandtag which can be placed on type aliases andinterfaces. When a type with
@expandis referenced and TypeDoc has a placeto include additional details about the type, the properties of the type
will be included in the page where
@expandis found. Note that use of thistag can significantly increase the size of your generated documentation if
it is applied to commonly used types as it will result in inlining the
comments for those types everywhere they are referenced, #2303.
@inlinetag which can be placed on type aliases andinterfaces. When a type with
@inlineis referenced, TypeDoc will resolvethe referenced type and convert the type as if it was included directly
within the referencing type. Note that use of this tag can significantly
increase the size of your generated documentation if it is applied to
commonly used types as it will result in inlining the comments for those
types everywhere they are referenced, #2303.
@useDeclaredTypetag for type aliases which can sometimesimprove their documentation, #2654.
@mergeModuleWithtag which can be used to tell TypeDoc toplace a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
@includeand@includeCodeinline tags to include files withincomments/documents.
notRenderedTagsoption. This option is similar to theexcludeTagsoption, but while
excludeTagswill result in the tag being completelyremoved from the documentation,
notRenderedTagsonly prevents it frombeing included when rendering.
groupReferencesByTypeoption.navigation.excludeReferencesoptionuseFirstParagraphOfCommentAsSummaryoption to configure how TypeDochandles comments for module members without the
@summarytag.faviconoption to specify a.icoor.svgfavicon to reference.together and will expand/collapse together, #2335.
app.outputsobject for defining new output strategies.@layer typedoc, #2782.Bug Fixes
readonlyindex signatures.overloads if present, #2718.
@enumif the type was declared before the variable, #2719.declared inside
declare global, #2774declare module "foo"as a module rather than a namespace, #2778.cases. This primarily affected destructured parameters.
yamlto the highlight languages supported by default.txtas an alias oftextto indicate a code blockshould not be highlighted.
@ignoreor@hiddenbut still referenced byother types will no longer produce warnings about not being exported.
module when resolving
@linktags.JavaScript is disabled.
rather than when converting. This prevents issues where boosts used by just
one package were incorrectly reported as unused when running with
entryPointStrategy set to packages.
Thanks!
v0.26.11Compare Source
Features
hostedBaseUrlis set to the root page on a website, TypeDoc will now includeWebSitestructured data, #2760.Bug Fixes
"module": "ESNext"and importing TypeDoc, #2747.v0.26.10Compare Source
Bug Fixes
v0.26.9Compare Source
Features
headingsoption to control optional headings, #2729.Bug Fixes
externalSymbolLinkMappingsnow uses the TypeScript reported link target if available, #2725.Thanks!
v0.26.8Compare Source
Features
<div>tags and includes the tag name in a class name, #2723.Bug Fixes
@linktags present in comments at the start of source files.ReflectionSymbolId.posno longer references the position before any doc comments for a symbol.This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.
Thanks!
v0.26.7Compare Source
Features
customJsoption to include a script tag in generated HTML output, #2650.markdownLinkExternaloption to treathttp[s]://links in markdown documents and comments as external to be opened in a new tab, #2679.navigation.excludeReferencesoption to prevent re-exports from appearing in the left hand navigation, #2685.@abstracttag, #2692.Bug Fixes
@linktags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.@paramtags on comments attached to function callback parameters, #2683.alphabeticalandalphabetical-ignoring-documentssort options now uselocaleCompareto sort, #2684.thisparameter, #2698.Thanks!
v0.26.6Compare Source
Features
@extendsblock tag no longer produces warnings, #2659.This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
navigation.compactFoldersoption to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.Bug Fixes
suppressCommentWarningsInDeclarationFilesoption now correctly ignores warnings in.d.ctsand.d.mtsfiles, #2647.v0.26.5Compare Source
Features
OptionDefaults, #2640.Bug Fixes
@documentincludes an empty file, #2638.Thanks!
v0.26.4Compare Source
Bug Fixes
@linktags will now be validated in referenced markdown documents, #2629.@linktags are now resolved in project documents, #2629.@hiddenis now properly applied when placed in a function implementation comment, #2634.Thanks!
v0.26.3Compare Source
Features
Bug Fixes
mailto:links are no longer incorrectly recognized as relative paths, #2613.@sinceto the default list of recognized tags, #2614.v0.26.2Compare Source
Features
--suppressCommentWarningsInDeclarationFilesoption to disable warnings fromparsing comments in declaration files, #2611.
for members of interfaces/classes, #2084, #2545.
Bug Fixes
textnon-highlighted language no longer causes warnings when rendering, #2610.use an
@paramtag from the parent, TypeDoc will no longer warn about the@paramtag.v0.26.1Compare Source
Features
Bug Fixes
@authorto the default list of recognized tags, #2603..jsoncconfiguration files are now properly read as JSONC, rather than being passed torequire.Thanks!
v0.26.0Compare Source
Breaking Changes
markedtomarkdown-itfor parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.This means that any projects setting
markedOptionsneeds to be updated to usemarkdownItOptions.Unlike
marked@4,markdown-itpushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with themarkdownItLoaderoption.As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the
--highlightLanguagesoption.--excludePrivatetotrue.--sitemapBaseUrlto--hostedBaseUrlto reflect that it can be used for more than just the sitemap.navigation.fullTreeoption.--mediaoption, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.--includesoption, use the@documenttag instead.--stripYamlFrontmatteroption, TypeDoc will always do this now.--htmlLangoption to--lang.--gaIdoption for Google Analytics integration and correspondinganalyticstheme member, #2600.were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
Converter.EVENT_CREATE_DECLARATIONwas emitted for
ProjectReflectionin some circumstances.MapOptionDeclaration.mapErrorhas been removed.BindOptiondecorator has been removed.DeclarationReflection.indexSignaturehas been renamed toDeclarationReflection.indexSignatures.Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
JSONOutput.SignatureReflection.typeParameterhas been renamed totypeParametersto match the JS API.DefaultThemeRenderContext.iconsCachehas been removed as it is no longer needed.DefaultThemeRenderContext.hookmust now be passedcontextif required by the hook.Features
--projectDocumentsoption to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
packageOptionsobject which specifies options that should be applied to each entry point when running with--entryPointStrategy packages, #2523.--hostedBaseUrlwill now be used to generate a<link rel="canonical">element in the project root page, #2550.Note: This feature is only available on type aliases directly containing unions.
--customFooterHtmlto add custom HTML to the generated page footer, #2559.--cascadedModifierTagsoption, #2056.@alphaand@beta), #2056.@hideconstructortag.This tag should only be used to work around TypeScript#58653, prefer the more general
@hidden/@ignoretag to hide members normally, #2577.--useHostedBaseUrlForAbsoluteLinksoption to use the--hostedBaseUrloption to produce absolute links to pages on a site, #940.--blockTagsoption.documents-first,documents-last, andalphabetical-ignoring-documentsto order markdown documents.--alwaysCreateEntryPointModuleoption. When set, TypeDoc will always create aModulefor entry points, even if only one is provided.If
--projectDocumentsis used to add documents, this option defaults totrue, otherwise, defaults tofalse.--highlightLanguagesoption to control what Shiki language packages are loaded.This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
comment.beforeTagsandcomment.afterTagshooks for plugin use.Combined with
CommentTag.skipRenderingthis can be used to provide custom tag handling at render time.Bug Fixes
Returnsheader are now properly colored, #2546.navigationLinksoption are now moved into the pull out navigation on mobile displays, #2548.@licenseand@importcomments will be ignored at the top of files, #2552.charsetis now correctly cased in<meta>tag generated by the default theme, #2568.<head>element could result in broken icons, #2589.@defaultand@defaultValueblocks are now recognized as regular blocks if they include inline tags, #2601.localStorage.--hideParameterTypesInTitleoption no longer applies when rendering function types.@linktags in readme files will now cause a warning when link validation is enabled.externalSymbolLinkMappingsoption's support for meanings in declaration references.type=buttonattribute set to avoid being treated as submit buttons.--hostedBaseUrlwill now implicitly add a trailing slash to the generated URL.Thanks!
v0.25.13Compare Source
Features
gitRevision:shortplaceholder option to--sourceLinkTemplateoption, #2529.Links generated by TypeDoc will now default to using the non-short git revision.
<footer>tag, addedfooter.beginandfooter.endrender hooks for use by custom plugins, #2532.
Bug Fixes
NoInfermissing type parameter reference, #2539."This member is normally hidden due to your filter settings" for every member.
Thanks!
v0.25.12Compare Source
Bug Fixes
Thanks!
v0.25.11Compare Source
Bug Fixes
h1>h2>h3process, #2515.v0.25.10Compare Source
Bug Fixes
@interface, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
v0.25.9Compare Source
Features
Bug Fixes
--excludeNotDocumentedwas used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepthoption, #2507.Thanks!
v0.25.8Compare Source
v0.25.7Compare Source
Bug Fixes
v0.25.6Compare Source
Bug Fixes
v0.25.5Compare Source
v0.25.4Compare Source
Features
This can be controlled through the new
DefaultThemeRenderContext.reflectionPreviewhelper.Bug Fixes
gitRevisionwill now be replaced insourceLinkTemplate, #2434.Object.assign, #2436.skipLibCheckis used to ignore some compiler errors, #2438.@exampletag titles will now be rendered in the example heading, #2440.@namespace-created namespaces, #2444.Thanks!
v0.25.3Compare Source
Features
--sourceLinkExternaloption to render source code links as external, #2415.declarationMapoption to be set to true to handle cross-package links in packages mode, #2416.external-lastoption for the--sortoption, #2418.Bug Fixes
Thanks!
v0.25.2Compare Source
Features
navigationLeavesoption to remove branches from the navigation tree, #2382.sortEntryPointsoption (defaults to true) to allow disabling entry point sorting, #2393.Bug Fixes
@templateconstraints on JSDoc defined type parameters, #2389.declare module "foo", #2401.Thanks!
v0.25.1Compare Source
Features
stripYamlFrontmatterconfig option to remove YAML frontmatter from README.md, #2381.--excludeCategoriesconfig option to remove reflections present in any excluded category, #1407.with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigationto customize the displayed navigation tree, #2287.
Note: This change renders
navigation.fullTreeobsolete. If you set it, TypeDoc will warn that it is being ignored.It will be removed in v0.26.
DefaultThemeRenderContext.iconsis overwritten by a custom theme.Note: To perform this optimization, TypeDoc relies on
DefaultThemeRenderContext.iconCachebeing rendered withineach page. TypeDoc does it in the
defaultLayouttemplate.Bug Fixes
@propertynow works as expected if used to override a method's documentation.--watchmode works again, #2378.intrinsickeyword if TS intrinsic types are included in documentation.--excludeis now respected when expanding globs in entry points, #2376.Thanks!
v0.25.0Compare Source
Breaking Changes
legacy-packagesoption for--entryPointStrategy.--categorizeByGrouptofalse.gitRemoteis no longer supported.Applicationinstance must now be retrieved viaApplication.bootstraporApplication.bootstrapWithPlugins, #2268.ReflectionKind.ObjectLiteralthat was never used by TypeDoc.DefaultThemeRenderContext.commentandDefaultThemeRenderContext.attemptExternalResolution.Features
--preserveLinkTextoption (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.
--disableGitoption to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups,@hideGroups,@showCategories,@hideCategoriesto configure the navigation pane on aper-reflection basis, #2329.
--jsDocCompatibility.defaultTagsset,@defaultValueis now implicitly a code block if the text contains no code, #2370.Bug Fixes
Foo#bar) links were used and--useTsLinkResolutionis enabled in some cases, #2360.@inheritDocwas not properly resolved across packages in packages mode, #2331.@interfaceuse on union types, #2352.Theme.getUrls, #2318.@namespaceis used on a variable with an associated namespace, #2364.@namespaceproperty discovery if merged with a type and the type was declared first #2364.reflection.sourcesnow considers the node's name like non-signature location discovery does.Thanks!
v0.24.8 (2023-06-04)
Features
navigation.fullTreeto 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.
--prettyoption now also controls whether generated HTML contains line breaks, #2287.Configuration
📅 Schedule: Branch creation - "* 0-3 * * 1" (UTC), 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 was generated by Mend Renovate. View the repository job log.