Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Snyk] Upgrade typedoc from 0.22.18 to 0.25.4 #235

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Snyk] Upgrade typedoc from 0.22.18 to 0.25.4 #235

wants to merge 1 commit into from

Conversation

NOUIY
Copy link
Owner

@NOUIY NOUIY commented Jan 8, 2024

This PR was automatically created by Snyk using the credentials of a real user.


Snyk has created this PR to upgrade typedoc from 0.22.18 to 0.25.4.

ℹ️ 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 59 versions ahead of your current version.
  • The recommended version was released a month ago, on 2023-11-26.
Release notes
Package name: typedoc
  • 0.25.4 - 2023-11-26

    Features

    • Added support for TypeScript 5.3, #2446.
    • TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449.
      This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
    • Improved type rendering to highlight keywords differently than symbols.

    Bug Fixes

    • Fixed automatic declaration file resolution on Windows, #2416.
    • Fixed default option values on options declared by plugins in packages mode, #2433.
    • gitRevision will now be replaced in sourceLinkTemplate, #2434.
    • Improved handling of function-modules created with Object.assign, #2436.
    • TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
    • Fixed an infinite loop when skipLibCheck is used to ignore some compiler errors, #2438.
    • @ example tag titles will now be rendered in the example heading, #2440.
    • Correctly handle transient symbols in @ namespace-created namespaces, #2444.
    • TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
    • Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.

    Thanks!

  • 0.25.3 - 2023-10-29

    Features

    • Added --sourceLinkExternal option to render source code links as external, #2415.
    • TypeDoc no longer requires the declarationMap option to be set to true to handle cross-package links in packages mode, #2416.
    • Added external-last option for the --sort option, #2418.

    Bug Fixes

    • TypeDoc now attempts to correct local anchor links in readme files which are broken by its deconfliction logic, #2413.
    • TypeDoc now finds comments on index signatures again, #2414.
    • TypeDoc now does a better job of detecting properties when destructured function arguments are used.
    • Quotes will now be properly escaped in HTML attribute values.

    Thanks!

  • 0.25.2 - 2023-10-08

    Features

    • Added navigationLeaves option to remove branches from the navigation tree, #2382.
    • Added sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #2393.
    • Improved support for multi-word searches, #2400.

    Bug Fixes

    • Fixed conversion of @ template constraints on JSDoc defined type parameters, #2389.
    • Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #2403.
    • Fixed tsconfig handling for projects using a solution-style tsconfig, #2406.
    • Fixed broken settings icons caused by icon caching introduced in 0.25.1, #2408.
    • Corrected module comment handling on declaration files containing a single declare module "foo", #2401.

    Thanks!

  • 0.25.1 - 2023-09-04

    Features

    • Added stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #2381.
    • Added --excludeCategories config option to remove reflections present in any excluded category, #1407.
    • If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #2304.
    • Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
      with large projects and also provides large space benefits. Themes may now override DefaultTheme.buildNavigation
      to customize the displayed navigation tree, #2287.
      Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
      It will be removed in v0.26.
    • The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
    • TypeDoc will now attempt to cache icons when DefaultThemeRenderContext.icons is overwritten by a custom theme.
      Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
      each page. TypeDoc does it in the defaultLayout template.
    • Cache URL derivation during generation, #2386.

    Bug Fixes

    • @ property now works as expected if used to override a method's documentation.
    • Deprecated functions/methods are now correctly rendered with a struck-out name.
    • --watch mode works again, #2378.
    • Improved support for optional names within JSDoc types, #2384.
    • Fixed duplicate rendering of reflection flags on signature parameters, #2385.
    • TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
    • --exclude is now respected when expanding globs in entry points, #2376.

    Thanks!

  • 0.25.0 - 2023-08-25
    Read more
  • 0.24.8 - 2023-06-04

    Features

    • Added support for TypeScript 5.1, #2296.
    • Added navigation.fullTree to 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.
    • TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
    • Optimized icon caching to reduce file size in generated HTML documentation, #2287.
    • Render property description of "roughly top level" object types, #2276.
    • Added MarkdownEvent.INCLUDE for plugins, #2284.

    Bug Fixes

    • When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
      and any other block tags in the order they are defined in the comment, #2285.
    • Comments are no longer removed from classes/interfaces containing call signatures, #2290.

    Thanks!

  • 0.24.7 - 2023-05-08
    Read more
  • 0.24.6 - 2023-04-24
    Read more
  • 0.24.5 - 2023-04-22
    Read more
  • 0.24.4 - 2023-04-16
    Read more
  • 0.24.3 - 2023-04-16
  • 0.24.2 - 2023-04-15
  • 0.24.1 - 2023-04-09
  • 0.24.0 - 2023-04-08
  • 0.24.0-beta.8 - 2023-04-03
  • 0.24.0-beta.7 - 2023-03-26
  • 0.24.0-beta.6 - 2023-03-25
  • 0.24.0-beta.5 - 2023-03-25
  • 0.24.0-beta.4 - 2023-03-25
  • 0.24.0-beta.3 - 2023-03-12
  • 0.24.0-beta.2 - 2023-03-06
  • 0.24.0-beta.1 - 2023-03-05
  • 0.23.28 - 2023-03-19
  • 0.23.27 - 2023-03-16
  • 0.23.26 - 2023-02-26
  • 0.23.25 - 2023-02-11
  • 0.23.24 - 2023-01-07
  • 0.23.23 - 2022-12-18
  • 0.23.22 - 2022-12-11
  • 0.23.21 - 2022-11-14
  • 0.23.20 - 2022-11-03
  • 0.23.19 - 2022-10-28
  • 0.23.18 - 2022-10-23
  • 0.23.17 - 2022-10-18
  • 0.23.16 - 2022-10-10
  • 0.23.15 - 2022-09-18
  • 0.23.14 - 2022-09-03
  • 0.23.13 - 2022-09-01
  • 0.23.12 - 2022-08-31
  • 0.23.11 - 2022-08-26
  • 0.23.10 - 2022-07-31
  • 0.23.9 - 2022-07-24
  • 0.23.8 - 2022-07-17
  • 0.23.7 - 2022-07-09
  • 0.23.6 - 2022-07-08
  • 0.23.5 - 2022-07-02
  • 0.23.4 - 2022-07-02
  • 0.23.3 - 2022-07-01
  • 0.23.2 - 2022-06-28
  • 0.23.1 - 2022-06-26
  • 0.23.0 - 2022-06-26
  • 0.23.0-beta.7 - 2022-06-25
  • 0.23.0-beta.6 - 2022-06-25
  • 0.23.0-beta.5 - 2022-06-20
  • 0.23.0-beta.4 - 2022-06-04
  • 0.23.0-beta.3 - 2022-06-03
  • 0.23.0-beta.2 - 2022-05-30
  • 0.23.0-beta.1 - 2022-04-19
  • 0.23.0-beta.0 - 2022-04-17
  • 0.22.18 - 2022-06-25
from typedoc GitHub release notes
Commit messages
Package name: typedoc

Compare

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:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

@guardrails GuardRails
Copy link

guardrails bot commented Jan 8, 2024

⚠️ We detected 7 security issues in this pull request:

Vulnerable Libraries (7)
Severity Details
High pkg:npm/[email protected] (t) upgrade to: > 4.18.2
High pkg:npm/[email protected] (t) upgrade to: > 3.15.0
High pkg:npm/@11ty/[email protected] (t) upgrade to: > 1.0.2
High pkg:npm/[email protected] (t) upgrade to: > 4.3.8
Critical pkg:npm/@google-cloud/[email protected] (t) upgrade to: > 3.12.0
N/A pkg:npm/[email protected] (t) upgrade to: 15.10.1
Medium pkg:npm/[email protected] (t) upgrade to: > 3.1.1

More info on how to fix Vulnerable Libraries in JavaScript.

👉 Go to the dashboard for detailed results.

📥 Happy? Share your feedback with us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NOUIY @snyk-bot