fix(deps): update dependency typedoc to ^0.27.0 #74
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}
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
60baad2 to
3cc3edd
Compare
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
4 times, most recently
from
a683d80 to
a7d6b84
Compare
renovate
bot
force-pushed
the
renovate/typedoc-0.x
branch
from
a7d6b84 to
df74550
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.26.11->^0.27.0Release Notes
TypeStrong/TypeDoc (typedoc)
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!
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 is behind base branch, 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.