-
-
Notifications
You must be signed in to change notification settings - Fork 0
Update dependency typedoc to v0.28.15 #209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
Open
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
c2d0205 to
2a5c72d
Compare
2a5c72d to
90fa262
Compare
90fa262 to
7a91f5c
Compare
Contributor
Author
|
7a91f5c to
fd49f40
Compare
fd49f40 to
74c3cc2
Compare
74c3cc2 to
21edc24
Compare
21edc24 to
75e3450
Compare
75e3450 to
6d90dd9
Compare
6d90dd9 to
010b690
Compare
010b690 to
d7edd86
Compare
d7edd86 to
7445337
Compare
7445337 to
ba65c69
Compare
ba65c69 to
fa6a907
Compare
fa6a907 to
0cc88fa
Compare
0cc88fa to
f555799
Compare
f555799 to
aff90b0
Compare
aff90b0 to
029e121
Compare
029e121 to
38b75c5
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.27.6->0.28.15Release Notes
TypeStrong/TypeDoc (typedoc)
v0.28.15Compare Source
Features
gitRevisionoption now accepts the special value{branch}, which indicates source links should usethe current git branch for links, #3041.
validation.invalidPathfor suppressing warnings caused by referencing relative paths whichdo not exist when building the documentation, #3033.
Logger.validationWarningfor validation which occurs during conversion rather thanduring TypeDoc's normal validation step, #3033.
v0.28.14Compare Source
Features
preservedTypeAnnotationTagsoption to specify tags whose type annotations shouldbe copied to the output documentation, #3020.
API: Introduced
typeAnnotationonCommentTagexcludePrivateClassFieldsoption to hide#privatemembers while allowingprivatemembers, #3017.@thistag for JS files which describethisparameters, #3026.v0.28.13Compare Source
Features
basePathoption now also affects relative link resolution, TypeDoc will also check forpaths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use the
displayBasePathoption, #3009.Bug Fixes
@inheritDocwill now correctly overwrite@remarksand@returnsblocks on the target comment, #3012.externalSymbolLinkMappingsoption now works properly on links pointing to inherited/overwritten signatures, #3014.v0.28.12Compare Source
Bug Fixes
@enumnow work for symbols imported from another module, #3003.API:
Reflection.hasCommentandComment.hasVisibleComponentnow accepts an optionalnotRenderedTagsparameter.v0.28.11Compare Source
Features
if they do not have their own comment, #2999.
Bug Fixes
?in the reflection preview and signature, #2995.compilerOptionsoption now functions properly with non-boolean options, #3000.compilerOptionsoption are now handled gracefully, #3000.v0.28.10Compare Source
Bug Fixes
v0.28.9Compare Source
Features
Bug Fixes
v0.28.8Compare Source
Features
pluginfunction can now be given plugin functions to load.-within tag names to supporttypescript-json-schema's@TJS-typetag, #2972.Context.createSymbolIdfor use by plugins.Bug Fixes
<img srcset>will now be discovered by TypeDoc, #2975.<source src>and<source srcset>elements will now be discovered by TypeDoc, #2975.Thanks!
v0.28.7Compare Source
Features
@sortStrategytag to override thesortoption on a specific reflection, #2965.Bug Fixes
export { type X }are no longer missing comments, #2970.localeto an unknown value will now cause TypeDoc to operate in English instead of a debug locale.v0.28.6Compare Source
Features
Bug Fixes
export { type X }are now detected and converted as interfaces/type aliases, #2962.Thanks!
v0.28.5Compare Source
Bug Fixes
ignoredHighlightLanguagescan now be used to prevent warnings for codeblocks containing languageswhich are supported by Shiki but are not loaded, #2956.
v0.28.4Compare Source
Features
Bug Fixes
The
chevronSmallhelper is now deprecated and will be removed with v0.29.0.@hiddenwill no longer appear in the"Hierarchy" section of the docs.
Thanks!
v0.28.3Compare Source
Bug Fixes
@inlinenow functions when referencing tuple types, #2932.@linklinks to the current page are now rendered, #2934.@includeCodenow supports regions in TypeScript files with.mtsand.ctsfile extensions, #2935.v0.28.2Compare Source
Features
@group noneand@category nonewill now render their children without a sectionheading in the default theme, #2922.
@disableGroupstag to completely disable the grouping mechanism for agiven reflection, #2922.
Bug Fixes
@classnow correctly handle@category, #2914.@classnow include constructor parameters, #2914.@classwith a generic first constructor function now adoptthat function's type parameters as the class type parameters, #2914.
externalSymbolLinkMappingsoption when URL is set to#, #2921.@typedefnow correctly handle the constraint, #2929.toStringon types containing index signatures now behave correctly, #2917.@inlineTypeto the list of tags excluded by default.v0.28.1Compare Source
Features
preservedTypeAnnotationTagsoption to specify tags whose type annotations shouldbe copied to the output documentation, #3020.
API: Introduced
typeAnnotationonCommentTagexcludePrivateClassFieldsoption to hide#privatemembers while allowingprivatemembers, #3017.@thistag for JS files which describethisparameters, #3026.v0.28.0Compare Source
Breaking Changes
/path separators, #2825.--entryPointStrategy mergemode now requires JSON from at least version 0.28.0.jptranslations fromlang, to migrate switch toja.intentionallyNotExportednow use a package name/package relative path instead of an absolute path for matching.source-ordersort ordering now considers package names / package relative paths instead of using the absolute paths to a file.package.jsonfile if--readmeis not setthis change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the
@functiontag, #2881.to how interfaces are rendered, #2817.
API Breaking Changes
ProjectReflection.getReflectionFromSymbolandProjectReflection.getSymbolFromReflectionhave been moved toContextPathandPathArrayparameter types now always contain normalized paths.Routerwhich is used for URL creation.Reflection.url,Reflection.anchor, andReflection.hasOwnDocumenthave been removed.Deserializer.reviveProject(s)no longer accepts an option to add project documents.Deserializer.reviveProjectsnow requires analwaysCreateEntryPointModuleoption.Comment.serializeDisplayPartsno longer requires a serializer argument.ReflectionSymbolId.fileNameis now optional, TypeDoc now stores a combination of a package name and package relative path instead.The
fileNameproperty will be present when initially created, but is not serialized.DeclarationReflection.relevanceBoostattribute which was added for plugins, but never used.i18nproxy is no longer passed to many functions, instead, referencei18nexported from the module directly.ReflectionKind.singularStringandReflectionKind.pluralStringnow returns translated strings.The methods on
Internationalizationto do this previously have been removed.DefaultThemeRenderContext'stypeDeclarationandtypeDetailsIfUsefulmethods now require both a reflection and a type in order to support
@expandTypeFeatures
--routeroption which can be used to modify TypeDoc's output folderstructure. This can be extended with plugins, #2111.
@primaryExportmodifier tag to provide more fine grainedcontrol over export conversion order, #2856
packagesRequiringDocumentationoption forvalidation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.typedoc/browserentrypoint for parsing and using serialized JSON files, #2528.packageOptionsasPartial<TypeDocOptions>, #2878.packageOptions, #2878.@functiontag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.TypeDocglobal object in the HTML theme which can be used to prevent TypeDoc from usinglocalStorage, #2872.@preventInlineand@inlineTypetags for further control extending the@inlinetag, #2862.@preventExpandand@expandTypetags for further control extending the@expandtag, #2862.DefaultThemeRenderContext.reflectionIconfor more granular control over displayed reflection icons.Bug Fixes
Thanks!
v0.27.9Compare Source
This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.
Features
v0.27.8Compare Source
Features
visibilityFilteroption now supports individual signatures, #2846.faviconoption may now be given a link starting withhttps?://instead of a path, #2851.#as the link inexternalSymbolLinkMappingsto indicate the type should not be linked to, #2853.Bug Fixes
undefined, #2854.Thanks!
v0.27.7Compare Source
Features
@includeCodeand@inlinecan now inject parts of files using regionnames or line numbers, #2816.
jatranslation options, deprecatedjpin favor ofja, #2843.--watchoption to support watching files not caught byTypeScript's watch mode, #2675.
@inlinetag now works in more places for generic types.Bug Fixes
@classincorrectly handling mapped types, #2842.so that declaration merged members with global symbols can be documented, #2844.
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.