[Snyk] Upgrade typedoc from 0.24.8 to 0.26.3 #6
Conversation
Snyk has created this PR to upgrade typedoc from 0.24.8 to 0.26.3. See this package in npm: typedoc See this project in Snyk: https://app.snyk.io/org/abdulrahman305/project/01031fdb-0ccb-4fc5-b7af-321a195f6ed3?utm_source=github&utm_medium=referral&page=upgrade-pr
|
👋 I'm here to help you review your pull request. When you're ready for me to perform a review, you can comment anywhere on this pull request with this command: As a reminder, here are some helpful tips on how we can collaborate together:
|
|
Your organization has reached the subscribed usage limit. You can upgrade your account by purchasing a subscription at Stripe payment link Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect. Current plan usage: 103.59% Have feedback or need help? |
|
Important Review skippedIgnore keyword(s) in the title. Please check the settings in the CodeRabbit UI or 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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/typedoc@0.24.8 |
Snyk has created this PR to upgrade typedoc from 0.24.8 to 0.26.3.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 24 versions ahead of your current version.
The recommended version was released on a month ago.
Release notes
Package name: typedoc
-
0.26.3 - 2024-06-28
- "On This Page" navigation now includes the page groups in collapsible sections, #2616.
- Added
- Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.
-
0.26.2 - 2024-06-24
- Added a
- Improved comment discovery to more closely match TypeScript's discovery when getting comments
- The
- If a comment on a method is inherited from a parent class, and the child class does not
-
0.26.1 - 2024-06-22
- Improved Korean translation coverage, #2602.
- Added
- Anchor links are no longer incorrectly checked for relative paths, #2604.
- Fixed an issue where line numbers reported in error messages could be incorrect, #2605.
- Fixed relative link detection for markdown links containing code in their label, #2606.
- Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.
- TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.
- Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
- Fixed an issue where modifier tags were not applied to top level modules in packages mode.
- Fixed an issue where excluded tags were not removed from top level modules in packages mode.
- @ KNU-K
-
0.26.0 - 2024-06-22
- Drop support for Node 16.
- Moved from
- Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
- Changed default of
- Renamed
- Removed deprecated
- Removed
- Removed
- Removed
- Renamed the
- Removed the
- All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
- API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where
- API:
- API: Deprecated
- API:
- API:
- API:
- API:
- Added support for TypeScript 5.5.
- Added new
- TypeDoc now has the architecture in place to support localization. No languages besides English
- Added support for a
- Added support for documenting individual elements of a union type, #2585.
- TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
- New option,
- TypeDoc will now copy modifier tags to children if specified in the
- TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both
- Groups and categories can now be collapsed in the page body, #2330.
- Added support for JSDoc
- Added
- Tag headers now generate permalinks in the default theme, #2308.
- TypeDoc now attempts to use the "most likely name" for a symbol if the symbol is not present in the documentation, #2574.
- Fixed an issue where the "On This Page" section would include markdown if the page contained headings which contained markdown.
- TypeDoc will now warn if a block tag is used which is not defined by the
- Added three new sort strategies
- Added new
- Added new
- TypeDoc will now render union elements on new lines if there are more than 3 items in the union.
- TypeDoc will now only render the "Type Declaration" section if it will provide additional information not already presented in the page.
- Added
- TypeDoc now supports objects with multiple index signatures, #2470.
- Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, #2546.
- Types rendered in the
- Links added with the
- Fixed issue in documentation validation where constructor signatures where improperly considered not documented, #2553.
- Keyboard focus is now visible on dropdowns and checkboxes in the default theme, #2556.
- The color theme label in the default theme now has an accessible name, #2557.
- Fixed issue where search results could not be navigated while Windows Narrator was on, #2563.
- Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, #2586.
- Validation will now be run in watch mode, #2584.
- Fixed an issue where custom themes which added dependencies in the
- Navigation folders sharing a name will no longer be saved with a shared key to
- The
- Broken
- Fixed
- Buttons to copy code now have the
- @ Aryakoste
- @ bladerunner2020
- @ Dinnerbone
- @ HarelM
- @ kraenhansen
- @ Nil2000
- @ steve02081504
- @ tristanzander
-
0.26.0-beta.5 - 2024-06-16
-
0.26.0-beta.4 - 2024-06-16
-
0.26.0-beta.3 - 2024-06-09
-
0.26.0-beta.2 - 2024-06-01
-
0.26.0-beta.1 - 2024-05-06
-
0.26.0-beta.0 - 2024-05-04
-
0.25.13 - 2024-04-07
- Added
- Moved "Generated by TypeDoc" footer into a
- Fixed conversion of
- Linking to a member on a page no longer incorrectly claims that
- @ xuhdev
-
0.25.12 - 2024-03-10
- Added support for TypeScript 5.4, #2517.
- Updated page font to work around issues with Mac rendering, #2518.
- @ docmattman
-
0.25.11 - 2024-03-06
- Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
- "On This Page" section is now smarter when handling page headings which do not follow the normal
-
0.25.10 - 2024-03-03
- Constructed references to enum types will be properly linked with
- Comments on property-methods will no longer be duplicated in generated documentation, #2509.
- Reduced rendered docs size by writing icons to a referenced SVG asset, #2505.
- The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
- When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.
-
0.25.9 - 2024-02-26
- Literal numeric unions will now be sorted during conversion, #2502.
- Module readmes will now be included in JSON output, #2500.
- Fixed crash when
- Fixed crash when converting an infinitely recursive type via a new
- Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.
- @ JMBeresford
-
0.25.8 - 2024-02-09
- Added a new
- Added support for the
- Added support for
- API: Exposed
- Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
- A class which implements itself will no longer cause a crash when rendering HTML, #2495.
- Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
- The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
- Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
- API:
-
0.25.7 - 2024-01-08
-
0.25.6 - 2024-01-01
-
0.25.5 - 2024-01-01
-
0.25.4 - 2023-11-26
-
0.25.3 - 2023-10-29
-
0.25.2 - 2023-10-08
-
0.25.1 - 2023-09-04
-
0.25.0 - 2023-08-25
-
0.24.8 - 2023-06-04
from typedoc GitHub release notesFeatures
Bug Fixes
mailto:links are no longer incorrectly recognized as relative paths, #2613.@ sinceto the default list of recognized tags, #2614.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.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!
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!
Unreleased
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!
Features
Bug Fixes
Thanks!
Bug Fixes
h1>h2>h3process, #2515.Bug Fixes
@ interface, #2508.For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
Features
Bug Fixes
--excludeNotDocumentedwas used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepthoption, #2507.Thanks!
Features
--sitemapBaseUrloption. When specified, TypeDoc will generate asitemap.xmlin your output folder that describes the site, #2480.@ classtag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
@ groupDescriptionand@ categoryDescriptionto provide a description of groups and categories, #2494.Context.getNodeCommentfor plugin use, #2498.Bug Fixes
Context.programswill no longer contain duplicates, #2498.Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information: