Update dependency typedoc to ^0.27.0 #165
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
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
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.26.5->^0.27.0Release Notes
TypeStrong/TypeDoc (typedoc)
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.
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.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 was generated by Mend Renovate. View the repository job log.